ExpressionDescriptorDefineStringParameter Method (String, String, String, ParameterToken, Int32)

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.2.0.1000)
Syntax
public ParameterPlaceholder DefineStringParameter(
	string placeholderCaption,
	string name,
	string description,
	ParameterToken defaultValue,
	int maxLength
)

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.
maxLength
Type: SystemInt32
The maximum length for the string value.

Return Value

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