This topic has not yet been rated - Rate this topic

ReportParameter Class

SQL Server 2012

Other Versions

Represents a report parameter.

Inheritance Hierarchy

System.Object
ReportService2005.ReportParameter

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

Syntax

C++

JScript

public class ReportParameter

The ReportParameter type exposes the following members.

Constructors

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

Top

Properties

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

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	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.

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.

Reference

ReportService2005 Namespace

Other Resources

Setting Parameter Properties for a Published Report

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD