Class DataModelPickerButton
Represents a button that can be used to pick a data model path in a flyout.
Inheritance
Implements
Inherited Members
Namespace: Artemis.UI.Shared.DataModelPicker
Assembly: Artemis.UI.Shared.dll
Syntax
public class DataModelPickerButton : TemplatedControl, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, IStyleable, IInputElement, IDataTemplateHost, INamed, ISetterValue
Constructors
DataModelPickerButton()
Declaration
public DataModelPickerButton()
Fields
DataModelPathProperty
Gets or sets data model path.
Declaration
public static readonly StyledProperty<DataModelPath?> DataModelPathProperty
Field Value
Type | Description |
---|---|
StyledProperty<DataModelPath> |
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>> |
HasValueProperty
Gets a boolean indicating whether the data model picker has a value.
Declaration
public static readonly StyledProperty<bool> HasValueProperty
Field Value
Type | Description |
---|---|
StyledProperty<bool> |
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>> |
PlaceholderProperty
Gets or sets the placeholder to show when nothing is selected.
Declaration
public static readonly StyledProperty<string> PlaceholderProperty
Field Value
Type | Description |
---|---|
StyledProperty<string> |
PlacementProperty
Gets or sets the desired flyout placement.
Declaration
public static readonly StyledProperty<PlacementMode> PlacementProperty
Field Value
Type | Description |
---|---|
StyledProperty<PlacementMode> |
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> |
ShowFullPathProperty
Gets or sets a boolean indicating whether the data model picker should show the full path of the selected value.
Declaration
public static readonly StyledProperty<bool> ShowFullPathProperty
Field Value
Type | Description |
---|---|
StyledProperty<bool> |
ShowTypeIconProperty
Gets or sets a boolean indicating whether the button should show the icon of the first provided filter type.
Declaration
public static readonly StyledProperty<bool> ShowTypeIconProperty
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 |
FilterTypes
A list of types to filter the selectable paths on.
Declaration
public ObservableCollection<Type>? FilterTypes { get; set; }
Property Value
Type | Description |
---|---|
ObservableCollection<Type> |
HasValue
Gets a boolean indicating whether the data model picker has a value.
Declaration
public bool HasValue { get; }
Property Value
Type | Description |
---|---|
bool |
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> |
Placeholder
Gets or sets the placeholder to show when nothing is selected.
Declaration
public string Placeholder { get; set; }
Property Value
Type | Description |
---|---|
string |
Placement
Gets or sets the desired flyout placement.
Declaration
public PlacementMode Placement { get; set; }
Property Value
Type | Description |
---|---|
PlacementMode |
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 |
ShowFullPath
Gets or sets a boolean indicating whether the data model picker should show the full path of the selected value.
Declaration
public bool ShowFullPath { get; set; }
Property Value
Type | Description |
---|---|
bool |
ShowTypeIcon
Gets or sets a boolean indicating whether the button should show the icon of the first provided filter type.
Declaration
public bool ShowTypeIcon { 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
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
FlyoutClosed
Raised when the flyout closes.
Declaration
public event TypedEventHandler<DataModelPickerButton, EventArgs>? FlyoutClosed
Event Type
Type | Description |
---|---|
TypedEventHandler<DataModelPickerButton, EventArgs> |
FlyoutOpened
Raised when the flyout opens.
Declaration
public event TypedEventHandler<DataModelPickerButton, EventArgs>? FlyoutOpened
Event Type
Type | Description |
---|---|
TypedEventHandler<DataModelPickerButton, EventArgs> |