Class

RadPropertyGrid

Initializes a new instance of the RadPropertyGrid class.

Declaration

public RadPropertyGrid()

Represents the AutoExpandGroups dependency property.

Declaration

public static readonly DependencyProperty AutoExpandGroupsProperty

Field Value

Represents the AutoGenerateBindingPaths dependency property.

Declaration

public static readonly DependencyProperty AutoGenerateBindingPathsProperty

Field Value

Represents the AutoGeneratePropertyDefinitionsMode  dependency property.

Declaration

public static readonly DependencyProperty AutoGeneratePropertyDefinitionsModeProperty

Field Value

Represents the AutoGeneratePropertyDefinitions dependency property.

Declaration

public static readonly DependencyProperty AutoGeneratePropertyDefinitionsProperty

Field Value

Represents the BeginningEdit routed event.

Declaration

public static readonly RoutedEvent BeginningEditEvent

Field Value

Represents the CanUserResizeDescriptionPanel dependency property.

Declaration

public static readonly DependencyProperty CanUserResizeDescriptionPanelProperty

Field Value

Identifies the CanUserSelect dependency property.

Declaration

public static readonly DependencyProperty CanUserSelectProperty

Field Value

Represents the CommandProvider dependency property.

Declaration

public static readonly DependencyProperty CommandProviderProperty

Field Value

Represents the DescriptionPanelVisibility dependency property.

Declaration

public static readonly DependencyProperty DescriptionPanelVisibilityProperty

Field Value

Represents the EditEnded routed event.

Declaration

public static readonly RoutedEvent EditEndedEvent

Field Value

Represents the EditMode DependencyProperty.

Declaration

public static readonly DependencyProperty EditModeProperty

Field Value

Represents the EditorTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty EditorTemplateSelectorProperty

Field Value

Represents the EnableCustomFiltering dependency property.

Declaration

public static readonly DependencyProperty EnableCustomFilteringProperty

Field Value

Represents the EnableDeferredFiltering dependency property.

Declaration

public static readonly DependencyProperty EnableDeferredFilteringProperty

Field Value

Represents the EnableEditorCaching dependency property.

Declaration

public static readonly DependencyProperty EnableEditorCachingProperty

Field Value

represents the FieldIndicatorVisibility dependency property.

Declaration

public static readonly DependencyProperty FieldIndicatorVisibilityProperty

Field Value

Represents the FieldStyle dependency property.

Declaration

public static readonly DependencyProperty FieldStyleProperty

Field Value

Represents the GroupStyle dependency property.

Declaration

public static readonly DependencyProperty GroupStyleProperty

Field Value

Identifies the GroupStyleSelector dependency property.

Declaration

public static readonly DependencyProperty GroupStyleSelectorProperty

Field Value

Occurs after grouping was performed.

Declaration

public static readonly RoutedEvent GroupedEvent

Field Value

Represents the IsGrouped dependency property.

Declaration

public static readonly DependencyProperty IsGroupedProperty

Field Value

Represents the IsReadOnly property.

Declaration

public static readonly DependencyProperty IsReadOnlyProperty

Field Value

Represents the IsTextSearchEnabled dependency property.

Declaration

public static readonly DependencyProperty IsTextSearchCaseSensitiveProperty

Field Value

Represents the IsTextSearchEnabled dependency property.

Declaration

public static readonly DependencyProperty IsTextSearchEnabledProperty

Field Value

Represents the IsVirtualizing property.

Declaration

public static readonly DependencyProperty IsVirtualizingProperty

Field Value

Represents the Item dependency property.

Declaration

public static readonly DependencyProperty ItemProperty

Field Value

Represents the LabelColumnWidth dependency property.

Declaration

public static readonly DependencyProperty LabelColumnWidthProperty

Field Value

Represents the ModeProperty dependency property.

Declaration

public static readonly DependencyProperty NestedPropertiesVisibilityProperty

Field Value

Represents the PreparedEditor routed event.

Declaration

public static readonly RoutedEvent PreparedEditorEvent

Field Value

Remarks

Represents the PropertySetMode property.

Declaration

public static readonly DependencyProperty PropertySetModeProperty

Field Value

Represents the PropertySetViewModelProperty property.

Declaration

public static readonly DependencyProperty PropertySetViewModelProperty

Field Value

Represents the PropertySetsValidationFunction dependency property.

Declaration

public static readonly DependencyProperty PropertySetsValidationFunctionProperty

Field Value

Represents the ReadOnlyEditorState dependency property.

Declaration

public static readonly DependencyProperty ReadOnlyEditorStateProperty

Field Value

Represents the RenderMode dependency property.

Declaration

public static readonly DependencyProperty RenderModeProperty

Field Value

Represents the SearchBoxVisibility dependency property.

Declaration

public static readonly DependencyProperty SearchBoxVisibilityProperty

Field Value

Represents the SearchInNestedProperties dependency property.

Declaration

public static readonly DependencyProperty SearchInNestedPropertiesProperty

Field Value

Represents the SelectedPropertyDefinition dependency property.

Declaration

public static readonly DependencyProperty SelectedPropertyDefinitionProperty

Field Value

Identifies the SelectionChanged routed event.

Declaration

public static readonly RoutedEvent SelectionChangedEvent

Field Value

Identifies the SelectionMode dependency property.

Declaration

public static readonly DependencyProperty SelectionModeProperty

Field Value

Represents the SortAndGroupButtonsVisibility dependency property.

Declaration

public static readonly DependencyProperty SortAndGroupButtonsVisibilityProperty

Field Value

Occurs after sorting was performed.

Declaration

public static readonly RoutedEvent SortedEvent

Field Value

Represents the TextSearchMode dependency property.

Declaration

public static readonly DependencyProperty TextSearchModeProperty

Field Value

Represents the Validated routed event.

Declaration

public static readonly RoutedEvent ValidatedEvent

Field Value

Represents the Validating routed event.

Declaration

public static readonly RoutedEvent ValidatingEvent

Field Value

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

Declaration

public bool AutoExpandGroups { get; set; }

Property Value

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

Declaration

public bool AutoGenerateBindingPaths { get; set; }

Property Value

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

Declaration

public bool AutoGeneratePropertyDefinitions { get; set; }

Property Value

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

Declaration

public AutoGeneratePropertyDefinitionsMode AutoGeneratePropertyDefinitionsMode { get; set; }

Property Value

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

Declaration

public bool CanUserResizeDescriptionPanel { get; set; }

Property Value

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

Declaration

public bool CanUserSelect { get; set; }

Property Value

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

Declaration

public ICommandProvider CommandProvider { get; set; }

Property Value

Gets or sets the description panel visibility.

Declaration

public Visibility DescriptionPanelVisibility { get; set; }

Property Value

Gets or sets the EditMode of RadPropertyGrid.

Declaration

public PropertyGridEditMode EditMode { get; set; }

Property Value

Gets or sets the editor template selector.

Declaration

public DataTemplateSelector EditorTemplateSelector { get; set; }

Property Value

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

Declaration

public bool EnableCustomFiltering { get; set; }

Property Value

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

Declaration

public bool EnableDeferredFiltering { get; set; }

Property Value

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

Declaration

public bool EnableEditorCaching { get; set; }

Property Value

Gets or sets the field indicator visibility.

Declaration

public Visibility FieldIndicatorVisibility { get; set; }

Property Value

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

Declaration

public Style FieldStyle { get; set; }

Property Value

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

Declaration

public GroupDefinitionsCollection GroupDefinitions { get; }

Property Value

Remarks

Gets or sets the style for GroupDefinition button.

Declaration

public Style GroupStyle { get; set; }

Property Value

Gets or sets the style selector for RadPropertyGrid group.

Declaration

public StyleSelector GroupStyleSelector { get; set; }

Property Value

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

Declaration

public bool IsGrouped { get; set; }

Property Value

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

Declaration

public bool IsReadOnly { get; set; }

Property Value

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

Declaration

public bool IsTextSearchCaseSensitive { get; set; }

Property Value

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

Declaration

public bool IsTextSearchEnabled { get; set; }

Property Value

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

Declaration

public bool IsVirtualizing { get; set; }

Property Value

Gets or sets the item to edit.

Declaration

public object Item { get; set; }

Property Value

Gets or Sets the width of the first column.

Declaration

public GridLength LabelColumnWidth { get; set; }

Property Value

Gets or sets the nested properties' Visibility.

Declaration

public Visibility NestedPropertiesVisibility { get; set; }

Property Value

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

Declaration

public PropertyDefinitionCollection PropertyDefinitions { get; }

Property Value

Gets the property set.

Declaration

public PropertySet PropertySet { get; }

Property Value

Gets or sets the property set mode.

Declaration

public PropertySetOperation PropertySetMode { get; set; }

Property Value

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

Declaration

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

Property Value

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

Declaration

public ReadOnlyEditorStates ReadOnlyEditorState { get; set; }

Property Value

Gets or sets the render mode.

Declaration

public RenderMode RenderMode { get; set; }

Property Value

Gets or sets the search box visibility.

Declaration

public Visibility SearchBoxVisibility { get; set; }

Property Value

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

Declaration

public bool SearchInNestedProperties { get; set; }

Property Value

Gets the selected property definition.

Declaration

public PropertyDefinition SelectedPropertyDefinition { get; set; }

Property Value

Gets a collection that contains the selected property definitions.

Declaration

public ObservableCollection<PropertyDefinition> SelectedPropertyDefinitions { get; }

Property Value

Remarks

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

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

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

Declaration

public Visibility SortAndGroupButtonsVisibility { get; set; }

Property Value

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

Declaration

public TextSearchMode TextSearchMode { get; set; }

Property Value

Begins a new edit operation.

Declaration

public void BeginEdit()

Begins a new edit operation.

Declaration

public void BeginEdit(PropertyDefinition propertyDefinition)

Parameters

Cancels the changes from the current edit operation.

Declaration

public void CancelEdit()

Collapses all groups recursively.

Declaration

public void CollapseAllGroups()

Remarks

Collapses the visual group for the given GroupDefinition.

Declaration

public void CollapseGroup(object groupKey)

Parameters

Remarks

Commits the changes from the current edit operation.

Declaration

public void CommitEdit()

Commits the changes from the current edit operation.

Declaration

public void CommitEdit(PropertyDefinition propertyDefinition)

Parameters

Indicates that the initialization process for the element is complete.

Declaration

public override void EndInit()

Expands all groups recursively.

Declaration

public void ExpandAllGroups()

Remarks

Set expand state for the given GroupDefinition.

Declaration

public void ExpandGroup(object groupKey)

Parameters

Remarks

Groups this RadPropertyGrid instance.

Declaration

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.

Declaration

public override void OnApplyTemplate()

Raises the BeginningEdit event.

Declaration

protected virtual void OnBeginningEdit(PropertyGridBeginningEditEventArgs args)

Parameters

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

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Raises the EditEnded event.

Declaration

protected virtual void OnEditEnded(PropertyGridEditEndedEventArgs args)

Parameters

Raises the FieldLoaded event.

Declaration

protected virtual void OnFieldLoaded(PropertyGridField field)

Parameters

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

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Called when IsReadOnly property is changed.

Declaration

protected static void OnIsReadOnlyPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

Called when IsVirtualizing property gets changed.

Declaration

protected static void OnIsVirtualizingPropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs args)

Parameters

Raises the ItemChanged event.

Declaration

protected virtual void OnItemChanged(PropertyGridItemChangedEventArgs args)

Parameters

Called when the MouseLeftButton down event occurs.

Declaration

protected void OnMouseLeftButtonDown(object sender, RoutedEventArgs e)

Parameters

Raises the PreparedEditor event.

Declaration

protected virtual void OnPreparedEditor(PropertyGridPreparedEditorEventArgs args)

Parameters

Called when PropertyDefinitionCollection's CollectionChanged event is raised.

Declaration

protected virtual void OnPropertyDefinitionsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Raises the PropertySetValueChanged event.

Declaration

protected virtual void OnPropertySetValueChanged(string propertyName, IEnumerable items, object value)

Parameters

Declaration

protected override void OnTextInput(TextCompositionEventArgs e)

Parameters

Raises the Validating event.

Declaration

protected virtual void OnValidated(PropertyGridValidatedEventArgs args)

Parameters

Raises the Validating event.

Declaration

protected virtual void OnValidating(PropertyGridValidatingEventArgs args)

Parameters

Rebinds the property grid.

Declaration

public void Rebind()

Registers the command bindings associated with RadPropertyGrid.

Declaration

public void RegisterCommandBindings()

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

Declaration

public void ReloadData()

Resets the theme.

Declaration

public void ResetTheme()

Scrolls a given PropertyDefinition into view in virtualized scenarios.

Declaration

public void ScrollIntoViewAsync(PropertyDefinition propertyDefinition, Action<PropertyGridField> finishedCallback)

Parameters

Searches for PropertyDefinitions which DisplayName contains the given search parameter.

Declaration

public void Search(string searchParameter)

Parameters

Sorts this RadPropertyGrid instance.

Declaration

public void Sort()

Updates the layout state of the PropertyGridPresenter.

Declaration

protected void UpdateLayoutState()

Declaration

public void UpdatePropertySetValue(string propertyName, object propertyValue, bool shouldUpdateBoundData)

Parameters

Occurs when a property definition is being generated.

Declaration

public event EventHandler<AutoGeneratingPropertyDefinitionEventArgs> AutoGeneratingPropertyDefinition

Event Value

Occurs when a new edit operation is initiated.

Declaration

public event EventHandler<PropertyGridBeginningEditEventArgs> BeginningEdit

Event Value

Remarks

Occurs when edit operation is finished.

Declaration

public event EventHandler<PropertyGridEditEndedEventArgs> EditEnded

Event Value

Remarks

Occurs when a new field is loaded.

Declaration

public event EventHandler<FieldEventArgs> FieldLoaded

Event Value

Occurs after filtering is applied to RadPropertyGrid.

Declaration

public event EventHandler<EventArgs> Filtered

Event Value

Occurs when filtering RadPropertyGrid.

Declaration

public event EventHandler<PropertyGridFilteringEventArgs> Filtering

Event Value

Occurs after grouping was performed.

Declaration

public event EventHandler<RadRoutedEventArgs> Grouped

Event Value

Occurs when RadPropertyGrid's item gets changed.

Declaration

public event EventHandler<PropertyGridItemChangedEventArgs> ItemChanged

Event Value

Occurs when the field editor gets prepared .

Declaration

public event PropertyGridPreparedEditorEventHandler PreparedEditor

Event Value

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

Declaration

public event EventHandler<PropertySetValueChangedEventArgs> PropertySetValueChanged

Event Value

Occurs when the selected property definition has changed.

Declaration

public event EventHandler<SelectionChangeEventArgs> SelectionChanged

Event Value

Occurs after sorting was performed.

Declaration

public event EventHandler<RadRoutedEventArgs> Sorted

Event Value

Occurs after validation of edit changes takes place.

Declaration

public event EventHandler<PropertyGridValidatedEventArgs> Validated

Event Value

Occurs before validation of edit changes takes place.

Declaration

public event EventHandler<PropertyGridValidatingEventArgs> Validating

Event Value