Skip to main content
All docs
V25.2
  • DxDocumentViewerCallbacks.CustomizeElements Property

    Specifies the handler for the CustomizeElements client-side event that allows you to customize the Web Document Viewer UI elements.

    Namespace: DevExpress.Blazor.Reporting

    Assembly: DevExpress.Blazor.Reporting.v25.2.JSBasedControls.Common.dll

    NuGet Package: DevExpress.Blazor.Reporting.JSBasedControls.Common

    Declaration

    [Parameter]
    public string CustomizeElements { get; set; }

    Property Value

    Type Description
    String

    The name of a JavaScript function used to handle the CustomizeElements event.

    Remarks

    The CustomizeElements event allows you to customize the Web Document Viewer’s UI elements (Right Panel, Toolbar, etc.).

    The handler function receives two parameters. The first parameter is the client-side Document Viewer (the event sender) that exposes the property to access the client-side DevExpress objects. The second parameter is an object with the following properties and methods:

    Elements
    A collection of Web Document Viewer UI elements.
    GetById
    Passes the element ID as the method’s parameter and gets the UI element. Use the PreviewElements enumeration to specify the element ID.

    The following code snippet hides the Web Document Viewer Toolbar.

    window.ViewerCustomization = {
        // Hide the toolbar
        onCustomizeElements: function(s, e) {
            var toolbarPart = e.GetById(DevExpress.Reporting.Viewer.PreviewElements.Toolbar);
            var index = e.Elements.indexOf(toolbarPart);
            e.Elements.splice(index, 1);
        }
    }
    
    See Also