Class DataModelPicker
Represents a data model picker picker that can be used to select a data model path.
Inheritance
Implements
Inherited Members
Namespace: Artemis.UI.Shared.DataModelPicker
Assembly: Artemis.UI.Shared.dll
Syntax
public class DataModelPicker : TemplatedControl, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, IStyleable, IInputElement, IDataTemplateHost, INamed, ISetterValue
Constructors
DataModelPicker()
Creates a new instance of the DataModelPicker class.
Declaration
public DataModelPicker()
Fields
DataModelPathProperty
Gets or sets data model path.
Declaration
public static readonly StyledProperty<DataModelPath?> DataModelPathProperty
Field Value
| Type | Description |
|---|---|
| StyledProperty<DataModelPath> |
DataModelUIService
The data model UI service this picker should use.
Declaration
public static IDataModelUIService? DataModelUIService
Field Value
| Type | Description |
|---|---|
| IDataModelUIService |
DataModelViewModelProperty
The data model view model to show, if not provided one will be retrieved by the control.
Declaration
public static readonly StyledProperty<DataModelPropertiesViewModel?> DataModelViewModelProperty
Field Value
| Type | Description |
|---|---|
| StyledProperty<DataModelPropertiesViewModel> |
FilterTypesProperty
A list of types to filter the selectable paths on.
Declaration
public static readonly StyledProperty<ObservableCollection<Type>?> FilterTypesProperty
Field Value
| Type | Description |
|---|---|
| StyledProperty<ObservableCollection<Type>> |
IsEventPickerProperty
Gets or sets a boolean indicating whether the picker is in event picker mode. When true event children aren't selectable and non-events are described as "{PropertyName} changed".
Declaration
public static readonly StyledProperty<bool> IsEventPickerProperty
Field Value
| Type | Description |
|---|---|
| StyledProperty<bool> |
ModulesProperty
A list of extra modules to show data models of.
Declaration
public static readonly StyledProperty<ObservableCollection<Module>?> ModulesProperty
Field Value
| Type | Description |
|---|---|
| StyledProperty<ObservableCollection<Module>> |
ShowDataModelValuesProperty
Gets or sets a boolean indicating whether the data model picker should show current values when selecting a path.
Declaration
public static readonly StyledProperty<bool> ShowDataModelValuesProperty
Field Value
| Type | Description |
|---|---|
| StyledProperty<bool> |
Properties
DataModelPath
Gets or sets data model path.
Declaration
public DataModelPath? DataModelPath { get; set; }
Property Value
| Type | Description |
|---|---|
| DataModelPath |
DataModelViewModel
The data model view model to show, if not provided one will be retrieved by the control.
Declaration
public DataModelPropertiesViewModel? DataModelViewModel { get; }
Property Value
| Type | Description |
|---|---|
| DataModelPropertiesViewModel |
FilterTypes
A list of types to filter the selectable paths on.
Declaration
public ObservableCollection<Type>? FilterTypes { get; set; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<Type> |
IsEventPicker
Gets or sets a boolean indicating whether the picker is in event picker mode. When true event children aren't selectable and non-events are described as "{PropertyName} changed".
Declaration
public bool IsEventPicker { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Modules
A list of extra modules to show data models of.
Declaration
public ObservableCollection<Module>? Modules { get; set; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<Module> |
SelectPropertyCommand
Gets a command that selects the path by it's view model.
Declaration
public ReactiveCommand<DataModelVisualizationViewModel, Unit> SelectPropertyCommand { get; }
Property Value
| Type | Description |
|---|---|
| ReactiveCommand<DataModelVisualizationViewModel, Unit> |
ShowDataModelValues
Gets or sets a boolean indicating whether the data model picker should show current values when selecting a path.
Declaration
public bool ShowDataModelValues { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Methods
OnApplyTemplate(TemplateAppliedEventArgs)
Called when the control's template is applied. In simple terms, this means the method is called just before the control is displayed.
Declaration
protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| TemplateAppliedEventArgs | e | The event args. |
Overrides
OnAttachedToVisualTree(VisualTreeAttachmentEventArgs)
Called when the control is added to a rooted visual tree.
Declaration
protected override void OnAttachedToVisualTree(VisualTreeAttachmentEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| VisualTreeAttachmentEventArgs | e | The event args. |
Overrides
OnDataModelPathSelected(DataModelSelectedEventArgs)
Invokes the DataModelPathSelected event
Declaration
protected virtual void OnDataModelPathSelected(DataModelSelectedEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| DataModelSelectedEventArgs | e |
OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs)
Called when the control is removed from a rooted visual tree.
Declaration
protected override void OnDetachedFromVisualTree(VisualTreeAttachmentEventArgs e)
Parameters
| Type | Name | Description |
|---|---|---|
| VisualTreeAttachmentEventArgs | e | The event args. |
Overrides
Events
DataModelPathSelected
Occurs when a new path has been selected
Declaration
public event EventHandler<DataModelSelectedEventArgs>? DataModelPathSelected
Event Type
| Type | Description |
|---|---|
| EventHandler<DataModelSelectedEventArgs> |