ASPxClientPreviewClickEventArgs Class

Provides data for the ASPxClientWebDocumentViewer.PreviewClick and ASPxClientReportDesigner.PreviewClick events.

Declaration

declare class ASPxClientPreviewClickEventArgs extends ASPxClientEventArgs

Remarks

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

Inheritance

ASPxClientEventArgs

ASPxClientPreviewClickEventArgs

constructor(pageIndex, brick)

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

Declaration

constructor(
    pageIndex: number,
    brick: DevExpress.Reporting.Viewer.Utils.IBrickNode
)

Parameters

Name	Type	Description
pageIndex	number	An integer value that specifies the zero-based index of the page that has been clicked. This value is assigned to the ASPxClientPreviewClickEventArgs.PageIndex property.
brick	IBrickNode	An object that provides information on a visual brick representing the content of a report control that has been clicked. This value is assigned to the ASPxClientPreviewClickEventArgs.Brick property.

Properties

Brick Property

Provides information on a visual brick representing content of a report control that has been clicked.

Declaration

Brick: DevExpress.Reporting.Viewer.Utils.IBrickNode

Property Value

Type	Description
IBrickNode	An object that provides information on a visual brick.

Handled Property

Specifies whether or not the event was handled and no default processing is required.

Declaration

Handled: boolean

Property Value

Type	Description
boolean	true, if the event is completely handled by custom code and no default processing is required; otherwise, false.

Remarks

When handling the ASPxClientWebDocumentViewer.PreviewClick event, set the Handled property to true to indicate that default processing should not occur. If you set this property to false, the ASPxClientPreviewClickEventArgs.DefaultHandler function will be called after executing code in the event handler.

PageIndex Property

Gets a value specifying the zero-based index of the page that has been clicked.

Declaration

PageIndex: number

Property Value

Type	Description
number	An integer value that specifies a page index.

Methods

DefaultHandler Method

Specifies the default function used to handle the ASPxClientWebDocumentViewer.PreviewClick event.

Declaration

DefaultHandler(): void

Remarks

When handling the ASPxClientWebDocumentViewer.PreviewClick event, you can call the DefaultHandler function to preform default processing. This function will also be automatically called after executing custom code in the event handler if you set the ASPxClientPreviewClickEventArgs.Handled property of an event argument to false.

GetBrickText Method

Returns the text displayed by the ASPxClientPreviewClickEventArgs.Brick.

Declaration

GetBrickText(): string

Returns

Type	Description
string	A string that specified the brick text.

GetBrickValue Method

Returns a string providing additional information about the current ASPxClientPreviewClickEventArgs.Brick by the specified key.

Declaration

GetBrickValue(
    key?: string
): string

Parameters

Name	Type	Description
key	string	A string that specifies a unique key.

Returns

Type	Description
string	A string that provides additional information on the current brick by the specified key.