Dialog Class |
Namespace: BionicCode.Utilities.Net.Framework.Wpf.Dialog
The Dialog type exposes the following members.
Name | Description | |
---|---|---|
![]() | DependencyObjectType | Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.) |
![]() | Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
![]() | IsSealed | Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.) |
Name | Description | |
---|---|---|
![]() | ClearValue(DependencyProperty) | Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.) |
![]() | ClearValue(DependencyPropertyKey) | Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.) |
![]() | CoerceValue | Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.) |
![]() | Equals | Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetDataTemplateSelector |
Returns the DataTemplateSelector registered with the attachingElement.
|
![]() ![]() | GetDialogDataContext |
The getter for the attached DialogDataContextProperty property.
|
![]() | GetHashCode | Gets a hash code for this DependencyObject. (Inherited from DependencyObject.) |
![]() ![]() | GetIsClosable |
Get method of the attached property IsClosableProperty.
|
![]() ![]() | GetIsModal |
Get method of the attached property IsModalProperty.
|
![]() | GetLocalValueEnumerator | Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.) |
![]() ![]() | GetStyle |
Get method of the attached property StyleProperty.
|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetValue | Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.) |
![]() | InvalidateProperty | Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnPropertyChanged | Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject.) |
![]() | ReadLocalValue | Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.) |
![]() | SetCurrentValue | Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.) |
![]() ![]() | SetDataTemplateSelector |
Set method of the attached DataTemplateSelectorProperty property.
|
![]() ![]() | SetDialogDataContext |
The setter for the attached DialogDataContextProperty property.
|
![]() ![]() | SetIsClosable |
Set method of the IsClosableProperty attached property.
|
![]() ![]() | SetIsModal |
Set method of the IsModalProperty attached property.
|
![]() ![]() | SetStyle |
Set method of the attached property StyleProperty.
|
![]() | SetValue(DependencyProperty, Object) | Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.) |
![]() | SetValue(DependencyPropertyKey, Object) | Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.) |
![]() | ShouldSerializeProperty | Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() ![]() | TryGetDialog |
Attempts to get the dialog Window of the associated IDialogViewModel instance.
|
Name | Description | |
---|---|---|
![]() ![]() | DataTemplateSelectorProperty |
Attached property to set a DataTemplateSelector to use for the displayed dialog Window to display the content.
|
![]() ![]() | DialogDataContextProperty |
Attached property designed to bind to a view model property of type IDialogViewModel. A change of this property will trigger the Dialog to show a Window with the DataContext set to the IDialogViewModel instance of this property.
|
![]() ![]() | IsClosableProperty |
Attached property that controls if the user is allowed to explicitly close the Window.
|
![]() ![]() | IsModalProperty |
Attached property that controls if the Window is shown modal.
|
![]() ![]() | StyleProperty |
The attached Style property which holds the Style which should apply to the dialog. TargetType must be Window.
|
Name | Description | |
---|---|---|
![]() | DataTemplateSelector |
Attached property to set a DataTemplateSelector to use for the displayed dialog Window to display the content.
|
![]() | DialogDataContext |
Attached property designed to bind to a view model property of type IDialogViewModel. A change of this property will trigger the Dialog to show a Window with the DataContext set to the IDialogViewModel instance of this property.
|
![]() | IsClosable |
Attached property that controls if the user is allowed to explicitly close the Window.
|
![]() | IsModal |
Attached property that controls if the Window is shown modal.
|
![]() | Style |
The attached Style property which holds the Style which should apply to the dialog. TargetType must be Window.
|
Name | Description | |
---|---|---|
![]() | EnumerateVisualChildElements<TChildren> |
Traverses the visual tree towards the leafs until all elements with a matching element type is found.
Returns an IEnumerable<T> to enable deferred traversal.
(Defined by HelperExtensions.) |
![]() | FindVisualChildElements<TChildren> |
Traverses the visual tree towards the leafs until all elements with a matching element type is found.
Returns an IEnumerable<T> to enable deferred traversal.
(Defined by HelperExtensions.) |
![]() | ToDictionary() | Overloaded.
Coverts any type to a Dictionary<TKey, TValue>, where the TKey is the member name and TValue the member's value.
(Defined by HelperExtensions.) |
![]() | ToDictionary() | Overloaded.
Coverts any type to a Dictionary<TKey, TValue>, where the TKey is the member name and TValue the member's value.
(Defined by HelperExtensions.) |
![]() | TryFindVisualChildElement<TChild> |
Traverses the visual tree towards the leafs until an element with a matching element type is found.
(Defined by HelperExtensions.) |
![]() | TryFindVisualChildElementByName<TChild> |
Traverses the visual tree towards the leafs until an element with a matching element name is found.
(Defined by HelperExtensions.) |
![]() | TryFindVisualParentElement<TParent> |
Traverses the visual tree towards the root until an element with a matching element name is found.
(Defined by HelperExtensions.) |
![]() | TryFindVisualParentElementByName<TChild> |
Traverses the visual tree towards the root until an element with a matching element type is found.
(Defined by HelperExtensions.) |
The IDialogViewModel instance bound to the DialogDataContextProperty will be assigned to the Content of the Window. To layout the content requires to define an implicit DataTemplate that targets the type of the IDialogViewModel implementation. Alternatively set the template for the ContentTemplate via a Style that targets Window and is assigned to the StyleProperty attached property. For more complex scenarios it is possible to assign a DataTemplateSelector to the DataTemplateSelectorProperty attached property.
To define the attributes like title and icon of the dialog, set the corresponding values of the IDialogViewModel implementation. Dialog sets up a data binding to those properties, so that they can be dynamically changed by the view model.
It is recommended to use and extend the abstract DialogViewModel, which provides the basic IDialogViewModel implementation and logic. It only needs to be extended to provide the required specific properties for the dialog's context.
To show a dialog, simply assign an instance of IDialogViewModel to the attached property DialogDataContextProperty. A change of that property will automatically display a new dialog window. To each IDialogViewModel maps an instance of Window. It is recommended to bind the attached DialogDataContextProperty to a property of a view model class that implements INotifyPropertyChanged. This way it is very simple to display dialogs dynamically initiated by the view model i.e. the binding source of the attached DialogDataContextProperty property.
To close a dialog, raise the InteractionCompleted event from the IDialogViewModel implementation e.g., by calling OnInteractionCompleted() or by invoking the SendResponseAsyncCommand (in case you followed the recommendation to extend DialogViewModel).