Default Command Descriptors

RadSpreadsheet's command descriptors are wrappers of its predefined set of commands. They were introduced as a way to easily enable/disable the commands based on the current document state. This comes in handy in the creation of UI for the RadSpreadsheet such as a ribbon, context menu, etc.

The CommandDescriptor class contains 3 public properties:

  • IsEnabled(Boolean): Gets or sets if the command is enabled.
  • Command(ICommand): The command to be executed.
  • SelectedValue(object): Gets or sets the selected value (if available for the current command).

Custom Command Descriptors

The following section demonstrates how you can create a custom command along with the respective command descriptor.

First you need to inherit the WorksheetCommandDescriptors class. This will allow you to override the default commands properties and return your custom command. In this case, you will change the open file command with a custom one. If you want to override the key combination that triggers this command you should register the new command as well.

Example 1: Create a class that inherits WorksheetCommandDescriptors

class CustomDescriptors : WorksheetCommandDescriptors 
{ 
    private ICommand openCommand; 
    private CommandDescriptor openFile; 
    RadWorksheetEditor owner; 
 
    public CustomDescriptors(RadWorksheetEditor owner) : base(owner) 
    { 
        this.owner = owner; 
        InitializeCommands(); 
    } 
    public override CommandDescriptor OpenFile 
    { 
        get 
        { 
            return openFile; 
        } 
    } 
 
    private void InitializeCommands() 
    { 
        this.openCommand = new DelegateCommand((p) => 
        { 
            MessageBox.Show("Open command executed."); 
        }); 
        openFile = new CommandDescriptor(openCommand); 
        this.owner.KeyBindings.RegisterCommand(new DelegateCommand(p => { this.openCommand.Execute(null); }), Key.O, ModifierKeys.Control, null); 
 
    } 
} 

The second step is to set the newly created class to the active worksheet editor. This should be done each time the editor is changed, this is why you are going to use the ActiveSheetEditorChanged event to set the new descriptors.

Example 2: Change the default command descriptors

private void RadSpreadsheet_ActiveSheetEditorChanged(object sender, EventArgs e) 
{ 
    RadWorksheetEditor editor = (RadWorksheetEditor)this.radSpreadsheet.ActiveSheetEditor; 
    if (editor != null) 
    { 
        editor.RadWorksheetCommandDescriptors = new CustomDescriptors(editor); 
    } 
 
} 
That is everything that is required to change the default command. Now when the open button is pressed or the Ctrl + O combination is used the custom command will be executed.
In this article
Not finding the help you need? Improve this article