Back to Devexpress

IParameterDescriptor Interface

xtrareports-js-devexpress-dot-reporting-dot-viewer-dot-parameters-c2bf9ef9.md

latest2.2 KB
Original Source

IParameterDescriptor Interface

Provides information about a report parameter.

Declaration

ts
export interface IParameterDescriptor

Properties

allowNull Property

Specifies whether the parameter’s value can be unspecified.

Declaration

ts
allowNull?: boolean

Property Value

TypeDescription
boolean

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

|

description Property

Specifies the parameter description.

Declaration

ts
description: string

Property Value

TypeDescription
string

The parameter description.

|

enabled Property

Declaration

ts
enabled: boolean

Property Value

Type
boolean

multiValue Property

Specifies whether a parameter can have multiple values.

Declaration

ts
multiValue?: boolean

Property Value

TypeDescription
boolean

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

|

name Property

Specifies the parameter name.

Declaration

ts
name: string

Property Value

TypeDescription
string

The parameter name.

|

selectAllValues Property

Declaration

ts
selectAllValues?: boolean

Property Value

Type
boolean

tag Property

Specifies data about the report parameter.

Declaration

ts
tag?: any

Property Value

TypeDescription
any

Data about the report parameter.

|

type Property

Specifies a report parameter’s value type.

Declaration

ts
type: string

Property Value

TypeDescription
string

The report parameter type.

|

value Property

Specifies the current value of a report parameter.

Declaration

ts
value: any

Property Value

TypeDescription
any

The current value of a report parameter.

|

visible Property

Specifies the parameter’s visibility state.

Declaration

ts
visible: boolean

Property Value

TypeDescription
boolean

true if the parameter is visible; otherwise false.

|