-
Notifications
You must be signed in to change notification settings - Fork 62
/
word.interfaces.custompropertycollectionloadoptions.yml
66 lines (66 loc) · 2.64 KB
/
word.interfaces.custompropertycollectionloadoptions.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
### YamlMime:TSType
name: Word.Interfaces.CustomPropertyCollectionLoadOptions
uid: 'word!Word.Interfaces.CustomPropertyCollectionLoadOptions:interface'
package: word!
fullName: Word.Interfaces.CustomPropertyCollectionLoadOptions
summary: 'Contains the collection of [Word.CustomProperty](xref:word!Word.CustomProperty:class) objects.'
remarks: '\[ [API set: WordApi 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'word!Word.Interfaces.CustomPropertyCollectionLoadOptions#$all:member'
package: word!
fullName: $all
summary: >-
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: key
uid: 'word!Word.Interfaces.CustomPropertyCollectionLoadOptions#key:member'
package: word!
fullName: key
summary: 'For EACH ITEM in the collection: 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: 'key?: boolean;'
return:
type: boolean
- name: type
uid: 'word!Word.Interfaces.CustomPropertyCollectionLoadOptions#type:member'
package: word!
fullName: type
summary: >-
For EACH ITEM in the collection: 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: 'type?: boolean;'
return:
type: boolean
- name: value
uid: 'word!Word.Interfaces.CustomPropertyCollectionLoadOptions#value:member'
package: word!
fullName: value
summary: >-
For EACH ITEM in the collection: 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?: boolean;'
return:
type: boolean