| Name | Description | |
|---|---|---|
 | Parameter Constructor | Overloaded. |
Exago .NET API Documentation
Parameter Class Members
The following tables list the members exposed by Parameter.
| Name | Description | |
|---|---|---|
| Parameter Constructor | Overloaded. |
| Name | Description | |
|---|---|---|
 | DataType | The parameter data type. |
| DataTypeStr | String representation of the data type stored in this parameter. |
| DisplayDataType | When a Parameter has an associated Parameter Dropdown Object, this is the data type of the Display Value Field. The Display Value Field is displayed in reports and formulas. For more information, see the Parameters article. |
| DisplayDataTypeStr | When a Parameter has an associated Parameter Dropdown Object, this is the data type of the Display Value Field. The Display Value Field is displayed in reports and formulas. For more information, see the Parameters article. |
| DropdownDataSourceId | For a Parameter with a Parameter Dropdown Object, this is the Id Property of the DataSource Class object from which the Parameter retrieves its values. |
| DropdownDbName | For Parameters with a Parameter Dropdown Object, this is the DbName Property of the Entity in the Data Source that is queried to fill the dropdown with values. |
| DropdownDisplayValueField | For Parameters with a Parameter Dropdown Object, a column from the data object or custom SQL that sets the display value of the parameter for the dropdown selector. This represents the set of values that should be presented to the end user when they are executing or scheduling a report. The Display Value is also displayed in reports and used in formulas (except in formula filters). |
| DropdownObjectType | For Parameters with a Parameter Dropdown Object, this is the ObjectType Property value for the Entity (Data Object) that is queried to fill the dropdown with values. |
| DropdownSqlStmt | For a Parameter with a Parameter Dropdown Object, this is the custom SQL statement that will be executed against the Data Source (specified by the DropdownDataSourceId Property) when retrieving values for the dropdown. A value is only required when using a custom SQL object to query for dropdown values. |
| DropdownValueField | For Parameters with a Parameter Dropdown Object, a column from the data object or custom SQL that sets that actual value of the parameter at runtime. This represents a set of values that are not displayed to the end user but are instead used when parameter values are required in custom SQL or stored procedures, or other server side processing. |
| Id | The case-sensitive name for the parameter. Prompting parameters are sorted alphabetically by name unless otherwise specified or unless there are dropdown parameters with dependencies. The following names are reserved by the application:
filter, email, userId, companyId, reportName, reportFullName, pageNumber, data_label, data_value, series_label, bubble_size, bubble_value, batch_x (where x can be any string of characters). The following characters are not allowed: |
| IsHidden | Set hidden to True to disable this parameter from being used by users in cells and formulas. |
| IsReportLevelParameter | Differentiates between a Parameter created at the configuration/session level, or at the report-level. See the Report-Level Parameters section of the Parameters article in the documentation for more information. |
| PromptText | Give non-hidden parameters a prompt text to query the user for a value at the time of report execution. Leave blank to use the default value. |
| StoredProcParams | For Parameters that have a Parameter Dropdown Object, this is a comma-separated list of preexisting Exago parameters to be used as variables for a selected stored procedure, when the DropdownDbName Property refers to a stored procedure. For more information, refer to the Stored Procedures section of the Data Objects article in the documentation. |
| Value | The default value of a parameter. This is intended to be overwritten at runtime through the API. Date values should be entered in yyyy-MM-dd format. Null values may also be passed to parameters. In order to do so, the default value of the parameter needs to be set to Formulas that return strings, integers, dates or decimals may also be passed as parameter default values. Just as entering a function into a cell in the Report Designer, include an equals sign as a prefix (e.g. Formulas may include multiple functions. As with other functions, these may also include other parameters. |
| Name | Description | |
|---|---|---|
 | CompareTo | |
| GetDisplayValue | |
| GetValue | |
| ToString | Returns a string that represents the current object. |