Back to Devexpress

ASPxImageZoom.ClientInstanceName Property

aspnet-devexpress-dot-web-dot-aspximagezoom-e7fc625a.md

latest2.4 KB
Original Source

ASPxImageZoom.ClientInstanceName Property

Gets or sets the ASPxImageZoom‘s client programmatic identifier.

Namespace : DevExpress.Web

Assembly : DevExpress.Web.v25.2.dll

NuGet Package : DevExpress.Web

Declaration

csharp
[DefaultValue("")]
public string ClientInstanceName { get; set; }
vb
<DefaultValue("")>
Public Property ClientInstanceName As String

Property Value

TypeDefaultDescription
StringString.Empty

A string value that specifies the ASPxImageZoom‘s client identifier.

|

Remarks

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

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.

aspx
<dx:ASPxTextBox ... ClientInstanceName="SomeType.SomeProp" />
js
var txt = ASPxClientControl.GetControlCollection().GetByName("SomeType.SomeProp");  
txt.SetText("Some Text");

See Also

ASPxImageZoom Class

ASPxImageZoom Members

DevExpress.Web Namespace