SQL Passthrough Data Set Range Properties

The following properties are available on SQLPassthroughDataSetRange objects, which appear as expandable sub-properties of the objects that use them.

Behavior

Property Type Default Description

AutoBuildOnViewBuild

bool

true

Controls whether the DataSetRange is built when the view is built.

When a DataSetRange is built, the associated query or queries are executed and the data for each DataTableRange is copied to the associated sheet range.

If AutoBuildOnViewBuild is True, the DataSetRange is built when the view is built. If AutoBuildOnViewBuild is False, the DataSetRange can be built using the workbook script method BuildDataSetRange.

DataSet

Property Type Default Description

SQLPassthroughDataSetID

string

The ID of the SQLPassthroughDataSet metadata instance that defines the query or queries used to generate and save the data.

DataTable Ranges

Property Type Default Description

DataTableRanges

DataTableRangeList of DataTableRange

Maps each DataTable generated by the DataSet to a worksheet range and configures the settings that control the behavior, the sorting and grouping, and the presentation of row data errors.

Name

Property Type Default Description

Name

string

The DataSetRange name, which is used to uniquely identify the instance in the DataSet Range Editor.

Tokens

Property Type Default Description

DataSetTokens

TokenTable

Optional token definitions that are included along with the default tokens for token replacement. The default tokens include the view tokens, application tokens and, if applicable, selector tokens as well as any tokens added by a workbook script.

When building a SQLPassthroughDataSetRange, tokens are replaced within the Select SQL statement and on the worksheet. When saving the SQLPassthroughDataSetRange, tokens are replaced within the Insert, Delete, and Update SQL statements.