ASPxScheduler.ClientInstanceName Property

Gets or sets the ASPxScheduler’s client programmatic identifier.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v19.1.dll

Declaration

C#

[DefaultValue("")]
public string ClientInstanceName { get; set; }

VB.NET

<DefaultValue("")>
Public Property ClientInstanceName As String

Property Value

Type	Default	Description
String	String.Empty	A string value that specifies the ASPxScheduler’s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for a scheduler control. The ClientInstanceName property’s value can be used on the client side to programmatically access the client object rendered for the scheduler in client-side script. This property is particularly important in referencing the scheduler when it is contained within a naming container (for instance, within an ASPxPageControl‘s page).

If the ClientInstanceName property is not specified, a scheduler’s client identifier is generated automatically, and equals the value of the scheduler’s ID property. Note that in this case, client-side programmatic access to the scheduler by its ID is not allowed when it is contained within a naming container.

ASPX

<dx:ASPxScheduler ID="DemoScheduler" runat="server" Width="100%" ClientInstanceName="scheduler" ActiveViewType="FullWeek" GroupType="Resource"
    AppointmentDataSourceID="AppointmentDataSource" ResourceDataSourceID="efResourceDataSource" OnCustomCallback="DemoScheduler_CustomCallback">
    <ClientSideEvents
        SelectionChanged="OnSelectionChanged"
        CellClick="OnCellClick"
        Init="OnInit"
    />
    <OptionsToolTips ShowAppointmentToolTip="false" />
    <FloatingActionButton>
    ...
    </FloatingActionButton>
    <Views>
    ...
    </Views>
</dx:ASPxScheduler>

JS

function OnSelectionChanged(s, e) {
    SwitchToTimeCellContext();
}
function SwitchToTimeCellContext() {
    ClearTimeRulerSelection();
}
function ClearTimeRulerSelection(s, e) {
    $(scheduler.GetMainElement()).removeClass('timeRulerSelected');
}

Related GitHub Examples

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

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-show-color-icons-for-labels-and-statuses-in-the-appointment-edit-form-and-popup-menu-t344486/CS/CustomFormStatusEditors/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.cs#L62

ASPxScheduler scheduler = container.Control;
string actualSchedulerInstanceName = scheduler.ClientInstanceName;
if(String.IsNullOrEmpty(actualSchedulerInstanceName))

how-to-show-images-for-tentative-and-working-elsewhere-appointment-statuses-t344062/CS/CustomStatusSample/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.cs#L62

ASPxScheduler scheduler = container.Control;
string actualSchedulerInstanceName = scheduler.ClientInstanceName;
if(String.IsNullOrEmpty(actualSchedulerInstanceName))

XAF_how-to-access-the-scheduler-control-e225/CS/HowToAccessSchedulerControl.Web/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.cs#L53

ASPxScheduler scheduler = container.Control;
string actualSchedulerInstanceName = scheduler.ClientInstanceName;
if(String.IsNullOrEmpty(actualSchedulerInstanceName))

XAF_how-to-perform-custom-actions-when-a-recurring-events-exceptional-occurrence-is-created-e1088/CS/CustomSchedulerEvent.Web/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.cs#L53

ASPxScheduler scheduler = container.Control;
string actualSchedulerInstanceName = scheduler.ClientInstanceName;
if(String.IsNullOrEmpty(actualSchedulerInstanceName))

VB.NET

how-to-show-color-icons-for-labels-and-statuses-in-the-appointment-edit-form-and-popup-menu-t344486/VB/CustomFormStatusEditors/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.vb#L64

Dim scheduler As ASPxScheduler = container.Control
Dim actualSchedulerInstanceName As String = scheduler.ClientInstanceName
If String.IsNullOrEmpty(actualSchedulerInstanceName) Then

how-to-show-images-for-tentative-and-working-elsewhere-appointment-statuses-t344062/VB/CustomStatusSample/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.vb#L64

Dim scheduler As ASPxScheduler = container.Control
Dim actualSchedulerInstanceName As String = scheduler.ClientInstanceName
If String.IsNullOrEmpty(actualSchedulerInstanceName) Then

XAF_how-to-access-the-scheduler-control-e225/VB/HowToAccessSchedulerControl.Web/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.vb#L55

Dim scheduler As ASPxScheduler = container.Control
Dim actualSchedulerInstanceName As String = scheduler.ClientInstanceName
If String.IsNullOrEmpty(actualSchedulerInstanceName) Then

XAF_how-to-perform-custom-actions-when-a-recurring-events-exceptional-occurrence-is-created-e1088/VB/CustomSchedulerEvent.Web/DevExpress/ASPxSchedulerForms/GotoDateForm.ascx.vb#L55

Dim scheduler As ASPxScheduler = container.Control
Dim actualSchedulerInstanceName As String = scheduler.ClientInstanceName
If String.IsNullOrEmpty(actualSchedulerInstanceName) Then