PropertyGrid Class

public class PropertyGrid : TreeListView, IPropertyEditorsProvider

public PropertyGrid()

public bool AreAttachedPropertiesBrowsable { get; set; }

Property Value

bool:

true if attached properties are browsable and are displayed in the property grid; otherwise false. The default value is false.

public bool AreCategoriesAutoExpanded { get; set; }

Property Value

bool:

true if categories are auto-expanded when they are added into the property grid; otherwise false. The default value is true.

public bool AreClipboardMenuItemsEnabled { get; set; }

Property Value

bool:

true if the default item context menu should include menu items for clipboard operations such as copying a property value; otherwise false. The default value is true.

public bool AreInheritedPropertiesBrowsable { get; set; }

Property Value

bool:

true if inherited properties are browsable and are displayed in the property grid; otherwise false. The default value is true.

public bool AreNestedCategoriesSupported { get; set; }

Property Value

bool:

true if nested categories are supported; otherwise false. The default value is false.

Remarks

To specify a nested category, the category names should be separated by a ''. Individual category names can be wrapped with single or double quotes, as needed.

public bool ArePropertiesAutoExpanded { get; set; }

Property Value

bool:

true if expandable properties are auto-expanded when they are added into the property grid; otherwise false. The default value is false.

public bool AreReadOnlyPropertiesBrowsable { get; set; }

Property Value

bool:

true if read-only properties are browsable and are displayed in the property grid; otherwise false. The default value is true.

public IEnumerable<Attribute> BrowsableAttributes { get; set; }

Property Value

IEnumerable<Attribute>:

The list of Attribute objects that are used to determine which properties are browsable. The default value is a list with a single entry of BrowsableAttribute.Yes.

public bool CanClearDataObjectOnUnload { get; set; }

Property Value

bool:

true if the DataObject property is cleared when the property grid is unloaded; otherwise, false. The default value is false.

Remarks

Clearing the DataObject property when the property grid is no longer needed is important to prevent memory leaks from property change notification handlers. The DataObject property can be cleared manually or the CanClearDataObjectOnUnload property can be set to true to automatically do this when the control is unloaded.

The CanClearDataObjectOnUnload property should not be set to true if a property grid or its ancestor hierarchy can get temporarily unloaded. For instance, when a property grid is in a tab control, the property grid is unloaded when the parent tab is deselected. Likewise, when a property grid is a docking window, the property grid is temporarily unloaded during dock operations as layout changes occur. In these sorts of scenarios, it is better to manually clear the DataObject property when the primary UI (such as a main window) is closed.

public bool CanSummaryAutoSize { get; set; }

Property Value

bool:

true if the user can double-tap the summary splitter to auto-size to the summary area content; otherwise, false. The default value is false.

public static PropertyGridItemActionHandlerDictionary CancelPropertyValueEditHandlers { get; }

Property Value

PropertyGridItemActionHandlerDictionary:

A mapping between control types and associated delegates.

Remarks

When a KeyDown event is raised on a PropertyGridItem, the PropertyGrid will use the control with focus to find an associated delegate in the CancelPropertyValueEditHandlers dictionary. If a matching entry is found, it will be executed. Exact type matches will be used first, then each base type will be queried.

public CategoryEditorCollection CategoryEditors { get; }

Property Value

CategoryEditorCollection:

The category editors that can consume and display one or more properties.

public CollectionPropertyDisplayMode CollectionPropertyDisplayMode { get; set; }

Property Value

CollectionPropertyDisplayMode:

A CollectionPropertyDisplayMode that indicates the display mode of collection properties. The default value is CollectionPropertyDisplayMode.Default.

public static PropertyGridItemActionHandlerDictionary CommitPropertyValueEditHandlers { get; }

Property Value

PropertyGridItemActionHandlerDictionary:

A mapping between control types and associated delegates.

Remarks

When a KeyDown event is raised on a PropertyGridItem, the PropertyGrid will use the control with focus to find an associated delegate in the CommitPropertyValueEditHandlers dictionary. If a matching entry is found, it will be executed. Exact type matches will be used first, then each base type will be queried.

public ICommand CopyDisplayNameCommand { get; }

Property Value

ICommand:

The ICommand used to call the CopyDisplayName(IDataModel) method.

public ICommand CopyPropertyValueCommand { get; }

Property Value

ICommand:

The ICommand used to call the CopyPropertyValue(IPropertyModel) method.

public IDataFactory DataFactory { get; set; }

Property Value

IDataFactory:

The IDataFactory used to return the data models for objects.

public object DataObject { get; set; }

Property Value

object:

The data object for which the control displays properties.

Remarks

The DataObject property sets that a single object should be browsed in the property grid. If multiple objects are being browsed, this property returns the first one in the list specified by DataObjects. If no objects are being browsed, null is returned. Setting this DataObject property replaces the value of the DataObjects property.

public IEnumerable DataObjects { get; set; }

Property Value

IEnumerable:

The data objects for which the control displays properties.

Remarks

Set this property if multiple data objects should be browsed at the same time. The property grid only displays the properties that are common to all the data objects. Setting this DataObjects property replaces the value of the DataObject property.

public DataTemplate DefaultBooleanValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultBrushValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public Style DefaultCategoryEditorItemContainerStyle { get; set; }

Property Value

Style:

A default PropertyGridItem container Style used for category editor models.

public Style DefaultCategoryItemContainerStyle { get; set; }

Property Value

Style:

A default PropertyGridItem container Style used for category models.

public DataTemplate DefaultColorValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultExtendedStringValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultFontFamilyValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultFontStretchValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultFontStyleValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultFontWeightValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultLimitedObjectValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultLimitedStringValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultNullableBooleanValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public static PropertyEditorCollection DefaultPropertyEditors { get; }

Property Value

PropertyEditorCollection:

The collection of property editors that are used by default in all PropertyGrid instances.

See Also

• PropertyEditors

public Style DefaultPropertyItemContainerStyle { get; set; }

Property Value

Style:

A default PropertyGridItem container Style used for property models.

public DataTemplate DefaultStringNameTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for name column cells.

public DataTemplate DefaultStringValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate DefaultSuggestedStringValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that can be used for value column cells.

public DataTemplate ImmediateStringValueTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate that is the same as DefaultStringValueTemplate, but the edited string value is immediately updated as text is typed instead of only on focus loss.

public bool IsCategorized { get; set; }

Property Value

bool:

true if properties are categorized; otherwise, false. The default value is true.

public bool IsDefaultItemContextMenuEnabled { get; set; }

Property Value

bool:

true if the default context menu is enabled for property grid items; otherwise false. The default value is true.

public bool IsReadOnly { get; set; }

Property Value

bool:

true if value editors are read-only; otherwise, false. The default value is false.

public bool IsSummaryResizable { get; set; }

Property Value

bool:

true if the summary is resizable; otherwise, false. The default value is true.

public bool IsSummaryToggleAllowed { get; set; }

Property Value

bool:

true if the summary area's visibility is allowed to be toggled; otherwise, false. The default value is true.

public bool IsSummaryVisible { get; set; }

Property Value

bool:

true if the summary area is visible; otherwise, false. The default value is true.

protected override IEnumerator LogicalChildren { get; }

Property Value

IEnumerator:

An enumerator for logical child elements of this element.

[Localizability(LocalizationCategory.Title)]
public string MiscCategoryName { get; set; }

Property Value

string:

The name used for the miscellaneous category. The default value is the localized "Misc" text.

public int NameColumnIndex { get; }

Property Value

int:

The index of the name column.

public double NameColumnMaxWidth { get; set; }

Property Value

double:

The maximum width of the name column.

public Style NameContainerStyle { get; set; }

Property Value

Style:

The Style to use for the name column cells.

public DataTemplate NameTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the name column cells.

public DataTemplateSelector NameTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the name column cells.

public ICommand PastePropertyValueCommand { get; }

Property Value

ICommand:

The ICommand used to call the PastePropertyValue(IPropertyModel) method.

public PropertyModelCollection Properties { get; }

Property Value

PropertyModelCollection:

The explicitly-defined properties that should be displayed.

Remarks

These properties will be merged with the properties generated from the DataObjects property. If DataObjects is null or empty, then only these properties will be displayed.

public PropertyEditorCollection PropertyEditors { get; }

Property Value

PropertyEditorCollection:

The PropertyEditorCollection that contains property editor definitions specifically for this property grid instance.

Remarks

The DefaultPropertyEditors collection contains other property editors that apply to all PropertyGrid instances.

See Also

• DefaultPropertyEditors

public static object PropertyEditorsModifierKey { get; }

Property Value

object:

A resource key whose value is the string "PropertyGridPropertyEditorsModifierKey".

public PropertyExpandability PropertyExpandability { get; set; }

Property Value

PropertyExpandability:

A PropertyExpandability that indicates the expandability of properties. The default value is PropertyExpandability.Default.

public DataModelSortComparer SortComparer { get; set; }

Property Value

DataModelSortComparer:

The DataModelSortComparer to use for sorting data models. The default value is a DataModelSortComparer instance.

public static PropertyGridItemActionHandlerDictionary StartPropertyValueEditHandlers { get; }

Property Value

PropertyGridItemActionHandlerDictionary:

A mapping between control types and associated delegates.

Remarks

When a KeyDown event is raised on a PropertyGridItem, the PropertyGrid will use the control that should gain focus to find an associated delegate in the StartPropertyValueEditHandlers dictionary. If a matching entry is found, it will be executed. Exact type matches will be used first, then each base type will be queried.

[TypeConverter(typeof(LengthConverter))]
public double SummaryHeight { get; set; }

Property Value

double:

The height of the summary area. The default value is 78.

public DataTemplate SummaryTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate used to display the selected item in the summary area. The default value is null.

public DataTemplateSelector SummaryTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector used to select a DataTemplate, which is used to display the selected item in the summary area. The default value is null.

public ICommand ToggleSummaryVisibilityCommand { get; }

Property Value

ICommand:

The ICommand used to toggle the IsSummaryVisible property.

public int ValueColumnIndex { get; }

Property Value

int:

The index of the value column.

public Style ValueContainerStyle { get; set; }

Property Value

Style:

The Style to use for the value column cells.

public DataTemplate ValueTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the value column cells.

public DataTemplateSelector ValueTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the value column cells.

public void CopyDisplayName(IDataModel model)

Parameter	Type	Description
model	IDataModel	The IDataModel to examine.

public void CopyPropertyValue(IPropertyModel model)

Parameter	Type	Description
model	IPropertyModel	The IPropertyModel to examine.

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element that is used to display the given item.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	Specified item.

Returns

bool:

true if the item is its own item container; otherwise, false.

public override void OnApplyTemplate()

protected virtual void OnChildPropertyAdded(PropertyModelChildChangeEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnChildPropertyAdding(PropertyModelChildChangeEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnChildPropertyRemoved(PropertyModelChildChangeEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnChildPropertyRemoving(PropertyModelChildChangeEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

An AutomationPeer instance.

protected override void OnItemMenuRequested(TreeListBoxItemMenuEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected override void OnKeyDown(KeyEventArgs e)

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

protected virtual void OnPropertyValueChanged(PropertyModelValueChangeEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

protected virtual void OnPropertyValueChanging(PropertyModelValueChangeEventArgs e)

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

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

public void PastePropertyValue(IPropertyModel model)

Parameter	Type	Description
model	IPropertyModel	The IPropertyModel to examine.

public void RequestRefresh()

public bool TryCommitPropertyValueEdit()

Returns

bool:

true if the commit was handled; otherwise, false.

public event EventHandler<PropertyModelChildChangeEventArgs> ChildPropertyAdded

Event Type

EventHandler<PropertyModelChildChangeEventArgs>

public event EventHandler<PropertyModelChildChangeEventArgs> ChildPropertyAdding

Event Type

EventHandler<PropertyModelChildChangeEventArgs>

public event EventHandler<PropertyModelChildChangeEventArgs> ChildPropertyRemoved

Event Type

EventHandler<PropertyModelChildChangeEventArgs>

public event EventHandler<PropertyModelChildChangeEventArgs> ChildPropertyRemoving

Event Type

EventHandler<PropertyModelChildChangeEventArgs>

public event EventHandler<PropertyModelValueChangeEventArgs> PropertyValueChanged

Event Type

EventHandler<PropertyModelValueChangeEventArgs>

public event EventHandler<PropertyModelValueChangeEventArgs> PropertyValueChanging

Event Type

EventHandler<PropertyModelValueChangeEventArgs>

public static readonly DependencyProperty AreAttachedPropertiesBrowsableProperty

public static readonly DependencyProperty AreCategoriesAutoExpandedProperty

public static readonly DependencyProperty AreClipboardMenuItemsEnabledProperty

public static readonly DependencyProperty AreInheritedPropertiesBrowsableProperty

public static readonly DependencyProperty AreNestedCategoriesSupportedProperty

public static readonly DependencyProperty ArePropertiesAutoExpandedProperty

public static readonly DependencyProperty AreReadOnlyPropertiesBrowsableProperty

public static readonly DependencyProperty BrowsableAttributesProperty

public static readonly DependencyProperty CanClearDataObjectOnUnloadProperty

public static readonly DependencyProperty CanSummaryAutoSizeProperty

public static readonly RoutedEvent ChildPropertyAddedEvent

public static readonly RoutedEvent ChildPropertyAddingEvent

public static readonly RoutedEvent ChildPropertyRemovedEvent

public static readonly RoutedEvent ChildPropertyRemovingEvent

public static readonly DependencyProperty CollectionPropertyDisplayModeProperty

public static readonly DependencyProperty DataFactoryProperty

public static readonly DependencyProperty DataObjectProperty

public static readonly DependencyProperty DataObjectsProperty

public static readonly DependencyProperty DefaultBooleanValueTemplateProperty

public static readonly DependencyProperty DefaultBrushValueTemplateProperty

public static readonly DependencyProperty DefaultCategoryEditorItemContainerStyleProperty

public static readonly DependencyProperty DefaultCategoryItemContainerStyleProperty

public static readonly DependencyProperty DefaultColorValueTemplateProperty

public static readonly DependencyProperty DefaultExtendedStringValueTemplateProperty

public static readonly DependencyProperty DefaultFontFamilyValueTemplateProperty

public static readonly DependencyProperty DefaultFontStretchValueTemplateProperty

public static readonly DependencyProperty DefaultFontStyleValueTemplateProperty

public static readonly DependencyProperty DefaultFontWeightValueTemplateProperty

public static readonly DependencyProperty DefaultLimitedObjectValueTemplateProperty

public static readonly DependencyProperty DefaultLimitedStringValueTemplateProperty

public static readonly DependencyProperty DefaultNullableBooleanValueTemplateProperty

public static readonly DependencyProperty DefaultPropertyItemContainerStyleProperty

public static readonly DependencyProperty DefaultStringNameTemplateProperty

public static readonly DependencyProperty DefaultStringValueTemplateProperty

public static readonly DependencyProperty DefaultSuggestedStringValueTemplateProperty

public static readonly DependencyProperty ImmediateStringValueTemplateProperty

public static readonly DependencyProperty IsCategorizedProperty

public static readonly DependencyProperty IsDefaultItemContextMenuEnabledProperty

public static readonly DependencyProperty IsReadOnlyProperty

public static readonly DependencyProperty IsSummaryResizableProperty

public static readonly DependencyProperty IsSummaryToggleAllowedProperty

public static readonly DependencyProperty IsSummaryVisibleProperty

public static readonly DependencyProperty MiscCategoryNameProperty

public static readonly DependencyProperty NameColumnMaxWidthProperty

public static readonly DependencyProperty NameContainerStyleProperty

public static readonly DependencyProperty NameTemplateProperty

public static readonly DependencyProperty NameTemplateSelectorProperty

public static readonly DependencyProperty PropertyExpandabilityProperty

public static readonly RoutedEvent PropertyValueChangedEvent

public static readonly RoutedEvent PropertyValueChangingEvent

public static readonly DependencyProperty SortComparerProperty

public static readonly DependencyProperty SummaryHeightProperty

public static readonly DependencyProperty SummaryTemplateProperty

public static readonly DependencyProperty SummaryTemplateSelectorProperty

public static readonly DependencyProperty ValueContainerStyleProperty

public static readonly DependencyProperty ValueTemplateProperty

public static readonly DependencyProperty ValueTemplateSelectorProperty