ReportParameter Class

 

Updated: February 25, 2016

Contains information about a parameter to the report.

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


public class ReportParameter : ReportObject, INamedObject

NameDescription
System_CAPS_pubmethodReportParameter()

Creates a new instance of the ReportParameter class.

NameDescription
System_CAPS_pubpropertyAllowBlank

Gets or sets a value that indicates whether the value for this parameter is allowed to be the empty string.

System_CAPS_pubpropertyComponentMetadata

Gets or sets the component metadata.(Inherited from ReportObject.)

System_CAPS_pubpropertyDataType

Gets or sets the data type of the parameter.

System_CAPS_pubpropertyDefaultValue

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

System_CAPS_pubpropertyHidden

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

System_CAPS_pubpropertyMultiValue

Gets or sets a value that indicates whether this is a multivalue parameter (a parameter that can take a set of values).

System_CAPS_pubpropertyName

Gets or sets the report parameter name.

System_CAPS_pubpropertyNullable

Gets or sets a value that indicates whether the value for this parameter is allowed to be Null.

System_CAPS_pubpropertyParent

The parent of this report object.(Inherited from ReportObjectBase.)

System_CAPS_pubpropertyPrompt

Gest or sets the user prompt to display when asking for parameter values.

System_CAPS_pubpropertyPromptLocID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the unique identifier for the Prompt property.

System_CAPS_pubpropertySite

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the site associated with the ReportObject object.(Inherited from ReportObject.)

System_CAPS_pubpropertyUsedInQuery

Gets or sets a value that indicates whether or not the parameter is used in a query in the report.

System_CAPS_pubpropertyValidValues

Gets or sets the possible values for the parameter (for the end-user UI).

NameDescription
System_CAPS_pubmethodDeepClone()

Returns a deep clone of this ReportObject instance.(Inherited from ReportObject.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetContainingDataScopes()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the list of report object that contains data scopes.(Inherited from ReportObject.)

System_CAPS_protmethodGetDataScopesForDefaultImpl(IContainedObject)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the data scopes for default implementation.(Inherited from ReportObject.)

System_CAPS_protmethodGetDependenciesCore(IList<ReportObject>)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the dependencies core for the ReportObject object.(Inherited from ReportObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes an instance of ReportObject.(Inherited from ReportObject.)

System_CAPS_protmethodInitializeForDesigner()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes the report object for designer.(Inherited from ReportObject.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnChildPropertyChanged(Int32, Object, Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises an event when the property of the child was changed.(Inherited from ReportObject.)

System_CAPS_protmethodOnPropertyChanged(Int32, Object, Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Raises an event when the property was changed.(Inherited from ReportObject.)

System_CAPS_protmethodRdlSemanticEqualsCore(ReportObject, ICollection<ReportObject>)

This API supports the product infrastructure and is not intended to be used directly from your code. Indicates whether the RDL semantic is equal to the core objects.(Overrides ReportObject.RdlSemanticEqualsCore(ReportObject, ICollection<ReportObject>).)

System_CAPS_protmethodSavePropertyValue<T>(String, T, ReportObject.SwapValue<T>)

This API supports the product infrastructure and is not intended to be used directly from your code. Saves the property value of the report object.(Inherited from ReportObject.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_priveventIComponent.Disposed

Occurs when the ReportObject object is disposed.(Inherited from ReportObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIDisposable.Dispose()

This API supports the product infrastructure and is not intended to be used directly from your code. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from ReportObject.)

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
Show: