ReportParameter Object

Crystal Report Plugin Library
See Also  

The ReportParameter object represents a single parameter for a particular report. It allows you to view detailed information about the parameter, and to also add new values to the parameter values list. It is owned by the ReportParameters Collection:

Properties

Property Description

CurrentValues Property

The values currently chosen for the parameter. Read-Only.

DefaultValues Property

The default values that may be chosen to be the current value for the parameter. Read-Only.

DisallowEditing Property

The flag that indicates whether or not a value can be chosen that is not one of the default values. Read-Only.

EditMask Property

The mask that defines the format of the value to be input for the prompt. Read-Only.

EnableExclusiveGroup Property

Indicates whether the group the parameter belongs to is mutually exclusive. Read-Only.

EnableMultipleValues Property

Enables the choice of having multiple current values for the parameter. Read-Only.

EnableNullValue Property

Enables null current values to be chosen. Read-Only.

EnableRangeLimit Property

Enables a limit, within which the current value, and default value, will be confined. Read-Only.

EnableShowDescriptionOnly Property

Enables the display of only the current values description, and not its value.

EnableSortBasedOnDesc Property

Enables a sort of the default, and current values in descending order. Read-Only.

GroupNumber Property

The number of the group that the parameter belongs to. Read-Only.

IsCurrentValueSet Property

Shows whether the current value is set or not. Read-Only.

IsDefaultValueSet Property

Shows whether there are any default values. Read-Only.

MaximumValue Property

The maximum value a parameter may have. Read-Only.

MinimumValue Property

The minimum value a parameter may have. Read-Only.

ParameterName Property

The name of the parameter. Read-Only.

PartOfGroup Property

Indicates whether or not the parameter is part of a group. Read-Only.

PickListFileName Property

The name of a text file that contains default values for the parameter.

PickListSortMethod Property

The order in which the pick list and the default values are sorted. Read-Only.

PickListValues Property

The values in the pick list file. Read-Only.

Prompt Property

The text that prompts the user to enter a value for the parameter. Read-Only.

PromptOnDemandViewing Property

Indicates whether or not parameter values should be prompted for when viewing on-demand reports.

ReportName Property

The name of the report to which the parameter belongs. Read-Only.

SupportsDiscreteValues Property

Indicates whether or not the parameter supports discrete values. Read-Only.

SupportsRangeValues Property

Indicates whether or not the parameter supports range values. Read-Only.

ValueDisplayString Property

A string representation of the parameter's value. Read-Only.

ValueType Property

The type of the parameter. Read-Only.

Methods

Method Explanation

CreateRangeValue Method

Creates a new range value.

CreateSingleValue Method

Creates a new single value.



Crystal Decisions, Inc.
http://www.crystaldecisions.com
Support services:
http://support.crystaldecisions.com