IPropertyModel Interface

public interface IPropertyModel : IDataModel, IDisposable

ICommand AddChildCommand { get; }

Property Value

ICommand:

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

bool CanAddChild { get; }

Property Value

bool:

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

bool CanRemove { get; }

Property Value

bool:

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

bool CanResetValue { get; }

Property Value

bool:

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

string Category { get; }

Property Value

string:

A category for the property.

TypeConverter Converter { get; }

Property Value

TypeConverter:

The TypeConverter to use for the property.

bool HasStandardValues { get; }

Property Value

bool:

true if the property supports StandardValues; otherwise, false.

bool IsHostReadOnly { get; set; }

Property Value

bool:

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

bool IsImmutable { get; }

Property Value

bool:

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

bool IsLimitedToStandardValues { get; }

Property Value

bool:

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

bool IsMergeable { get; }

Property Value

bool:

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

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.

bool IsValueReadOnly { get; set; }

Property Value

bool:

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

Remarks

This property can be set to true to force a normally-editable property to be read-only. Some implementations of this property will always return true when the underlying property value is unable to be set.

PropertyEditor NamePropertyEditor { get; set; }

Property Value

PropertyEditor:

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

DataTemplate NameTemplate { get; }

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.

object NameTemplateKey { get; }

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.

DataTemplateSelector NameTemplateSelector { get; }

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.

ICommand RemoveCommand { get; }

Property Value

ICommand:

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

ICommand ResetValueCommand { get; }

Property Value

ICommand:

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

bool ShouldNotifyParentOnValueChange { get; }

Property Value

bool:

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

IEnumerable StandardValues { get; }

Property Value

IEnumerable:

The standard list of values for the Value property.

IEnumerable<string> StandardValuesAsStrings { get; }

Property Value

IEnumerable<string>:

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

string StandardValuesDisplayMemberPath { get; set; }

Property Value

string:

The display member path for StandardValues when IsLimitedToStandardValues is true.

string StandardValuesSelectedValuePath { get; set; }

Property Value

string:

The selected value path for StandardValues when IsLimitedToStandardValues is true.

object Target { get; }

Property Value

object:

The target object that owns the property.

Type TargetType { get; }

Property Value

Type:

The Type of the Target property.

object Value { get; set; }

Property Value

object:

The property value.

string ValueAsString { get; set; }

Property Value

string:

The property value in a string representation.

PropertyEditor ValuePropertyEditor { get; set; }

Property Value

PropertyEditor:

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

DataTemplate ValueTemplate { get; }

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.

object ValueTemplateKey { get; }

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.

DefaultValueTemplateKind ValueTemplateKind { get; }

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.

DataTemplateSelector ValueTemplateSelector { get; }

Property Value

DataTemplateSelector:

The DataTemplateSelector 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.

Type ValueType { get; }

Property Value

Type:

The Type of the Value property.

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.

void AddChild()

bool CycleToNextStandardValue()

Returns

bool:

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

void Refresh(PropertyRefreshReason reason)

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

void Remove()

void ResetValue()