WpfDialogAssistant Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

This class styles a WPF window according to the Visual Studio standards.

Create this class in the constructor of the class and keep a reference to it until after the window is closed.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Controls.WPF.WpfDialogAssistant

Namespace:  Microsoft.TeamFoundation.Controls.WPF
Assembly:  Microsoft.TeamFoundation.Controls (in Microsoft.TeamFoundation.Controls.dll)

Syntax

'Declaration
Public Class WpfDialogAssistant
public class WpfDialogAssistant
public ref class WpfDialogAssistant
type WpfDialogAssistant =  class end
public class WpfDialogAssistant

The WpfDialogAssistant type exposes the following members.

Constructors

  Name Description
Public method WpfDialogAssistant(Window)
Public method WpfDialogAssistant(Window, Boolean) styles a WPF window according to the Visual Studio standards. remembers its size and position
Public method WpfDialogAssistant(Window, Boolean, Boolean) styles a WPF window according to the Visual Studio standards. remembers its size and position

Top

Properties

  Name Description
Public property DisableCloseButton This property controls whether this window has a close button.
Public property DisableContextHelp
Protected property Handle
Protected property HandleSource
Public property HelpTopic Owning classes must set this to their help topic string.
Public property SaveRestorePosition This property controls whether dialog size and position will automatically be saved and restored during OnLoad and OnFormClosing.
Public property ShowHelpButton This property controls whether this window appears in the taskbar.
Public property ShowInTaskbar This property controls whether this window appears in the taskbar.
Public property UseModalDialogStyling This property controls whether this window is styled as a modal dialog box. When true, the dialog box will not have maximize, minimize, and help buttons.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetWaitCursor Call this method to change the window cursor to a wait cursor. Disposing the WaitCursor object returned will restore the previous cursor.
Protected method InitializeWindowStyle
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetOwner(IntPtr) Call this method to set the owner of the Window from a window handle. For a modal dialog this property must be set.
Public method SetOwner(Form) Call this method to set the owner of the Window from a Windows Forms form. For a modal dialog this property must be set.
Public method SetOwner(IWin32Window) Call this method to set the owner of the Window from an IWin32Window. For a modal dialog this property must be set.
Public method SetOwner(Window) Call this method to set the owner of the window. For a modal dialog this property must be set.
Public methodStatic member ShowDialog
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Controls.WPF Namespace