ReportParameter Class

Represents a report parameter.


Namespace:  ReportExecution2005
Assembly:  ReportExecution2005 (in ReportExecution2005.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. Read-only.
Public propertyAllowBlankSpecifiedIndicates that the AllowBlank property has been specified.
Public propertyDefaultValuesGets or sets the default values of the parameter.
Public propertyDefaultValuesQueryBasedIndicates whether the default values of the parameter are based on a query. Boolean. Read-only.
Public propertyDefaultValuesQueryBasedSpecifiedIndicates whether the DefaultValuesQueryBased property has been specified.
Public propertyDependenciesGets or sets a list of parameters whose values are used to retrieve additional parameter values in a query.
Public propertyErrorMessageAn error message, returned when the parameter has failed validation.
Public propertyMultiValueIndicates whether the parameter can be a multivalue parameter.
Public propertyMultiValueSpecifiedIndicates whether the MultiValue property has been specified.
Public propertyNameGets or sets the name of the parameter.
Public propertyNullableIndicates whether the value of the parameter can be null.
Public propertyNullableSpecifiedIndicates whether the Nullable property has been specified.
Public propertyPromptGets or sets the text that prompts the user to provide parameter values.
Public propertyPromptUserIndicates whether the user is prompted for the value of the parameter.
Public propertyPromptUserSpecifiedIndicates whether a value for the PromptUser property is specified.
Public propertyQueryParameterIndicates whether the parameter is used in a query to an external data source.
Public propertyQueryParameterSpecifiedIndicates whether the ReportParameter property has been specified.
Public propertyStateDescribes the state (ParameterStateEnum) of the parameter.
Public propertyStateSpecifiedIndicates whether the State property has been specified.
Public propertyTypeThe data type (ParameterTypeEnum) of the parameter.
Public propertyTypeSpecifiedIndicates whether the Type property has been specified.
Public propertyValidValuesThe available valid values for the parameter. Read-only.
Public propertyValidValuesQueryBasedIndicates whether the parameter's valid values are based on a query. Read-only.
Public propertyValidValuesQueryBasedSpecifiedIndicates whether the ValidValuesQueryBased property has been 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.

The value of the ReportParameter may change if the user calls SetReportDefinition.

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