Del via


ReportParameter Class

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
Public method ReportParameter Creates a new instance of the ReportParameter class.

Top

Properties

  Name Description
Public property AllowBlank Indicates the value for this parameter is allowed to be the empty string.
Public property ComponentMetadata The component metadata. (Inherited from ReportObject.)
Public property DataType The data type of the parameter.
Public property DefaultValue 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).
Public property Hidden Indicates the parameter should not be displayed to the user (however, it will still be available for programmatic use with subreports, drillthrough reports etc.).
Public property MultiValue Indicates this is a multivalue parameter (a parameter that can take a set of values).
Public property Name The report parameter name.
Public property Nullable Indicates the value for this parameter is allowed to be Null.
Public property Parent The parent of this report object. (Inherited from ReportObjectBase.)
Public property Prompt The user prompt to display when asking for parameter values
Public property PromptLocID The unique identifier for the Prompt property.
Public property Site Infrastructure. (Inherited from ReportObject.)
Public property UsedInQuery Indicates whether or not the parameter is used in a query in the report.
Public property ValidValues Possible values for the parameter (for the end-user UI)

Top

Methods

  Name Description
Public method DeepClone Returns a deep clone of this ReportObject instance. (Inherited from ReportObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetContainingDataScopes Infrastructure. (Inherited from ReportObject.)
Protected method GetDataScopesForDefaultImpl Infrastructure. (Inherited from ReportObject.)
Protected method GetDependenciesCore Infrastructure. (Inherited from ReportObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Initialize Infrastructure. (Inherited from ReportObject.)
Protected method InitializeForDesigner Infrastructure. (Inherited from ReportObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnChildPropertyChanged Infrastructure. (Inherited from ReportObject.)
Protected method OnPropertyChanged Infrastructure. (Inherited from ReportObject.)
Protected method RdlSemanticEqualsCore Infrastructure. (Overrides ReportObject.RdlSemanticEqualsCore(ReportObject, ICollection<ReportObject>).)
Protected method SavePropertyValue<T> Infrastructure. (Inherited from ReportObject.)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IDisposable.Dispose (Inherited from ReportObject.)
Explicit interface implemetationPrivate event IComponent.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.