Essbase Auto Complete Range Properties

AutoCompleteAddToListPolicy.SortAscending

When the ItemNotInListPolicy is AddToList, indicates where in the list to include the cell value: AddToTop, AddToBottom, SortAscending, SortDescending

The order of the cell values in the list is determined by the retrieved order, or the listed order in the case of a DelimitedString.

AutoCompleteComparisonType.StartsWith

The type of comparison used to detect a match between the current character string in the cell and the available cell values.

StartsWith - The items in the dropdown list start with the character string in the cell. Contains - The items in the dropdown list contain the character string in the cell.

When the character string in the cell does not match any available cell value, the dropdown list is displayed with all the cell values. This allows the user to view and select from the entire list.

The caption of the confirmation message displayed when the ItemNotInListPolicy is AddToList, and the user enters a value into a cell that is not in the list of cell values. The user is able to confirm or cancel the change to the cell value.

The confirmation message displayed when the ItemNotInListPolicy is AddToList, and the user enters a value into a cell that is not in the list of cell values. The user is able to confirm or cancel the change to the cell value.

To include the value the user entered in the message, use {0} or "{0}" to enclose in double quotes, such as: "{0}" is not an existing SKU. Do you still want to use the value?

If this setting is not specified, the value of the cell is changed without a confirmation from the user.

The caption of the error message displayed when the ItemNotInListPolicy is LimitToList, and the user enters a value into a cell that is not in the list of cell values.

The error message displayed when the ItemNotInListPolicy is LimitToList, and the user enters a value into a cell that is not in the list of cell values.

To include the value the user entered in the message, use {0} or "{0}" to enclose in double quotes, such as: "{0}" is not a valid SKU.

AutoCompleteItemNotInListPolicy.LimitToList

Controls whether a cell value can only be set to a value in the list of cell values.

LimitToList - A cell value is limited to the cell values in the list. An error message is displayed. The ErrorMessageCaptionForAddToList and ErrorMessageTextForAddToList can be used to customize the message caption and text.

AddToList - Allows a cell value to be set to a value that is not in the list. The user is asked to confirm or cancel the change to the cell value. The ConfirmMessageCaptionForAddToList and ConfirmMessageTextForAddToList can be used to customize the message caption and text. If confirmed, the value is also added to the list based on the AddToListPolicy.

Ignore - Allows a cell value to be set to a value that is not in the list without requiring the user to confirm. The value is not added to the list. This policy can be used in conjunction with the ListSourceType.Range, RangeSourceType.ViewWorkbook, and ListLoadPolicy.OnDemand to emulate the Excel auto-complete behavior by setting the SheetRangeName and RangeSourceSheetRangeName to the same range.

AutoCompleteListDropDownWidth.AutoSize

Controls the width of the dropdown list:

ColumnWidth - The dropdown width is the same as the width of the column.

AutoSize - The dropdown width is the width of the column or the longest item, whichever is greater.

AutoCompleteListSortPolicy.Ascending

Controls whether and how the list of cell values is sorted:

None - The order of the cell values is the order returned by the source. Ascending - The cell values are sorted in ascending order. Descending - The cell values are sorted in descending order.

10

The maximum number of items displayed in the visible portion of the dropdown list. When the total number of filtered cell values exceeds the maximum, a vertical scrollbar is displayed.

false

Controls whether a dropdown button is displayed in the active cell when edit mode is entered.

The AutoCompleteRange name, which is used to uniquely identify the instance in the AutoComplete Range Editor.

The name of the range that contains the cells for this AutoComplete Range.

Default

The name of the alias table used when the ListSourceType is MdxScript and the MdxScriptConnectionPolicy is UseSpecifiedConnection.

When no alias table is specified, the Default alias table is used.

The name of the data table returned by the SQLPassthroughDataSet that contains the cell values. The value can be tokenized.

This setting is optional. If no DataTableName is specified, the first data table in the data set is used.

The semi-colon delimited list of strings representing the list of cell values. The value can be tokenized.

The ID of the Essbase connection used when the ListSourceType is MdxScript and the MdxScriptConnectionPolicy is UseSpecifiedConnection. The value can be tokenized.

The object type ID of the Essbase login service used when the ListSourceType is MdxScript.

This setting is not required when the EssbaseConnectionID references an Essbase connection that does not require obtaining the Essbase credentials from the user.

When the RangeSourcePolicy is ExcelBinaryArfifact, specifies the ID and version of the binary artifact, which contains the RangeSourceSheetRangeName from which the cell values are obtained.

The name of the data table column returned by the SQLPassthroughDataSet that contains the cell values. The value can be tokenized.

This setting is optional. If no ItemColumnName is specified, the first column in the data table is used.

AutoCompleteItemListLoadPolicy.OnViewOpen

Controls when the list of cell values is generated from the ListSourceType:

OnViewOpen (Default) - Generates the list when the view opens. This is the policy to use when the list source is not tokenized and is not dependent on the context of the active cell.

OnViewBuild - Generates the list when the view builds. This is the policy to use when the list source contains tokens, such as selector tokens.

OnDemand - Generates the list when the user starts typing into a cell in the RangeAddress. This is the policy to use when the list is dependent on the context of the active cell.

AutoCompleteListSourceType.Undefined

Indicates the source of the list of cell values:

Undefined - The source is not defined, which results in an empty list.

DelimitedString - The list is represented as a delimited string.

SQLPassthroughDataSet - The list is retrieved by a relational database query using the specified SQLPassthroughDataSetID.

MdxScript - The list is retrieved by an MDX query using the specified MdxScriptID.

Range - Based on the RangeSourcePolicy, the list is extracted from a sheet range in either the view’s workbook or the specified ExcelBinaryArtifact.

Indicates the Essbase connection ID to use for the MDX query to retrieve the list of cell values:

UseViewConnection - Use the EssbaseConnectionID assigned to the view.

UseSpecifiedConnection - Use the specified EssbaseConnectionID.

UseRetrieveRangeConnection - Use the Ess.Retrieve.Connection.<id> named constant associated with the retrieve range in the template, which contains the cell.

The ID of the MDX script to use when the ListSourceType is MdxScript. The value can be tokenized.

AutoCompleteListRangeSourcePolicy.ViewWorkbook

When the ListSourceType is Range, indicates whether the cell values are extracted from the view’s workbook or the specified ExcelBinaryArtifact.

ExcelBinaryArtifact - The cell values are extracted from the Excel file contained in the specified ExcelBinaryArtifact.

ViewWorkbook - The cell values are extracted from the view’s Excel template binary artifact (OnViewOpen) or from the active workbook (OnViewBuild and OnDemand).

When the ListLoadPolicy is OnViewOpen, the cell values are obtained before the view’s user-interface has been initialized, so the view’s Excel template binary artifact is loaded into memory. When the ListLoadPolicy is OnViewBuild or OnDemand, the cell values are obtained from the active workbook, which is the view’s Excel template loaded into the grid control.

When the ListSourceType is Range, indicates the name of the sheet range that contains the cell values. The sheet range is located in the Excel file as specified by the RangeSourcePolicy. The value can be tokenized.

The ID of the SQLPassthroughDataSet metadata instance that defines the query used to generate the list of cell values. The value can be tokenized.

If multiple queries are defined by the SQLPassthroughDataSet, the DataTableName identifies the query that contains the cell values. This allows a single SQLPassthroughDataSet to generate the list of cell values for multiple AutoCompleteRanges in the same view.

false

When the ListSourceType is MdxScript and the MdxScriptConnectionPolicy is UseSpecifiedConnection, the UseAliases setting indicates whether member aliases should be used as the cell values instead of member names.

If True, the aliases are obtained from the specified AliasTable. For a given member, if an alias is not assigned, the name is used.