-
Notifications
You must be signed in to change notification settings - Fork 63
/
word.interfaces.inlinepicturecollectionloadoptions.yml
129 lines (129 loc) · 5.36 KB
/
word.interfaces.inlinepicturecollectionloadoptions.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
### YamlMime:TSType
name: Word.Interfaces.InlinePictureCollectionLoadOptions
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions:interface'
package: word!
fullName: Word.Interfaces.InlinePictureCollectionLoadOptions
summary: 'Contains a collection of [Word.InlinePicture](xref:word!Word.InlinePicture:class) objects.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: $all
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#$all:member'
package: word!
fullName: $all
summary: >-
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`<!-- -->) but not
the navigational properties (such as `Range.format.fill.color`<!-- -->).
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: '$all?: boolean;'
return:
type: boolean
- name: altTextDescription
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#altTextDescription:member'
package: word!
fullName: altTextDescription
summary: >-
For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the
inline image.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'altTextDescription?: boolean;'
return:
type: boolean
- name: altTextTitle
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#altTextTitle:member'
package: word!
fullName: altTextTitle
summary: 'For EACH ITEM in the collection: Specifies a string that contains the title for the inline image.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'altTextTitle?: boolean;'
return:
type: boolean
- name: height
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#height:member'
package: word!
fullName: height
summary: 'For EACH ITEM in the collection: Specifies a number that describes the height of the inline image.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'height?: boolean;'
return:
type: boolean
- name: hyperlink
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#hyperlink:member'
package: word!
fullName: hyperlink
summary: >-
For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '\#' to separate the address part from
the optional location part.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'hyperlink?: boolean;'
return:
type: boolean
- name: lockAspectRatio
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#lockAspectRatio:member'
package: word!
fullName: lockAspectRatio
summary: >-
For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original
proportions when you resize it.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'lockAspectRatio?: boolean;'
return:
type: boolean
- name: paragraph
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#paragraph:member'
package: word!
fullName: paragraph
summary: 'For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image.'
remarks: '\[ [API set: WordApi 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'paragraph?: Word.Interfaces.ParagraphLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ParagraphLoadOptions:interface" />'
- name: parentContentControl
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#parentContentControl:member'
package: word!
fullName: parentContentControl
summary: >-
For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound`
error if there isn't a parent content control.
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'parentContentControl?: Word.Interfaces.ContentControlLoadOptions;'
return:
type: '<xref uid="word!Word.Interfaces.ContentControlLoadOptions:interface" />'
- name: width
uid: 'word!Word.Interfaces.InlinePictureCollectionLoadOptions#width:member'
package: word!
fullName: width
summary: 'For EACH ITEM in the collection: Specifies a number that describes the width of the inline image.'
remarks: '\[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'width?: boolean;'
return:
type: boolean