ASPxScheduler.ClientInstanceName Property

Gets or sets the ASPxScheduler’s client programmatic identifier.

Namespace: DevExpress.Web.ASPxScheduler

Assembly: DevExpress.Web.ASPxScheduler.v23.2.dll

NuGet Package: DevExpress.Web.Scheduler

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');
}

Special Characters in Client Instance Name

If the ClientInstanceName property contains special characters, for instance, the dot (.), you cannot access a client object by this name. Call the GetByName(name) method to retrieve the client-side object instead.

<dx:ASPxTextBox ... ClientInstanceName="SomeType.SomeProp" />

var txt = ASPxClientControl.GetControlCollection().GetByName("SomeType.SomeProp");  
txt.SetText("Some Text");