ReportParameter Class

Represents a report parameter.


Namespace:  ReportService2005
Assembly:  ReportService2005 (in ReportService2005.dll)

public class ReportParameter

The ReportParameter type exposes the following members.

Public methodReportParameterInitializes a new instance of the ReportParameter class.

Public propertyAllowBlankIndicates whether an empty string is a valid value for the parameter.
Public propertyAllowBlankSpecifiedGets or sets a value that indicates whether the AllowBlank property is specified.
Public propertyDefaultValuesGets or sets the default value of the parameter.
Public propertyDefaultValuesQueryBasedIndicates whether the default values of the parameter are based on a query.
Public propertyDefaultValuesQueryBasedSpecifiedGets or sets a value that indicates whether the DefaultValuesQueryBased property is specified.
Public propertyDependenciesA list of parameters whose values are used to retrieve additional parameter values in a query.
Public propertyErrorMessageThe error message returned when a parameter value has failed validation.
Public propertyMultiValueIndicates whether the parameter is a multi-valued parameter.
Public propertyMultiValueSpecifiedGets or sets a value that indicates whether the MultiValue property is specified.
Public propertyNameGets or sets the name of the parameter.
Public propertyNullableIndicates whether the value of the parameter can be null.
Public propertyNullableSpecifiedGets or sets a value that indicates whether the Nullable property is specified.
Public propertyPromptGets or sets the text that prompts the user for parameter values.
Public propertyPromptUserIndicates whether the user is prompted for the value of the parameter.
Public propertyPromptUserSpecifiedGets or sets a value that indicates whether the PromptUser property is specified.
Public propertyQueryParameterIndicates whether the parameter is used in a query.
Public propertyQueryParameterSpecifiedGets or sets a value that indicates whether the QueryParameter property is specified.
Public propertyStateDescribes the state (ParameterStateEnum) of the parameter.
Public propertyStateSpecifiedGets or sets a value that indicates whether the State property is specified.
Public propertyTypeGets or sets the data type (ParameterTypeEnum enumeration) of the parameter.
Public propertyTypeSpecifiedGets or sets a value that indicates whether the Type property is specified.
Public propertyValidValuesThe available ValidValues objects for the parameter.
Public propertyValidValuesQueryBasedIndicates whether the parameter's valid values are based on a query.
Public propertyValidValuesQueryBasedSpecifiedGets or sets a value that indicates whether the ValidValuesQueryBased property is specified.

Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions