GrapeCity.ActiveReports.Core.Rendering.ReportParameters.Parameter.Create

Create Method

Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, Report)

Creates new instance of Parameter with specified properties.

Declaration

[Obsolete("This overload must not be used. Use the overload with EnableEmptyArray parameter instead.")]
public static Parameter Create(string name, ExpressionInfo prompt, ParameterType dataType, ParameterState state, bool nullable, bool allowBlank, bool hidden, bool multiValue, bool usedInQuery, bool multiline, bool dateOnly, OrderByCondition orderByCondition, OrderByDirection orderByDirection, Report report = null)

Parameters

Type	Name	Description
string	name	The parameter name.
ExpressionInfo	prompt	The text to display to a user when prompting the a for the parameter's value.
ParameterType	dataType	The data type of the new parameter.
ParameterState	state	Specifies the state of the new parameter.
bool	nullable	Specifies whether the new parameter is allowed to be Null.
bool	allowBlank	Specifies whether an empty string is a valid value for the new parameter.
bool	hidden	Specifies whether parameter should not be displayed to the user.
bool	multiValue	Specifies whether the new parameter accepts multiple values.
bool	usedInQuery	Specifies whether the new parameter is used in a query.
bool	multiline	Specifies whether the parameter value supposes to be multiline.
bool	dateOnly	Indicates whether the user should be prompted for both date and time or only the date. Applicable to DateTime parameters.
OrderByCondition	orderByCondition	Specifies whether the valid values are ordered by labels, values or none for the parameter.
OrderByDirection	orderByDirection	Specifies whether the valid values are ordered in ascending or descending order for the parameter.
Report	report	The report.

Returns

Type	Description
Parameter	New Parameter instance.

Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, Report, EnableEmptyArray)

Creates new instance of Parameter with specified properties.

Declaration

public static Parameter Create(string name, ExpressionInfo prompt, ParameterType dataType, ParameterState state, bool nullable, bool allowBlank, bool hidden, bool multiValue, bool usedInQuery, bool multiline, bool dateOnly, OrderByCondition orderByCondition, OrderByDirection orderByDirection, Report report, EnableEmptyArray enableEmptyArray)

Parameters

Type	Name	Description
string	name	The parameter name.
ExpressionInfo	prompt	The text to display to a user when prompting for the parameter's value.
ParameterType	dataType	The data type of the new parameter.
ParameterState	state	Specifies the state of the new parameter.
bool	nullable	Specifies whether the new parameter is allowed to be Null.
bool	allowBlank	Specifies whether an empty string is a valid value for the new parameter.
bool	hidden	Specifies whether parameter should not be displayed to the user.
bool	multiValue	Specifies whether the new parameter accepts multiple values.
bool	usedInQuery	Specifies whether the new parameter is used in a query.
bool	multiline	Specifies whether the parameter value supposes to be multiline.
bool	dateOnly	Indicates whether the user should be prompted for both date and time or only the date. Applicable to DateTime parameters.
OrderByCondition	orderByCondition	Specifies whether the valid values are ordered by labels, values or none for the parameter.
OrderByDirection	orderByDirection	Specifies whether the valid values are ordered in ascending or descending order for the parameter.
Report	report	The report.
EnableEmptyArray	enableEmptyArray	Specifies whether this parameter can have an empty array as its value.

Returns

Type	Description
Parameter	New Parameter instance.

Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, ExpressionInfo, Report)

Creates new instance of Parameter with specified properties.

Declaration

public static Parameter Create(string name, ExpressionInfo prompt, ParameterType dataType, ParameterState state, bool nullable, bool allowBlank, bool hidden, bool multiValue, bool usedInQuery, bool multiline, bool dateOnly, OrderByCondition orderByCondition, OrderByDirection orderByDirection, ExpressionInfo displayFormat, Report report = null)

Parameters

Type	Name	Description
string	name	The parameter name.
ExpressionInfo	prompt	The text to display to a user when prompting for the parameter's value.
ParameterType	dataType	The data type of the new parameter.
ParameterState	state	Specifies the state of the new parameter.
bool	nullable	Specifies whether the new parameter is allowed to be Null.
bool	allowBlank	Specifies whether an empty string is a valid value for the new parameter.
bool	hidden	Specifies whether parameter should not be displayed to the user.
bool	multiValue	Specifies whether the new parameter accepts multiple values.
bool	usedInQuery	Specifies whether the new parameter is used in a query.
bool	multiline	Specifies whether the parameter value supposes to be multiline.
bool	dateOnly	Indicates whether the user should be prompted for both date and time or only the date. Applicable to DateTime parameters.
OrderByCondition	orderByCondition	Specifies whether the valid values are ordered by labels, values or none for the parameter.
OrderByDirection	orderByDirection	Specifies whether the valid values are ordered in ascending or descending order for the parameter.
ExpressionInfo	displayFormat	Parameter display format.
Report	report	The report.

Returns

Type	Description
Parameter	New Parameter instance.

Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, ExpressionInfo, Report, EnableEmptyArray)

Creates new instance of Parameter with specified properties.

Declaration

public static Parameter Create(string name, ExpressionInfo prompt, ParameterType dataType, ParameterState state, bool nullable, bool allowBlank, bool hidden, bool multiValue, bool usedInQuery, bool multiline, bool dateOnly, OrderByCondition orderByCondition, OrderByDirection orderByDirection, ExpressionInfo displayFormat, Report report, EnableEmptyArray enableEmptyArray)

Parameters

Type	Name	Description
string	name	The parameter name.
ExpressionInfo	prompt	The text to display to a user when prompting the a for the parameter's value.
ParameterType	dataType	The data type of the new parameter.
ParameterState	state	Specifies the state of the new parameter.
bool	nullable	Specifies whether the new parameter is allowed to be Null.
bool	allowBlank	Specifies whether an empty string is a valid value for the new parameter.
bool	hidden	Specifies whether parameter should not be displayed to the user.
bool	multiValue	Specifies whether the new parameter accepts multiple values.
bool	usedInQuery	Specifies whether the new parameter is used in a query.
bool	multiline	Specifies whether the parameter value supposes to be multiline.
bool	dateOnly	Indicates whether the user should be prompted for both date and time or only the date. Applicable to DateTime parameters.
OrderByCondition	orderByCondition	Specifies whether the valid values are ordered by labels, values or none for the parameter.
OrderByDirection	orderByDirection	Specifies whether the valid values are ordered in ascending or descending order for the parameter.
ExpressionInfo	displayFormat	Parameter display format.
Report	report	The report.
EnableEmptyArray	enableEmptyArray	Specifies whether this parameter can have an empty array as its value.

Returns

Type	Description
Parameter	New Parameter instance.