ISpreadsheetCommandFactoryService Interface

A service which is used to create Spreadsheet commands.

Namespace: DevExpress.XtraSpreadsheet.Services

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

[ComVisible(true)]
public interface ISpreadsheetCommandFactoryService

VB.NET

<ComVisible(True)>
Public Interface ISpreadsheetCommandFactoryService

Related API Members

The following members accept/return ISpreadsheetCommandFactoryService objects:

• SpreadsheetCommandFactoryServiceWrapper.Service

Remarks

All commands in the SpreadsheetControl are created using the command factory service. You can substitute the default command factory service with its descendant, designed to create a custom command instead of the default command. Subsequently, the specified custom command is used in all SpreadsheetControl operations instead of the original command.

To substitute a default command factory service, create a class descending from the SpreadsheetCommandFactoryServiceWrapper class. Do not implement the ISpreadsheetCommandFactoryService interface directly in your class.

The following code snippet demonstrates a custom service used to substitute for the Clear Contents formatting commands located in Ribbon and context menu with a custom command.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-replace-standard-spreadsheetcontrol-command-with-your-own-custom-command-t163272

CustomService.cs

public class CustomService : SpreadsheetCommandFactoryServiceWrapper {
    public CustomService(ISpreadsheetCommandFactoryService service)
        : base(service) {
    }
    public SpreadsheetControl Control {get;set;}

    public override SpreadsheetCommand CreateCommand(SpreadsheetCommandId id)
    {
        if (id == SpreadsheetCommandId.FormatClearContents || id == SpreadsheetCommandId.FormatClearContentsContextMenuItem)
            return new CustomFormatClearContentsCommand(Control);

        return base.CreateCommand(id);
    }

}

CustomService.vb

Public Class CustomService
    Inherits SpreadsheetCommandFactoryServiceWrapper

    Public Sub New(ByVal service As ISpreadsheetCommandFactoryService)
        MyBase.New(service)
    End Sub
    Public Property Control() As SpreadsheetControl

    Public Overrides Function CreateCommand(ByVal id As SpreadsheetCommandId) As SpreadsheetCommand
        If id = SpreadsheetCommandId.FormatClearContents OrElse id = SpreadsheetCommandId.FormatClearContentsContextMenuItem Then
            Return New CustomFormatClearContentsCommand(Control)
        End If

        Return MyBase.CreateCommand(id)
    End Function

End Class

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ISpreadsheetCommandFactoryService interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-replace-standard-spreadsheetcontrol-command-with-your-own-custom-command-t163272/CS/SpreadsheetCustomCommand/CustomService.cs#L9

public class CustomService : SpreadsheetCommandFactoryServiceWrapper {
    public CustomService(ISpreadsheetCommandFactoryService service)
        : base(service) {

how-to-get-data-validation-errors-count-t559295/CS/DXApplication15/CustomCommandFactoryService.cs#L12

{
    public CustomCommandFactoryService(ISpreadsheetCommandFactoryService service)
        : base(service)

wpf-spreadsheet-how-to-replace-standard-command-with-custom-command/CS/WpfSpreadsheet_CustomCommand/CustomCommandService.cs#L13

{
    public CustomService(ISpreadsheetCommandFactoryService service)
        : base(service)

how-to-customize-the-spreadsheet-context-menu-e4978/CS/SpreadsheetContextMenu/Form1.cs#L38

// Create a menu item for the Spreadsheet command, which inserts a picture into a worksheet.
ISpreadsheetCommandFactoryService service = (ISpreadsheetCommandFactoryService)spreadsheetControl1.GetService(typeof(ISpreadsheetCommandFactoryService));
SpreadsheetCommand cmd = service.CreateCommand(SpreadsheetCommandId.InsertPicture);

VB.NET

how-to-replace-standard-spreadsheetcontrol-command-with-your-own-custom-command-t163272/VB/SpreadsheetCustomCommand/CustomService.vb#L10

Public Sub New(ByVal service As ISpreadsheetCommandFactoryService)
    MyBase.New(service)

how-to-get-data-validation-errors-count-t559295/VB/DXApplication15/CustomCommandFactoryService.vb#L12

Inherits SpreadsheetCommandFactoryServiceWrapper
Public Sub New(ByVal service As ISpreadsheetCommandFactoryService)
    MyBase.New(service)

wpf-spreadsheet-how-to-replace-standard-command-with-custom-command/VB/WpfSpreadsheet_CustomCommand/CustomCommandService.vb#L13

Public Sub New(ByVal service As ISpreadsheetCommandFactoryService)
    MyBase.New(service)

how-to-customize-the-spreadsheet-context-menu-e4978/VB/SpreadsheetContextMenu/Form1.vb#L35

' Create a menu item for the Spreadsheet command, which inserts a picture into a worksheet.
Dim service As ISpreadsheetCommandFactoryService = CType(spreadsheetControl1.GetService(GetType(ISpreadsheetCommandFactoryService)), ISpreadsheetCommandFactoryService)
Dim cmd As SpreadsheetCommand = service.CreateCommand(SpreadsheetCommandId.InsertPicture)