ASPxFileManager.ClientInstanceName Property

Specifies the ASPxFileManager‘s client programmatic identifier.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v23.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
String	String.Empty	The control’s client identifier.

Remarks

Use the ClientInstanceName property to specify a unique client-side identifier for the ASPxFileManager control. Use this identifier in the client side to access the ASPxClientFileManager object.

ASPX

<dx:ASPxFileManager ID="fileManager" runat="server" ClientInstanceName="fileManager" >
    ...
</dx:ASPxFileManager>

<dx:ASPxButton ID="ASPxButton1" runat="server" Text="Clear" AutoPostBack="false">
     <ClientSideEvents Click="click" />
</dx:ASPxButton>

JS

function click(s, e) {
    var selectedFileName;
    selectedFileName = fileManager.GetSelectedFile().name;
}

The ClientInstanceName property is important when a control is contained within a naming container, for instance, within an ASPxPageControl‘s page or an ASPxPopupControl‘s window.

If the ClientInstanceName property is not specified for a control, the control’s client identifier is generated automatically and equals the value of the control’s System.Web.UI.Control.ID property. Note that in this case, client-side programmatic access to the control is not allowed when the control is contained within a naming container.

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");