ASPxClientReportParametersPanel Class

The client-side equivalent of the ASPxClientDocumentViewer control’s Parameters Panel.

Declaration

declare class ASPxClientReportParametersPanel extends ASPxClientControl

Remarks

To access an ASPxClientReportParametersPanel, call the ASPxClientDocumentViewer.GetParametersPanel method.

Inherited Members

Init

name

AdjustControl

GetClientVisible

GetHeight

GetMainElement

GetParentControl

GetVisible

GetWidth

InCallback

SendMessageToAssistiveTechnology(message)

SetClientVisible(visible)

SetHeight(height)

SetVisible(visible)

SetWidth(width)

AdjustControls

Cast(obj)

GetControlCollection

Inheritance

ASPxClientControlBase

ASPxClientControl

ASPxClientReportParametersPanel

Methods

AssignParameter(path, value) Method

Assigns a value to a parameter of the report displayed in the document viewer.

Declaration

AssignParameter(
    path: string,
    value: any
): void

Parameters

Name	Type	Description
path	string	A System.String specifying the parameter’s path.
value	any	An object specifying the parameter value.

AssignParameters(parametersInfo) Method

Assigns a value to a parameter of the report displayed in the document viewer.

Declaration

AssignParameters(
    parametersInfo: ASPxClientReportParameterInfo[]
): void

Parameters

Name	Type	Description
parametersInfo	ASPxClientReportParameterInfo[]	An array of ASPxClientReportParameterInfo values specifying parameters and values to assign.

GetEditorByParameterName(parameterName) Method

Returns a value editor that is associated with a parameter with the specified name.

Declaration

GetEditorByParameterName(
    parameterName: string
): ASPxClientControl

Parameters

Name	Type	Description
parameterName	string	A String value, specifying the parameter name.

Returns

Type	Description
ASPxClientControl	An editor.

GetParameterNames Method

Returns an array storing the names of parameters available in a report.

Declaration

GetParameterNames(): string[]

Returns

Type	Description
string[]	An array of String values.