SpreadsheetControl.GetService(Type) Method

Gets the service object of the specified type.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

Declaration

C#

public virtual object GetService(
    Type serviceType
)

VB.NET

Public Overridable Function GetService(
    serviceType As Type
) As Object

Parameters

Name	Type	Description
serviceType	Type	An object that specifies the type of service object to get.

Returns

Type	Description
Object	A service object of the specified type, or a null reference (Nothing in Visual Basic) if there is no service object of this type.

Remarks

Use this method to enable your application objects to obtain a service of the SpreadsheetControl in order to employ methods of the service. The control implements the IServiceProvider interface, so you can tell it what type of service you wish to retrieve via the GetService method; and if a service is available, it is offered to the caller object.

There is a set of predefined services you can retrieve. The IServiceProvider and IServiceContainer interface realization allows hiding implementation details, and provides more flexibility for future updates of the component.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetService(Type) method.

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#

winforms-spreadsheet-replace-standard-command-with-custom-command/CS/SpreadsheetCustomCommand/Form1.cs#L13

private void SubstituteService() {
    ISpreadsheetCommandFactoryService service = (ISpreadsheetCommandFactoryService)spreadsheetControl1.GetService(typeof(ISpreadsheetCommandFactoryService));
    CustomService customService = new CustomService(service);

winforms-spreadsheet-load-an-ms-access-database-file-into-the-document/CS/WindowsFormsApplication1/MSAccessImportHelper.cs#L74

public static void ExtendOpenFileCommand(this SpreadsheetControl spreadSheet) {
    IDocumentImportManagerService service = (IDocumentImportManagerService)spreadSheet.GetService(typeof(IDocumentImportManagerService));
    CustomDocumentImportManagerService customService = new CustomDocumentImportManagerService(spreadSheet.Document);

VB.NET

winforms-spreadsheet-replace-standard-command-with-custom-command/VB/SpreadsheetCustomCommand/Form1.vb#L13

Private Sub SubstituteService()
    Dim service As ISpreadsheetCommandFactoryService = DirectCast(spreadsheetControl1.GetService(GetType(ISpreadsheetCommandFactoryService)), ISpreadsheetCommandFactoryService)
    Dim customService As New CustomService(service)

winforms-spreadsheet-load-an-ms-access-database-file-into-the-document/VB/WindowsFormsApplication1/MSAccessImportHelper.vb#L94

Public Sub ExtendOpenFileCommand(ByVal spreadSheet As SpreadsheetControl)
    Dim service As IDocumentImportManagerService = CType(spreadSheet.GetService(GetType(IDocumentImportManagerService)), IDocumentImportManagerService)
    Dim customService As New CustomDocumentImportManagerService(spreadSheet.Document)