ReportParameter Class
Represents a report parameter.
Inheritance Hierarchy
System.Object
ReportExecution2005.ReportParameter
Namespace: ReportExecution2005
Assembly: ReportExecution2005 (in ReportExecution2005.dll)
Syntax
'Declaration
Public Class ReportParameter
'Usage
Dim instance As ReportParameter
public class ReportParameter
public ref class ReportParameter
type ReportParameter = class end
public class ReportParameter
The ReportParameter type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
ReportParameter | Initializes a new instance of the ReportParameter class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
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. Boolean. Read-only. |
|
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 nulla null reference (Nothing in Visual Basic). |
|
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. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
ToString | (Inherited from Object.) |
Top
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.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.