A Sandcastle Documented Class Library

# ExpressionDescriptor DefineStringParameter Method (String, String, String, String, 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 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public ParameterPlaceholder DefineStringParameter(
    	string placeholderCaption,
    	string name,
    	string description,
    	string defaultValue,
    	int maxLength
    )

    Public Function DefineStringParameter (
    	placeholderCaption As String,
    	name As String,
    	description As String,
    	defaultValue As String,
    	maxLength As Integer
    ) As ParameterPlaceholder

    public:
    ParameterPlaceholder^ DefineStringParameter(
    	String^ placeholderCaption,
    	String^ name,
    	String^ description,
    	String^ defaultValue,
    	int maxLength
    )

    member DefineStringParameter :
            placeholderCaption : string *
            name : string *
            description : string *
            defaultValue : string *
            maxLength : int -> ParameterPlaceholder

#### Parameters

placeholderCaption
  Type: System
  String
  The parameter placeholder used in the expression statement.
name
  Type: System
  String
  The name.
description
  Type: System
  String
  The parameter description.
defaultValue
  Type: System
  String
  The default value.
maxLength
  Type: System
  Int32
  The maximum length for the string value.

#### Return Value

Type: ParameterPlaceholder
The expression parameter.
Exceptions

Exception | Condition
--- | ---
ArgumentOutOfRangeException | maxLength is invalid.
ArgumentException | placeholderCaption is or Empty or already in use in the expression statement.
InvalidOperationException | Parameters can be defined only for entity specific expressions.

See Also

#### Reference

ExpressionDescriptor Class
DefineStringParameter Overload
Dundas.BI.Data.Metadata Namespace