Class PropertyGridElement

Represents the main element of the RadPropertyGrid control that contains the property table and toolbar.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
StackLayoutElement
PropertyGridElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class PropertyGridElement : StackLayoutElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

PropertyGridElement()

Declaration
public PropertyGridElement()

Properties

EnableCustomGrouping

Gets or sets a value indicating whether custom grouping of properties can be applied programmatically.

Declaration
public bool EnableCustomGrouping { get; set; }
Property Value
System.Boolean

EnableFiltering

Gets or sets a value indicating whether properties can be filtered using the search functionality in the toolbar.

Declaration
public bool EnableFiltering { get; set; }
Property Value
System.Boolean

EnableGrouping

Gets or sets a value indicating whether properties can be grouped by categories in the property grid.

Declaration
public bool EnableGrouping { get; set; }
Property Value
System.Boolean

EnableSorting

Gets or sets a value indicating whether properties can be sorted alphabetically in the property grid.

Declaration
public bool EnableSorting { get; set; }
Property Value
System.Boolean

PropertyTableElement

Gets the PropertyGridTableElement that displays the properties in a table format with value editors.

Declaration
public PropertyGridTableElement PropertyTableElement { get; }
Property Value
PropertyGridTableElement

SplitElement

Gets the PropertyGridSplitElement.

Declaration
public PropertyGridSplitElement SplitElement { get; }
Property Value
PropertyGridSplitElement

ToolbarElement

Gets the PropertyGridToolbarElement that provides search and categorization functionality.

Declaration
public PropertyGridToolbarElement ToolbarElement { get; }
Property Value
PropertyGridToolbarElement

ToolbarElementHeight

Gets or sets the height of the PropertyGridToolbarElement in pixels.

Declaration
public float ToolbarElementHeight { get; set; }
Property Value
System.Single

ToolbarVisible

Gets or sets a value indicating whether the PropertyGridToolbarElement is visible and accessible to users.

Declaration
public bool ToolbarVisible { get; set; }
Property Value
System.Boolean

Methods

BestFit()

Automatically adjusts the column widths to optimize the visibility of property names and values in the property grid.

Declaration
public void BestFit()

BestFit(PropertyGridBestFitMode)

Automatically adjusts the column widths using the specified fitting algorithm to optimize property display.

Declaration
public void BestFit(PropertyGridBestFitMode mode)
Parameters
PropertyGridBestFitMode mode

The PropertyGridBestFitMode that determines the fitting algorithm to use.

CollapseAllGridItems()

Collapses all the categories in the PropertyGridElement.

Declaration
public void CollapseAllGridItems()

CreateChildElements()

Creates and initializes the child elements of the PropertyGridElement.

Declaration
protected override void CreateChildElements()
Overrides

CreateSplitElement()

Creates the split element that contains the property grid table and help panel.

Declaration
protected virtual PropertyGridSplitElement CreateSplitElement()
Returns
PropertyGridSplitElement

A new instance of PropertyGridSplitElement.

CreateToolbarElement()

Creates the toolbar element used for searching and categorizing properties.

Declaration
protected virtual PropertyGridToolbarElement CreateToolbarElement()
Returns
PropertyGridToolbarElement

A new instance of PropertyGridToolbarElement.

DpiScaleChanged(SizeF)

Called when the DPI scaling factor changes, allowing the property grid to adjust for the new scale.

Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF scaleFactor

The new DPI scale factor.
Overrides

ExpandAllGridItems()

Expands all the categories in the PropertyGridElement.

Declaration
public void ExpandAllGridItems()

InitializeFields()

Initializes the default fields and properties of the PropertyGridElement.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the size required by the property grid element.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size for the element.
Returns
System.Drawing.SizeF

The desired size of the element.
Overrides

OnStyleChanged(RadPropertyChangedEventArgs)

Called when the style of the element changes. Ensures proper cleanup and refreshing of the property table.

Declaration
protected override void OnStyleChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The event arguments containing the style change information.
Overrides

ResetSelectedProperty()

Resets the currently selected property to its default value as defined by the property descriptor.

Declaration
public void ResetSelectedProperty()

Extension Methods