/
word.customproperty.yml
264 lines (255 loc) · 10.5 KB
/
word.customproperty.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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
### YamlMime:TSType
name: Word.CustomProperty
uid: 'word!Word.CustomProperty:class'
package: word!
fullName: Word.CustomProperty
summary: Represents a custom property.
remarks: >-
\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml
await Word.run(async (context) => {
const properties = context.document.properties.customProperties;
properties.load("key,type,value");
await context.sync();
for (let i = 0; i < properties.items.length; i++)
console.log("Property Name:" + properties.items[i].key + "; Type=" + properties.items[i].type + "; Property Value=" + properties.items[i].value);
});
```
isPreview: false
isDeprecated: false
type: class
properties:
- name: context
uid: 'word!Word.CustomProperty#context:member'
package: word!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="word!Word.RequestContext:class" />'
- name: key
uid: 'word!Word.CustomProperty#key:member'
package: word!
fullName: key
summary: Gets the key of the custom property.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly key: string;'
return:
type: string
- name: type
uid: 'word!Word.CustomProperty#type:member'
package: word!
fullName: type
summary: 'Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean.'
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly type: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean";'
return:
type: '<xref uid="word!Word.DocumentPropertyType:enum" /> | "String" | "Number" | "Date" | "Boolean"'
- name: value
uid: 'word!Word.CustomProperty#value:member'
package: word!
fullName: value
summary: >-
Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow
these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit
chars (possibly creating invalid unicode by breaking up a surrogate pair).
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'value: any;'
return:
type: any
methods:
- name: delete()
uid: 'word!Word.CustomProperty#delete:member(1)'
package: word!
fullName: delete()
summary: Deletes the custom property.
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'delete(): void;'
return:
type: void
description: ''
- name: load(options)
uid: 'word!Word.CustomProperty#load:member(1)'
package: word!
fullName: load(options)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(options?: Word.Interfaces.CustomPropertyLoadOptions): Word.CustomProperty;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="word!Word.Interfaces.CustomPropertyLoadOptions:interface" />'
return:
type: '<xref uid="word!Word.CustomProperty:class" />'
description: ''
- name: load(propertyNames)
uid: 'word!Word.CustomProperty#load:member(2)'
package: word!
fullName: load(propertyNames)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'load(propertyNames?: string | string[]): Word.CustomProperty;'
parameters:
- id: propertyNames
description: A comma-delimited string or an array of strings that specify the properties to load.
type: 'string | string[]'
return:
type: '<xref uid="word!Word.CustomProperty:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'word!Word.CustomProperty#load:member(3)'
package: word!
fullName: load(propertyNamesAndPaths)
summary: >-
Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
the properties.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.CustomProperty;
parameters:
- id: propertyNamesAndPaths
description: >-
`propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
`propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
type: |-
{
select?: string;
expand?: string;
}
return:
type: '<xref uid="word!Word.CustomProperty:class" />'
description: ''
- name: 'set(properties, options)'
uid: 'word!Word.CustomProperty#set:member(1)'
package: word!
fullName: 'set(properties, options)'
summary: >-
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
properties, or another API object of the same type.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Interfaces.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;'
parameters:
- id: properties
description: >-
A JavaScript object with properties that are structured isomorphically to the properties of the object on
which the method is called.
type: '<xref uid="word!Word.Interfaces.CustomPropertyUpdateData:interface" />'
- id: options
description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
return:
type: void
description: ''
- name: set(properties)
uid: 'word!Word.CustomProperty#set:member(2)'
package: word!
fullName: set(properties)
summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'set(properties: Word.CustomProperty): void;'
parameters:
- id: properties
description: ''
type: '<xref uid="word!Word.CustomProperty:class" />'
return:
type: void
description: ''
- name: toJSON()
uid: 'word!Word.CustomProperty#toJSON:member(1)'
package: word!
fullName: toJSON()
summary: >-
Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
`JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
passed to it.) Whereas the original Word.CustomProperty object is an API object, the `toJSON` method returns a
plain JavaScript object (typed as `Word.Interfaces.CustomPropertyData`<!-- -->) that contains shallow copies of
any loaded child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): Word.Interfaces.CustomPropertyData;'
return:
type: '<xref uid="word!Word.Interfaces.CustomPropertyData:interface" />'
description: ''
- name: track()
uid: 'word!Word.CustomProperty#track:member(1)'
package: word!
fullName: track()
summary: >-
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand
for
[context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member)<!--
-->. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and
get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the
object to the tracked object collection when the object was first created. If this object is part of a collection,
you should also track the parent collection.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'track(): Word.CustomProperty;'
return:
type: '<xref uid="word!Word.CustomProperty:class" />'
description: ''
- name: untrack()
uid: 'word!Word.CustomProperty#untrack:member(1)'
package: word!
fullName: untrack()
summary: >-
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for
[context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member)<!--
-->. Having many tracked objects slows down the host application, so please remember to free any objects you add,
once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'untrack(): Word.CustomProperty;'
return:
type: '<xref uid="word!Word.CustomProperty:class" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'