ReportParameter Class

Reference

Definition

Namespace:: Microsoft.ReportingServices.RdlObjectModel

Assembly:: Microsoft.ReportingServices.Designer.Controls.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains information about a parameter to the report.

public ref class ReportParameter : Microsoft::ReportingServices::RdlObjectModel::ReportObject, Microsoft::ReportingServices::RdlObjectModel::INamedObject

[System.ComponentModel.TypeConverter(typeof(Microsoft.ReportingServices.RdlObjectModel.ReportParameter/ReportParameterConverter))]
public class ReportParameter : Microsoft.ReportingServices.RdlObjectModel.ReportObject, Microsoft.ReportingServices.RdlObjectModel.INamedObject

[<System.ComponentModel.TypeConverter(typeof(Microsoft.ReportingServices.RdlObjectModel.ReportParameter/ReportParameterConverter))>]
type ReportParameter = class
    inherit ReportObject
    interface INamedObject

Public Class ReportParameter
Inherits ReportObject
Implements INamedObject

Inheritance: Object

ReportObjectBase

ReportObject
ReportParameter

Derived: Microsoft.ReportingServices.RdlObjectModel2005.ReportParameter2005

Attributes: TypeConverterAttribute

Implements: INamedObject

Constructors

ReportParameter()

Creates a new instance of the ReportParameter class.

Properties

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	Gets or sets the unique identifier for the Prompt property.
Site	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).

Methods

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

Explicit Interface Implementations

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

Applies to