promptAreaCollapsed Property

Gets or sets a Boolean value that indicates whether the parameter prompt area 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 promptCollapsed = $find(viewerId).get_promptAreaCollapsed();
$find(viewerId).set_promptAreaCollapsed(isCollapsed);

Parameters

  • isCollapsed
    A Boolean value that indicates whether to collapse the parameter prompt area.

Return Value

true if the parameter prompt area is collapsed; false if the prompt area is not collapsed or if there is no prompt area to display.

Remarks

Changing the value of this property has no effect if there are no report parameters to display or if parameter prompts are disabled using the ShowParameterPrompts property in the server control.

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 parameter prompt area.

function togglePrompt() { 
    var viewer = $find(viewerID);
    if (!viewer.get_isLoading()) {
        viewer.set_promptAreaCollapsed(!viewer.get_promptAreaCollapsed());
    }
}

See Also

Reference

ReportViewer Class