Back to Devexpress

ASPxClientReportParametersPanel Class

xtrareports-js-aspxclientreportparameterspanel.md

latest3.8 KB
Original Source

ASPxClientReportParametersPanel Class

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

Declaration

ts
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

See Also

ASPxClientDocumentViewer

GetParametersPanel

Methods

AssignParameter(path, value) Method

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

Declaration

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

Parameters

NameTypeDescription
pathstring

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

ts
AssignParameters(
    parametersInfo: ASPxClientReportParameterInfo[]
): void

Parameters

NameTypeDescription
parametersInfoASPxClientReportParameterInfo[]

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

ts
GetEditorByParameterName(
    parameterName: string
): ASPxClientControl

Parameters

NameTypeDescription
parameterNamestring

A String value, specifying the parameter name.

|

Returns

TypeDescription
ASPxClientControl

An editor.

|

GetParameterNames Method

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

Declaration

ts
GetParameterNames(): string[]

Returns

TypeDescription
string[]

An array of String values.

|