ReportParameter Class

Article
02/01/2013

Contains information about a parameter to the report.

Inheritance Hierarchy

System.Object
  Microsoft.ReportingServices.RdlObjectModel.ReportObjectBase
    Microsoft.ReportingServices.RdlObjectModel.ReportObject
      Microsoft.ReportingServices.RdlObjectModel.ReportParameter

Namespace: Microsoft.ReportingServices.RdlObjectModel
Assembly: Microsoft.ReportingServices.Designer.Controls (in Microsoft.ReportingServices.Designer.Controls.dll)

Syntax

'Declaration
Public Class ReportParameter _
    Inherits ReportObject _
    Implements INamedObject
'Usage
Dim instance As ReportParameter

public class ReportParameter : ReportObject, 
    INamedObject

public ref class ReportParameter : public ReportObject, 
    INamedObject

type ReportParameter =  
    class 
        inherit ReportObject 
        interface INamedObject 
    end

public class ReportParameter extends ReportObject implements INamedObject

The ReportParameter type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AllowBlank	Gets or sets a value that indicates whether the value for this parameter is allowed to be the empty string.
	ComponentMetadata	Gets or sets the component metadata. (Inherited from ReportObject.)
	DataType	Gets or sets the data type of the parameter.
	DefaultValue	Gets or sets the default value to use for the parameter (if not provided by the user). If no value is provided as a part of the definition or by the user, the value is null. Required if there is no Prompt and either Nullable is False or a ValidValues list is provided that does not contain Null (an omitted Value).
	Hidden	Gets or sets a value that indicates whether the parameter should not be displayed to the user (however, it will still be available for programmatic use with subreports, drillthrough reports etc.).
	MultiValue	Gets or sets a value that indicates whether this is a multivalue parameter (a parameter that can take a set of values).
	Name	Gets or sets the report parameter name.
	Nullable	Gets or sets a value that indicates whether the value for this parameter is allowed to be Null.
	Parent	The parent of this report object. (Inherited from ReportObjectBase.)
	Prompt	Gest or sets the user prompt to display when asking for parameter values.
	PromptLocID	Infrastructure. Gets or sets the unique identifier for the Prompt property.
	Site	Infrastructure. Gets or sets the site associated with the ReportObject object. (Inherited from ReportObject.)
	UsedInQuery	Gets or sets a value that indicates whether or not the parameter is used in a query in the report.
	ValidValues	Gets or sets the possible values for the parameter (for the end-user UI).

Top

Methods

	Name	Description
	DeepClone	Returns a deep clone of this ReportObject instance. (Inherited from ReportObject.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetContainingDataScopes	Infrastructure. Returns the list of report object that contains data scopes. (Inherited from ReportObject.)
	GetDataScopesForDefaultImpl	Infrastructure. Returns the data scopes for default implementation. (Inherited from ReportObject.)
	GetDependenciesCore	Infrastructure. Returns the dependencies core for the ReportObject object. (Inherited from ReportObject.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Initialize	Infrastructure. Initializes an instance of ReportObject. (Inherited from ReportObject.)
	InitializeForDesigner	Infrastructure. Initializes the report object for designer. (Inherited from ReportObject.)
	MemberwiseClone	(Inherited from Object.)
	OnChildPropertyChanged	Infrastructure. Raises an event when the property of the child was changed. (Inherited from ReportObject.)
	OnPropertyChanged	Infrastructure. Raises an event when the property was changed. (Inherited from ReportObject.)
	RdlSemanticEqualsCore	Infrastructure. Indicates whether the RDL semantic is equal to the core objects. (Overrides ReportObject.RdlSemanticEqualsCore(ReportObject, ICollection<ReportObject>).)
	SavePropertyValue<T>	Infrastructure. Saves the property value of the report object. (Inherited from ReportObject.)
	ToString	(Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IDisposable.Dispose	Infrastructure. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ReportObject.)
	IComponent.Disposed	Infrastructure. Occurs when the ReportObject object is disposed. (Inherited from ReportObject.)

Top

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.

Share via