WPF Samples

Drag and Drop within a TreeView

mpochimcherla — Fri, 22 Feb 2008 20:30:04 GMT

This sample demonstrates drag-and-drop within a TreeView, a common user-interface feature in Windows Forms applications that's also possible in WPF applications.

This sample does not implement styling for drop targets and does not auto-expand nodes, but it will get you started.

URI Query String Parameters Sample

jaytayl — Sat, 04 Aug 2007 23:16:56 GMT

This sample demonstrates how to retrieve the query string parameters from a uniform resource identifier (URI) for an application such as an application that is launched from a Web server using ClickOnce.

Important: This sample must be deployed to and launched from a Web server to work.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

To get the query string parameters, the code uses the ApplicationDeployment class to determine if the application has been launched using ClickOnce and, if so, to retrieve the query string parameters and insert them into a hash table for storage.

Structured Navigation Sample

jaytayl — Sat, 04 Aug 2007 23:13:21 GMT

This sample illustrates how to use PageFunctionto support structured navigation, which is discussed fully in Structured Navigation Overview.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Safe File Upload from an XBAP Sample

jaytayl — Sat, 04 Aug 2007 23:11:34 GMT

This sample illustrates how a XAML browser application (XBAP) that is running in partial trust can safely upload files from a client machine.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

A XBAP that is running in partial trust does not have permission to either open or save files on the client machine. However, it is possible to safely open read-only files chosen by the user: OpenFileDialog exposes only the name of the (ie no path information) using SafeFileName, and only returns a read-only stream from the OpenFile method with read-only access.

Remember Multiple Sets of State Per Page Instance

jaytayl — Sat, 04 Aug 2007 23:08:03 GMT

This sample illustrates how to remember and navigate through multiple sets of state for a single page instance.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

State navigation allows the change of state for a piece of content to be recorded as a navigation history entry that can be subsequently navigated to. When navigated to, the state recorded by the navigation history entry is restored.

This sample demonstrates state navigation by recording when the selected item of a list box is changed. Each state entry is stored by a custom CustomContentState object, and is added to navigation history by calling AddBackEntry, to add the initial entry, and GetContentState to ensure an entry is retained across navigations. Additionally, it shows how to remove a state navigation entry from back navigation history.

This technique is most useful when you need to remember and navigate through multiple sets of state for a single page instance. To remember a single item of state across page instances, consider using a journalable dependency property (see Remember A Single Item of State Across Page Instances). To remember a single set of state across page instancesconsider IProvideCustomContentState (see Remember A Single Set of State Across Page Instances).

Important: When you store information in custom content state, make sure you do not store references to the instance of the page for which you are remembering state when you navigate away from the page. This prevents WPF from releasing the page instance, and defeats the purpose of the default navigation history behavior. If you must do this, you might consider using KeepAlive instead.

Remember A Single Set of State Across Page Instances

jaytayl — Sat, 04 Aug 2007 23:04:43 GMT

This sample illustrates how to remember multiple items of page state across page instances by using IProvideCustomContentState and CustomContentState.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

By default, Windows Presentation Foundation (WPF) does not store page instances in navigation history. Instead, a new instance of a page is created each time it is navigated to. Subsequently, any state information on the first instance of the page is not remembered when the page is navigated to again. It is possible for WPF to retain page instances and, implicitly, page state in navigation history, although this can be costly from a memory consumption perspective.

However, WPF provides an infrastructure that allows you to both store state information with a page entry in navigation history and reapply it to the new page instance when navigated to using navigation history.

This sample shows how a page can implement IProvideCustomContentState to allow it to remember a single set of state, which may contain one or more items. When a page is navigated away from, WPF calls GetContentState to ask the page for state that it wants to be remembered. GetContentState returns an subclass of CustomContentState, which you create to store and replay state.

This technique is most useful when you need to store several items of page state across page instances. To remember a single item of state across page instances, you should consider using a journalable dependency property.

Important: When you store information in custom content state, you cannot store any references to the instance of the page for which you are remembering state. This prevents WPF from releasing the page instance, and defeats the purpose of the default navigation history behavior. If you must do this, you might consider using KeepAlive instead.

Remember A Single Item of State Across Page Instances

jaytayl — Sat, 04 Aug 2007 22:59:31 GMT

This sample illustrates how to remember a single item of page state across page instances by using a dependency property.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

By default, Windows Presentation Foundation (WPF) does not store page instances in navigation history. Instead, a new instance of a page is created each time it is navigated to. It is possible for WPF to retain page instances in navigation history, although this can be costly from a memory consumption perspective.

However, WPF provides an infrastructure that allows you to store state information with a page entry in navigation history. In this case, you can use the stored state to reconstitute the state of the page after it is instantiated.

This sample shows how to use a journaled dependency property to store and retrieve page state using navigation history.

This technique is most useful when you need to store a single item of page state across page instances. To remember a single set of state across page instances, you should consider using IProvideCustomContentState (see Remember A Single Set of State Across Page Instances). To remember multiple sets of state for a single page instance, see Remember Multiple Sets of State Per Page Instance.

NavigationService Sample

jaytayl — Sat, 04 Aug 2007 22:51:28 GMT

This sample demonstrates using NavigationService to navigate to embedded and loose XAML content.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

To navigate to an embedded XAML page, type DocumentPage.xaml into the address bar and click the Go button.
To navigate to a loose XAML page, type LooseDocumentPage.xaml into the address bar and click the Go button.

Navigation over a Fixed Linear Topology Sample

jaytayl — Sat, 04 Aug 2007 22:45:45 GMT

This sample illustrates how to provide navigation over a fixed linear topology.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Navigation over a Dynamically-Generated Topology Sample

jaytayl — Sat, 04 Aug 2007 22:43:53 GMT

This sample illustrates how to support navigation over a dynamically-generated navigation topology.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Handling NavigationWindow Events Sample

jaytayl — Sat, 04 Aug 2007 22:42:03 GMT

This sample shows how to handle the NavigationWindow events (C#, Extensible Application Markup Language (XAML)). It also displays the text equivalents of the arguments that are passed to the event handlers.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Get Referring Page Sample

jaytayl — Sat, 04 Aug 2007 22:37:57 GMT

This sample demonstrates how a Page can determine the referring Page, which is the source Page which navigated to this Page. The referring page is available from static Referrer property, of type Page, which is implemented by the Application subclass. The value of Referrer is determined when navigation to any page in an application occurs, specifically by handling Navigating and Navigated.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Frame Navigation in a Window Sample

jaytayl — Sat, 04 Aug 2007 22:34:15 GMT

This sample demonstrates how to host a Frame within a Window.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Frame Navigation in a Page Sample

jaytayl — Sat, 04 Aug 2007 22:29:59 GMT

This sample demonstrates how to host a Frame within a Page.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

When a Frame is hosted in a Page, and the Page is browser-hosted, the default navigation history behavior the Frame is to integrate with the browser's navigation history. However, you can specify that the Frame uses its own navigation history by setting JournalOwnership property to OwnsJournal.

This sample shows both styles of navigation history.

Fragment Navigation Sample

jaytayl — Sat, 04 Aug 2007 22:27:14 GMT

This sample demonstrates how to navigate to an embedded XAML Page fragment. It also shows how to handle the FragmentNavigation event to detect when the desired fragment is not found, and override the default behavior by navigating to an error XAML Page, FragmentNotFoundPage.

Building the Sample

Install the Windows Software Development Kit (SDK) and open its build environment command window. On the Start menu, point to All Programs, Microsoft Windows SDK, and then click CMD Shell.
Download the sample, usually from the software development kit (SDK) documentation, to your hard disk drive.
To build the sample from the build environment command window, go to the source directory of the sample. At the command prompt, type MSBUILD.
To build the sample in Microsoft Visual Studio 2005, load the sample solution or project file and then press CTRL+SHIFT+B.

Running the Sample

To run the compiled sample from the build environment command window, execute the .exe file in the Bin\Debug or Bin\Release folder contained under the sample source code folder.
To run the compiled sample with debugging in Visual Studio 2005, press F5.

Remarks

To navigate to an embedded XAML page fragment, type DocumentPage.xaml#Fragment5 into the address bar and click the Go button.