-
Notifications
You must be signed in to change notification settings - Fork 63
/
office.getbindingdataoptions.yml
138 lines (138 loc) · 4.55 KB
/
office.getbindingdataoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
### YamlMime:TSType
name: Office.GetBindingDataOptions
uid: 'office!Office.GetBindingDataOptions:interface'
package: office!
fullName: Office.GetBindingDataOptions
summary: Provides options for how to get the data in a binding.
remarks: 'If the rows option is used, the value must be "thisRow".'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: asyncContext
uid: 'office!Office.GetBindingDataOptions#asyncContext:member'
package: office!
fullName: asyncContext
summary: >-
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.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'asyncContext?: any'
return:
type: any
- name: coercionType
uid: 'office!Office.GetBindingDataOptions#coercionType:member'
package: office!
fullName: coercionType
summary: >-
The expected shape of the selection. Use [Office.CoercionType](xref:office!Office.CoercionType:enum) or text
value. Default: The original, uncoerced type of the binding.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'coercionType?: Office.CoercionType | string'
return:
type: '<xref uid="office!Office.CoercionType:enum" /> | string'
- name: columnCount
uid: 'office!Office.GetBindingDataOptions#columnCount:member'
package: office!
fullName: columnCount
summary: >-
For table or matrix bindings, specifies the number of columns offset from the startColumn. Default is all
subsequent columns.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'columnCount?: number'
return:
type: number
- name: filterType
uid: 'office!Office.GetBindingDataOptions#filterType:member'
package: office!
fullName: filterType
summary: >-
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.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'filterType?: Office.FilterType | string'
return:
type: '<xref uid="office!Office.FilterType:enum" /> | string'
- name: rowCount
uid: 'office!Office.GetBindingDataOptions#rowCount:member'
package: office!
fullName: rowCount
summary: >-
For table or matrix bindings, specifies the number of rows offset from the startRow. Default is all subsequent
rows.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'rowCount?: number'
return:
type: number
- name: rows
uid: 'office!Office.GetBindingDataOptions#rows:member'
package: office!
fullName: rows
summary: >-
Only for table bindings in content add-ins for Access. Specifies the pre-defined string "thisRow" to get data in
the currently selected row.
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: Microsoft Access is no longer supported.
syntax:
content: 'rows?: string'
return:
type: string
- name: startColumn
uid: 'office!Office.GetBindingDataOptions#startColumn:member'
package: office!
fullName: startColumn
summary: >-
For table or matrix bindings, specifies the zero-based starting column for a subset of the data in the binding.
Default is first column.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'startColumn?: number'
return:
type: number
- name: startRow
uid: 'office!Office.GetBindingDataOptions#startRow:member'
package: office!
fullName: startRow
summary: >-
For table or matrix bindings, specifies the zero-based starting row for a subset of the data in the binding.
Default is first row.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'startRow?: number'
return:
type: number
- name: valueFormat
uid: 'office!Office.GetBindingDataOptions#valueFormat:member'
package: office!
fullName: valueFormat
summary: >-
Specifies whether values, such as numbers and dates, are returned with their formatting applied. Use
Office.ValueFormat or text value. Default: Unformatted data.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'valueFormat?: Office.ValueFormat | string'
return:
type: '<xref uid="office!Office.ValueFormat:enum" /> | string'