The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V19.2
19.2
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

IParameterDescriptor Interface

Provides information about a report parameter.

Declaration

interface IParameterDescriptor

Properties

allowNull Property

Specifies whether the parameter's value can be unspecified.

Declaration

allowNull?: boolean

Property Value

Type Description
boolean

true, to allow the parameter to be unspecified; otherwise, false.

description Property

Specifies the parameter description.

Declaration

description: string

Property Value

Type Description
string

The parameter description.

multiValue Property

Specifies whether a parameter can have multiple values.

Declaration

multiValue?: boolean

Property Value

Type Description
boolean

true, if a parameter can have multiple values; otherwise, false.

name Property

Specifies the parameter name.

Declaration

name: string

Property Value

Type Description
string

The parameter name.

tag Property

Specifies data about the report parameter.

Declaration

tag?: any

Property Value

Type Description
any

Data about the report parameter.

type Property

Specifies a report parameter's value type.

Declaration

type: string

Property Value

Type Description
string

The report parameter type.

value Property

Specifies the current value of a report parameter.

Declaration

value: any

Property Value

Type Description
any

The current value of a report parameter.

visible Property

Specifies the parameter's visibility state.

Declaration

visible: boolean

Property Value

Type Description
boolean

true if the parameter is visible; otherwise false.