Share via

  • Article

ReportParameter Class

Represents a report parameter.

Inheritance Hierarchy

System.Object
  ReportService2005.ReportParameter

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class ReportParameter
'Usage
Dim instance As ReportParameter

[SerializableAttribute]
public class ReportParameter

[SerializableAttribute]
public ref class ReportParameter

[<SerializableAttribute>]
type ReportParameter =  class end

public class ReportParameter

The ReportParameter type exposes the following members.

Constructors

  Name Description
Public method ReportParameter Initializes a new instance of the ReportParameter class.

Top

Properties

  Name Description
Public property AllowBlank Indicates whether an empty string is a valid value for the parameter.
Public property AllowBlankSpecified Gets or sets a value that indicates whether the AllowBlank property is specified.
Public property DefaultValues Gets or sets the default value of the parameter.
Public property DefaultValuesQueryBased Indicates whether the default values of the parameter are based on a query.
Public property DefaultValuesQueryBasedSpecified Gets or sets a value that indicates whether the DefaultValuesQueryBased property is specified.
Public property Dependencies A list of parameters whose values are used to retrieve additional parameter values in a query.
Public property ErrorMessage The error message returned when a parameter value has failed validation.
Public property MultiValue Indicates whether the parameter is a multi-valued parameter.
Public property MultiValueSpecified Gets or sets a value that indicates whether the MultiValue property is specified.
Public property Name Gets or sets the name of the parameter.
Public property Nullable Indicates whether the value of the parameter can be nulla null reference (Nothing in Visual Basic).
Public property NullableSpecified Gets or sets a value that indicates whether the Nullable property is specified.
Public property Prompt Gets or sets the text that prompts the user for parameter values.
Public property PromptUser Indicates whether the user is prompted for the value of the parameter.
Public property PromptUserSpecified Gets or sets a value that indicates whether the PromptUser property is specified.
Public property QueryParameter Indicates whether the parameter is used in a query.
Public property QueryParameterSpecified Gets or sets a value that indicates whether the QueryParameter property is specified.
Public property State Describes the state (ParameterStateEnum) of the parameter.
Public property StateSpecified Gets or sets a value that indicates whether the State property is specified.
Public property Type Gets or sets the data type (ParameterTypeEnum enumeration) of the parameter.
Public property TypeSpecified Gets or sets a value that indicates whether the Type property is specified.
Public property ValidValues The available ValidValues objects for the parameter.
Public property ValidValuesQueryBased Indicates whether the parameter's valid values are based on a query.
Public property ValidValuesQueryBasedSpecified Gets or sets a value that indicates whether the ValidValuesQueryBased property is specified.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method 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.

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.