Microsoft.Reporting.WebFormsClient.ReportViewer.documentMapCollapsed Property

Gets or sets a Boolean value that indicates whether the document map is collapsed.

Note

To get or set property values for client API properties, you must call property accessor methods that are named with the get_ and set_ prefixes.

var mapCollapsed = $find(viewerId).get_documentMapCollapsed();
$find(viewerId).set_documentMapCollapsed(isCollapsed);

Parameters

  • isCollapsed
    A Boolean value that indicates whether to collapse the document map.

Return Value

true if the document map is collapsed; false if the document map is not collapsed or if there is no document map to display.

Remarks

When the Web page is performing a postback or the client-side control is loading content, accessing the methods or properties will cause an exception with the message: "The report or page is being updated. Please wait for the current action to complete." Use the isLoading property to check whether the report or page is being updated and whether you can access the methods and properties.

The following method shows how to toggle the document map.

function toggleDocMap() { 
    var viewer = $find(viewerID);
    if (!viewer.get_isLoading()) {
        viewer.set_documentMapCollapsed(!viewer.get_documentMapCollapsed());
    }
}

See Also

Reference

Microsoft.Reporting.WebFormsClient.ReportViewer Class