SchedulerControl.GetService(Type) Method

Gets the service object of the specified type.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v24.1.dll

NuGet Package: DevExpress.Win.Scheduler

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 SchedulerControl in order to employ its methods. The scheduler implements IServiceProvider interface, so you can tell it what type of service you wish to retrive 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 gives more flexibility regarding future updates of the component.

For more information review the Introduction to Services in XtraScheduler topic.

The following code illustrates a typical scenario of the GetService method:

C#

IServiceType myService = (IServiceType) (scheduler1.GetService(typeof (IServiceType))) ;
    if (myService != null)
  {
    // Use methods of service.
  }

VB.NET

Dim myService As IServiceType = TryCast(scheduler1.GetService(GetType(IServiceType)), IServiceType)
    If Not myService Is Nothing Then
    ' Use methods of service.
    End If

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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-scheduler-formatting-services/CS/FormattingServicesExample/Form1.cs#L37

public void CreateAppointmentFormatStringService() {
    this.prevAppointmentFormatStringService = (IAppointmentFormatStringService)schedulerControl1.GetService(typeof(IAppointmentFormatStringService));
    this.customAppointmentFormatStringService = new CustomAppointmentFormatStringService(prevAppointmentFormatStringService);

VB.NET

winforms-scheduler-formatting-services/VB/FormattingServicesExample/Form1.vb#L43

Public Sub CreateAppointmentFormatStringService()
    prevAppointmentFormatStringService = CType(schedulerControl1.GetService(GetType(IAppointmentFormatStringService)), IAppointmentFormatStringService)
    customAppointmentFormatStringService = New CustomAppointmentFormatStringService(prevAppointmentFormatStringService)