ASPxClientWebDocumentViewer.PerformCustomDocumentOperation(String, Boolean) Method

Performs a custom operation with a currently opened document on the client-side.

Namespace: DevExpress.XtraReports.Web.Scripts

Assembly: DevExpress.XtraReports.v18.2.Web.Scripts.dll

Declaration

public JQueryPromise<ASPxClientWebDocumentViewerDocumentOperationResponse> PerformCustomDocumentOperation(
    string customData,
    bool hideMessageFromUser
)
Public Function PerformCustomDocumentOperation(
    customData As String,
    hideMessageFromUser As Boolean
) As JQueryPromise(Of ASPxClientWebDocumentViewerDocumentOperationResponse)

Parameters

Type Name Description
String customData

Provides access to custom client data associated with a target document operation.

Boolean hideMessageFromUser

true, to hide a message with the operation result from a user; otherwise, false.

Returns

Type Description
JQueryPromise<ASPxClientWebDocumentViewerDocumentOperationResponse>

A Deferred Promise object.

Call the PerformCustomDocumentOperation method on the client side to perform the required operation with the current report document. The customData parameter contains data associated with a target operation.

On the sever side, create a DocumentOperationService class descendant and override its DocumentOperationService.CanPerformOperation and DocumentOperationService.PerformOperation methods. To register your custom class, use the DefaultWebDocumentViewerContainer.Register<T, TImpl> method at the application startup.

For a code sample, refer to Web Document Viewer - How to send a report via Email from the client side.

See Also