Class PropertyGridCommandProvider

Provides command logic and navigation functionality for a RadPropertyGrid control.

Inheritance
System.Object
PropertyGridCommandProvider
Namespace: Telerik.Windows.Controls.Data.PropertyGrid
Assembly: Telerik.Windows.Controls.Data.dll

Syntax

public class PropertyGridCommandProvider : DependencyObject, ICommandProvider, IKeyboardCommandExecutor
Remarks

This class implements the ICommandProvider interface and provides built-in commands for grouping, sorting, searching, and navigating within a RadPropertyGrid. It also supports enabling or disabling custom navigation logic and processing handled events.

Constructors

PropertyGridCommandProvider()

Initializes a new instance of the PropertyGridCommandProvider class.

Declaration
public PropertyGridCommandProvider()

PropertyGridCommandProvider(RadPropertyGrid)

Initializes a new instance of the PropertyGridCommandProvider class.

Declaration
public PropertyGridCommandProvider(RadPropertyGrid propertyGrid)
Parameters
RadPropertyGrid propertyGrid

Fields

EnableBuiltInNavigationProperty

Represents the EnableBuiltInNavigation dependency property.

Declaration
public static readonly DependencyProperty EnableBuiltInNavigationProperty
Field Value
System.Windows.DependencyProperty

PropertyGridProperty

Represents the PropertyGrid DependencyProperty.

Declaration
public static readonly DependencyProperty PropertyGridProperty
Field Value
System.Windows.DependencyProperty

ShouldProcessHandledEventsProperty

Represents the ShouldProcessHandledEvents dependency property.

Declaration
public static readonly DependencyProperty ShouldProcessHandledEventsProperty
Field Value
System.Windows.DependencyProperty

Properties

CurrentIndex

Gets the index of the current PropertyDefinition.

Declaration
protected int CurrentIndex { get; }
Property Value
System.Int32

The index of the current.

EnableBuiltInNavigation

Gets or sets a value that indicates whether custom control navigation logic should be enabled.

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

Implements

PropertyGrid

Gets or sets the RadPropertyGrid instance related to this provider.

Declaration
public RadPropertyGrid PropertyGrid { get; set; }
Property Value
RadPropertyGrid

The RadPropertyGrid instance.

ShouldProcessHandledEvents

Gets or sets a value that indicates whether handled events should be processed.

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

Implements

SourceList

Gets the processed PropertyDefinitions list.

Declaration
protected List<object> SourceList { get; }
Property Value
System.Collections.Generic.List<System.Object>

The source list.

Methods

CanExpandCurrentField()

Represents the logic that is going to be executed in RadPropertyGridCommands.ExpandCurrentField can-execute callback.

Declaration
protected virtual bool CanExpandCurrentField()
Returns
System.Boolean

CanGroup()

Represents the logic that is going to be executed in RadPropertyGridCommands.Group can-execute callback.

Declaration
protected virtual bool CanGroup()
Returns
System.Boolean

CanMovePageDown()

Represents the logic that is going to be executed in RadPropertyGridCommands.MovePageDown can-execute callback.

Declaration
protected virtual bool CanMovePageDown()
Returns
System.Boolean

CanMovePageUp()

Represents the logic that is going to be executed in RadPropertyGridCommands.MovePageUp can-execute callback.

Declaration
protected virtual bool CanMovePageUp()
Returns
System.Boolean

CanMoveToFirst()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToFirst can-execute callback.

Declaration
protected virtual bool CanMoveToFirst()
Returns
System.Boolean

CanMoveToLast()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToLast can-execute callback.

Declaration
protected virtual bool CanMoveToLast()
Returns
System.Boolean

CanMoveToNext()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToNext can-execute callback.

Declaration
protected virtual bool CanMoveToNext()
Returns
System.Boolean

CanMoveToPrevious()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToPrevious can-execute callback.

Declaration
protected virtual bool CanMoveToPrevious()
Returns
System.Boolean

CanSearch()

Represents the logic that is going to be executed in RadPropertyGridCommands.Search can-execute callback.

Declaration
protected virtual bool CanSearch()
Returns
System.Boolean

CanSort()

Represents the logic that is going to be executed in RadPropertyGridCommands.Sort can-execute callback.

Declaration
protected virtual bool CanSort()
Returns
System.Boolean

EnsureIndexIntoView(Int32)

Ensures that the PropertyDefinition with the given index is scrolled into view.

Declaration
protected void EnsureIndexIntoView(int index)
Parameters
System.Int32 index

ExpandCurrentField()

Represents the logic that is going to be executed in RadPropertyGridCommands.ExpandCurrentField execute callback.

Declaration
protected virtual void ExpandCurrentField()

ExpandCurrentFieldInternal()

Expands the current item.

Declaration
protected void ExpandCurrentFieldInternal()

Group()

Represents the logic that is going to be executed in RadPropertyGridCommands.Group execute callback.

Declaration
protected virtual void Group()

HandleKeyDown(KeyEventArgs)

Handles the logic executed on KeyDown.

Declaration
public virtual void HandleKeyDown(KeyEventArgs args)
Parameters
System.Windows.Input.KeyEventArgs args

Implements

MovePageDown()

Represents the logic that is going to be executed in RadPropertyGridCommands.MovePageDown execute callback.

Declaration
protected virtual void MovePageDown()

MovePageUp()

Represents the logic that is going to be executed in RadPropertyGridCommands.MovePageUp execute callback.

Declaration
protected virtual void MovePageUp()

MoveToFirst()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToFirst execute callback.

Declaration
protected virtual void MoveToFirst()

MoveToFirstInternal()

Executes the logic that moves focus to the first field's editor.

Declaration
protected void MoveToFirstInternal()

MoveToLast()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToFirst execute callback.

Declaration
protected virtual void MoveToLast()

MoveToLastInternal()

Executes the logic that moves focus to the last field's editor.

Declaration
protected void MoveToLastInternal()

MoveToNext()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToNext execute callback.

Declaration
protected virtual void MoveToNext()

MoveToPrevious()

Represents the logic that is going to be executed in RadPropertyGridCommands.MoveToPrevious execute callback.

Declaration
protected virtual void MoveToPrevious()

ProvideCommandsForKey(KeyEventArgs)

Provides a list of actions to be executed when a key is pressed.

Declaration
public virtual List<DelegateCommandWrapper> ProvideCommandsForKey(KeyEventArgs args)
Parameters
System.Windows.Input.KeyEventArgs args

Returns
System.Collections.Generic.List<DelegateCommandWrapper>

Implements

RegisterCommandBindings()

Registers the CommandBindings.

Declaration
public void RegisterCommandBindings()
Implements

ScrollIndexIntoView(Int32, ScrollViewer)

Scrolls the PropertyDefinition with the given index into view.

Declaration
protected void ScrollIndexIntoView(int index, ScrollViewer scrollViewer)
Parameters
System.Int32 index

The index.
System.Windows.Controls.ScrollViewer scrollViewer

The scroll viewer.

Search(String)

Represents the logic that is going to be executed in RadPropertyGridCommands.Search execute callback.

Declaration
protected virtual void Search(string searchParameter)
Parameters
System.String searchParameter

Sort()

Represents the logic that is going to be executed in RadPropertyGridCommands.Sort execute callback.

Declaration
protected virtual void Sort()

Extension Methods