ReportParameter ReportParameter ReportParameter Class

Definition

Represents a report parameter.

public ref class ReportParameter
public class ReportParameter
Public Class ReportParameter
Inheritance
ReportParameterReportParameterReportParameter

Remarks

A ReportParameter object is returned as output by the GetReportParameters method and is passed as input to the SetReportParameters method.

Constructors

ReportParameter() ReportParameter() ReportParameter()

Initializes a new instance of the ReportParameter class.

Properties

AllowBlank AllowBlank AllowBlank

Indicates whether an empty string is a valid value for the parameter.

AllowBlankSpecified AllowBlankSpecified AllowBlankSpecified

Gets or sets a value that indicates whether the AllowBlank property is specified.

DefaultValues DefaultValues DefaultValues

Gets or sets the default value of the parameter.

DefaultValuesQueryBased DefaultValuesQueryBased DefaultValuesQueryBased

Indicates whether the default values of the parameter are based on a query.

DefaultValuesQueryBasedSpecified DefaultValuesQueryBasedSpecified DefaultValuesQueryBasedSpecified

Gets or sets a value that indicates whether the DefaultValuesQueryBased property is specified.

Dependencies Dependencies Dependencies

A list of parameters whose values are used to retrieve additional parameter values in a query.

ErrorMessage ErrorMessage ErrorMessage

The error message returned when a parameter value has failed validation.

MultiValue MultiValue MultiValue

Indicates whether the parameter is a multi-valued parameter.

MultiValueSpecified MultiValueSpecified MultiValueSpecified

Gets or sets a value that indicates whether the MultiValue property is specified.

Name Name Name

Gets or sets the name of the parameter.

Nullable Nullable Nullable

Indicates whether the value of the parameter can be null.

NullableSpecified NullableSpecified NullableSpecified

Gets or sets a value that indicates whether the Nullable property is specified.

Prompt Prompt Prompt

Gets or sets the text that prompts the user for parameter values.

PromptUser PromptUser PromptUser

Indicates whether the user is prompted for the value of the parameter.

PromptUserSpecified PromptUserSpecified PromptUserSpecified

Gets or sets a value that indicates whether the PromptUser property is specified.

QueryParameter QueryParameter QueryParameter

Indicates whether the parameter is used in a query.

QueryParameterSpecified QueryParameterSpecified QueryParameterSpecified

Gets or sets a value that indicates whether the QueryParameter property is specified.

State State State

Describes the state (ParameterStateEnum) of the parameter.

StateSpecified StateSpecified StateSpecified

Gets or sets a value that indicates whether the State property is specified.

Type Type Type

Gets or sets the data type (ParameterTypeEnum enumeration) of the parameter.

TypeSpecified TypeSpecified TypeSpecified

Gets or sets a value that indicates whether the Type property is specified.

ValidValues ValidValues ValidValues

The available ValidValues objects for the parameter.

ValidValuesQueryBased ValidValuesQueryBased ValidValuesQueryBased

Indicates whether the parameter's valid values are based on a query.

ValidValuesQueryBasedSpecified ValidValuesQueryBasedSpecified ValidValuesQueryBasedSpecified

Gets or sets a value that indicates whether the ValidValuesQueryBased property is specified.

Applies to