Back to Devexpress

ASPxClientCustomizeElementsEventArgs Class

xtrareports-js-aspxclientcustomizeelementseventargs.md

latest2.3 KB
Original Source

ASPxClientCustomizeElementsEventArgs Class

Provides data for the ASPxClientReportDesigner.CustomizeElements, ASPxClientReportDesigner.PreviewCustomizeElements and ASPxClientWebDocumentViewer.CustomizeElements events.

Declaration

ts
declare class ASPxClientCustomizeElementsEventArgs extends ASPxClientEventArgs

Remarks

ASPxClientCustomizeElementsEventArgs objects are automatically created, initialized and passed to corresponding event handlers.

Inheritance

ASPxClientEventArgs ASPxClientCustomizeElementsEventArgs

constructor(elements)

Initializes a new instance of the ASPxClientCustomizeElementsEventArgs class with the specified settings.

Declaration

ts
constructor(
    elements: ASPxReportUIElement[]
)

Parameters

NameTypeDescription
elementsASPxReportUIElement[]

An array of ASPxReportUIElement objects. This value is assigned to the ASPxClientCustomizeElementsEventArgs.Elements property.

|

Properties

Elements Property

Provides access to the collection of UI elements.

Declaration

ts
Elements: ASPxReportUIElement[]

Property Value

TypeDescription
ASPxReportUIElement[]

An array of the ASPxReportUIElement objects.

|

Methods

GetById(templateId) Method

Returns UI elements with the specified ID.

Declaration

ts
GetById(
    templateId: string
): ASPxReportUIElement[]

Parameters

NameTypeDescription
templateIdstring

A string that specifies the element ID.

|

Returns

TypeDescription
ASPxReportUIElement[]

An array of ASPxReportUIElement objects.

|