Export (0) Print
Expand All

ReportParameter Class

 

Applies To: SQL Server 2016 Preview

Represents a report parameter.

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

System.Object
  ReportExecution2005.ReportParameter

public class ReportParameter

NameDescription
System_CAPS_pubmethodReportParameter()

Initializes a new instance of the ReportParameter class.

NameDescription
System_CAPS_pubpropertyAllowBlank

Indicates whether an empty string is a valid value for the parameter. Read-only.

System_CAPS_pubpropertyAllowBlankSpecified

Indicates that the AllowBlank property has been specified.

System_CAPS_pubpropertyDefaultValues

Gets or sets the default values of the parameter.

System_CAPS_pubpropertyDefaultValuesQueryBased

Indicates whether the default values of the parameter are based on a query. Boolean. Read-only.

System_CAPS_pubpropertyDefaultValuesQueryBasedSpecified

Indicates whether the DefaultValuesQueryBased property has been specified.

System_CAPS_pubpropertyDependencies

Gets or sets a list of parameters whose values are used to retrieve additional parameter values in a query.

System_CAPS_pubpropertyErrorMessage

An error message, returned when the parameter has failed validation.

System_CAPS_pubpropertyMultiValue

Indicates whether the parameter can be a multivalue parameter.

System_CAPS_pubpropertyMultiValueSpecified

Indicates whether the MultiValue property has been specified.

System_CAPS_pubpropertyName

Gets or sets the name of the parameter.

System_CAPS_pubpropertyNullable

Indicates whether the value of the parameter can be null.

System_CAPS_pubpropertyNullableSpecified

Indicates whether the Nullable property has been specified.

System_CAPS_pubpropertyPrompt

Gets or sets the text that prompts the user to provide parameter values.

System_CAPS_pubpropertyPromptUser

Indicates whether the user is prompted for the value of the parameter.

System_CAPS_pubpropertyPromptUserSpecified

Indicates whether a value for the PromptUser property is specified.

System_CAPS_pubpropertyQueryParameter

Indicates whether the parameter is used in a query to an external data source.

System_CAPS_pubpropertyQueryParameterSpecified

Indicates whether the ReportParameter property has been specified.

System_CAPS_pubpropertyState

Describes the state (ParameterStateEnum) of the parameter.

System_CAPS_pubpropertyStateSpecified

Indicates whether the State property has been specified.

System_CAPS_pubpropertyType

The data type (ParameterTypeEnum) of the parameter.

System_CAPS_pubpropertyTypeSpecified

Indicates whether the Type property has been specified.

System_CAPS_pubpropertyValidValues

The available valid values for the parameter. Read-only.

System_CAPS_pubpropertyValidValuesQueryBased

Indicates whether the parameter's valid values are based on a query. Read-only.

System_CAPS_pubpropertyValidValuesQueryBasedSpecified

Indicates whether the ValidValuesQueryBased property has been specified.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(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.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft