New to Telerik UI for WPFStart a free 30-day trial

Provides infrastructure for command execution for RadPropertyGrid.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Data.dll

Syntax:

C#
[TelerikToolboxCategory("Data")]
public class RadPropertyGrid : Control

Inheritance: objectRadPropertyGrid

Constructors

Initializes a new instance of the RadPropertyGrid class.

C#
public RadPropertyGrid()

Fields

AutoExpandGroupsProperty

DependencyProperty

Represents the AutoExpandGroups dependency property.

C#
public static readonly DependencyProperty AutoExpandGroupsProperty

Represents the AutoGenerateBindingPaths dependency property.

C#
public static readonly DependencyProperty AutoGenerateBindingPathsProperty

Represents the AutoGeneratePropertyDefinitionsMode  dependency property.

C#
public static readonly DependencyProperty AutoGeneratePropertyDefinitionsModeProperty

Represents the AutoGeneratePropertyDefinitions dependency property.

C#
public static readonly DependencyProperty AutoGeneratePropertyDefinitionsProperty

Represents the BeginningEdit routed event.

C#
public static readonly RoutedEvent BeginningEditEvent

Represents the CanUserResizeDescriptionPanel dependency property.

C#
public static readonly DependencyProperty CanUserResizeDescriptionPanelProperty

CanUserSelectProperty

DependencyProperty

Identifies the CanUserSelect dependency property.

C#
public static readonly DependencyProperty CanUserSelectProperty

CommandProviderProperty

DependencyProperty

Represents the CommandProvider dependency property.

C#
public static readonly DependencyProperty CommandProviderProperty

Represents the DescriptionPanelVisibility dependency property.

C#
public static readonly DependencyProperty DescriptionPanelVisibilityProperty

EditEndedEvent

RoutedEvent

Represents the EditEnded routed event.

C#
public static readonly RoutedEvent EditEndedEvent

EditModeProperty

DependencyProperty

Represents the EditMode DependencyProperty.

C#
public static readonly DependencyProperty EditModeProperty

Represents the EditorTemplateSelector dependency property.

C#
public static readonly DependencyProperty EditorTemplateSelectorProperty

Represents the EnableCustomFiltering dependency property.

C#
public static readonly DependencyProperty EnableCustomFilteringProperty

Represents the EnableDeferredFiltering dependency property.

C#
public static readonly DependencyProperty EnableDeferredFilteringProperty

EnableEditorCachingProperty

DependencyProperty

Represents the EnableEditorCaching dependency property.

C#
public static readonly DependencyProperty EnableEditorCachingProperty

represents the FieldIndicatorVisibility dependency property.

C#
public static readonly DependencyProperty FieldIndicatorVisibilityProperty

FieldStyleProperty

DependencyProperty

Represents the FieldStyle dependency property.

C#
public static readonly DependencyProperty FieldStyleProperty

GroupedEvent

RoutedEvent

Occurs after grouping was performed.

C#
public static readonly RoutedEvent GroupedEvent

GroupStyleProperty

DependencyProperty

Represents the GroupStyle dependency property.

C#
public static readonly DependencyProperty GroupStyleProperty

GroupStyleSelectorProperty

DependencyProperty

Identifies the GroupStyleSelector dependency property.

C#
public static readonly DependencyProperty GroupStyleSelectorProperty

IsGroupedProperty

DependencyProperty

Represents the IsGrouped dependency property.

C#
public static readonly DependencyProperty IsGroupedProperty

IsReadOnlyProperty

DependencyProperty

Represents the IsReadOnly property.

C#
public static readonly DependencyProperty IsReadOnlyProperty

Represents the IsTextSearchEnabled dependency property.

C#
public static readonly DependencyProperty IsTextSearchCaseSensitiveProperty

IsTextSearchEnabledProperty

DependencyProperty

Represents the IsTextSearchEnabled dependency property.

C#
public static readonly DependencyProperty IsTextSearchEnabledProperty

IsVirtualizingProperty

DependencyProperty

Represents the IsVirtualizing property.

C#
public static readonly DependencyProperty IsVirtualizingProperty

ItemProperty

DependencyProperty

Represents the Item dependency property.

C#
public static readonly DependencyProperty ItemProperty

LabelColumnWidthProperty

DependencyProperty

Represents the LabelColumnWidth dependency property.

C#
public static readonly DependencyProperty LabelColumnWidthProperty

Represents the ModeProperty dependency property.

C#
public static readonly DependencyProperty NestedPropertiesVisibilityProperty

Represents the PreparedEditor routed event.

C#
public static readonly RoutedEvent PreparedEditorEvent
Remarks:

This event is fired only when the value of the EditMode property is Single.

PropertySetModeProperty

DependencyProperty

Represents the PropertySetMode property.

C#
public static readonly DependencyProperty PropertySetModeProperty

Represents the PropertySetsValidationFunction dependency property.

C#
public static readonly DependencyProperty PropertySetsValidationFunctionProperty

Represents the PropertySetViewModelProperty property.

C#
public static readonly DependencyProperty PropertySetViewModelProperty

ReadOnlyEditorStateProperty

DependencyProperty

Represents the ReadOnlyEditorState dependency property.

C#
public static readonly DependencyProperty ReadOnlyEditorStateProperty

RenderModeProperty

DependencyProperty

Represents the RenderMode dependency property.

C#
public static readonly DependencyProperty RenderModeProperty

SearchBoxVisibilityProperty

DependencyProperty

Represents the SearchBoxVisibility dependency property.

C#
public static readonly DependencyProperty SearchBoxVisibilityProperty

Represents the SearchInNestedProperties dependency property.

C#
public static readonly DependencyProperty SearchInNestedPropertiesProperty

Represents the SelectedPropertyDefinition dependency property.

C#
public static readonly DependencyProperty SelectedPropertyDefinitionProperty

Identifies the SelectionChanged routed event.

C#
public static readonly RoutedEvent SelectionChangedEvent

SelectionModeProperty

DependencyProperty

Identifies the SelectionMode dependency property.

C#
public static readonly DependencyProperty SelectionModeProperty

Represents the SortAndGroupButtonsVisibility dependency property.

C#
public static readonly DependencyProperty SortAndGroupButtonsVisibilityProperty

SortedEvent

RoutedEvent

Occurs after sorting was performed.

C#
public static readonly RoutedEvent SortedEvent

TextSearchModeProperty

DependencyProperty

Represents the TextSearchMode dependency property.

C#
public static readonly DependencyProperty TextSearchModeProperty

ValidatedEvent

RoutedEvent

Represents the Validated routed event.

C#
public static readonly RoutedEvent ValidatedEvent

ValidatingEvent

RoutedEvent

Represents the Validating routed event.

C#
public static readonly RoutedEvent ValidatingEvent

Properties

Gets or sets a value indicating whether groups should be automatically expanded.

C#
public bool AutoExpandGroups { get; set; }

Gets or sets a value indicating whether manually defined nested PropertyDefinitions, should have auto-generated paths.

C#
public bool AutoGenerateBindingPaths { get; set; }
Property Value:

true if [auto generate binding paths]; otherwise, false.

Gets or sets a value indicating whether property definitions will be auto-generated.

C#
public bool AutoGeneratePropertyDefinitions { get; set; }

Gets or sets a value indicating whether property definitions will be auto-generated for nested properties.

C#
public AutoGeneratePropertyDefinitionsMode AutoGeneratePropertyDefinitionsMode { get; set; }

Gets or sets a value that indicates whether the user can adjust description panel width using the mouse.

C#
public bool CanUserResizeDescriptionPanel { get; set; }

Gets or sets a value indicating whether the user can select property definition.

C#
public bool CanUserSelect { get; set; }
Property Value:

true if user can select; otherwise, false.

Gets or sets the command provider associated with this RadPropertyGrid instance.

C#
public ICommandProvider CommandProvider { get; set; }
Property Value:

The command provider.

Gets or sets the description panel visibility.

C#
public Visibility DescriptionPanelVisibility { get; set; }

Gets or sets the EditMode of RadPropertyGrid.

C#
public PropertyGridEditMode EditMode { get; set; }

EditorTemplateSelector

DataTemplateSelector

Gets or sets the editor template selector.

C#
public DataTemplateSelector EditorTemplateSelector { get; set; }
Property Value:

The editor template selector.

Gets or sets a value indicating whether RadPropertyGrid enables custom filtering.

C#
public bool EnableCustomFiltering { get; set; }
Property Value:

true if [enable custom filtering]; otherwise, false.

Gets or sets a value indicating whether RadPropertyGrid enables deferred filtering.

C#
public bool EnableDeferredFiltering { get; set; }
Property Value:

true if [enable deferred filtering]; otherwise, false.

Gets or sets a value indicating whether RadPropertyGrid uses editor caching.

C#
public bool EnableEditorCaching { get; set; }
Property Value:

true if [enable editor caching]; otherwise, false.

Gets or sets the field indicator visibility.

C#
public Visibility FieldIndicatorVisibility { get; set; }
Property Value:

The field indicator visibility.

Gets or sets a Style for all PropertyGridFields in the scope of a RadPropertyGrid instance.

C#
public Style FieldStyle { get; set; }
Property Value:

The field style.

Gets a collection of GroupDefinition objects used to group the property grid.

C#
public GroupDefinitionsCollection GroupDefinitions { get; }
Property Value:

The group definition.

Remarks:

GroupDefinitions collection will be filled only when RenderMode="Flat".

Gets or sets the style for GroupDefinition button.

C#
public Style GroupStyle { get; set; }
Property Value:

The GroupStyle.

GroupStyleSelector

StyleSelector

Gets or sets the style selector for RadPropertyGrid group.

C#
public StyleSelector GroupStyleSelector { get; set; }

Gets or sets a value indicating whether this instance is grouped.

C#
public bool IsGrouped { get; set; }

Gets or sets a value indicating whether this instance is read only.

C#
public bool IsReadOnly { get; set; }
Property Value:

true if this instance is read only; otherwise, false.

Gets or sets a value that indicates whether case is a condition when searching.

C#
public bool IsTextSearchCaseSensitive { get; set; }

Gets or sets a value that determines whether the user can navigate to an item by typing when RadPropertyGrid is focused.

C#
public bool IsTextSearchEnabled { get; set; }

Gets or sets a value indicating whether this PropertyGrid is virtualized.

C#
public bool IsVirtualizing { get; set; }
Property Value:

true if this instance is virtualized; otherwise, false.

Gets or sets the item to edit.

C#
public object Item { get; set; }

Gets or Sets the width of the first column.

C#
public GridLength LabelColumnWidth { get; set; }

Gets or sets the nested properties' Visibility.

C#
public Visibility NestedPropertiesVisibility { get; set; }

Gets a collection of PropertyDefinitions describing the properties displayed or edited by RadPropertyGrid.

C#
public PropertyDefinitionCollection PropertyDefinitions { get; }
Property Value:

The collection of PropertyDefinitions.

Gets the property set.

C#
public PropertySet PropertySet { get; }
Property Value:

The property set.

Gets or sets the property set mode.

C#
public PropertySetOperation PropertySetMode { get; set; }
Property Value:

The property set mode.

Gets or sets a function that is used to validate PropertySet properties.

C#
public Func<string, object, string> PropertySetsValidationFunction { get; set; }

Gets or sets the state of editors when RadPropertyGrid is ReadOnly.

C#
public ReadOnlyEditorStates ReadOnlyEditorState { get; set; }
Property Value:

The state of the read only editor.

Gets or sets the render mode.

C#
public RenderMode RenderMode { get; set; }
Property Value:

The rendering mode.

Gets or sets the search box visibility.

C#
public Visibility SearchBoxVisibility { get; set; }
Property Value:

The search box visibility.

Gets or sets a value indicating whether search should be execute over nested properties.

C#
public bool SearchInNestedProperties { get; set; }
Property Value:

true if search in nested properties is enabled; otherwise, false.

Gets the selected property definition.

C#
public PropertyDefinition SelectedPropertyDefinition { get; set; }

Gets a collection that contains the selected property definitions.

C#
public ObservableCollection<PropertyDefinition> SelectedPropertyDefinitions { get; }
Property Value:

A collection of the data items corresponding to the selected fields.

Remarks:

If the SelectionMode property is set to Single, the SelectedPropertyDefinitions list will contain only the SelectedPropertyDefinition property value.

SelectionMode

SelectionMode

Gets or sets the SelectionMode. This is a dependency property.

C#
public SelectionMode SelectionMode { get; set; }

Gets or sets the visibility of the sort and group buttons.

C#
public Visibility SortAndGroupButtonsVisibility { get; set; }

Gets or sets the text search mode. Specifies how TextSearch will match items. This is a dependency property.

C#
public TextSearchMode TextSearchMode { get; set; }
Property Value:

The text search mode.

Methods

Begins a new edit operation.

C#
public void BeginEdit()

Begins a new edit operation.

C#
public void BeginEdit(PropertyDefinition propertyDefinition)
Parameters:propertyDefinitionPropertyDefinition

Cancels the changes from the current edit operation.

C#
public void CancelEdit()

Collapses all groups recursively.

C#
public void CollapseAllGroups()
Remarks:

The method will work only when RenderMode="Flat".

Collapses the visual group for the given GroupDefinition.

C#
public void CollapseGroup(object groupKey)
Parameters:groupKeyobject

The key for the group to collapse.

Remarks:

The method will work only when RenderMode="Flat".

Commits the changes from the current edit operation.

C#
public void CommitEdit()

Commits the changes from the current edit operation.

C#
public void CommitEdit(PropertyDefinition propertyDefinition)
Parameters:propertyDefinitionPropertyDefinition

Indicates that the initialization process for the element is complete.

C#
public override void EndInit()

Expands all groups recursively.

C#
public void ExpandAllGroups()
Remarks:

The method will work only when RenderMode="Flat".

Set expand state for the given GroupDefinition.

C#
public void ExpandGroup(object groupKey)
Parameters:groupKeyobject

The key for the group to expand.

Remarks:

The method will work only when RenderMode="Flat".

Groups this RadPropertyGrid instance.

C#
public void Group()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call . In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks.

C#
public override void OnApplyTemplate()

Raises the BeginningEdit event.

C#
protected virtual void OnBeginningEdit(PropertyGridBeginningEditEventArgs args)
Parameters:argsPropertyGridBeginningEditEventArgs

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

Raises the EditEnded event.

C#
protected virtual void OnEditEnded(PropertyGridEditEndedEventArgs args)
Parameters:argsPropertyGridEditEndedEventArgs

Raises the FieldLoaded event.

C#
protected virtual void OnFieldLoaded(PropertyGridField field)
Parameters:fieldPropertyGridField

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Called when IsReadOnly property is changed.

C#
protected static void OnIsReadOnlyPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters:senderDependencyObject

The sender.

argsDependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Called when IsVirtualizing property gets changed.

C#
protected static void OnIsVirtualizingPropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs args)
Parameters:dDependencyObject

The d.

argsDependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Raises the ItemChanged event.

C#
protected virtual void OnItemChanged(PropertyGridItemChangedEventArgs args)
Parameters:argsPropertyGridItemChangedEventArgs

Called when the MouseLeftButton down event occurs.

C#
protected void OnMouseLeftButtonDown(object sender, RoutedEventArgs e)
Parameters:senderobject

The sender.

eRoutedEventArgs

The MouseButtonEventArgs instance containing the event data.

Raises the PreparedEditor event.

C#
protected virtual void OnPreparedEditor(PropertyGridPreparedEditorEventArgs args)
Parameters:argsPropertyGridPreparedEditorEventArgs

Called when PropertyDefinitionCollection's CollectionChanged event is raised.

C#
protected virtual void OnPropertyDefinitionsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
Parameters:senderobject

The sender.

eNotifyCollectionChangedEventArgs

The NotifyCollectionChangedEventArgs instance containing the event data.

Raises the PropertySetValueChanged event.

C#
protected virtual void OnPropertySetValueChanged(string propertyName, IEnumerable items, object value)
Parameters:propertyNamestringitemsIEnumerablevalueobject
C#
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters:eTextCompositionEventArgs

Raises the Validating event.

C#
protected virtual void OnValidated(PropertyGridValidatedEventArgs args)
Parameters:argsPropertyGridValidatedEventArgs

Raises the Validating event.

C#
protected virtual void OnValidating(PropertyGridValidatingEventArgs args)
Parameters:argsPropertyGridValidatingEventArgs

Rebinds the property grid.

C#
public void Rebind()

Registers the command bindings associated with RadPropertyGrid.

C#
public void RegisterCommandBindings()

Reloads the set of PropertyDefinitions, the list of item properties and recreates the PropertySetView model, if PropertySetMode is different from None.

C#
public void ReloadData()

Resets the theme.

C#
public void ResetTheme()

Scrolls a given PropertyDefinition into view in virtualized scenarios.

C#
public void ScrollIntoViewAsync(PropertyDefinition propertyDefinition, Action<PropertyGridField> finishedCallback)
Parameters:propertyDefinitionPropertyDefinition

The property definition.

finishedCallbackAction<PropertyGridField>

The finished callback.

Searches for PropertyDefinitions which DisplayName contains the given search parameter.

C#
public void Search(string searchParameter)
Parameters:searchParameterstring

Sorts this RadPropertyGrid instance.

C#
public void Sort()

Updates the layout state of the PropertyGridPresenter.

C#
protected void UpdateLayoutState()
C#
public void UpdatePropertySetValue(string propertyName, object propertyValue, bool shouldUpdateBoundData)
Parameters:propertyNamestring

The name of the updated property.

propertyValueobject

The value of the updated property.

shouldUpdateBoundDatabool

Indicates whether the bound data (Item) should be updated.

Events

Occurs when a property definition is being generated.

C#
public event EventHandler<AutoGeneratingPropertyDefinitionEventArgs> AutoGeneratingPropertyDefinition

Occurs when a new edit operation is initiated.

C#
public event EventHandler<PropertyGridBeginningEditEventArgs> BeginningEdit
Remarks:

This event is fired only when the value of the EditMode property is Single.

Occurs when edit operation is finished.

C#
public event EventHandler<PropertyGridEditEndedEventArgs> EditEnded
Remarks:

This event is fired only when the value of the EditMode property is Single.

Occurs when a new field is loaded.

C#
public event EventHandler<FieldEventArgs> FieldLoaded

Occurs after filtering is applied to RadPropertyGrid.

C#
public event EventHandler<EventArgs> Filtered

Occurs when filtering RadPropertyGrid.

C#
public event EventHandler<PropertyGridFilteringEventArgs> Filtering

Occurs after grouping was performed.

C#
public event EventHandler<RadRoutedEventArgs> Grouped

Occurs when RadPropertyGrid's item gets changed.

C#
public event EventHandler<PropertyGridItemChangedEventArgs> ItemChanged

Occurs when the field editor gets prepared .

C#
public event PropertyGridPreparedEditorEventHandler PreparedEditor

Occurs when the value of a property from the PropertySet is changed.

C#
public event EventHandler<PropertySetValueChangedEventArgs> PropertySetValueChanged

Occurs when the selected property definition has changed.

C#
public event EventHandler<SelectionChangeEventArgs> SelectionChanged

Occurs after sorting was performed.

C#
public event EventHandler<RadRoutedEventArgs> Sorted

Occurs after validation of edit changes takes place.

C#
public event EventHandler<PropertyGridValidatedEventArgs> Validated

Occurs before validation of edit changes takes place.

C#
public event EventHandler<PropertyGridValidatingEventArgs> Validating
In this article
DefinitionConstructorsRadPropertyGrid()FieldsAutoExpandGroupsPropertyAutoGenerateBindingPathsPropertyAutoGeneratePropertyDefinitionsModePropertyAutoGeneratePropertyDefinitionsPropertyBeginningEditEventCanUserResizeDescriptionPanelPropertyCanUserSelectPropertyCommandProviderPropertyDescriptionPanelVisibilityPropertyEditEndedEventEditModePropertyEditorTemplateSelectorPropertyEnableCustomFilteringPropertyEnableDeferredFilteringPropertyEnableEditorCachingPropertyFieldIndicatorVisibilityPropertyFieldStylePropertyGroupedEventGroupStylePropertyGroupStyleSelectorPropertyIsGroupedPropertyIsReadOnlyPropertyIsTextSearchCaseSensitivePropertyIsTextSearchEnabledPropertyIsVirtualizingPropertyItemPropertyLabelColumnWidthPropertyNestedPropertiesVisibilityPropertyPreparedEditorEventPropertySetModePropertyPropertySetsValidationFunctionPropertyPropertySetViewModelPropertyReadOnlyEditorStatePropertyRenderModePropertySearchBoxVisibilityPropertySearchInNestedPropertiesPropertySelectedPropertyDefinitionPropertySelectionChangedEventSelectionModePropertySortAndGroupButtonsVisibilityPropertySortedEventTextSearchModePropertyValidatedEventValidatingEventPropertiesAutoExpandGroupsAutoGenerateBindingPathsAutoGeneratePropertyDefinitionsAutoGeneratePropertyDefinitionsModeCanUserResizeDescriptionPanelCanUserSelectCommandProviderDescriptionPanelVisibilityEditModeEditorTemplateSelectorEnableCustomFilteringEnableDeferredFilteringEnableEditorCachingFieldIndicatorVisibilityFieldStyleGroupDefinitionsGroupStyleGroupStyleSelectorIsGroupedIsReadOnlyIsTextSearchCaseSensitiveIsTextSearchEnabledIsVirtualizingItemLabelColumnWidthNestedPropertiesVisibilityPropertyDefinitionsPropertySetPropertySetModePropertySetsValidationFunctionReadOnlyEditorStateRenderModeSearchBoxVisibilitySearchInNestedPropertiesSelectedPropertyDefinitionSelectedPropertyDefinitionsSelectionModeSortAndGroupButtonsVisibilityTextSearchModeMethodsBeginEdit()BeginEdit(PropertyDefinition)CancelEdit()CollapseAllGroups()CollapseGroup(object)CommitEdit()CommitEdit(PropertyDefinition)EndInit()ExpandAllGroups()ExpandGroup(object)Group()OnApplyTemplate()OnBeginningEdit(PropertyGridBeginningEditEventArgs)OnCreateAutomationPeer()OnEditEnded(PropertyGridEditEndedEventArgs)OnFieldLoaded(PropertyGridField)OnInitialized(EventArgs)OnIsReadOnlyPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)OnIsVirtualizingPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)OnItemChanged(PropertyGridItemChangedEventArgs)OnMouseLeftButtonDown(object, RoutedEventArgs)OnPreparedEditor(PropertyGridPreparedEditorEventArgs)OnPropertyDefinitionsCollectionChanged(object, NotifyCollectionChangedEventArgs)OnPropertySetValueChanged(string, IEnumerable, object)OnTextInput(TextCompositionEventArgs)OnValidated(PropertyGridValidatedEventArgs)OnValidating(PropertyGridValidatingEventArgs)Rebind()RegisterCommandBindings()ReloadData()ResetTheme()ScrollIntoViewAsync(PropertyDefinition, Action<PropertyGridField>)Search(string)Sort()UpdateLayoutState()UpdatePropertySetValue(string, object, bool)EventsAutoGeneratingPropertyDefinitionBeginningEditEditEndedFieldLoadedFilteredFilteringGroupedItemChangedPreparedEditorPropertySetValueChangedSelectionChangedSortedValidatedValidating
Not finding the help you need?
Contact Support