-
Notifications
You must be signed in to change notification settings - Fork 61
/
powerpoint.textframe.yml
262 lines (262 loc) · 10.7 KB
/
powerpoint.textframe.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
### YamlMime:TSType
name: PowerPoint.TextFrame
uid: 'powerpoint!PowerPoint.TextFrame:class'
package: powerpoint!
fullName: PowerPoint.TextFrame
summary: Represents the text frame of a shape object.
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: autoSizeSetting
uid: 'powerpoint!PowerPoint.TextFrame#autoSizeSetting:member'
package: powerpoint!
fullName: autoSizeSetting
summary: >-
The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the
text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText"
| "AutoSizeMixed";
return:
type: >-
<xref uid="powerpoint!PowerPoint.ShapeAutoSize:enum" /> | "AutoSizeNone" | "AutoSizeTextToFitShape" |
"AutoSizeShapeToFitText" | "AutoSizeMixed"
- name: bottomMargin
uid: 'powerpoint!PowerPoint.TextFrame#bottomMargin:member'
package: powerpoint!
fullName: bottomMargin
summary: 'Represents the bottom margin, in points, of the text frame.'
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'bottomMargin: number;'
return:
type: number
- name: context
uid: 'powerpoint!PowerPoint.TextFrame#context:member'
package: powerpoint!
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="powerpoint!PowerPoint.RequestContext:class" />'
- name: hasText
uid: 'powerpoint!PowerPoint.TextFrame#hasText:member'
package: powerpoint!
fullName: hasText
summary: Specifies if the text frame contains text.
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly hasText: boolean;'
return:
type: boolean
- name: leftMargin
uid: 'powerpoint!PowerPoint.TextFrame#leftMargin:member'
package: powerpoint!
fullName: leftMargin
summary: 'Represents the left margin, in points, of the text frame.'
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'leftMargin: number;'
return:
type: number
- name: rightMargin
uid: 'powerpoint!PowerPoint.TextFrame#rightMargin:member'
package: powerpoint!
fullName: rightMargin
summary: 'Represents the right margin, in points, of the text frame.'
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'rightMargin: number;'
return:
type: number
- name: textRange
uid: 'powerpoint!PowerPoint.TextFrame#textRange:member'
package: powerpoint!
fullName: textRange
summary: >-
Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the
text. See [PowerPoint.TextRange](xref:powerpoint!PowerPoint.TextRange:class) for details.
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly textRange: PowerPoint.TextRange;'
return:
type: '<xref uid="powerpoint!PowerPoint.TextRange:class" />'
- name: topMargin
uid: 'powerpoint!PowerPoint.TextFrame#topMargin:member'
package: powerpoint!
fullName: topMargin
summary: 'Represents the top margin, in points, of the text frame.'
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'topMargin: number;'
return:
type: number
- name: verticalAlignment
uid: 'powerpoint!PowerPoint.TextFrame#verticalAlignment:member'
package: powerpoint!
fullName: verticalAlignment
summary: >-
Represents the vertical alignment of the text frame. See
[PowerPoint.TextVerticalAlignment](xref:powerpoint!PowerPoint.TextVerticalAlignment:enum) for details.
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" |
"MiddleCentered" | "BottomCentered";
return:
type: >-
<xref uid="powerpoint!PowerPoint.TextVerticalAlignment:enum" /> | "Top" | "Middle" | "Bottom" | "TopCentered"
| "MiddleCentered" | "BottomCentered"
- name: wordWrap
uid: 'powerpoint!PowerPoint.TextFrame#wordWrap:member'
package: powerpoint!
fullName: wordWrap
summary: Determines whether lines break automatically to fit text inside the shape.
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'wordWrap: boolean;'
return:
type: boolean
methods:
- name: deleteText()
uid: 'powerpoint!PowerPoint.TextFrame#deleteText:member(1)'
package: powerpoint!
fullName: deleteText()
summary: Deletes all the text in the text frame.
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'deleteText(): void;'
return:
type: void
description: ''
- name: getParentShape()
uid: 'powerpoint!PowerPoint.TextFrame#getParentShape:member(1)'
package: powerpoint!
fullName: getParentShape()
summary: >-
Returns the parent [PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class) object that holds this
`TextFrame`<!-- -->.
remarks: '\[ [API set: PowerPointApi 1.5](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getParentShape(): PowerPoint.Shape;'
return:
type: '<xref uid="powerpoint!PowerPoint.Shape:class" />'
description: ''
- name: load(options)
uid: 'powerpoint!PowerPoint.TextFrame#load:member(1)'
package: powerpoint!
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?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;'
parameters:
- id: options
description: Provides options for which properties of the object to load.
type: '<xref uid="powerpoint!PowerPoint.Interfaces.TextFrameLoadOptions:interface" />'
return:
type: '<xref uid="powerpoint!PowerPoint.TextFrame:class" />'
description: ''
- name: load(propertyNames)
uid: 'powerpoint!PowerPoint.TextFrame#load:member(2)'
package: powerpoint!
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[]): PowerPoint.TextFrame;'
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="powerpoint!PowerPoint.TextFrame:class" />'
description: ''
- name: load(propertyNamesAndPaths)
uid: 'powerpoint!PowerPoint.TextFrame#load:member(3)'
package: powerpoint!
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;
}): PowerPoint.TextFrame;
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="powerpoint!PowerPoint.TextFrame:class" />'
description: ''
- name: toJSON()
uid: 'powerpoint!PowerPoint.TextFrame#toJSON:member(1)'
package: powerpoint!
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 PowerPoint.TextFrame object is an API object, the `toJSON` method returns a
plain JavaScript object (typed as `PowerPoint.Interfaces.TextFrameData`<!-- -->) that contains shallow copies of
any loaded child properties from the original object.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'toJSON(): PowerPoint.Interfaces.TextFrameData;'
return:
type: '<xref uid="powerpoint!PowerPoint.Interfaces.TextFrameData:interface" />'
description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'