ExpressionDescriptorDefineStringParameter Method (String, String, String, ParameterToken, ValidValuesSource)

Defines a parameter placeholder that expects string values for resolution.

Namespace:  Dundas.BI.Data.Metadata
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.4.0.1000)
Syntax
public ParameterPlaceholder DefineStringParameter(
	string placeholderCaption,
	string name,
	string description,
	ParameterToken defaultValue,
	ValidValuesSource validValuesSource
)

Parameters

placeholderCaption
Type: SystemString
The parameter placeholder used in the expression statement.
name
Type: SystemString
The name.
description
Type: SystemString
The parameter description.
defaultValue
Type: Dundas.BI.Data.Parameters.TokensParameterToken
The default value.
validValuesSource
Type: Dundas.BI.Data.ParametersValidValuesSource
The valid values source.

Return Value

Type: ParameterPlaceholder
The expression parameter.
Exceptions
ExceptionCondition
ArgumentExceptionplaceholderCaption is or Empty or already in use in the expression statement.
ArgumentExceptiondefaultValue is invalid for the specified parameter category.
ArgumentNullExceptionvalidValuesSource is invalid.
InvalidOperationExceptionParameters can be defined only for entity specific expressions.
See Also