PropertyModel Class

public class PropertyModel : FrameworkElement, IPropertyModel, IDataModel, IDisposable

public PropertyModel()

public ICommand AddChildCommand { get; }

Property Value

ICommand:

The ICommand used to add a new child into to an associated collection/parent.

public virtual bool CanAddChild { get; }

Property Value

bool:

true if a new child can be added to an associated collection/parent; otherwise, false.

public bool CanAutoConfigure { get; set; }

Property Value

bool:

true if the property can be auto-configured based on a simple Binding on its Value property; otherwise, false. The default value is false.

public bool CanAutoDispose { get; }

Property Value

bool:

true if the data model should be automatically disposed when it is removed from a parent data model; otherwise, false.

public virtual bool CanRemove { get; }

Property Value

bool:

true if the property can be removed from an associated collection/parent; otherwise, false.

public bool CanResetValue { get; set; }

Property Value

bool:

true if the property can be reset to its default value; otherwise, false. The default value is false.

public string Category { get; set; }

Property Value

string:

A category for the property.

public DataModelCollection Children { get; }

Property Value

DataModelCollection:

The collection of child data models.

public TypeConverter Converter { get; set; }

Property Value

TypeConverter:

The TypeConverter to use for the property.

public object DefaultValue { get; set; }

Property Value

object:

The default value to use for a reset operation.

public string Description { get; set; }

Property Value

string:

The description of the data model, often displayed in a summary area or a tooltip.

public string DisplayName { get; set; }

Property Value

string:

The name to use when displaying the data model, often the same as Name.

public virtual bool HasStandardValues { get; }

Property Value

bool:

true if the property supports StandardValues; otherwise, false.

public bool IsExpanded { get; set; }

Property Value

bool:

true if the data model is expanded; otherwise, false.

public bool IsHostReadOnly { get; set; }

Property Value

bool:

true if the host UI control (e.g. a property grid) is read-only; otherwise, false.

public bool IsImmutable { get; set; }

Property Value

bool:

true if the Value's child properties, if any, are capable of being edited; otherwise, false.

public bool IsLimitedToStandardValues { get; set; }

Property Value

bool:

true if the Value property can only be set to one of the values defined by the StandardValues property; otherwise, false.

public virtual bool IsMergeable { get; }

Property Value

bool:

true if the property can be merged when presenting multiple objects; otherwise, false.

public bool IsModified { get; set; }

Property Value

bool:

true if the data model has been modified; otherwise, false.

public bool IsReadOnly { get; }

Property Value

bool:

true if the UI for editing the property value is read-only; otherwise, false.

Remarks

This property is a resolved value of IsHostReadOnly and IsValueReadOnly, and also considers whether a parent property is immutable.

protected virtual bool IsRoot { get; }

Property Value

bool:

true if the data model is the root; otherwise, false.

public bool IsSelected { get; set; }

Property Value

bool:

true if the data model is selected; otherwise, false.

public bool IsValueReadOnly { get; set; }

Property Value

bool:

true if the Value property is read-only; otherwise, false.

public PropertyEditor NamePropertyEditor { get; set; }

Property Value

PropertyEditor:

The PropertyEditor, if any, that was used to select the DataTemplate for showing the property display name.

public DataTemplate NameTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for showing the property display name.

Remarks

The priority order of value template specification is NameTemplate, NameTemplateSelector, NameTemplateKey, and finally any name templates in matching property editors.

public object NameTemplateKey { get; set; }

Property Value

object:

The resource key that references a DataTemplate to use for showing the property display name.

Remarks

The priority order of value template specification is NameTemplate, NameTemplateSelector, NameTemplateKey, and finally any name templates in matching property editors.

public DataTemplateSelector NameTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for showing the property display name.

Remarks

The priority order of value template specification is NameTemplate, NameTemplateSelector, NameTemplateKey, and finally any name templates in matching property editors.

public ICommand RemoveCommand { get; }

Property Value

ICommand:

The ICommand used to remove the property from an associated collection/parent.

public ICommand ResetValueCommand { get; }

Property Value

ICommand:

The ICommand used to reset the property value to its default value.

public virtual bool ShouldNotifyParentOnValueChange { get; }

Property Value

bool:

true if the property should notify its parent property when the Value changes; otherwise, false.

public DataModelSortComparer SortComparer { get; set; }

Property Value

DataModelSortComparer:

The DataModelSortComparer to use for sorting this data model's children.

Remarks

If this property doesn't return anything, the default SortComparer will be used.

public virtual DataModelSortImportance SortImportance { get; set; }

Property Value

DataModelSortImportance:

A DataModelSortImportance that indicates the sort importance of this data model.

public int SortOrder { get; set; }

Property Value

int:

A numeric sort order for sorting the data model within other data models of the same sort importance.

public IEnumerable StandardValues { get; set; }

Property Value

IEnumerable:

The standard list of values for the Value property.

public IEnumerable<string> StandardValuesAsStrings { get; set; }

Property Value

IEnumerable<string>:

The standard list of values for the ValueAsString property as a list of strings.

public string StandardValuesDisplayMemberPath { get; set; }

Property Value

string:

The display member path for StandardValues when IsLimitedToStandardValues is true.

public string StandardValuesSelectedValuePath { get; set; }

Property Value

string:

The selected value path for StandardValues when IsLimitedToStandardValues is true.

public object Target { get; set; }

Property Value

object:

The target object that owns the property.

public Type TargetType { get; set; }

Property Value

Type:

The Type of the Target property.

public object Value { get; set; }

Property Value

object:

The property value.

public string ValueAsString { get; set; }

Property Value

string:

The property value in a string representation.

public PropertyEditor ValuePropertyEditor { get; set; }

Property Value

PropertyEditor:

The PropertyEditor, if any, that was used to select the DataTemplate for editing the property value.

public DataTemplate ValueTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for editing the property value.

Remarks

The priority order of value template specification is ValueTemplate, ValueTemplateSelector, ValueTemplateKey, ValueTemplateKind, and finally any value templates in matching property editors.

public object ValueTemplateKey { get; set; }

Property Value

object:

The resource key that references a DataTemplate to use for editing the property value.

Remarks

The priority order of value template specification is ValueTemplate, ValueTemplateSelector, ValueTemplateKey, ValueTemplateKind, and finally any value templates in matching property editors.

public DefaultValueTemplateKind ValueTemplateKind { get; set; }

Property Value

DefaultValueTemplateKind:

The DefaultValueTemplateKind that specifies a default value cell template to use for editing the property value.

Remarks

The priority order of value template specification is ValueTemplate, ValueTemplateSelector, ValueTemplateKey, ValueTemplateKind, and finally any value templates in matching property editors.

public DataTemplateSelector ValueTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplate to use for editing the property value.

Remarks

The priority order of value template specification is ValueTemplate, ValueTemplateSelector, ValueTemplateKey, ValueTemplateKind, and finally any value templates in matching property editors.

public Type ValueType { get; set; }

Property Value

Type:

The Type of the Value property.

public virtual IList<object> Values { get; }

Property Value

IList<object>:

The property values, of which there will only be more than one if this is a merged property.

public virtual void AddChild()

protected virtual object ConvertFromString(string stringValue)

Parameter	Type	Description
stringValue	string	The string value to convert.

Returns

object:

An object from the string representation, or null.

protected virtual string ConvertToString(object value)

Parameter	Type	Description
value	object	The value to convert.

Returns

string:

A string representation of the specified value, or null.

public virtual bool CycleToNextStandardValue()

Returns

bool:

true if a standard value was set; otherwise, false.

public void Dispose()

protected virtual void Dispose(bool disposing)

Parameter	Type	Description
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose method and the Finalize method. Dispose invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

protected virtual IEnumerable GetErrorMessages(string columnName)

Parameter	Type	Description
columnName	string	The name of the property to examine, or null if the target object itself should be examined.

Returns

IEnumerable:

The error messages that are applicable, if any.

protected void NotifyPropertyChanged(string propertyName)

Parameter	Type	Description
propertyName	string	The name of the property that was changed.

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameter	Type	Description
e	PropertyChangedEventArgs	The PropertyChangedEventArgs that contains the event data.

protected void RaiseChildPropertyAddedEvent(PropertyModelChildChangeEventArgs e)

Parameter	Type	Description
e	PropertyModelChildChangeEventArgs	The PropertyModelChildChangeEventArgs that contains the event data.

protected void RaiseChildPropertyAddingEvent(PropertyModelChildChangeEventArgs e)

Parameter	Type	Description
e	PropertyModelChildChangeEventArgs	The PropertyModelChildChangeEventArgs that contains the event data.

protected void RaiseChildPropertyRemovedEvent(PropertyModelChildChangeEventArgs e)

Parameter	Type	Description
e	PropertyModelChildChangeEventArgs	The PropertyModelChildChangeEventArgs that contains the event data.

protected void RaiseChildPropertyRemovingEvent(PropertyModelChildChangeEventArgs e)

Parameter	Type	Description
e	PropertyModelChildChangeEventArgs	The PropertyModelChildChangeEventArgs that contains the event data.

protected void RaisePropertyValueChangedEvent(PropertyModelValueChangeEventArgs e)

Parameter	Type	Description
e	PropertyModelValueChangeEventArgs	The PropertyModelValueChangeEventArgs that contains the event data.

protected void RaisePropertyValueChangingEvent(PropertyModelValueChangeEventArgs e)

Parameter	Type	Description
e	PropertyModelValueChangeEventArgs	The PropertyModelValueChangeEventArgs that contains the event data.

public virtual void Refresh(PropertyRefreshReason reason)

Parameter	Type	Description
reason	PropertyRefreshReason	The reason the property needs to be refreshed.

protected virtual void RefreshChildren()

public virtual void Remove()

public virtual void ResetValue()

public override string ToString()

Returns

string:

A string representation of this instance.

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

public static readonly DependencyProperty CanAutoConfigureProperty

public static readonly DependencyProperty CanResetValueProperty

public static readonly DependencyProperty CategoryProperty

public static readonly DependencyProperty ConverterProperty

public static readonly DependencyProperty DefaultValueProperty

public static readonly DependencyProperty DescriptionProperty

public static readonly DependencyProperty DisplayNameProperty

public static readonly DependencyProperty IsExpandedProperty

public static readonly DependencyProperty IsHostReadOnlyProperty

public static readonly DependencyProperty IsImmutableProperty

public static readonly DependencyProperty IsLimitedToStandardValuesProperty

public static readonly DependencyProperty IsModifiedProperty

public static readonly DependencyProperty IsReadOnlyProperty

public static readonly DependencyProperty IsSelectedProperty

public static readonly DependencyProperty IsValueReadOnlyProperty

public static readonly DependencyProperty NamePropertyEditorProperty

public static readonly DependencyProperty NameTemplateKeyProperty

public static readonly DependencyProperty NameTemplateProperty

public static readonly DependencyProperty NameTemplateSelectorProperty

public static readonly DependencyProperty SortComparerProperty

public static readonly DependencyProperty SortImportanceProperty

public static readonly DependencyProperty SortOrderProperty

public static readonly DependencyProperty StandardValuesAsStringsProperty

public static readonly DependencyProperty StandardValuesDisplayMemberPathProperty

public static readonly DependencyProperty StandardValuesProperty

public static readonly DependencyProperty StandardValuesSelectedValuePathProperty

public static readonly DependencyProperty TargetProperty

public static readonly DependencyProperty TargetTypeProperty

public static readonly DependencyProperty ValueProperty

public static readonly DependencyProperty ValuePropertyEditorProperty

public static readonly DependencyProperty ValueTemplateKeyProperty

public static readonly DependencyProperty ValueTemplateKindProperty

public static readonly DependencyProperty ValueTemplateProperty

public static readonly DependencyProperty ValueTemplateSelectorProperty

public static readonly DependencyProperty ValueTypeProperty