ReportParameter Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
The value of the ReportParameter may change if the user calls SetReportDefinition.
Constructors
ReportParameter() |
Initializes a new instance of the ReportParameter class. |
Properties
AllowBlank |
Indicates whether an empty string is a valid value for the parameter. Read-only. |
AllowBlankSpecified |
Indicates that the AllowBlank property has been specified. |
DefaultValues |
Gets or sets the default values of the parameter. |
DefaultValuesQueryBased |
Indicates whether the default values of the parameter are based on a query. |
DefaultValuesQueryBasedSpecified |
Indicates whether the DefaultValuesQueryBased property has been specified. |
Dependencies |
Gets or sets a list of parameters whose values are used to retrieve additional parameter values in a query. |
ErrorMessage |
An error message, returned when the parameter has failed validation. |
MultiValue |
Indicates whether the parameter can be a multivalue parameter. |
MultiValueSpecified |
Indicates whether the MultiValue property has been specified. |
Name |
Gets or sets the name of the parameter. |
Nullable |
Indicates whether the value of the parameter can be |
NullableSpecified |
Indicates whether the Nullable property has been specified. |
Prompt |
Gets or sets the text that prompts the user to provide parameter values. |
PromptUser |
Indicates whether the user is prompted for the value of the parameter. |
PromptUserSpecified |
Indicates whether a value for the PromptUser property is specified. |
QueryParameter |
Indicates whether the parameter is used in a query to an external data source. |
QueryParameterSpecified |
Indicates whether the ReportParameter property has been specified. |
State |
Describes the state (ParameterStateEnum) of the parameter. |
StateSpecified |
Indicates whether the State property has been specified. |
Type |
The data type (ParameterTypeEnum) of the parameter. |
TypeSpecified |
Indicates whether the Type property has been specified. |
ValidValues |
The available valid values for the parameter. Read-only. |
ValidValuesQueryBased |
Indicates whether the parameter's valid values are based on a query. Read-only. |
ValidValuesQueryBasedSpecified |
Indicates whether the ValidValuesQueryBased property has been specified. |