Class

RadPropertyGrid

Initializes a new instance of the RadPropertyGrid class with default settings.

Declaration

public RadPropertyGrid()

Gets the currently active editor instance used for editing property values.

Declaration

[Browsable(false)]
public IValueEditor ActiveEditor { get; }

Property Value

Gets or sets a value indicating whether the default context menu is enabled.

Declaration

public bool AllowDefaultContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether property groups are automatically expanded when the property grid is populated.

Declaration

[Browsable(true)]
public bool AutoExpandGroups { get; set; }

Property Value

Gets or sets the mode that determines how users can initiate editing of property values.

Declaration

[Browsable(true)]
public RadPropertyGridBeginEditModes BeginEditMode { get; set; }

Property Value

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets a value indicating whether properties can be grouped programmatically using custom grouping logic.

Declaration

[Browsable(true)]
public bool EnableCustomGrouping { get; set; }

Property Value

Gets or sets a value indicating whether filtering is enabled.

Declaration

[Browsable(true)]
public bool EnableFiltering { get; set; }

Property Value

Gets or sets a value indicating whether grouping is enabled.

Declaration

[Browsable(true)]
public bool EnableGrouping { get; set; }

Property Value

Gets or sets a value indicating whether kinetic scrolling is enabled for smooth touch-based scrolling interactions.

Declaration

[Browsable(true)]
public bool EnableKineticScrolling { get; set; }

Property Value

Gets or sets a value indicating whether sorting is enabled.

Declaration

[Browsable(true)]
public bool EnableSorting { get; set; }

Property Value

Gets the filter descriptors.

Declaration

[Browsable(false)]
public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

Gets or sets the string comparer used by the keyboard navigation functionality.

Declaration

[Browsable(false)]
public IFindStringComparer FindStringComparer { get; set; }

Property Value

Gets the group descriptors.

Declaration

[Browsable(false)]
public GroupDescriptorCollection GroupDescriptors { get; }

Property Value

Gets the Groups collection.

Declaration

[Browsable(false)]
public PropertyGridGroupItemCollection Groups { get; }

Property Value

Gets or sets the height of the PropertyGridHelpElement.

Declaration

[Browsable(true)]
public float HelpBarHeight { get; set; }

Property Value

Gets or sets a value indicating whether the PropertyGridHelpElement is visible.

Declaration

[Browsable(true)]
public bool HelpVisible { get; set; }

Property Value

Gets a value indicating whether any property editors are currently active and being edited.

Declaration

[Browsable(false)]
public bool IsEditing { get; }

Property Value

Gets or sets the height of the items.

Declaration

[Browsable(true)]
public int ItemHeight { get; set; }

Property Value

Gets or sets the width of the indentation of subitems.

Declaration

[Browsable(true)]
public int ItemIndent { get; set; }

Property Value

Gets or sets the distance between items of the RadPropertyGridElement.

Declaration

[Browsable(true)]
public int ItemSpacing { get; set; }

Property Value

Gets the Items collection.

Declaration

[Browsable(false)]
public PropertyGridItemCollection Items { get; }

Property Value

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

Declaration

[Browsable(true)]
public bool KeyboardSearchEnabled { get; set; }

Property Value

Gets or sets a value that specifies how long the user must wait before searching with the keyboard is reset.

Declaration

[Browsable(true)]
public int KeyboardSearchResetInterval { get; set; }

Property Value

Gets the PropertyGridTableElement of this control.

Declaration

[Browsable(false)]
public PropertyGridElement PropertyGridElement { get; }

Property Value

Gets or sets the mode in which the properties will be displayed in the RadPropertyGrid.

Declaration

[Browsable(true)]
public PropertySort PropertySort { get; set; }

Property Value

Gets or sets the shortcut menu associated with the control.

Declaration

public virtual RadContextMenu RadContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether the property grid is in read-only mode, preventing users from editing property values.

Declaration

[Browsable(true)]
public bool ReadOnly { get; set; }

Property Value

Gets or sets the PropertyGridTableElement selected item.

Declaration

[Browsable(false)]
public PropertyGridItemBase SelectedGridItem { get; set; }

Property Value

Gets or sets the object which properties the RadPropertyGrid is displaying.

Declaration

[TypeConverter(typeof(SelectedObjectConverter))]
[Browsable(true)]
public object SelectedObject { get; set; }

Property Value

Gets or sets the objects which properties the RadPropertyGrid is displaying.

Declaration

[TypeConverter(typeof(SelectedObjectConverter))]
[Browsable(false)]
public object[] SelectedObjects { get; set; }

Property Value

Gets the sort descriptors.

Declaration

[Browsable(false)]
public SortDescriptorCollection SortDescriptors { get; }

Property Value

Gets or sets the sort order of items.

Declaration

[Browsable(true)]
public SortOrder SortOrder { get; set; }

Property Value

Gets or sets a value indicating whether the search box of the RadPropertyGrid should be visible

Declaration

[Browsable(true)]
public bool ToolbarVisible { get; set; }

Property Value

Puts the current item in edit mode.

Declaration

public void BeginEdit()

Uses a mechanism to maximize the visible strings in both columns of RadPropertyGrid.

Declaration

public void BestFit()

Best fits the column(s) of RadPropertyGrid using the given mode.

Declaration

public void BestFit(PropertyGridBestFitMode mode)

Parameters

Close the currently active editor and discard changes.

Declaration

public void CancelEdit()

Collapses all the categories in the RadPropertyGrid.

Declaration

public void CollapseAllGridItems()

Declaration

protected override AccessibleObject CreateAccessibilityInstance()

Returns

Overrides Control.CreateAccessibilityInstance()

Creates the child elements for the property grid control.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates the main PropertyGridElement that provides the core functionality for the property grid.

Declaration

protected virtual PropertyGridElement CreatePropertyGridElement()

Returns

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

Commits any changes and ends the edit operation on the current item.

Declaration

public bool EndEdit()

Returns

Expands all the categories in the RadPropertyGrid.

Declaration

public void ExpandAllGridItems()

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Declaration

protected override void OnKeyPress(KeyPressEventArgs e)

Parameters

Overrides RadControl.OnKeyPress(KeyPressEventArgs)

Notifies that the control is about to be visualized.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Declaration

protected override void OnMouseClick(MouseEventArgs e)

Parameters

Overrides Control.OnMouseClick(MouseEventArgs)

Declaration

protected override void OnMouseDoubleClick(MouseEventArgs e)

Parameters

Overrides Control.OnMouseDoubleClick(MouseEventArgs)

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseDown(MouseEventArgs)

Declaration

protected override void OnMouseEnter(EventArgs e)

Parameters

Overrides RadControl.OnMouseEnter(EventArgs)

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Overrides RadControl.OnMouseLeave(EventArgs)

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseMove(MouseEventArgs)

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseUp(MouseEventArgs)

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseWheel(MouseEventArgs)

Declaration

protected override void OnValidating(CancelEventArgs e)

Parameters

Overrides Control.OnValidating(CancelEventArgs)

Declaration

protected override bool ProcessDialogKey(Keys keyData)

Parameters

Returns

Overrides Control.ProcessDialogKey(Keys)

Resets the selected property to its default value.

Declaration

public void ResetSelectedProperty()

Declaration

protected override void WndProc(ref Message m)

Parameters

Overrides RadControl.WndProc(ref Message)

Occurs when opening the context menu.

Declaration

public event PropertyGridContextMenuOpeningEventHandler ContextMenuOpening

Event Value

Occurs when a new item element is going to be created.

Declaration

public event CreatePropertyGridItemEventHandler CreateItem

Event Value

Occurs when a new item element is going to be created.

Declaration

public event CreatePropertyGridItemElementEventHandler CreateItemElement

Event Value

Fires for custom grouping operation.

Declaration

[Browsable(true)]
public event PropertyGridCustomGroupingEventHandler CustomGrouping

Event Value

Occurs when editing has been finished.

Declaration

public event PropertyGridItemEditedEventHandler Edited

Event Value

Occurs when editing is started.

Declaration

public event PropertyGridItemEditingEventHandler Editing

Event Value

Occurs when editor is initialized.

Declaration

public event PropertyGridItemEditorInitializedEventHandler EditorInitialized

Event Value

Occurs when editor is required.

Declaration

public event PropertyGridEditorRequiredEventHandler EditorRequired

Event Value

Occurs after the value of the Expanded property of a property grid item is changed.

Declaration

public event RadPropertyGridEventHandler ItemExpandedChanged

Event Value

Occurs before the value of the Expanded property of a property grid item is changed.

Declaration

public event RadPropertyGridCancelEventHandler ItemExpandedChanging

Event Value

Occurs when the item changes its state and needs to be formatted.

Declaration

public event PropertyGridItemFormattingEventHandler ItemFormatting

Event Value

Occurs when a mouse button is clicked inside a PropertyGridItemElementBase

Declaration

public event RadPropertyGridEventHandler ItemMouseClick

Event Value

Occurs when a mouse button is double clicked inside a PropertyGridItemElementBase

Declaration

public event RadPropertyGridEventHandler ItemMouseDoubleClick

Event Value

Occurs when the user presses a mouse button over a property grid item.

Declaration

public event PropertyGridMouseEventHandler ItemMouseDown

Event Value

Occurs when the user moves the mouse in the area of a property grid item.

Declaration

public event PropertyGridMouseEventHandler ItemMouseMove

Event Value

Fires when a property has finished validating.

Declaration

public event PropertyValidatedEventHandler PropertyValidated

Event Value

Fires when a property value is validating.

Declaration

public event PropertyValidatingEventHandler PropertyValidating

Event Value

Occurs when a property value changes.

Declaration

public event PropertyGridItemValueChangedEventHandler PropertyValueChanged

Event Value

Occurs when item's value is changing.

Declaration

public event PropertyGridItemValueChangingEventHandler PropertyValueChanging

Event Value

Occurs after the property item is selected. For more information about handling events, see also SelectedItemChanging.

Declaration

public event RadPropertyGridEventHandler SelectedGridItemChanged

Event Value

Occurs before a property grid item is selected.

Declaration

public event RadPropertyGridCancelEventHandler SelectedGridItemChanging

Event Value

Occurs after the selected object is changed.

Declaration

public event PropertyGridSelectedObjectChangedEventHandler SelectedObjectChanged

Event Value

Occurs before the selected object is changed.

Declaration

public event PropertyGridSelectedObjectChangingEventHandler SelectedObjectChanging

Event Value

Fires when the value of an editor changes.

Declaration

[Browsable(true)]
public event EventHandler ValueChanged

Event Value

Fires before the value in an editor is being changed. The action can be canceled.

Declaration

[Browsable(true)]
public event ValueChangingEventHandler ValueChanging

Event Value