ReportParameter Class

Definition

Represents a report parameter.

public ref class ReportParameter
public class ReportParameter
type ReportParameter = class
Public Class ReportParameter
Inheritance
ReportParameter

Remarks

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

Constructors

ReportParameter()

Initializes a new instance of the ReportParameter class.

Properties

AllowBlank

Gets or sets a value that indicates whether an empty string is a valid value for the parameter.

AllowBlankSpecified

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

DefaultValues

Gets or sets the default values for the parameter.

DefaultValuesQueryBased

Gets or sets a value that indicates whether the default values for the parameter are based on a query.

DefaultValuesQueryBasedSpecified

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

Dependencies

Gets or sets a list of parameters whose values are used to retrieve additional parameter values in a query.

ErrorMessage

Gets the error message returned when a parameter value has failed validation.

MultiValue

Gets or sets a value that indicates whether the parameter is a multivalued parameter.

MultiValueSpecified

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

Name

Gets or sets the name of the parameter.

Nullable

Gets or sets a value that indicates whether the value of the parameter can be null.

NullableSpecified

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

Prompt

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

PromptUser

Gets or sets a value that indicates whether the user is prompted for the value of the parameter.

PromptUserSpecified

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

QueryParameter

Gets or sets a value that indicates whether the parameter is used in a query.

QueryParameterSpecified

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

State

Gets or sets a value that describes the state (ParameterStateEnum) of the parameter.

StateSpecified

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

Type

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

TypeSpecified

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

ValidValues

Gets or sets the available ValidValue objects for the parameter.

ValidValuesQueryBased

Gets or sets a value that indicates whether the parameter's valid values are based on a query.

ValidValuesQueryBasedSpecified

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

Applies to