Edit

Share via

Office.SetBindingDataOptions interface

Package:
office

Provides options for how to set 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.
cellFormat

Use only with binding type table and when a TableData object is passed for the data parameter. An array of objects that specify a range of columns, rows, or cells and specify, as key-value pairs, the cell formatting to apply to that range.

Example: [{cells: Office.Table.Data, format: {fontColor: "yellow"}}, {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]
coercionType

Explicitly sets the shape of the data object. If not supplied is inferred from the data type.
columns

Only for table bindings in content add-ins for Access. Array of strings. Specifies the column names.
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

Specifies the zero-based starting column for a subset of the data. Only for table or matrix bindings. If omitted, data is set starting in the first column.
startRow

Specifies the zero-based starting row for a subset of the data in the binding. Only for table or matrix bindings. If omitted, data is set starting in the first row.
tableOptions

For an inserted table, a list of key-value pairs that specify table formatting options, such as header row, total row, and banded rows. Example: {bandedRows: true, filterButton: false}

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

cellFormat

Use only with binding type table and when a TableData object is passed for the data parameter. An array of objects that specify a range of columns, rows, or cells and specify, as key-value pairs, the cell formatting to apply to that range.

Example: [{cells: Office.Table.Data, format: {fontColor: "yellow"}}, {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]

cellFormat?: RangeFormatConfiguration[]

Property Value

Office.RangeFormatConfiguration[]

coercionType

Explicitly sets the shape of the data object. If not supplied is inferred from the data type.

coercionType?: Office.CoercionType | string

Property Value

Office.CoercionType | string

columns

Warning

This API is now deprecated.

Microsoft Access is no longer supported.

Only for table bindings in content add-ins for Access. Array of strings. Specifies the column names.

columns?: string[]

Property Value

string[]

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

Specifies the zero-based starting column for a subset of the data. Only for table or matrix bindings. If omitted, data is set starting in the first column.

startColumn?: number

Property Value

number

startRow

Specifies the zero-based starting row for a subset of the data in the binding. Only for table or matrix bindings. If omitted, data is set starting in the first row.

startRow?: number

Property Value

number

tableOptions

For an inserted table, a list of key-value pairs that specify table formatting options, such as header row, total row, and banded rows. Example: {bandedRows: true, filterButton: false}

tableOptions?: object

Property Value

object