Office.GetBindingDataOptions interface

Package:

office

Provides options for how to get the data in a binding.

Remarks

If the rows option is used, the value must be "thisRow".

Properties

asyncContext	A user-defined item of any type that is returned, unchanged, in the asyncContext property of the AsyncResult object that is passed to a callback.
coercionType	The expected shape of the selection. Use Office.CoercionType or text value. Default: The original, uncoerced type of the binding.
columnCount	For table or matrix bindings, specifies the number of columns offset from the startColumn. Default is all subsequent columns.
filterType	Specify whether to get only the visible (filtered in) data or all the data (default is all). Useful when filtering data. Use Office.FilterType or text value.
rowCount	For table or matrix bindings, specifies the number of rows offset from the startRow. Default is all subsequent rows.
rows	Only for table bindings in content add-ins for Access. Specifies the pre-defined string "thisRow" to get data in the currently selected row.
startColumn	For table or matrix bindings, specifies the zero-based starting column for a subset of the data in the binding. Default is first column.
startRow	For table or matrix bindings, specifies the zero-based starting row for a subset of the data in the binding. Default is first row.
valueFormat	Specifies whether values, such as numbers and dates, are returned with their formatting applied. Use Office.ValueFormat or text value. Default: Unformatted data.

Property Details

asyncContext

A user-defined item of any type that is returned, unchanged, in the asyncContext property of the AsyncResult object that is passed to a callback.

asyncContext?: any

Property Value

any

coercionType

The expected shape of the selection. Use Office.CoercionType or text value. Default: The original, uncoerced type of the binding.

coercionType?: Office.CoercionType | string

Property Value

Office.CoercionType | string

columnCount

For table or matrix bindings, specifies the number of columns offset from the startColumn. Default is all subsequent columns.

columnCount?: number

Property Value

number

filterType

Specify whether to get only the visible (filtered in) data or all the data (default is all). Useful when filtering data. Use Office.FilterType or text value.

filterType?: Office.FilterType | string

Property Value

Office.FilterType | string

rowCount

For table or matrix bindings, specifies the number of rows offset from the startRow. Default is all subsequent rows.

rowCount?: number

Property Value

number

rows

Warning

This API is now deprecated.

Microsoft Access is no longer supported.

Only for table bindings in content add-ins for Access. Specifies the pre-defined string "thisRow" to get data in the currently selected row.

rows?: string

Property Value

string

startColumn

For table or matrix bindings, specifies the zero-based starting column for a subset of the data in the binding. Default is first column.

startColumn?: number

Property Value

number

startRow

For table or matrix bindings, specifies the zero-based starting row for a subset of the data in the binding. Default is first row.

startRow?: number

Property Value

number

valueFormat

Specifies whether values, such as numbers and dates, are returned with their formatting applied. Use Office.ValueFormat or text value. Default: Unformatted data.

valueFormat?: Office.ValueFormat | string

Property Value

Office.ValueFormat | string