@types/office-js 1.0.261 → 1.0.262
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +3376 -295
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -98821,314 +98821,2487 @@ declare namespace PowerPoint {
|
|
|
98821
98821
|
*/
|
|
98822
98822
|
slideMasterId?: string;
|
|
98823
98823
|
}
|
|
98824
|
+
/**
|
|
98825
|
+
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
|
|
98826
|
+
*
|
|
98827
|
+
* @remarks
|
|
98828
|
+
* [Api set: PowerPointApi 1.4]
|
|
98829
|
+
*/
|
|
98830
|
+
class BulletFormat extends OfficeExtension.ClientObject {
|
|
98831
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
98832
|
+
context: RequestContext;
|
|
98833
|
+
/**
|
|
98834
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
98835
|
+
*
|
|
98836
|
+
* @remarks
|
|
98837
|
+
* [Api set: PowerPointApi 1.4]
|
|
98838
|
+
*/
|
|
98839
|
+
visible: boolean;
|
|
98840
|
+
/**
|
|
98841
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
98842
|
+
*
|
|
98843
|
+
* @param options Provides options for which properties of the object to load.
|
|
98844
|
+
*/
|
|
98845
|
+
load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
|
|
98846
|
+
/**
|
|
98847
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
98848
|
+
*
|
|
98849
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
98850
|
+
*/
|
|
98851
|
+
load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
|
|
98852
|
+
/**
|
|
98853
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
98854
|
+
*
|
|
98855
|
+
* @param propertyNamesAndPaths `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.
|
|
98856
|
+
*/
|
|
98857
|
+
load(propertyNamesAndPaths?: {
|
|
98858
|
+
select?: string;
|
|
98859
|
+
expand?: string;
|
|
98860
|
+
}): PowerPoint.BulletFormat;
|
|
98861
|
+
/**
|
|
98862
|
+
* 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.)
|
|
98863
|
+
* Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
98864
|
+
*/
|
|
98865
|
+
toJSON(): PowerPoint.Interfaces.BulletFormatData;
|
|
98866
|
+
}
|
|
98867
|
+
/**
|
|
98868
|
+
* Specifies the connector type for line shapes.
|
|
98869
|
+
*
|
|
98870
|
+
* @remarks
|
|
98871
|
+
* [Api set: PowerPointApi 1.4]
|
|
98872
|
+
*/
|
|
98873
|
+
enum ConnectorType {
|
|
98874
|
+
/**
|
|
98875
|
+
* Straight connector type
|
|
98876
|
+
* @remarks
|
|
98877
|
+
* [Api set: PowerPointApi 1.4]
|
|
98878
|
+
*/
|
|
98879
|
+
straight = "Straight",
|
|
98880
|
+
/**
|
|
98881
|
+
* Elbow connector type
|
|
98882
|
+
* @remarks
|
|
98883
|
+
* [Api set: PowerPointApi 1.4]
|
|
98884
|
+
*/
|
|
98885
|
+
elbow = "Elbow",
|
|
98886
|
+
/**
|
|
98887
|
+
* Curve connector type
|
|
98888
|
+
* @remarks
|
|
98889
|
+
* [Api set: PowerPointApi 1.4]
|
|
98890
|
+
*/
|
|
98891
|
+
curve = "Curve",
|
|
98892
|
+
}
|
|
98893
|
+
/**
|
|
98894
|
+
* Specifies the shape type for a `GeometricShape` object.
|
|
98895
|
+
*
|
|
98896
|
+
* @remarks
|
|
98897
|
+
* [Api set: PowerPointApi 1.4]
|
|
98898
|
+
*/
|
|
98899
|
+
enum GeometricShapeType {
|
|
98900
|
+
/**
|
|
98901
|
+
* Straight Line from Top-Right Corner to Bottom-Left Corner of the Shape
|
|
98902
|
+
* @remarks
|
|
98903
|
+
* [Api set: PowerPointApi 1.4]
|
|
98904
|
+
*/
|
|
98905
|
+
lineInverse = "LineInverse",
|
|
98906
|
+
/**
|
|
98907
|
+
* Isosceles Triangle
|
|
98908
|
+
* @remarks
|
|
98909
|
+
* [Api set: PowerPointApi 1.4]
|
|
98910
|
+
*/
|
|
98911
|
+
triangle = "Triangle",
|
|
98912
|
+
/**
|
|
98913
|
+
* Right Triangle
|
|
98914
|
+
* @remarks
|
|
98915
|
+
* [Api set: PowerPointApi 1.4]
|
|
98916
|
+
*/
|
|
98917
|
+
rightTriangle = "RightTriangle",
|
|
98918
|
+
/**
|
|
98919
|
+
* Rectangle
|
|
98920
|
+
* @remarks
|
|
98921
|
+
* [Api set: PowerPointApi 1.4]
|
|
98922
|
+
*/
|
|
98923
|
+
rectangle = "Rectangle",
|
|
98924
|
+
/**
|
|
98925
|
+
* Diamond
|
|
98926
|
+
* @remarks
|
|
98927
|
+
* [Api set: PowerPointApi 1.4]
|
|
98928
|
+
*/
|
|
98929
|
+
diamond = "Diamond",
|
|
98930
|
+
/**
|
|
98931
|
+
* Parallelogram
|
|
98932
|
+
* @remarks
|
|
98933
|
+
* [Api set: PowerPointApi 1.4]
|
|
98934
|
+
*/
|
|
98935
|
+
parallelogram = "Parallelogram",
|
|
98936
|
+
/**
|
|
98937
|
+
* Trapezoid
|
|
98938
|
+
* @remarks
|
|
98939
|
+
* [Api set: PowerPointApi 1.4]
|
|
98940
|
+
*/
|
|
98941
|
+
trapezoid = "Trapezoid",
|
|
98942
|
+
/**
|
|
98943
|
+
* Trapezoid which may have Non-Equal Sides
|
|
98944
|
+
* @remarks
|
|
98945
|
+
* [Api set: PowerPointApi 1.4]
|
|
98946
|
+
*/
|
|
98947
|
+
nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid",
|
|
98948
|
+
/**
|
|
98949
|
+
* Pentagon
|
|
98950
|
+
* @remarks
|
|
98951
|
+
* [Api set: PowerPointApi 1.4]
|
|
98952
|
+
*/
|
|
98953
|
+
pentagon = "Pentagon",
|
|
98954
|
+
/**
|
|
98955
|
+
* Hexagon
|
|
98956
|
+
* @remarks
|
|
98957
|
+
* [Api set: PowerPointApi 1.4]
|
|
98958
|
+
*/
|
|
98959
|
+
hexagon = "Hexagon",
|
|
98960
|
+
/**
|
|
98961
|
+
* Heptagon
|
|
98962
|
+
* @remarks
|
|
98963
|
+
* [Api set: PowerPointApi 1.4]
|
|
98964
|
+
*/
|
|
98965
|
+
heptagon = "Heptagon",
|
|
98966
|
+
/**
|
|
98967
|
+
* Octagon
|
|
98968
|
+
* @remarks
|
|
98969
|
+
* [Api set: PowerPointApi 1.4]
|
|
98970
|
+
*/
|
|
98971
|
+
octagon = "Octagon",
|
|
98972
|
+
/**
|
|
98973
|
+
* Decagon
|
|
98974
|
+
* @remarks
|
|
98975
|
+
* [Api set: PowerPointApi 1.4]
|
|
98976
|
+
*/
|
|
98977
|
+
decagon = "Decagon",
|
|
98978
|
+
/**
|
|
98979
|
+
* Dodecagon
|
|
98980
|
+
* @remarks
|
|
98981
|
+
* [Api set: PowerPointApi 1.4]
|
|
98982
|
+
*/
|
|
98983
|
+
dodecagon = "Dodecagon",
|
|
98984
|
+
/**
|
|
98985
|
+
* Star: 4 Points
|
|
98986
|
+
* @remarks
|
|
98987
|
+
* [Api set: PowerPointApi 1.4]
|
|
98988
|
+
*/
|
|
98989
|
+
star4 = "Star4",
|
|
98990
|
+
/**
|
|
98991
|
+
* Star: 5 Points
|
|
98992
|
+
* @remarks
|
|
98993
|
+
* [Api set: PowerPointApi 1.4]
|
|
98994
|
+
*/
|
|
98995
|
+
star5 = "Star5",
|
|
98996
|
+
/**
|
|
98997
|
+
* Star: 6 Points
|
|
98998
|
+
* @remarks
|
|
98999
|
+
* [Api set: PowerPointApi 1.4]
|
|
99000
|
+
*/
|
|
99001
|
+
star6 = "Star6",
|
|
99002
|
+
/**
|
|
99003
|
+
* Star: 7 Points
|
|
99004
|
+
* @remarks
|
|
99005
|
+
* [Api set: PowerPointApi 1.4]
|
|
99006
|
+
*/
|
|
99007
|
+
star7 = "Star7",
|
|
99008
|
+
/**
|
|
99009
|
+
* Star: 8 Points
|
|
99010
|
+
* @remarks
|
|
99011
|
+
* [Api set: PowerPointApi 1.4]
|
|
99012
|
+
*/
|
|
99013
|
+
star8 = "Star8",
|
|
99014
|
+
/**
|
|
99015
|
+
* Star: 10 Points
|
|
99016
|
+
* @remarks
|
|
99017
|
+
* [Api set: PowerPointApi 1.4]
|
|
99018
|
+
*/
|
|
99019
|
+
star10 = "Star10",
|
|
99020
|
+
/**
|
|
99021
|
+
* Star: 12 Points
|
|
99022
|
+
* @remarks
|
|
99023
|
+
* [Api set: PowerPointApi 1.4]
|
|
99024
|
+
*/
|
|
99025
|
+
star12 = "Star12",
|
|
99026
|
+
/**
|
|
99027
|
+
* Star: 16 Points
|
|
99028
|
+
* @remarks
|
|
99029
|
+
* [Api set: PowerPointApi 1.4]
|
|
99030
|
+
*/
|
|
99031
|
+
star16 = "Star16",
|
|
99032
|
+
/**
|
|
99033
|
+
* Star: 24 Points
|
|
99034
|
+
* @remarks
|
|
99035
|
+
* [Api set: PowerPointApi 1.4]
|
|
99036
|
+
*/
|
|
99037
|
+
star24 = "Star24",
|
|
99038
|
+
/**
|
|
99039
|
+
* Star: 32 Points
|
|
99040
|
+
* @remarks
|
|
99041
|
+
* [Api set: PowerPointApi 1.4]
|
|
99042
|
+
*/
|
|
99043
|
+
star32 = "Star32",
|
|
99044
|
+
/**
|
|
99045
|
+
* Rectangle: Rounded Corners
|
|
99046
|
+
* @remarks
|
|
99047
|
+
* [Api set: PowerPointApi 1.4]
|
|
99048
|
+
*/
|
|
99049
|
+
roundRectangle = "RoundRectangle",
|
|
99050
|
+
/**
|
|
99051
|
+
* Rectangle: Single Corner Rounded
|
|
99052
|
+
* @remarks
|
|
99053
|
+
* [Api set: PowerPointApi 1.4]
|
|
99054
|
+
*/
|
|
99055
|
+
round1Rectangle = "Round1Rectangle",
|
|
99056
|
+
/**
|
|
99057
|
+
* Rectangle: Top Corners Rounded
|
|
99058
|
+
* @remarks
|
|
99059
|
+
* [Api set: PowerPointApi 1.4]
|
|
99060
|
+
*/
|
|
99061
|
+
round2SameRectangle = "Round2SameRectangle",
|
|
99062
|
+
/**
|
|
99063
|
+
* Rectangle: Diagonal Corners Rounded
|
|
99064
|
+
* @remarks
|
|
99065
|
+
* [Api set: PowerPointApi 1.4]
|
|
99066
|
+
*/
|
|
99067
|
+
round2DiagonalRectangle = "Round2DiagonalRectangle",
|
|
99068
|
+
/**
|
|
99069
|
+
* Rectangle: Top Corners One Rounded and One Snipped
|
|
99070
|
+
* @remarks
|
|
99071
|
+
* [Api set: PowerPointApi 1.4]
|
|
99072
|
+
*/
|
|
99073
|
+
snipRoundRectangle = "SnipRoundRectangle",
|
|
99074
|
+
/**
|
|
99075
|
+
* Rectangle: Single Corner Snipped
|
|
99076
|
+
* @remarks
|
|
99077
|
+
* [Api set: PowerPointApi 1.4]
|
|
99078
|
+
*/
|
|
99079
|
+
snip1Rectangle = "Snip1Rectangle",
|
|
99080
|
+
/**
|
|
99081
|
+
* Rectangle: Top Corners Snipped
|
|
99082
|
+
* @remarks
|
|
99083
|
+
* [Api set: PowerPointApi 1.4]
|
|
99084
|
+
*/
|
|
99085
|
+
snip2SameRectangle = "Snip2SameRectangle",
|
|
99086
|
+
/**
|
|
99087
|
+
* Rectangle: Diagonal Corners Snipped
|
|
99088
|
+
* @remarks
|
|
99089
|
+
* [Api set: PowerPointApi 1.4]
|
|
99090
|
+
*/
|
|
99091
|
+
snip2DiagonalRectangle = "Snip2DiagonalRectangle",
|
|
99092
|
+
/**
|
|
99093
|
+
* Plaque
|
|
99094
|
+
* @remarks
|
|
99095
|
+
* [Api set: PowerPointApi 1.4]
|
|
99096
|
+
*/
|
|
99097
|
+
plaque = "Plaque",
|
|
99098
|
+
/**
|
|
99099
|
+
* Oval
|
|
99100
|
+
* @remarks
|
|
99101
|
+
* [Api set: PowerPointApi 1.4]
|
|
99102
|
+
*/
|
|
99103
|
+
ellipse = "Ellipse",
|
|
99104
|
+
/**
|
|
99105
|
+
* Teardrop
|
|
99106
|
+
* @remarks
|
|
99107
|
+
* [Api set: PowerPointApi 1.4]
|
|
99108
|
+
*/
|
|
99109
|
+
teardrop = "Teardrop",
|
|
99110
|
+
/**
|
|
99111
|
+
* Arrow: Pentagon
|
|
99112
|
+
* @remarks
|
|
99113
|
+
* [Api set: PowerPointApi 1.4]
|
|
99114
|
+
*/
|
|
99115
|
+
homePlate = "HomePlate",
|
|
99116
|
+
/**
|
|
99117
|
+
* Arrow: Chevron
|
|
99118
|
+
* @remarks
|
|
99119
|
+
* [Api set: PowerPointApi 1.4]
|
|
99120
|
+
*/
|
|
99121
|
+
chevron = "Chevron",
|
|
99122
|
+
/**
|
|
99123
|
+
* Partial Circle
|
|
99124
|
+
* @remarks
|
|
99125
|
+
* [Api set: PowerPointApi 1.4]
|
|
99126
|
+
*/
|
|
99127
|
+
pieWedge = "PieWedge",
|
|
99128
|
+
/**
|
|
99129
|
+
* Partial Circle with Adjustable Spanning Area
|
|
99130
|
+
* @remarks
|
|
99131
|
+
* [Api set: PowerPointApi 1.4]
|
|
99132
|
+
*/
|
|
99133
|
+
pie = "Pie",
|
|
99134
|
+
/**
|
|
99135
|
+
* Block Arc
|
|
99136
|
+
* @remarks
|
|
99137
|
+
* [Api set: PowerPointApi 1.4]
|
|
99138
|
+
*/
|
|
99139
|
+
blockArc = "BlockArc",
|
|
99140
|
+
/**
|
|
99141
|
+
* Circle: Hollow
|
|
99142
|
+
* @remarks
|
|
99143
|
+
* [Api set: PowerPointApi 1.4]
|
|
99144
|
+
*/
|
|
99145
|
+
donut = "Donut",
|
|
99146
|
+
/**
|
|
99147
|
+
* "Not Allowed" Symbol
|
|
99148
|
+
* @remarks
|
|
99149
|
+
* [Api set: PowerPointApi 1.4]
|
|
99150
|
+
*/
|
|
99151
|
+
noSmoking = "NoSmoking",
|
|
99152
|
+
/**
|
|
99153
|
+
* Arrow: Right
|
|
99154
|
+
* @remarks
|
|
99155
|
+
* [Api set: PowerPointApi 1.4]
|
|
99156
|
+
*/
|
|
99157
|
+
rightArrow = "RightArrow",
|
|
99158
|
+
/**
|
|
99159
|
+
* Arrow: Left
|
|
99160
|
+
* @remarks
|
|
99161
|
+
* [Api set: PowerPointApi 1.4]
|
|
99162
|
+
*/
|
|
99163
|
+
leftArrow = "LeftArrow",
|
|
99164
|
+
/**
|
|
99165
|
+
* Arrow: Up
|
|
99166
|
+
* @remarks
|
|
99167
|
+
* [Api set: PowerPointApi 1.4]
|
|
99168
|
+
*/
|
|
99169
|
+
upArrow = "UpArrow",
|
|
99170
|
+
/**
|
|
99171
|
+
* Arrow: Down
|
|
99172
|
+
* @remarks
|
|
99173
|
+
* [Api set: PowerPointApi 1.4]
|
|
99174
|
+
*/
|
|
99175
|
+
downArrow = "DownArrow",
|
|
99176
|
+
/**
|
|
99177
|
+
* Arrow: Striped Right
|
|
99178
|
+
* @remarks
|
|
99179
|
+
* [Api set: PowerPointApi 1.4]
|
|
99180
|
+
*/
|
|
99181
|
+
stripedRightArrow = "StripedRightArrow",
|
|
99182
|
+
/**
|
|
99183
|
+
* Arrow: Notched Right
|
|
99184
|
+
* @remarks
|
|
99185
|
+
* [Api set: PowerPointApi 1.4]
|
|
99186
|
+
*/
|
|
99187
|
+
notchedRightArrow = "NotchedRightArrow",
|
|
99188
|
+
/**
|
|
99189
|
+
* Arrow: Bent-Up
|
|
99190
|
+
* @remarks
|
|
99191
|
+
* [Api set: PowerPointApi 1.4]
|
|
99192
|
+
*/
|
|
99193
|
+
bentUpArrow = "BentUpArrow",
|
|
99194
|
+
/**
|
|
99195
|
+
* Arrow: Left-Right
|
|
99196
|
+
* @remarks
|
|
99197
|
+
* [Api set: PowerPointApi 1.4]
|
|
99198
|
+
*/
|
|
99199
|
+
leftRightArrow = "LeftRightArrow",
|
|
99200
|
+
/**
|
|
99201
|
+
* Arrow: Up-Down
|
|
99202
|
+
* @remarks
|
|
99203
|
+
* [Api set: PowerPointApi 1.4]
|
|
99204
|
+
*/
|
|
99205
|
+
upDownArrow = "UpDownArrow",
|
|
99206
|
+
/**
|
|
99207
|
+
* Arrow: Left-Up
|
|
99208
|
+
* @remarks
|
|
99209
|
+
* [Api set: PowerPointApi 1.4]
|
|
99210
|
+
*/
|
|
99211
|
+
leftUpArrow = "LeftUpArrow",
|
|
99212
|
+
/**
|
|
99213
|
+
* Arrow: Left-Right-Up
|
|
99214
|
+
* @remarks
|
|
99215
|
+
* [Api set: PowerPointApi 1.4]
|
|
99216
|
+
*/
|
|
99217
|
+
leftRightUpArrow = "LeftRightUpArrow",
|
|
99218
|
+
/**
|
|
99219
|
+
* Arrow: Quad
|
|
99220
|
+
* @remarks
|
|
99221
|
+
* [Api set: PowerPointApi 1.4]
|
|
99222
|
+
*/
|
|
99223
|
+
quadArrow = "QuadArrow",
|
|
99224
|
+
/**
|
|
99225
|
+
* Callout: Left Arrow
|
|
99226
|
+
* @remarks
|
|
99227
|
+
* [Api set: PowerPointApi 1.4]
|
|
99228
|
+
*/
|
|
99229
|
+
leftArrowCallout = "LeftArrowCallout",
|
|
99230
|
+
/**
|
|
99231
|
+
* Callout: Right Arrow
|
|
99232
|
+
* @remarks
|
|
99233
|
+
* [Api set: PowerPointApi 1.4]
|
|
99234
|
+
*/
|
|
99235
|
+
rightArrowCallout = "RightArrowCallout",
|
|
99236
|
+
/**
|
|
99237
|
+
* Callout: Up Arrow
|
|
99238
|
+
* @remarks
|
|
99239
|
+
* [Api set: PowerPointApi 1.4]
|
|
99240
|
+
*/
|
|
99241
|
+
upArrowCallout = "UpArrowCallout",
|
|
99242
|
+
/**
|
|
99243
|
+
* Callout: Down Arrow
|
|
99244
|
+
* @remarks
|
|
99245
|
+
* [Api set: PowerPointApi 1.4]
|
|
99246
|
+
*/
|
|
99247
|
+
downArrowCallout = "DownArrowCallout",
|
|
99248
|
+
/**
|
|
99249
|
+
* Callout: Left-Right Arrow
|
|
99250
|
+
* @remarks
|
|
99251
|
+
* [Api set: PowerPointApi 1.4]
|
|
99252
|
+
*/
|
|
99253
|
+
leftRightArrowCallout = "LeftRightArrowCallout",
|
|
99254
|
+
/**
|
|
99255
|
+
* Callout: Up-Down Arrow
|
|
99256
|
+
* @remarks
|
|
99257
|
+
* [Api set: PowerPointApi 1.4]
|
|
99258
|
+
*/
|
|
99259
|
+
upDownArrowCallout = "UpDownArrowCallout",
|
|
99260
|
+
/**
|
|
99261
|
+
* Callout: Quad Arrow
|
|
99262
|
+
* @remarks
|
|
99263
|
+
* [Api set: PowerPointApi 1.4]
|
|
99264
|
+
*/
|
|
99265
|
+
quadArrowCallout = "QuadArrowCallout",
|
|
99266
|
+
/**
|
|
99267
|
+
* Arrow: Bent
|
|
99268
|
+
* @remarks
|
|
99269
|
+
* [Api set: PowerPointApi 1.4]
|
|
99270
|
+
*/
|
|
99271
|
+
bentArrow = "BentArrow",
|
|
99272
|
+
/**
|
|
99273
|
+
* Arrow: U-Turn
|
|
99274
|
+
* @remarks
|
|
99275
|
+
* [Api set: PowerPointApi 1.4]
|
|
99276
|
+
*/
|
|
99277
|
+
uturnArrow = "UturnArrow",
|
|
99278
|
+
/**
|
|
99279
|
+
* Arrow: Circular
|
|
99280
|
+
* @remarks
|
|
99281
|
+
* [Api set: PowerPointApi 1.4]
|
|
99282
|
+
*/
|
|
99283
|
+
circularArrow = "CircularArrow",
|
|
99284
|
+
/**
|
|
99285
|
+
* Arrow: Circular with Opposite Arrow Direction
|
|
99286
|
+
* @remarks
|
|
99287
|
+
* [Api set: PowerPointApi 1.4]
|
|
99288
|
+
*/
|
|
99289
|
+
leftCircularArrow = "LeftCircularArrow",
|
|
99290
|
+
/**
|
|
99291
|
+
* Arrow: Circular with Two Arrows in Both Directions
|
|
99292
|
+
* @remarks
|
|
99293
|
+
* [Api set: PowerPointApi 1.4]
|
|
99294
|
+
*/
|
|
99295
|
+
leftRightCircularArrow = "LeftRightCircularArrow",
|
|
99296
|
+
/**
|
|
99297
|
+
* Arrow: Curved Right
|
|
99298
|
+
* @remarks
|
|
99299
|
+
* [Api set: PowerPointApi 1.4]
|
|
99300
|
+
*/
|
|
99301
|
+
curvedRightArrow = "CurvedRightArrow",
|
|
99302
|
+
/**
|
|
99303
|
+
* Arrow: Curved Left
|
|
99304
|
+
* @remarks
|
|
99305
|
+
* [Api set: PowerPointApi 1.4]
|
|
99306
|
+
*/
|
|
99307
|
+
curvedLeftArrow = "CurvedLeftArrow",
|
|
99308
|
+
/**
|
|
99309
|
+
* Arrow: Curved Up
|
|
99310
|
+
* @remarks
|
|
99311
|
+
* [Api set: PowerPointApi 1.4]
|
|
99312
|
+
*/
|
|
99313
|
+
curvedUpArrow = "CurvedUpArrow",
|
|
99314
|
+
/**
|
|
99315
|
+
* Arrow: Curved Down
|
|
99316
|
+
* @remarks
|
|
99317
|
+
* [Api set: PowerPointApi 1.4]
|
|
99318
|
+
*/
|
|
99319
|
+
curvedDownArrow = "CurvedDownArrow",
|
|
99320
|
+
/**
|
|
99321
|
+
* Arrow: Curved Right Arrow with Varying Width
|
|
99322
|
+
* @remarks
|
|
99323
|
+
* [Api set: PowerPointApi 1.4]
|
|
99324
|
+
*/
|
|
99325
|
+
swooshArrow = "SwooshArrow",
|
|
99326
|
+
/**
|
|
99327
|
+
* Cube
|
|
99328
|
+
* @remarks
|
|
99329
|
+
* [Api set: PowerPointApi 1.4]
|
|
99330
|
+
*/
|
|
99331
|
+
cube = "Cube",
|
|
99332
|
+
/**
|
|
99333
|
+
* Cylinder
|
|
99334
|
+
* @remarks
|
|
99335
|
+
* [Api set: PowerPointApi 1.4]
|
|
99336
|
+
*/
|
|
99337
|
+
can = "Can",
|
|
99338
|
+
/**
|
|
99339
|
+
* Lightning Bolt
|
|
99340
|
+
* @remarks
|
|
99341
|
+
* [Api set: PowerPointApi 1.4]
|
|
99342
|
+
*/
|
|
99343
|
+
lightningBolt = "LightningBolt",
|
|
99344
|
+
/**
|
|
99345
|
+
* Heart
|
|
99346
|
+
* @remarks
|
|
99347
|
+
* [Api set: PowerPointApi 1.4]
|
|
99348
|
+
*/
|
|
99349
|
+
heart = "Heart",
|
|
99350
|
+
/**
|
|
99351
|
+
* Sun
|
|
99352
|
+
* @remarks
|
|
99353
|
+
* [Api set: PowerPointApi 1.4]
|
|
99354
|
+
*/
|
|
99355
|
+
sun = "Sun",
|
|
99356
|
+
/**
|
|
99357
|
+
* Moon
|
|
99358
|
+
* @remarks
|
|
99359
|
+
* [Api set: PowerPointApi 1.4]
|
|
99360
|
+
*/
|
|
99361
|
+
moon = "Moon",
|
|
99362
|
+
/**
|
|
99363
|
+
* Smiley Face
|
|
99364
|
+
* @remarks
|
|
99365
|
+
* [Api set: PowerPointApi 1.4]
|
|
99366
|
+
*/
|
|
99367
|
+
smileyFace = "SmileyFace",
|
|
99368
|
+
/**
|
|
99369
|
+
* Explosion: 8 Points
|
|
99370
|
+
* @remarks
|
|
99371
|
+
* [Api set: PowerPointApi 1.4]
|
|
99372
|
+
*/
|
|
99373
|
+
irregularSeal1 = "IrregularSeal1",
|
|
99374
|
+
/**
|
|
99375
|
+
* Explosion: 14 Points
|
|
99376
|
+
* @remarks
|
|
99377
|
+
* [Api set: PowerPointApi 1.4]
|
|
99378
|
+
*/
|
|
99379
|
+
irregularSeal2 = "IrregularSeal2",
|
|
99380
|
+
/**
|
|
99381
|
+
* Rectangle: Folded Corner
|
|
99382
|
+
* @remarks
|
|
99383
|
+
* [Api set: PowerPointApi 1.4]
|
|
99384
|
+
*/
|
|
99385
|
+
foldedCorner = "FoldedCorner",
|
|
99386
|
+
/**
|
|
99387
|
+
* Rectangle: Beveled
|
|
99388
|
+
* @remarks
|
|
99389
|
+
* [Api set: PowerPointApi 1.4]
|
|
99390
|
+
*/
|
|
99391
|
+
bevel = "Bevel",
|
|
99392
|
+
/**
|
|
99393
|
+
* Frame
|
|
99394
|
+
* @remarks
|
|
99395
|
+
* [Api set: PowerPointApi 1.4]
|
|
99396
|
+
*/
|
|
99397
|
+
frame = "Frame",
|
|
99398
|
+
/**
|
|
99399
|
+
* Half Frame
|
|
99400
|
+
* @remarks
|
|
99401
|
+
* [Api set: PowerPointApi 1.4]
|
|
99402
|
+
*/
|
|
99403
|
+
halfFrame = "HalfFrame",
|
|
99404
|
+
/**
|
|
99405
|
+
* L-Shape
|
|
99406
|
+
* @remarks
|
|
99407
|
+
* [Api set: PowerPointApi 1.4]
|
|
99408
|
+
*/
|
|
99409
|
+
corner = "Corner",
|
|
99410
|
+
/**
|
|
99411
|
+
* Diagonal Stripe
|
|
99412
|
+
* @remarks
|
|
99413
|
+
* [Api set: PowerPointApi 1.4]
|
|
99414
|
+
*/
|
|
99415
|
+
diagonalStripe = "DiagonalStripe",
|
|
99416
|
+
/**
|
|
99417
|
+
* Chord
|
|
99418
|
+
* @remarks
|
|
99419
|
+
* [Api set: PowerPointApi 1.4]
|
|
99420
|
+
*/
|
|
99421
|
+
chord = "Chord",
|
|
99422
|
+
/**
|
|
99423
|
+
* Arc
|
|
99424
|
+
* @remarks
|
|
99425
|
+
* [Api set: PowerPointApi 1.4]
|
|
99426
|
+
*/
|
|
99427
|
+
arc = "Arc",
|
|
99428
|
+
/**
|
|
99429
|
+
* Left Bracket
|
|
99430
|
+
* @remarks
|
|
99431
|
+
* [Api set: PowerPointApi 1.4]
|
|
99432
|
+
*/
|
|
99433
|
+
leftBracket = "LeftBracket",
|
|
99434
|
+
/**
|
|
99435
|
+
* Right Bracket
|
|
99436
|
+
* @remarks
|
|
99437
|
+
* [Api set: PowerPointApi 1.4]
|
|
99438
|
+
*/
|
|
99439
|
+
rightBracket = "RightBracket",
|
|
99440
|
+
/**
|
|
99441
|
+
* Left Brace
|
|
99442
|
+
* @remarks
|
|
99443
|
+
* [Api set: PowerPointApi 1.4]
|
|
99444
|
+
*/
|
|
99445
|
+
leftBrace = "LeftBrace",
|
|
99446
|
+
/**
|
|
99447
|
+
* Right Brace
|
|
99448
|
+
* @remarks
|
|
99449
|
+
* [Api set: PowerPointApi 1.4]
|
|
99450
|
+
*/
|
|
99451
|
+
rightBrace = "RightBrace",
|
|
99452
|
+
/**
|
|
99453
|
+
* Double Bracket
|
|
99454
|
+
* @remarks
|
|
99455
|
+
* [Api set: PowerPointApi 1.4]
|
|
99456
|
+
*/
|
|
99457
|
+
bracketPair = "BracketPair",
|
|
99458
|
+
/**
|
|
99459
|
+
* Double Brace
|
|
99460
|
+
* @remarks
|
|
99461
|
+
* [Api set: PowerPointApi 1.4]
|
|
99462
|
+
*/
|
|
99463
|
+
bracePair = "BracePair",
|
|
99464
|
+
/**
|
|
99465
|
+
* Callout: Line with No Border
|
|
99466
|
+
* @remarks
|
|
99467
|
+
* [Api set: PowerPointApi 1.4]
|
|
99468
|
+
*/
|
|
99469
|
+
callout1 = "Callout1",
|
|
99470
|
+
/**
|
|
99471
|
+
* Callout: Bent Line with No Border
|
|
99472
|
+
* @remarks
|
|
99473
|
+
* [Api set: PowerPointApi 1.4]
|
|
99474
|
+
*/
|
|
99475
|
+
callout2 = "Callout2",
|
|
99476
|
+
/**
|
|
99477
|
+
* Callout: Double Bent Line with No Border
|
|
99478
|
+
* @remarks
|
|
99479
|
+
* [Api set: PowerPointApi 1.4]
|
|
99480
|
+
*/
|
|
99481
|
+
callout3 = "Callout3",
|
|
99482
|
+
/**
|
|
99483
|
+
* Callout: Line with Accent Bar
|
|
99484
|
+
* @remarks
|
|
99485
|
+
* [Api set: PowerPointApi 1.4]
|
|
99486
|
+
*/
|
|
99487
|
+
accentCallout1 = "AccentCallout1",
|
|
99488
|
+
/**
|
|
99489
|
+
* Callout: Bent Line with Accent Bar
|
|
99490
|
+
* @remarks
|
|
99491
|
+
* [Api set: PowerPointApi 1.4]
|
|
99492
|
+
*/
|
|
99493
|
+
accentCallout2 = "AccentCallout2",
|
|
99494
|
+
/**
|
|
99495
|
+
* Callout: Double Bent Line with Accent Bar
|
|
99496
|
+
* @remarks
|
|
99497
|
+
* [Api set: PowerPointApi 1.4]
|
|
99498
|
+
*/
|
|
99499
|
+
accentCallout3 = "AccentCallout3",
|
|
99500
|
+
/**
|
|
99501
|
+
* Callout: Line
|
|
99502
|
+
* @remarks
|
|
99503
|
+
* [Api set: PowerPointApi 1.4]
|
|
99504
|
+
*/
|
|
99505
|
+
borderCallout1 = "BorderCallout1",
|
|
99506
|
+
/**
|
|
99507
|
+
* Callout: Bent Line
|
|
99508
|
+
* @remarks
|
|
99509
|
+
* [Api set: PowerPointApi 1.4]
|
|
99510
|
+
*/
|
|
99511
|
+
borderCallout2 = "BorderCallout2",
|
|
99512
|
+
/**
|
|
99513
|
+
* Callout: Double Bent Line
|
|
99514
|
+
* @remarks
|
|
99515
|
+
* [Api set: PowerPointApi 1.4]
|
|
99516
|
+
*/
|
|
99517
|
+
borderCallout3 = "BorderCallout3",
|
|
99518
|
+
/**
|
|
99519
|
+
* Callout: Line with Border and Accent Bar
|
|
99520
|
+
* @remarks
|
|
99521
|
+
* [Api set: PowerPointApi 1.4]
|
|
99522
|
+
*/
|
|
99523
|
+
accentBorderCallout1 = "AccentBorderCallout1",
|
|
99524
|
+
/**
|
|
99525
|
+
* Callout: Bent Line with Border and Accent Bar
|
|
99526
|
+
* @remarks
|
|
99527
|
+
* [Api set: PowerPointApi 1.4]
|
|
99528
|
+
*/
|
|
99529
|
+
accentBorderCallout2 = "AccentBorderCallout2",
|
|
99530
|
+
/**
|
|
99531
|
+
* Callout: Double Bent Line with Border and Accent Bar
|
|
99532
|
+
* @remarks
|
|
99533
|
+
* [Api set: PowerPointApi 1.4]
|
|
99534
|
+
*/
|
|
99535
|
+
accentBorderCallout3 = "AccentBorderCallout3",
|
|
99536
|
+
/**
|
|
99537
|
+
* Speech Bubble: Rectangle
|
|
99538
|
+
* @remarks
|
|
99539
|
+
* [Api set: PowerPointApi 1.4]
|
|
99540
|
+
*/
|
|
99541
|
+
wedgeRectCallout = "WedgeRectCallout",
|
|
99542
|
+
/**
|
|
99543
|
+
* Speech Bubble: Rectangle with Corners Rounded
|
|
99544
|
+
* @remarks
|
|
99545
|
+
* [Api set: PowerPointApi 1.4]
|
|
99546
|
+
*/
|
|
99547
|
+
wedgeRRectCallout = "WedgeRRectCallout",
|
|
99548
|
+
/**
|
|
99549
|
+
* Speech Bubble: Oval
|
|
99550
|
+
* @remarks
|
|
99551
|
+
* [Api set: PowerPointApi 1.4]
|
|
99552
|
+
*/
|
|
99553
|
+
wedgeEllipseCallout = "WedgeEllipseCallout",
|
|
99554
|
+
/**
|
|
99555
|
+
* Thought Bubble: Cloud
|
|
99556
|
+
* @remarks
|
|
99557
|
+
* [Api set: PowerPointApi 1.4]
|
|
99558
|
+
*/
|
|
99559
|
+
cloudCallout = "CloudCallout",
|
|
99560
|
+
/**
|
|
99561
|
+
* Cloud
|
|
99562
|
+
* @remarks
|
|
99563
|
+
* [Api set: PowerPointApi 1.4]
|
|
99564
|
+
*/
|
|
99565
|
+
cloud = "Cloud",
|
|
99566
|
+
/**
|
|
99567
|
+
* Ribbon: Tilted Down
|
|
99568
|
+
* @remarks
|
|
99569
|
+
* [Api set: PowerPointApi 1.4]
|
|
99570
|
+
*/
|
|
99571
|
+
ribbon = "Ribbon",
|
|
99572
|
+
/**
|
|
99573
|
+
* Ribbon: Tilted Up
|
|
99574
|
+
* @remarks
|
|
99575
|
+
* [Api set: PowerPointApi 1.4]
|
|
99576
|
+
*/
|
|
99577
|
+
ribbon2 = "Ribbon2",
|
|
99578
|
+
/**
|
|
99579
|
+
* Ribbon: Curved and Tilted Down
|
|
99580
|
+
* @remarks
|
|
99581
|
+
* [Api set: PowerPointApi 1.4]
|
|
99582
|
+
*/
|
|
99583
|
+
ellipseRibbon = "EllipseRibbon",
|
|
99584
|
+
/**
|
|
99585
|
+
* Ribbon: Curved and Tilted Up
|
|
99586
|
+
* @remarks
|
|
99587
|
+
* [Api set: PowerPointApi 1.4]
|
|
99588
|
+
*/
|
|
99589
|
+
ellipseRibbon2 = "EllipseRibbon2",
|
|
99590
|
+
/**
|
|
99591
|
+
* Ribbon: Straight with Both Left and Right Arrows
|
|
99592
|
+
* @remarks
|
|
99593
|
+
* [Api set: PowerPointApi 1.4]
|
|
99594
|
+
*/
|
|
99595
|
+
leftRightRibbon = "LeftRightRibbon",
|
|
99596
|
+
/**
|
|
99597
|
+
* Scroll: Vertical
|
|
99598
|
+
* @remarks
|
|
99599
|
+
* [Api set: PowerPointApi 1.4]
|
|
99600
|
+
*/
|
|
99601
|
+
verticalScroll = "VerticalScroll",
|
|
99602
|
+
/**
|
|
99603
|
+
* Scroll: Horizontal
|
|
99604
|
+
* @remarks
|
|
99605
|
+
* [Api set: PowerPointApi 1.4]
|
|
99606
|
+
*/
|
|
99607
|
+
horizontalScroll = "HorizontalScroll",
|
|
99608
|
+
/**
|
|
99609
|
+
* Wave
|
|
99610
|
+
* @remarks
|
|
99611
|
+
* [Api set: PowerPointApi 1.4]
|
|
99612
|
+
*/
|
|
99613
|
+
wave = "Wave",
|
|
99614
|
+
/**
|
|
99615
|
+
* Double Wave
|
|
99616
|
+
* @remarks
|
|
99617
|
+
* [Api set: PowerPointApi 1.4]
|
|
99618
|
+
*/
|
|
99619
|
+
doubleWave = "DoubleWave",
|
|
99620
|
+
/**
|
|
99621
|
+
* Cross
|
|
99622
|
+
* @remarks
|
|
99623
|
+
* [Api set: PowerPointApi 1.4]
|
|
99624
|
+
*/
|
|
99625
|
+
plus = "Plus",
|
|
99626
|
+
/**
|
|
99627
|
+
* Flowchart: Process
|
|
99628
|
+
* @remarks
|
|
99629
|
+
* [Api set: PowerPointApi 1.4]
|
|
99630
|
+
*/
|
|
99631
|
+
flowChartProcess = "FlowChartProcess",
|
|
99632
|
+
/**
|
|
99633
|
+
* Flowchart: Decision
|
|
99634
|
+
* @remarks
|
|
99635
|
+
* [Api set: PowerPointApi 1.4]
|
|
99636
|
+
*/
|
|
99637
|
+
flowChartDecision = "FlowChartDecision",
|
|
99638
|
+
/**
|
|
99639
|
+
* Flowchart: Data
|
|
99640
|
+
* @remarks
|
|
99641
|
+
* [Api set: PowerPointApi 1.4]
|
|
99642
|
+
*/
|
|
99643
|
+
flowChartInputOutput = "FlowChartInputOutput",
|
|
99644
|
+
/**
|
|
99645
|
+
* Flowchart: Predefined Process
|
|
99646
|
+
* @remarks
|
|
99647
|
+
* [Api set: PowerPointApi 1.4]
|
|
99648
|
+
*/
|
|
99649
|
+
flowChartPredefinedProcess = "FlowChartPredefinedProcess",
|
|
99650
|
+
/**
|
|
99651
|
+
* Flowchart: Internal Storage
|
|
99652
|
+
* @remarks
|
|
99653
|
+
* [Api set: PowerPointApi 1.4]
|
|
99654
|
+
*/
|
|
99655
|
+
flowChartInternalStorage = "FlowChartInternalStorage",
|
|
99656
|
+
/**
|
|
99657
|
+
* Flowchart: Document
|
|
99658
|
+
* @remarks
|
|
99659
|
+
* [Api set: PowerPointApi 1.4]
|
|
99660
|
+
*/
|
|
99661
|
+
flowChartDocument = "FlowChartDocument",
|
|
99662
|
+
/**
|
|
99663
|
+
* Flowchart: Multidocument
|
|
99664
|
+
* @remarks
|
|
99665
|
+
* [Api set: PowerPointApi 1.4]
|
|
99666
|
+
*/
|
|
99667
|
+
flowChartMultidocument = "FlowChartMultidocument",
|
|
99668
|
+
/**
|
|
99669
|
+
* Flowchart: Terminator
|
|
99670
|
+
* @remarks
|
|
99671
|
+
* [Api set: PowerPointApi 1.4]
|
|
99672
|
+
*/
|
|
99673
|
+
flowChartTerminator = "FlowChartTerminator",
|
|
99674
|
+
/**
|
|
99675
|
+
* Flowchart: Preparation
|
|
99676
|
+
* @remarks
|
|
99677
|
+
* [Api set: PowerPointApi 1.4]
|
|
99678
|
+
*/
|
|
99679
|
+
flowChartPreparation = "FlowChartPreparation",
|
|
99680
|
+
/**
|
|
99681
|
+
* Flowchart: Manual Input
|
|
99682
|
+
* @remarks
|
|
99683
|
+
* [Api set: PowerPointApi 1.4]
|
|
99684
|
+
*/
|
|
99685
|
+
flowChartManualInput = "FlowChartManualInput",
|
|
99686
|
+
/**
|
|
99687
|
+
* Flowchart: Manual Operation
|
|
99688
|
+
* @remarks
|
|
99689
|
+
* [Api set: PowerPointApi 1.4]
|
|
99690
|
+
*/
|
|
99691
|
+
flowChartManualOperation = "FlowChartManualOperation",
|
|
99692
|
+
/**
|
|
99693
|
+
* Flowchart: Connector
|
|
99694
|
+
* @remarks
|
|
99695
|
+
* [Api set: PowerPointApi 1.4]
|
|
99696
|
+
*/
|
|
99697
|
+
flowChartConnector = "FlowChartConnector",
|
|
99698
|
+
/**
|
|
99699
|
+
* Flowchart: Card
|
|
99700
|
+
* @remarks
|
|
99701
|
+
* [Api set: PowerPointApi 1.4]
|
|
99702
|
+
*/
|
|
99703
|
+
flowChartPunchedCard = "FlowChartPunchedCard",
|
|
99704
|
+
/**
|
|
99705
|
+
* Flowchart: Punched Tape
|
|
99706
|
+
* @remarks
|
|
99707
|
+
* [Api set: PowerPointApi 1.4]
|
|
99708
|
+
*/
|
|
99709
|
+
flowChartPunchedTape = "FlowChartPunchedTape",
|
|
99710
|
+
/**
|
|
99711
|
+
* Flowchart: Summing Junction
|
|
99712
|
+
* @remarks
|
|
99713
|
+
* [Api set: PowerPointApi 1.4]
|
|
99714
|
+
*/
|
|
99715
|
+
flowChartSummingJunction = "FlowChartSummingJunction",
|
|
99716
|
+
/**
|
|
99717
|
+
* Flowchart: Or
|
|
99718
|
+
* @remarks
|
|
99719
|
+
* [Api set: PowerPointApi 1.4]
|
|
99720
|
+
*/
|
|
99721
|
+
flowChartOr = "FlowChartOr",
|
|
99722
|
+
/**
|
|
99723
|
+
* Flowchart: Collate
|
|
99724
|
+
* @remarks
|
|
99725
|
+
* [Api set: PowerPointApi 1.4]
|
|
99726
|
+
*/
|
|
99727
|
+
flowChartCollate = "FlowChartCollate",
|
|
99728
|
+
/**
|
|
99729
|
+
* Flowchart: Sort
|
|
99730
|
+
* @remarks
|
|
99731
|
+
* [Api set: PowerPointApi 1.4]
|
|
99732
|
+
*/
|
|
99733
|
+
flowChartSort = "FlowChartSort",
|
|
99734
|
+
/**
|
|
99735
|
+
* Flowchart: Extract
|
|
99736
|
+
* @remarks
|
|
99737
|
+
* [Api set: PowerPointApi 1.4]
|
|
99738
|
+
*/
|
|
99739
|
+
flowChartExtract = "FlowChartExtract",
|
|
99740
|
+
/**
|
|
99741
|
+
* Flowchart: Merge
|
|
99742
|
+
* @remarks
|
|
99743
|
+
* [Api set: PowerPointApi 1.4]
|
|
99744
|
+
*/
|
|
99745
|
+
flowChartMerge = "FlowChartMerge",
|
|
99746
|
+
/**
|
|
99747
|
+
* FlowChart: Offline Storage
|
|
99748
|
+
* @remarks
|
|
99749
|
+
* [Api set: PowerPointApi 1.4]
|
|
99750
|
+
*/
|
|
99751
|
+
flowChartOfflineStorage = "FlowChartOfflineStorage",
|
|
99752
|
+
/**
|
|
99753
|
+
* Flowchart: Stored Data
|
|
99754
|
+
* @remarks
|
|
99755
|
+
* [Api set: PowerPointApi 1.4]
|
|
99756
|
+
*/
|
|
99757
|
+
flowChartOnlineStorage = "FlowChartOnlineStorage",
|
|
99758
|
+
/**
|
|
99759
|
+
* Flowchart: Sequential Access Storage
|
|
99760
|
+
* @remarks
|
|
99761
|
+
* [Api set: PowerPointApi 1.4]
|
|
99762
|
+
*/
|
|
99763
|
+
flowChartMagneticTape = "FlowChartMagneticTape",
|
|
99764
|
+
/**
|
|
99765
|
+
* Flowchart: Magnetic Disk
|
|
99766
|
+
* @remarks
|
|
99767
|
+
* [Api set: PowerPointApi 1.4]
|
|
99768
|
+
*/
|
|
99769
|
+
flowChartMagneticDisk = "FlowChartMagneticDisk",
|
|
99770
|
+
/**
|
|
99771
|
+
* Flowchart: Direct Access Storage
|
|
99772
|
+
* @remarks
|
|
99773
|
+
* [Api set: PowerPointApi 1.4]
|
|
99774
|
+
*/
|
|
99775
|
+
flowChartMagneticDrum = "FlowChartMagneticDrum",
|
|
99776
|
+
/**
|
|
99777
|
+
* Flowchart: Display
|
|
99778
|
+
* @remarks
|
|
99779
|
+
* [Api set: PowerPointApi 1.4]
|
|
99780
|
+
*/
|
|
99781
|
+
flowChartDisplay = "FlowChartDisplay",
|
|
99782
|
+
/**
|
|
99783
|
+
* Flowchart: Delay
|
|
99784
|
+
* @remarks
|
|
99785
|
+
* [Api set: PowerPointApi 1.4]
|
|
99786
|
+
*/
|
|
99787
|
+
flowChartDelay = "FlowChartDelay",
|
|
99788
|
+
/**
|
|
99789
|
+
* Flowchart: Alternate Process
|
|
99790
|
+
* @remarks
|
|
99791
|
+
* [Api set: PowerPointApi 1.4]
|
|
99792
|
+
*/
|
|
99793
|
+
flowChartAlternateProcess = "FlowChartAlternateProcess",
|
|
99794
|
+
/**
|
|
99795
|
+
* Flowchart: Off-page Connector
|
|
99796
|
+
* @remarks
|
|
99797
|
+
* [Api set: PowerPointApi 1.4]
|
|
99798
|
+
*/
|
|
99799
|
+
flowChartOffpageConnector = "FlowChartOffpageConnector",
|
|
99800
|
+
/**
|
|
99801
|
+
* Action Button: Blank
|
|
99802
|
+
* @remarks
|
|
99803
|
+
* [Api set: PowerPointApi 1.4]
|
|
99804
|
+
*/
|
|
99805
|
+
actionButtonBlank = "ActionButtonBlank",
|
|
99806
|
+
/**
|
|
99807
|
+
* Action Button: Go Home
|
|
99808
|
+
* @remarks
|
|
99809
|
+
* [Api set: PowerPointApi 1.4]
|
|
99810
|
+
*/
|
|
99811
|
+
actionButtonHome = "ActionButtonHome",
|
|
99812
|
+
/**
|
|
99813
|
+
* Action Button: Help
|
|
99814
|
+
* @remarks
|
|
99815
|
+
* [Api set: PowerPointApi 1.4]
|
|
99816
|
+
*/
|
|
99817
|
+
actionButtonHelp = "ActionButtonHelp",
|
|
99818
|
+
/**
|
|
99819
|
+
* Action Button: Get Information
|
|
99820
|
+
* @remarks
|
|
99821
|
+
* [Api set: PowerPointApi 1.4]
|
|
99822
|
+
*/
|
|
99823
|
+
actionButtonInformation = "ActionButtonInformation",
|
|
99824
|
+
/**
|
|
99825
|
+
* Action Button: Go Forward or Next
|
|
99826
|
+
* @remarks
|
|
99827
|
+
* [Api set: PowerPointApi 1.4]
|
|
99828
|
+
*/
|
|
99829
|
+
actionButtonForwardNext = "ActionButtonForwardNext",
|
|
99830
|
+
/**
|
|
99831
|
+
* Action Button: Go Back or Previous
|
|
99832
|
+
* @remarks
|
|
99833
|
+
* [Api set: PowerPointApi 1.4]
|
|
99834
|
+
*/
|
|
99835
|
+
actionButtonBackPrevious = "ActionButtonBackPrevious",
|
|
99836
|
+
/**
|
|
99837
|
+
* Action Button: Go to End
|
|
99838
|
+
* @remarks
|
|
99839
|
+
* [Api set: PowerPointApi 1.4]
|
|
99840
|
+
*/
|
|
99841
|
+
actionButtonEnd = "ActionButtonEnd",
|
|
99842
|
+
/**
|
|
99843
|
+
* Action Button: Go to Beginning
|
|
99844
|
+
* @remarks
|
|
99845
|
+
* [Api set: PowerPointApi 1.4]
|
|
99846
|
+
*/
|
|
99847
|
+
actionButtonBeginning = "ActionButtonBeginning",
|
|
99848
|
+
/**
|
|
99849
|
+
* Action Button: Return
|
|
99850
|
+
* @remarks
|
|
99851
|
+
* [Api set: PowerPointApi 1.4]
|
|
99852
|
+
*/
|
|
99853
|
+
actionButtonReturn = "ActionButtonReturn",
|
|
99854
|
+
/**
|
|
99855
|
+
* Action Button: Document
|
|
99856
|
+
* @remarks
|
|
99857
|
+
* [Api set: PowerPointApi 1.4]
|
|
99858
|
+
*/
|
|
99859
|
+
actionButtonDocument = "ActionButtonDocument",
|
|
99860
|
+
/**
|
|
99861
|
+
* Action Button: Sound
|
|
99862
|
+
* @remarks
|
|
99863
|
+
* [Api set: PowerPointApi 1.4]
|
|
99864
|
+
*/
|
|
99865
|
+
actionButtonSound = "ActionButtonSound",
|
|
99866
|
+
/**
|
|
99867
|
+
* Action Button: Video
|
|
99868
|
+
* @remarks
|
|
99869
|
+
* [Api set: PowerPointApi 1.4]
|
|
99870
|
+
*/
|
|
99871
|
+
actionButtonMovie = "ActionButtonMovie",
|
|
99872
|
+
/**
|
|
99873
|
+
* Gear: A Gear with Six Teeth
|
|
99874
|
+
* @remarks
|
|
99875
|
+
* [Api set: PowerPointApi 1.4]
|
|
99876
|
+
*/
|
|
99877
|
+
gear6 = "Gear6",
|
|
99878
|
+
/**
|
|
99879
|
+
* Gear: A Gear with Nine Teeth
|
|
99880
|
+
* @remarks
|
|
99881
|
+
* [Api set: PowerPointApi 1.4]
|
|
99882
|
+
*/
|
|
99883
|
+
gear9 = "Gear9",
|
|
99884
|
+
/**
|
|
99885
|
+
* Funnel
|
|
99886
|
+
* @remarks
|
|
99887
|
+
* [Api set: PowerPointApi 1.4]
|
|
99888
|
+
*/
|
|
99889
|
+
funnel = "Funnel",
|
|
99890
|
+
/**
|
|
99891
|
+
* Plus Sign
|
|
99892
|
+
* @remarks
|
|
99893
|
+
* [Api set: PowerPointApi 1.4]
|
|
99894
|
+
*/
|
|
99895
|
+
mathPlus = "MathPlus",
|
|
99896
|
+
/**
|
|
99897
|
+
* Minus Sign
|
|
99898
|
+
* @remarks
|
|
99899
|
+
* [Api set: PowerPointApi 1.4]
|
|
99900
|
+
*/
|
|
99901
|
+
mathMinus = "MathMinus",
|
|
99902
|
+
/**
|
|
99903
|
+
* Multiplication Sign
|
|
99904
|
+
* @remarks
|
|
99905
|
+
* [Api set: PowerPointApi 1.4]
|
|
99906
|
+
*/
|
|
99907
|
+
mathMultiply = "MathMultiply",
|
|
99908
|
+
/**
|
|
99909
|
+
* Division Sign
|
|
99910
|
+
* @remarks
|
|
99911
|
+
* [Api set: PowerPointApi 1.4]
|
|
99912
|
+
*/
|
|
99913
|
+
mathDivide = "MathDivide",
|
|
99914
|
+
/**
|
|
99915
|
+
* Equals
|
|
99916
|
+
* @remarks
|
|
99917
|
+
* [Api set: PowerPointApi 1.4]
|
|
99918
|
+
*/
|
|
99919
|
+
mathEqual = "MathEqual",
|
|
99920
|
+
/**
|
|
99921
|
+
* Not Equal
|
|
99922
|
+
* @remarks
|
|
99923
|
+
* [Api set: PowerPointApi 1.4]
|
|
99924
|
+
*/
|
|
99925
|
+
mathNotEqual = "MathNotEqual",
|
|
99926
|
+
/**
|
|
99927
|
+
* Four Right Triangles that Define a Rectangular Shape
|
|
99928
|
+
* @remarks
|
|
99929
|
+
* [Api set: PowerPointApi 1.4]
|
|
99930
|
+
*/
|
|
99931
|
+
cornerTabs = "CornerTabs",
|
|
99932
|
+
/**
|
|
99933
|
+
* Four Small Squares that Define a Rectangular Shape.
|
|
99934
|
+
* @remarks
|
|
99935
|
+
* [Api set: PowerPointApi 1.4]
|
|
99936
|
+
*/
|
|
99937
|
+
squareTabs = "SquareTabs",
|
|
99938
|
+
/**
|
|
99939
|
+
* Four Quarter Circles that Define a Rectangular Shape.
|
|
99940
|
+
* @remarks
|
|
99941
|
+
* [Api set: PowerPointApi 1.4]
|
|
99942
|
+
*/
|
|
99943
|
+
plaqueTabs = "PlaqueTabs",
|
|
99944
|
+
/**
|
|
99945
|
+
* A Rectangle Divided into Four Parts Along Diagonal Lines.
|
|
99946
|
+
* @remarks
|
|
99947
|
+
* [Api set: PowerPointApi 1.4]
|
|
99948
|
+
*/
|
|
99949
|
+
chartX = "ChartX",
|
|
99950
|
+
/**
|
|
99951
|
+
* A Rectangle Divided into Six Parts Along a Vertical Line and Diagonal Lines.
|
|
99952
|
+
* @remarks
|
|
99953
|
+
* [Api set: PowerPointApi 1.4]
|
|
99954
|
+
*/
|
|
99955
|
+
chartStar = "ChartStar",
|
|
99956
|
+
/**
|
|
99957
|
+
* A Rectangle Divided Vertically and Horizontally into Four Quarters.
|
|
99958
|
+
* @remarks
|
|
99959
|
+
* [Api set: PowerPointApi 1.4]
|
|
99960
|
+
*/
|
|
99961
|
+
chartPlus = "ChartPlus",
|
|
99962
|
+
}
|
|
98824
99963
|
/**
|
|
98825
99964
|
* Specifies the formatting options for when slides are inserted.
|
|
98826
99965
|
*
|
|
98827
99966
|
* @remarks
|
|
98828
|
-
* [Api set: PowerPointApi 1.2]
|
|
99967
|
+
* [Api set: PowerPointApi 1.2]
|
|
99968
|
+
*/
|
|
99969
|
+
enum InsertSlideFormatting {
|
|
99970
|
+
/**
|
|
99971
|
+
* Copy the source theme into the target presentation and use that theme.
|
|
99972
|
+
* @remarks
|
|
99973
|
+
* [Api set: PowerPointApi 1.2]
|
|
99974
|
+
*/
|
|
99975
|
+
keepSourceFormatting = "KeepSourceFormatting",
|
|
99976
|
+
/**
|
|
99977
|
+
* Use the existing theme in the target presentation.
|
|
99978
|
+
* @remarks
|
|
99979
|
+
* [Api set: PowerPointApi 1.2]
|
|
99980
|
+
*/
|
|
99981
|
+
useDestinationTheme = "UseDestinationTheme",
|
|
99982
|
+
}
|
|
99983
|
+
/**
|
|
99984
|
+
* Represents the available options when inserting slides.
|
|
99985
|
+
*
|
|
99986
|
+
* @remarks
|
|
99987
|
+
* [Api set: PowerPointApi 1.2]
|
|
99988
|
+
*/
|
|
99989
|
+
interface InsertSlideOptions {
|
|
99990
|
+
/**
|
|
99991
|
+
* Specifies which formatting to use during slide insertion.
|
|
99992
|
+
The default option is to use "KeepSourceFormatting".
|
|
99993
|
+
*
|
|
99994
|
+
* @remarks
|
|
99995
|
+
* [Api set: PowerPointApi 1.2]
|
|
99996
|
+
*/
|
|
99997
|
+
formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
|
|
99998
|
+
/**
|
|
99999
|
+
* Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
|
|
100000
|
+
The order of these slides is preserved during the insertion.
|
|
100001
|
+
If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
100002
|
+
All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
|
|
100003
|
+
*
|
|
100004
|
+
* @remarks
|
|
100005
|
+
* [Api set: PowerPointApi 1.2]
|
|
100006
|
+
*/
|
|
100007
|
+
sourceSlideIds?: string[];
|
|
100008
|
+
/**
|
|
100009
|
+
* Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
|
|
100010
|
+
If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
|
|
100011
|
+
If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
100012
|
+
*
|
|
100013
|
+
* @remarks
|
|
100014
|
+
* [Api set: PowerPointApi 1.2]
|
|
100015
|
+
*/
|
|
100016
|
+
targetSlideId?: string;
|
|
100017
|
+
}
|
|
100018
|
+
/**
|
|
100019
|
+
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
|
|
100020
|
+
*
|
|
100021
|
+
* @remarks
|
|
100022
|
+
* [Api set: PowerPointApi 1.4]
|
|
100023
|
+
*/
|
|
100024
|
+
enum ParagraphHorizontalAlignment {
|
|
100025
|
+
/**
|
|
100026
|
+
* Align text to the left margin.
|
|
100027
|
+
* @remarks
|
|
100028
|
+
* [Api set: PowerPointApi 1.4]
|
|
100029
|
+
*/
|
|
100030
|
+
left = "Left",
|
|
100031
|
+
/**
|
|
100032
|
+
* Align text in the center.
|
|
100033
|
+
* @remarks
|
|
100034
|
+
* [Api set: PowerPointApi 1.4]
|
|
100035
|
+
*/
|
|
100036
|
+
center = "Center",
|
|
100037
|
+
/**
|
|
100038
|
+
* Align text to the right margin.
|
|
100039
|
+
* @remarks
|
|
100040
|
+
* [Api set: PowerPointApi 1.4]
|
|
100041
|
+
*/
|
|
100042
|
+
right = "Right",
|
|
100043
|
+
/**
|
|
100044
|
+
* Align text so that it is justified across the whole line.
|
|
100045
|
+
* @remarks
|
|
100046
|
+
* [Api set: PowerPointApi 1.4]
|
|
100047
|
+
*/
|
|
100048
|
+
justify = "Justify",
|
|
100049
|
+
/**
|
|
100050
|
+
* Specifies the alignment or adjustment of kashida length in Arabic text.
|
|
100051
|
+
* @remarks
|
|
100052
|
+
* [Api set: PowerPointApi 1.4]
|
|
100053
|
+
*/
|
|
100054
|
+
justifyLow = "JustifyLow",
|
|
100055
|
+
/**
|
|
100056
|
+
* Distributes the text words across an entire text line.
|
|
100057
|
+
* @remarks
|
|
100058
|
+
* [Api set: PowerPointApi 1.4]
|
|
100059
|
+
*/
|
|
100060
|
+
distributed = "Distributed",
|
|
100061
|
+
/**
|
|
100062
|
+
* Distributes Thai text specially, because each character is treated as a word.
|
|
100063
|
+
* @remarks
|
|
100064
|
+
* [Api set: PowerPointApi 1.4]
|
|
100065
|
+
*/
|
|
100066
|
+
thaiDistributed = "ThaiDistributed",
|
|
100067
|
+
}
|
|
100068
|
+
/**
|
|
100069
|
+
* Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
|
|
100070
|
+
*
|
|
100071
|
+
* @remarks
|
|
100072
|
+
* [Api set: PowerPointApi 1.4]
|
|
100073
|
+
*/
|
|
100074
|
+
class ParagraphFormat extends OfficeExtension.ClientObject {
|
|
100075
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100076
|
+
context: RequestContext;
|
|
100077
|
+
/**
|
|
100078
|
+
* Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
|
|
100079
|
+
*
|
|
100080
|
+
* @remarks
|
|
100081
|
+
* [Api set: PowerPointApi 1.4]
|
|
100082
|
+
*/
|
|
100083
|
+
readonly bulletFormat: PowerPoint.BulletFormat;
|
|
100084
|
+
/**
|
|
100085
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
100086
|
+
*
|
|
100087
|
+
* @remarks
|
|
100088
|
+
* [Api set: PowerPointApi 1.4]
|
|
100089
|
+
*/
|
|
100090
|
+
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
100091
|
+
/**
|
|
100092
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100093
|
+
*
|
|
100094
|
+
* @param options Provides options for which properties of the object to load.
|
|
100095
|
+
*/
|
|
100096
|
+
load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
|
|
100097
|
+
/**
|
|
100098
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100099
|
+
*
|
|
100100
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100101
|
+
*/
|
|
100102
|
+
load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
|
|
100103
|
+
/**
|
|
100104
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100105
|
+
*
|
|
100106
|
+
* @param propertyNamesAndPaths `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.
|
|
100107
|
+
*/
|
|
100108
|
+
load(propertyNamesAndPaths?: {
|
|
100109
|
+
select?: string;
|
|
100110
|
+
expand?: string;
|
|
100111
|
+
}): PowerPoint.ParagraphFormat;
|
|
100112
|
+
/**
|
|
100113
|
+
* 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.)
|
|
100114
|
+
* Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
100115
|
+
*/
|
|
100116
|
+
toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
|
|
100117
|
+
}
|
|
100118
|
+
/**
|
|
100119
|
+
* Represents the available options when adding shapes.
|
|
100120
|
+
*
|
|
100121
|
+
* @remarks
|
|
100122
|
+
* [Api set: PowerPointApi 1.4]
|
|
100123
|
+
*/
|
|
100124
|
+
interface ShapeAddOptions {
|
|
100125
|
+
/**
|
|
100126
|
+
* Specifies the height, in points, of the shape.
|
|
100127
|
+
When not provided, a default value will be used.
|
|
100128
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
100129
|
+
*
|
|
100130
|
+
* @remarks
|
|
100131
|
+
* [Api set: PowerPointApi 1.4]
|
|
100132
|
+
*/
|
|
100133
|
+
height?: number;
|
|
100134
|
+
/**
|
|
100135
|
+
* Specifies the distance, in points, from the left side of the shape to the left side of the slide.
|
|
100136
|
+
When not provided, a default value will be used.
|
|
100137
|
+
*
|
|
100138
|
+
* @remarks
|
|
100139
|
+
* [Api set: PowerPointApi 1.4]
|
|
100140
|
+
*/
|
|
100141
|
+
left?: number;
|
|
100142
|
+
/**
|
|
100143
|
+
* Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
100144
|
+
When not provided, a default value will be used.
|
|
100145
|
+
*
|
|
100146
|
+
* @remarks
|
|
100147
|
+
* [Api set: PowerPointApi 1.4]
|
|
100148
|
+
*/
|
|
100149
|
+
top?: number;
|
|
100150
|
+
/**
|
|
100151
|
+
* Specifies the width, in points, of the shape.
|
|
100152
|
+
When not provided, a default value will be used.
|
|
100153
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
100154
|
+
*
|
|
100155
|
+
* @remarks
|
|
100156
|
+
* [Api set: PowerPointApi 1.4]
|
|
100157
|
+
*/
|
|
100158
|
+
width?: number;
|
|
100159
|
+
}
|
|
100160
|
+
/**
|
|
100161
|
+
* Represents the collection of shapes.
|
|
100162
|
+
*
|
|
100163
|
+
* @remarks
|
|
100164
|
+
* [Api set: PowerPointApi 1.3]
|
|
100165
|
+
*/
|
|
100166
|
+
class ShapeCollection extends OfficeExtension.ClientObject {
|
|
100167
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100168
|
+
context: RequestContext;
|
|
100169
|
+
/** Gets the loaded child items in this collection. */
|
|
100170
|
+
readonly items: PowerPoint.Shape[];
|
|
100171
|
+
/**
|
|
100172
|
+
* Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
|
|
100173
|
+
*
|
|
100174
|
+
* @remarks
|
|
100175
|
+
* [Api set: PowerPointApi 1.4]
|
|
100176
|
+
*
|
|
100177
|
+
* @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
|
|
100178
|
+
* @param options An optional parameter to specify the additional options such as the position of the shape.
|
|
100179
|
+
* @returns The newly inserted shape.
|
|
100180
|
+
*/
|
|
100181
|
+
addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
|
|
100182
|
+
/**
|
|
100183
|
+
* Adds a geometric shape to the slide. Returns a `Shape` object that represents the new shape.
|
|
100184
|
+
*
|
|
100185
|
+
* @remarks
|
|
100186
|
+
* [Api set: PowerPointApi 1.4]
|
|
100187
|
+
*
|
|
100188
|
+
* @param geometricShapeType Specifies the type of the geometric shape. See {@link PowerPoint.GeometricShapeType} for details.
|
|
100189
|
+
* @param options An optional parameter to specify the additional options such as the position of the shape.
|
|
100190
|
+
* @returns The newly inserted shape.
|
|
100191
|
+
*/
|
|
100192
|
+
addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
|
|
100193
|
+
/**
|
|
100194
|
+
* Adds a line to the slide. Returns a `Shape` object that represents the new line.
|
|
100195
|
+
*
|
|
100196
|
+
* @remarks
|
|
100197
|
+
* [Api set: PowerPointApi 1.4]
|
|
100198
|
+
*
|
|
100199
|
+
* @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
|
|
100200
|
+
* @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
|
|
100201
|
+
* @returns The newly inserted shape.
|
|
100202
|
+
*/
|
|
100203
|
+
addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
|
|
100204
|
+
/**
|
|
100205
|
+
* Adds a line to the slide. Returns a `Shape` object that represents the new line.
|
|
100206
|
+
*
|
|
100207
|
+
* @remarks
|
|
100208
|
+
* [Api set: PowerPointApi 1.4]
|
|
100209
|
+
*
|
|
100210
|
+
* @param connectorType Specifies the connector type of the line. If not provided, `straight` connector type will be used. See {@link PowerPoint.ConnectorType} for details.
|
|
100211
|
+
* @param options An optional parameter to specify the additional options such as the position of the shape object that contains the line.
|
|
100212
|
+
* @returns The newly inserted shape.
|
|
100213
|
+
*/
|
|
100214
|
+
addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
|
|
100215
|
+
/**
|
|
100216
|
+
* Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
|
|
100217
|
+
*
|
|
100218
|
+
* @remarks
|
|
100219
|
+
* [Api set: PowerPointApi 1.4]
|
|
100220
|
+
*
|
|
100221
|
+
* @param text Specifies the text that will be shown in the created text box.
|
|
100222
|
+
* @param options An optional parameter to specify the additional options such as the position of the text box.
|
|
100223
|
+
* @returns The newly inserted shape.
|
|
100224
|
+
*/
|
|
100225
|
+
addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
|
|
100226
|
+
/**
|
|
100227
|
+
* Gets the number of shapes in the collection.
|
|
100228
|
+
*
|
|
100229
|
+
* @remarks
|
|
100230
|
+
* [Api set: PowerPointApi 1.3]
|
|
100231
|
+
* @returns The number of shapes in the collection.
|
|
100232
|
+
*/
|
|
100233
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
100234
|
+
/**
|
|
100235
|
+
* Gets a shape using its unique ID. An error is thrown if the shape does not exist.
|
|
100236
|
+
*
|
|
100237
|
+
* @remarks
|
|
100238
|
+
* [Api set: PowerPointApi 1.3]
|
|
100239
|
+
*
|
|
100240
|
+
* @param key The ID of the shape.
|
|
100241
|
+
* @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
|
|
100242
|
+
*/
|
|
100243
|
+
getItem(key: string): PowerPoint.Shape;
|
|
100244
|
+
/**
|
|
100245
|
+
* Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
|
|
100246
|
+
*
|
|
100247
|
+
* @remarks
|
|
100248
|
+
* [Api set: PowerPointApi 1.3]
|
|
100249
|
+
*
|
|
100250
|
+
* @param index The index of the shape in the collection.
|
|
100251
|
+
* @returns The shape at the given index. An error is thrown if index is out of range.
|
|
100252
|
+
*/
|
|
100253
|
+
getItemAt(index: number): PowerPoint.Shape;
|
|
100254
|
+
/**
|
|
100255
|
+
* Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
|
|
100256
|
+
*
|
|
100257
|
+
* @remarks
|
|
100258
|
+
* [Api set: PowerPointApi 1.3]
|
|
100259
|
+
*
|
|
100260
|
+
* @param id The ID of the shape.
|
|
100261
|
+
* @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
|
|
100262
|
+
*/
|
|
100263
|
+
getItemOrNullObject(id: string): PowerPoint.Shape;
|
|
100264
|
+
/**
|
|
100265
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100266
|
+
*
|
|
100267
|
+
* @param options Provides options for which properties of the object to load.
|
|
100268
|
+
*/
|
|
100269
|
+
load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
|
|
100270
|
+
/**
|
|
100271
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100272
|
+
*
|
|
100273
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100274
|
+
*/
|
|
100275
|
+
load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
|
|
100276
|
+
/**
|
|
100277
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100278
|
+
*
|
|
100279
|
+
* @param propertyNamesAndPaths `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.
|
|
100280
|
+
*/
|
|
100281
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
|
|
100282
|
+
/**
|
|
100283
|
+
* 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.)
|
|
100284
|
+
* Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
100285
|
+
*/
|
|
100286
|
+
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
|
|
100287
|
+
}
|
|
100288
|
+
/**
|
|
100289
|
+
* Represents the layout of a slide.
|
|
100290
|
+
*
|
|
100291
|
+
* @remarks
|
|
100292
|
+
* [Api set: PowerPointApi 1.3]
|
|
100293
|
+
*/
|
|
100294
|
+
class SlideLayout extends OfficeExtension.ClientObject {
|
|
100295
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100296
|
+
context: RequestContext;
|
|
100297
|
+
/**
|
|
100298
|
+
* Returns a collection of shapes in the slide layout.
|
|
100299
|
+
*
|
|
100300
|
+
* @remarks
|
|
100301
|
+
* [Api set: PowerPointApi 1.3]
|
|
100302
|
+
*/
|
|
100303
|
+
readonly shapes: PowerPoint.ShapeCollection;
|
|
100304
|
+
/**
|
|
100305
|
+
* Gets the unique ID of the slide layout.
|
|
100306
|
+
*
|
|
100307
|
+
* @remarks
|
|
100308
|
+
* [Api set: PowerPointApi 1.3]
|
|
100309
|
+
*/
|
|
100310
|
+
readonly id: string;
|
|
100311
|
+
/**
|
|
100312
|
+
* Gets the name of the slide layout.
|
|
100313
|
+
*
|
|
100314
|
+
* @remarks
|
|
100315
|
+
* [Api set: PowerPointApi 1.3]
|
|
100316
|
+
*/
|
|
100317
|
+
readonly name: string;
|
|
100318
|
+
/**
|
|
100319
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100320
|
+
*
|
|
100321
|
+
* @param options Provides options for which properties of the object to load.
|
|
100322
|
+
*/
|
|
100323
|
+
load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
|
|
100324
|
+
/**
|
|
100325
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100326
|
+
*
|
|
100327
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100328
|
+
*/
|
|
100329
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
|
|
100330
|
+
/**
|
|
100331
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100332
|
+
*
|
|
100333
|
+
* @param propertyNamesAndPaths `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.
|
|
100334
|
+
*/
|
|
100335
|
+
load(propertyNamesAndPaths?: {
|
|
100336
|
+
select?: string;
|
|
100337
|
+
expand?: string;
|
|
100338
|
+
}): PowerPoint.SlideLayout;
|
|
100339
|
+
/**
|
|
100340
|
+
* 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.)
|
|
100341
|
+
* Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
|
|
100342
|
+
*/
|
|
100343
|
+
toJSON(): PowerPoint.Interfaces.SlideLayoutData;
|
|
100344
|
+
}
|
|
100345
|
+
/**
|
|
100346
|
+
* Represents the collection of layouts provided by the Slide Master for slides.
|
|
100347
|
+
*
|
|
100348
|
+
* @remarks
|
|
100349
|
+
* [Api set: PowerPointApi 1.3]
|
|
100350
|
+
*/
|
|
100351
|
+
class SlideLayoutCollection extends OfficeExtension.ClientObject {
|
|
100352
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100353
|
+
context: RequestContext;
|
|
100354
|
+
/** Gets the loaded child items in this collection. */
|
|
100355
|
+
readonly items: PowerPoint.SlideLayout[];
|
|
100356
|
+
/**
|
|
100357
|
+
* Gets the number of layouts in the collection.
|
|
100358
|
+
*
|
|
100359
|
+
* @remarks
|
|
100360
|
+
* [Api set: PowerPointApi 1.3]
|
|
100361
|
+
* @returns The number of layouts in the collection.
|
|
100362
|
+
*/
|
|
100363
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
100364
|
+
/**
|
|
100365
|
+
* Gets a layout using its unique ID.
|
|
100366
|
+
*
|
|
100367
|
+
* @remarks
|
|
100368
|
+
* [Api set: PowerPointApi 1.3]
|
|
100369
|
+
*
|
|
100370
|
+
* @param key The ID of the layout.
|
|
100371
|
+
* @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
|
|
100372
|
+
*/
|
|
100373
|
+
getItem(key: string): PowerPoint.SlideLayout;
|
|
100374
|
+
/**
|
|
100375
|
+
* Gets a layout using its zero-based index in the collection.
|
|
100376
|
+
*
|
|
100377
|
+
* @remarks
|
|
100378
|
+
* [Api set: PowerPointApi 1.3]
|
|
100379
|
+
*
|
|
100380
|
+
* @param index The index of the layout in the collection.
|
|
100381
|
+
* @returns The layout at the given index. An error is thrown if index is out of range.
|
|
100382
|
+
*/
|
|
100383
|
+
getItemAt(index: number): PowerPoint.SlideLayout;
|
|
100384
|
+
/**
|
|
100385
|
+
* Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
|
|
100386
|
+
see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
100387
|
+
*
|
|
100388
|
+
* @remarks
|
|
100389
|
+
* [Api set: PowerPointApi 1.3]
|
|
100390
|
+
*
|
|
100391
|
+
* @param id The ID of the layout.
|
|
100392
|
+
* @returns The layout with the unique ID.
|
|
100393
|
+
*/
|
|
100394
|
+
getItemOrNullObject(id: string): PowerPoint.SlideLayout;
|
|
100395
|
+
/**
|
|
100396
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100397
|
+
*
|
|
100398
|
+
* @param options Provides options for which properties of the object to load.
|
|
100399
|
+
*/
|
|
100400
|
+
load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
|
|
100401
|
+
/**
|
|
100402
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100403
|
+
*
|
|
100404
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100405
|
+
*/
|
|
100406
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
|
|
100407
|
+
/**
|
|
100408
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100409
|
+
*
|
|
100410
|
+
* @param propertyNamesAndPaths `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.
|
|
100411
|
+
*/
|
|
100412
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
|
|
100413
|
+
/**
|
|
100414
|
+
* 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.)
|
|
100415
|
+
* Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
100416
|
+
*/
|
|
100417
|
+
toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
|
|
100418
|
+
}
|
|
100419
|
+
/**
|
|
100420
|
+
* Represents the Slide Master of a slide.
|
|
100421
|
+
*
|
|
100422
|
+
* @remarks
|
|
100423
|
+
* [Api set: PowerPointApi 1.3]
|
|
100424
|
+
*/
|
|
100425
|
+
class SlideMaster extends OfficeExtension.ClientObject {
|
|
100426
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100427
|
+
context: RequestContext;
|
|
100428
|
+
/**
|
|
100429
|
+
* Gets the collection of layouts provided by the Slide Master for slides.
|
|
100430
|
+
*
|
|
100431
|
+
* @remarks
|
|
100432
|
+
* [Api set: PowerPointApi 1.3]
|
|
100433
|
+
*/
|
|
100434
|
+
readonly layouts: PowerPoint.SlideLayoutCollection;
|
|
100435
|
+
/**
|
|
100436
|
+
* Returns a collection of shapes in the Slide Master.
|
|
100437
|
+
*
|
|
100438
|
+
* @remarks
|
|
100439
|
+
* [Api set: PowerPointApi 1.3]
|
|
100440
|
+
*/
|
|
100441
|
+
readonly shapes: PowerPoint.ShapeCollection;
|
|
100442
|
+
/**
|
|
100443
|
+
* Gets the unique ID of the Slide Master.
|
|
100444
|
+
*
|
|
100445
|
+
* @remarks
|
|
100446
|
+
* [Api set: PowerPointApi 1.3]
|
|
100447
|
+
*/
|
|
100448
|
+
readonly id: string;
|
|
100449
|
+
/**
|
|
100450
|
+
* Gets the unique name of the Slide Master.
|
|
100451
|
+
*
|
|
100452
|
+
* @remarks
|
|
100453
|
+
* [Api set: PowerPointApi 1.3]
|
|
100454
|
+
*/
|
|
100455
|
+
readonly name: string;
|
|
100456
|
+
/**
|
|
100457
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100458
|
+
*
|
|
100459
|
+
* @param options Provides options for which properties of the object to load.
|
|
100460
|
+
*/
|
|
100461
|
+
load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
|
|
100462
|
+
/**
|
|
100463
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100464
|
+
*
|
|
100465
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100466
|
+
*/
|
|
100467
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
|
|
100468
|
+
/**
|
|
100469
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100470
|
+
*
|
|
100471
|
+
* @param propertyNamesAndPaths `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.
|
|
100472
|
+
*/
|
|
100473
|
+
load(propertyNamesAndPaths?: {
|
|
100474
|
+
select?: string;
|
|
100475
|
+
expand?: string;
|
|
100476
|
+
}): PowerPoint.SlideMaster;
|
|
100477
|
+
/**
|
|
100478
|
+
* 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.)
|
|
100479
|
+
* Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
|
|
100480
|
+
*/
|
|
100481
|
+
toJSON(): PowerPoint.Interfaces.SlideMasterData;
|
|
100482
|
+
}
|
|
100483
|
+
/**
|
|
100484
|
+
* Represents a single tag in the slide.
|
|
100485
|
+
*
|
|
100486
|
+
* @remarks
|
|
100487
|
+
* [Api set: PowerPointApi 1.3]
|
|
100488
|
+
*/
|
|
100489
|
+
class Tag extends OfficeExtension.ClientObject {
|
|
100490
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100491
|
+
context: RequestContext;
|
|
100492
|
+
/**
|
|
100493
|
+
* Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
|
|
100494
|
+
*
|
|
100495
|
+
* @remarks
|
|
100496
|
+
* [Api set: PowerPointApi 1.3]
|
|
100497
|
+
*/
|
|
100498
|
+
readonly key: string;
|
|
100499
|
+
/**
|
|
100500
|
+
* Gets the value of the tag.
|
|
100501
|
+
*
|
|
100502
|
+
* @remarks
|
|
100503
|
+
* [Api set: PowerPointApi 1.3]
|
|
100504
|
+
*/
|
|
100505
|
+
value: string;
|
|
100506
|
+
/**
|
|
100507
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100508
|
+
*
|
|
100509
|
+
* @param options Provides options for which properties of the object to load.
|
|
100510
|
+
*/
|
|
100511
|
+
load(options?: PowerPoint.Interfaces.TagLoadOptions): PowerPoint.Tag;
|
|
100512
|
+
/**
|
|
100513
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100514
|
+
*
|
|
100515
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100516
|
+
*/
|
|
100517
|
+
load(propertyNames?: string | string[]): PowerPoint.Tag;
|
|
100518
|
+
/**
|
|
100519
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100520
|
+
*
|
|
100521
|
+
* @param propertyNamesAndPaths `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.
|
|
100522
|
+
*/
|
|
100523
|
+
load(propertyNamesAndPaths?: {
|
|
100524
|
+
select?: string;
|
|
100525
|
+
expand?: string;
|
|
100526
|
+
}): PowerPoint.Tag;
|
|
100527
|
+
/**
|
|
100528
|
+
* 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.)
|
|
100529
|
+
* Whereas the original PowerPoint.Tag object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagData`) that contains shallow copies of any loaded child properties from the original object.
|
|
100530
|
+
*/
|
|
100531
|
+
toJSON(): PowerPoint.Interfaces.TagData;
|
|
100532
|
+
}
|
|
100533
|
+
/**
|
|
100534
|
+
* Represents the collection of tags.
|
|
100535
|
+
*
|
|
100536
|
+
* @remarks
|
|
100537
|
+
* [Api set: PowerPointApi 1.3]
|
|
100538
|
+
*/
|
|
100539
|
+
class TagCollection extends OfficeExtension.ClientObject {
|
|
100540
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100541
|
+
context: RequestContext;
|
|
100542
|
+
/** Gets the loaded child items in this collection. */
|
|
100543
|
+
readonly items: PowerPoint.Tag[];
|
|
100544
|
+
/**
|
|
100545
|
+
* Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
|
|
100546
|
+
*
|
|
100547
|
+
* @remarks
|
|
100548
|
+
* [Api set: PowerPointApi 1.3]
|
|
100549
|
+
*
|
|
100550
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
|
|
100551
|
+
* @param value The value of the tag.
|
|
100552
|
+
*/
|
|
100553
|
+
add(key: string, value: string): void;
|
|
100554
|
+
/**
|
|
100555
|
+
* Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
|
|
100556
|
+
*
|
|
100557
|
+
* @remarks
|
|
100558
|
+
* [Api set: PowerPointApi 1.3]
|
|
100559
|
+
*
|
|
100560
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
|
|
100561
|
+
*/
|
|
100562
|
+
delete(key: string): void;
|
|
100563
|
+
/**
|
|
100564
|
+
* Gets the number of tags in the collection.
|
|
100565
|
+
*
|
|
100566
|
+
* @remarks
|
|
100567
|
+
* [Api set: PowerPointApi 1.3]
|
|
100568
|
+
* @returns The number of tags in the collection.
|
|
100569
|
+
*/
|
|
100570
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
100571
|
+
/**
|
|
100572
|
+
* Gets a tag using its unique ID. An error is thrown if the tag does not exist.
|
|
100573
|
+
*
|
|
100574
|
+
* @remarks
|
|
100575
|
+
* [Api set: PowerPointApi 1.3]
|
|
100576
|
+
*
|
|
100577
|
+
* @param key The ID of the tag.
|
|
100578
|
+
* @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
|
|
100579
|
+
*/
|
|
100580
|
+
getItem(key: string): PowerPoint.Tag;
|
|
100581
|
+
/**
|
|
100582
|
+
* Gets a tag using its zero-based index in the collection. An error is thrown if the index is out of range.
|
|
100583
|
+
*
|
|
100584
|
+
* @remarks
|
|
100585
|
+
* [Api set: PowerPointApi 1.3]
|
|
100586
|
+
*
|
|
100587
|
+
* @param index The index of the tag in the collection.
|
|
100588
|
+
* @returns The tag at the given index. An error is thrown if index is out of range.
|
|
100589
|
+
*/
|
|
100590
|
+
getItemAt(index: number): PowerPoint.Tag;
|
|
100591
|
+
/**
|
|
100592
|
+
* Gets a tag using its unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
|
|
100593
|
+
*
|
|
100594
|
+
* @remarks
|
|
100595
|
+
* [Api set: PowerPointApi 1.3]
|
|
100596
|
+
*
|
|
100597
|
+
* @param key The ID of the tag.
|
|
100598
|
+
* @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
|
|
100599
|
+
*/
|
|
100600
|
+
getItemOrNullObject(key: string): PowerPoint.Tag;
|
|
100601
|
+
/**
|
|
100602
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100603
|
+
*
|
|
100604
|
+
* @param options Provides options for which properties of the object to load.
|
|
100605
|
+
*/
|
|
100606
|
+
load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;
|
|
100607
|
+
/**
|
|
100608
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100609
|
+
*
|
|
100610
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100611
|
+
*/
|
|
100612
|
+
load(propertyNames?: string | string[]): PowerPoint.TagCollection;
|
|
100613
|
+
/**
|
|
100614
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100615
|
+
*
|
|
100616
|
+
* @param propertyNamesAndPaths `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.
|
|
100617
|
+
*/
|
|
100618
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;
|
|
100619
|
+
/**
|
|
100620
|
+
* 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.)
|
|
100621
|
+
* Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
100622
|
+
*/
|
|
100623
|
+
toJSON(): PowerPoint.Interfaces.TagCollectionData;
|
|
100624
|
+
}
|
|
100625
|
+
/**
|
|
100626
|
+
* Represents a single slide of a presentation.
|
|
100627
|
+
*
|
|
100628
|
+
* @remarks
|
|
100629
|
+
* [Api set: PowerPointApi 1.2]
|
|
100630
|
+
*/
|
|
100631
|
+
class Slide extends OfficeExtension.ClientObject {
|
|
100632
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100633
|
+
context: RequestContext;
|
|
100634
|
+
/**
|
|
100635
|
+
* Gets the layout of the slide.
|
|
100636
|
+
*
|
|
100637
|
+
* @remarks
|
|
100638
|
+
* [Api set: PowerPointApi 1.3]
|
|
100639
|
+
*/
|
|
100640
|
+
readonly layout: PowerPoint.SlideLayout;
|
|
100641
|
+
/**
|
|
100642
|
+
* Returns a collection of shapes in the slide.
|
|
100643
|
+
*
|
|
100644
|
+
* @remarks
|
|
100645
|
+
* [Api set: PowerPointApi 1.3]
|
|
100646
|
+
*/
|
|
100647
|
+
readonly shapes: PowerPoint.ShapeCollection;
|
|
100648
|
+
/**
|
|
100649
|
+
* Gets the `SlideMaster` object that represents the slide's default content.
|
|
100650
|
+
*
|
|
100651
|
+
* @remarks
|
|
100652
|
+
* [Api set: PowerPointApi 1.3]
|
|
100653
|
+
*/
|
|
100654
|
+
readonly slideMaster: PowerPoint.SlideMaster;
|
|
100655
|
+
/**
|
|
100656
|
+
* Returns a collection of tags in the slide.
|
|
100657
|
+
*
|
|
100658
|
+
* @remarks
|
|
100659
|
+
* [Api set: PowerPointApi 1.3]
|
|
100660
|
+
*/
|
|
100661
|
+
readonly tags: PowerPoint.TagCollection;
|
|
100662
|
+
/**
|
|
100663
|
+
* Gets the unique ID of the slide.
|
|
100664
|
+
*
|
|
100665
|
+
* @remarks
|
|
100666
|
+
* [Api set: PowerPointApi 1.2]
|
|
100667
|
+
*/
|
|
100668
|
+
readonly id: string;
|
|
100669
|
+
/**
|
|
100670
|
+
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
|
|
100671
|
+
*
|
|
100672
|
+
* @remarks
|
|
100673
|
+
* [Api set: PowerPointApi 1.2]
|
|
100674
|
+
*/
|
|
100675
|
+
delete(): void;
|
|
100676
|
+
/**
|
|
100677
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100678
|
+
*
|
|
100679
|
+
* @param options Provides options for which properties of the object to load.
|
|
100680
|
+
*/
|
|
100681
|
+
load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;
|
|
100682
|
+
/**
|
|
100683
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100684
|
+
*
|
|
100685
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100686
|
+
*/
|
|
100687
|
+
load(propertyNames?: string | string[]): PowerPoint.Slide;
|
|
100688
|
+
/**
|
|
100689
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100690
|
+
*
|
|
100691
|
+
* @param propertyNamesAndPaths `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.
|
|
100692
|
+
*/
|
|
100693
|
+
load(propertyNamesAndPaths?: {
|
|
100694
|
+
select?: string;
|
|
100695
|
+
expand?: string;
|
|
100696
|
+
}): PowerPoint.Slide;
|
|
100697
|
+
/**
|
|
100698
|
+
* 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.)
|
|
100699
|
+
* Whereas the original PowerPoint.Slide object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object.
|
|
100700
|
+
*/
|
|
100701
|
+
toJSON(): PowerPoint.Interfaces.SlideData;
|
|
100702
|
+
}
|
|
100703
|
+
/**
|
|
100704
|
+
* Specifies a shape's fill type.
|
|
100705
|
+
*
|
|
100706
|
+
* @remarks
|
|
100707
|
+
* [Api set: PowerPointApi 1.4]
|
|
100708
|
+
*/
|
|
100709
|
+
enum ShapeFillType {
|
|
100710
|
+
/**
|
|
100711
|
+
* Specifies that the shape should have no fill.
|
|
100712
|
+
* @remarks
|
|
100713
|
+
* [Api set: PowerPointApi 1.4]
|
|
100714
|
+
*/
|
|
100715
|
+
noFill = "NoFill",
|
|
100716
|
+
/**
|
|
100717
|
+
* Specifies that the shape should have regular solid fill.
|
|
100718
|
+
* @remarks
|
|
100719
|
+
* [Api set: PowerPointApi 1.4]
|
|
100720
|
+
*/
|
|
100721
|
+
solid = "Solid",
|
|
100722
|
+
/**
|
|
100723
|
+
* Specifies that the shape should have gradient fill.
|
|
100724
|
+
* @remarks
|
|
100725
|
+
* [Api set: PowerPointApi 1.4]
|
|
100726
|
+
*/
|
|
100727
|
+
gradient = "Gradient",
|
|
100728
|
+
/**
|
|
100729
|
+
* Specifies that the shape should have pattern fill.
|
|
100730
|
+
* @remarks
|
|
100731
|
+
* [Api set: PowerPointApi 1.4]
|
|
100732
|
+
*/
|
|
100733
|
+
pattern = "Pattern",
|
|
100734
|
+
/**
|
|
100735
|
+
* Specifies that the shape should have picture or texture fill.
|
|
100736
|
+
* @remarks
|
|
100737
|
+
* [Api set: PowerPointApi 1.4]
|
|
100738
|
+
*/
|
|
100739
|
+
pictureAndTexture = "PictureAndTexture",
|
|
100740
|
+
/**
|
|
100741
|
+
* Specifies that the shape should have slide background fill.
|
|
100742
|
+
* @remarks
|
|
100743
|
+
* [Api set: PowerPointApi 1.4]
|
|
100744
|
+
*/
|
|
100745
|
+
slideBackground = "SlideBackground",
|
|
100746
|
+
}
|
|
100747
|
+
/**
|
|
100748
|
+
* Represents the fill formatting of a shape object.
|
|
100749
|
+
*
|
|
100750
|
+
* @remarks
|
|
100751
|
+
* [Api set: PowerPointApi 1.4]
|
|
100752
|
+
*/
|
|
100753
|
+
class ShapeFill extends OfficeExtension.ClientObject {
|
|
100754
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
100755
|
+
context: RequestContext;
|
|
100756
|
+
/**
|
|
100757
|
+
* Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
100758
|
+
*
|
|
100759
|
+
* @remarks
|
|
100760
|
+
* [Api set: PowerPointApi 1.4]
|
|
100761
|
+
*/
|
|
100762
|
+
foregroundColor: string;
|
|
100763
|
+
/**
|
|
100764
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
100765
|
+
*
|
|
100766
|
+
* @remarks
|
|
100767
|
+
* [Api set: PowerPointApi 1.4]
|
|
100768
|
+
*/
|
|
100769
|
+
transparency: number;
|
|
100770
|
+
/**
|
|
100771
|
+
* Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
|
|
100772
|
+
*
|
|
100773
|
+
* @remarks
|
|
100774
|
+
* [Api set: PowerPointApi 1.4]
|
|
100775
|
+
*/
|
|
100776
|
+
readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
|
|
100777
|
+
/**
|
|
100778
|
+
* Clears the fill formatting of this shape.
|
|
100779
|
+
*
|
|
100780
|
+
* @remarks
|
|
100781
|
+
* [Api set: PowerPointApi 1.4]
|
|
100782
|
+
*/
|
|
100783
|
+
clear(): void;
|
|
100784
|
+
/**
|
|
100785
|
+
* Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
|
|
100786
|
+
*
|
|
100787
|
+
* @remarks
|
|
100788
|
+
* [Api set: PowerPointApi 1.4]
|
|
100789
|
+
*
|
|
100790
|
+
* @param color A string that specifies the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
100791
|
+
*/
|
|
100792
|
+
setSolidColor(color: string): void;
|
|
100793
|
+
/**
|
|
100794
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100795
|
+
*
|
|
100796
|
+
* @param options Provides options for which properties of the object to load.
|
|
100797
|
+
*/
|
|
100798
|
+
load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
|
|
100799
|
+
/**
|
|
100800
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100801
|
+
*
|
|
100802
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
100803
|
+
*/
|
|
100804
|
+
load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
|
|
100805
|
+
/**
|
|
100806
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
100807
|
+
*
|
|
100808
|
+
* @param propertyNamesAndPaths `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.
|
|
100809
|
+
*/
|
|
100810
|
+
load(propertyNamesAndPaths?: {
|
|
100811
|
+
select?: string;
|
|
100812
|
+
expand?: string;
|
|
100813
|
+
}): PowerPoint.ShapeFill;
|
|
100814
|
+
/**
|
|
100815
|
+
* 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.)
|
|
100816
|
+
* Whereas the original PowerPoint.ShapeFill object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
100817
|
+
*/
|
|
100818
|
+
toJSON(): PowerPoint.Interfaces.ShapeFillData;
|
|
100819
|
+
}
|
|
100820
|
+
/**
|
|
100821
|
+
* Specifies the style for a line.
|
|
100822
|
+
*
|
|
100823
|
+
* @remarks
|
|
100824
|
+
* [Api set: PowerPointApi 1.4]
|
|
98829
100825
|
*/
|
|
98830
|
-
enum
|
|
100826
|
+
enum ShapeLineStyle {
|
|
98831
100827
|
/**
|
|
98832
|
-
*
|
|
100828
|
+
* Single line.
|
|
98833
100829
|
* @remarks
|
|
98834
|
-
* [Api set: PowerPointApi 1.
|
|
100830
|
+
* [Api set: PowerPointApi 1.4]
|
|
98835
100831
|
*/
|
|
98836
|
-
|
|
100832
|
+
single = "Single",
|
|
98837
100833
|
/**
|
|
98838
|
-
*
|
|
100834
|
+
* Thick line with a thin line on each side.
|
|
98839
100835
|
* @remarks
|
|
98840
|
-
* [Api set: PowerPointApi 1.
|
|
100836
|
+
* [Api set: PowerPointApi 1.4]
|
|
98841
100837
|
*/
|
|
98842
|
-
|
|
100838
|
+
thickBetweenThin = "ThickBetweenThin",
|
|
100839
|
+
/**
|
|
100840
|
+
* Thick line next to thin line. For horizontal lines, the thick line is above the thin line. For vertical lines, the thick line is to the left of the thin line.
|
|
100841
|
+
* @remarks
|
|
100842
|
+
* [Api set: PowerPointApi 1.4]
|
|
100843
|
+
*/
|
|
100844
|
+
thickThin = "ThickThin",
|
|
100845
|
+
/**
|
|
100846
|
+
* Thick line next to thin line. For horizontal lines, the thick line is below the thin line. For vertical lines, the thick line is to the right of the thin line.
|
|
100847
|
+
* @remarks
|
|
100848
|
+
* [Api set: PowerPointApi 1.4]
|
|
100849
|
+
*/
|
|
100850
|
+
thinThick = "ThinThick",
|
|
100851
|
+
/**
|
|
100852
|
+
* Two thin lines.
|
|
100853
|
+
* @remarks
|
|
100854
|
+
* [Api set: PowerPointApi 1.4]
|
|
100855
|
+
*/
|
|
100856
|
+
thinThin = "ThinThin",
|
|
98843
100857
|
}
|
|
98844
100858
|
/**
|
|
98845
|
-
*
|
|
100859
|
+
* Specifies the dash style for a line.
|
|
98846
100860
|
*
|
|
98847
100861
|
* @remarks
|
|
98848
|
-
* [Api set: PowerPointApi 1.
|
|
100862
|
+
* [Api set: PowerPointApi 1.4]
|
|
98849
100863
|
*/
|
|
98850
|
-
|
|
100864
|
+
enum ShapeLineDashStyle {
|
|
98851
100865
|
/**
|
|
98852
|
-
*
|
|
98853
|
-
The default option is to use "KeepSourceFormatting".
|
|
98854
|
-
*
|
|
100866
|
+
* The dash line pattern
|
|
98855
100867
|
* @remarks
|
|
98856
|
-
* [Api set: PowerPointApi 1.
|
|
100868
|
+
* [Api set: PowerPointApi 1.4]
|
|
98857
100869
|
*/
|
|
98858
|
-
|
|
100870
|
+
dash = "Dash",
|
|
98859
100871
|
/**
|
|
98860
|
-
*
|
|
98861
|
-
The order of these slides is preserved during the insertion.
|
|
98862
|
-
If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
98863
|
-
All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
|
|
98864
|
-
*
|
|
100872
|
+
* The dash-dot line pattern
|
|
98865
100873
|
* @remarks
|
|
98866
|
-
* [Api set: PowerPointApi 1.
|
|
100874
|
+
* [Api set: PowerPointApi 1.4]
|
|
98867
100875
|
*/
|
|
98868
|
-
|
|
100876
|
+
dashDot = "DashDot",
|
|
98869
100877
|
/**
|
|
98870
|
-
*
|
|
98871
|
-
If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
|
|
98872
|
-
If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
98873
|
-
*
|
|
100878
|
+
* The dash-dot-dot line pattern
|
|
98874
100879
|
* @remarks
|
|
98875
|
-
* [Api set: PowerPointApi 1.
|
|
100880
|
+
* [Api set: PowerPointApi 1.4]
|
|
98876
100881
|
*/
|
|
98877
|
-
|
|
100882
|
+
dashDotDot = "DashDotDot",
|
|
100883
|
+
/**
|
|
100884
|
+
* The long dash line pattern
|
|
100885
|
+
* @remarks
|
|
100886
|
+
* [Api set: PowerPointApi 1.4]
|
|
100887
|
+
*/
|
|
100888
|
+
longDash = "LongDash",
|
|
100889
|
+
/**
|
|
100890
|
+
* The long dash-dot line pattern
|
|
100891
|
+
* @remarks
|
|
100892
|
+
* [Api set: PowerPointApi 1.4]
|
|
100893
|
+
*/
|
|
100894
|
+
longDashDot = "LongDashDot",
|
|
100895
|
+
/**
|
|
100896
|
+
* The round dot line pattern
|
|
100897
|
+
* @remarks
|
|
100898
|
+
* [Api set: PowerPointApi 1.4]
|
|
100899
|
+
*/
|
|
100900
|
+
roundDot = "RoundDot",
|
|
100901
|
+
/**
|
|
100902
|
+
* The solid line pattern
|
|
100903
|
+
* @remarks
|
|
100904
|
+
* [Api set: PowerPointApi 1.4]
|
|
100905
|
+
*/
|
|
100906
|
+
solid = "Solid",
|
|
100907
|
+
/**
|
|
100908
|
+
* The square dot line pattern
|
|
100909
|
+
* @remarks
|
|
100910
|
+
* [Api set: PowerPointApi 1.4]
|
|
100911
|
+
*/
|
|
100912
|
+
squareDot = "SquareDot",
|
|
100913
|
+
/**
|
|
100914
|
+
* The long dash-dot-dot line pattern
|
|
100915
|
+
* @remarks
|
|
100916
|
+
* [Api set: PowerPointApi 1.4]
|
|
100917
|
+
*/
|
|
100918
|
+
longDashDotDot = "LongDashDotDot",
|
|
100919
|
+
/**
|
|
100920
|
+
* The system dash line pattern
|
|
100921
|
+
* @remarks
|
|
100922
|
+
* [Api set: PowerPointApi 1.4]
|
|
100923
|
+
*/
|
|
100924
|
+
systemDash = "SystemDash",
|
|
100925
|
+
/**
|
|
100926
|
+
* The system dot line pattern
|
|
100927
|
+
* @remarks
|
|
100928
|
+
* [Api set: PowerPointApi 1.4]
|
|
100929
|
+
*/
|
|
100930
|
+
systemDot = "SystemDot",
|
|
100931
|
+
/**
|
|
100932
|
+
* The system dash-dot line pattern
|
|
100933
|
+
* @remarks
|
|
100934
|
+
* [Api set: PowerPointApi 1.4]
|
|
100935
|
+
*/
|
|
100936
|
+
systemDashDot = "SystemDashDot",
|
|
98878
100937
|
}
|
|
98879
100938
|
/**
|
|
98880
|
-
* Represents the
|
|
100939
|
+
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
|
|
98881
100940
|
*
|
|
98882
100941
|
* @remarks
|
|
98883
|
-
* [Api set: PowerPointApi 1.
|
|
100942
|
+
* [Api set: PowerPointApi 1.4]
|
|
98884
100943
|
*/
|
|
98885
|
-
class
|
|
100944
|
+
class ShapeLineFormat extends OfficeExtension.ClientObject {
|
|
98886
100945
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
98887
100946
|
context: RequestContext;
|
|
98888
|
-
/** Gets the loaded child items in this collection. */
|
|
98889
|
-
readonly items: PowerPoint.Shape[];
|
|
98890
100947
|
/**
|
|
98891
|
-
*
|
|
100948
|
+
* Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
98892
100949
|
*
|
|
98893
100950
|
* @remarks
|
|
98894
|
-
* [Api set: PowerPointApi 1.
|
|
98895
|
-
* @returns The number of shapes in the collection.
|
|
100951
|
+
* [Api set: PowerPointApi 1.4]
|
|
98896
100952
|
*/
|
|
98897
|
-
|
|
100953
|
+
color: string;
|
|
98898
100954
|
/**
|
|
98899
|
-
*
|
|
100955
|
+
* Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
|
|
98900
100956
|
*
|
|
98901
100957
|
* @remarks
|
|
98902
|
-
* [Api set: PowerPointApi 1.
|
|
98903
|
-
*
|
|
98904
|
-
* @param key The ID of the shape.
|
|
98905
|
-
* @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
|
|
100958
|
+
* [Api set: PowerPointApi 1.4]
|
|
98906
100959
|
*/
|
|
98907
|
-
|
|
100960
|
+
dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
|
|
98908
100961
|
/**
|
|
98909
|
-
*
|
|
100962
|
+
* Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
|
|
98910
100963
|
*
|
|
98911
100964
|
* @remarks
|
|
98912
|
-
* [Api set: PowerPointApi 1.
|
|
100965
|
+
* [Api set: PowerPointApi 1.4]
|
|
100966
|
+
*/
|
|
100967
|
+
style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
|
|
100968
|
+
/**
|
|
100969
|
+
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
|
|
98913
100970
|
*
|
|
98914
|
-
* @
|
|
98915
|
-
*
|
|
100971
|
+
* @remarks
|
|
100972
|
+
* [Api set: PowerPointApi 1.4]
|
|
98916
100973
|
*/
|
|
98917
|
-
|
|
100974
|
+
transparency: number;
|
|
98918
100975
|
/**
|
|
98919
|
-
*
|
|
100976
|
+
* Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
|
|
98920
100977
|
*
|
|
98921
100978
|
* @remarks
|
|
98922
|
-
* [Api set: PowerPointApi 1.
|
|
100979
|
+
* [Api set: PowerPointApi 1.4]
|
|
100980
|
+
*/
|
|
100981
|
+
visible: boolean;
|
|
100982
|
+
/**
|
|
100983
|
+
* Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
|
|
98923
100984
|
*
|
|
98924
|
-
* @
|
|
98925
|
-
*
|
|
100985
|
+
* @remarks
|
|
100986
|
+
* [Api set: PowerPointApi 1.4]
|
|
98926
100987
|
*/
|
|
98927
|
-
|
|
100988
|
+
weight: number;
|
|
98928
100989
|
/**
|
|
98929
100990
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
98930
100991
|
*
|
|
98931
100992
|
* @param options Provides options for which properties of the object to load.
|
|
98932
100993
|
*/
|
|
98933
|
-
load(options?: PowerPoint.Interfaces.
|
|
100994
|
+
load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;
|
|
98934
100995
|
/**
|
|
98935
100996
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
98936
100997
|
*
|
|
98937
100998
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
98938
100999
|
*/
|
|
98939
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
101000
|
+
load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;
|
|
98940
101001
|
/**
|
|
98941
101002
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
98942
101003
|
*
|
|
98943
101004
|
* @param propertyNamesAndPaths `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.
|
|
98944
101005
|
*/
|
|
98945
|
-
load(propertyNamesAndPaths?:
|
|
101006
|
+
load(propertyNamesAndPaths?: {
|
|
101007
|
+
select?: string;
|
|
101008
|
+
expand?: string;
|
|
101009
|
+
}): PowerPoint.ShapeLineFormat;
|
|
98946
101010
|
/**
|
|
98947
101011
|
* 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.)
|
|
98948
|
-
* Whereas the original
|
|
101012
|
+
* Whereas the original PowerPoint.ShapeLineFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeLineFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
98949
101013
|
*/
|
|
98950
|
-
toJSON(): PowerPoint.Interfaces.
|
|
101014
|
+
toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
|
|
98951
101015
|
}
|
|
98952
101016
|
/**
|
|
98953
|
-
*
|
|
101017
|
+
* Specifies the type of a shape.
|
|
98954
101018
|
*
|
|
98955
101019
|
* @remarks
|
|
98956
|
-
* [Api set: PowerPointApi 1.
|
|
101020
|
+
* [Api set: PowerPointApi 1.4]
|
|
98957
101021
|
*/
|
|
98958
|
-
|
|
98959
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
98960
|
-
context: RequestContext;
|
|
101022
|
+
enum ShapeType {
|
|
98961
101023
|
/**
|
|
98962
|
-
*
|
|
98963
|
-
*
|
|
101024
|
+
* The given shape's type is unsupported.
|
|
98964
101025
|
* @remarks
|
|
98965
|
-
* [Api set: PowerPointApi 1.
|
|
101026
|
+
* [Api set: PowerPointApi 1.4]
|
|
98966
101027
|
*/
|
|
98967
|
-
|
|
101028
|
+
unsupported = "Unsupported",
|
|
98968
101029
|
/**
|
|
98969
|
-
*
|
|
98970
|
-
*
|
|
101030
|
+
* The shape is an image
|
|
101031
|
+
* @remarks
|
|
101032
|
+
* [Api set: PowerPointApi 1.4]
|
|
101033
|
+
*/
|
|
101034
|
+
image = "Image",
|
|
101035
|
+
/**
|
|
101036
|
+
* The shape is a geometric shape such as rectangle
|
|
101037
|
+
* @remarks
|
|
101038
|
+
* [Api set: PowerPointApi 1.4]
|
|
101039
|
+
*/
|
|
101040
|
+
geometricShape = "GeometricShape",
|
|
101041
|
+
/**
|
|
101042
|
+
* The shape is a group shape which contains sub-shapes
|
|
101043
|
+
* @remarks
|
|
101044
|
+
* [Api set: PowerPointApi 1.4]
|
|
101045
|
+
*/
|
|
101046
|
+
group = "Group",
|
|
101047
|
+
/**
|
|
101048
|
+
* The shape is a line
|
|
101049
|
+
* @remarks
|
|
101050
|
+
* [Api set: PowerPointApi 1.4]
|
|
101051
|
+
*/
|
|
101052
|
+
line = "Line",
|
|
101053
|
+
}
|
|
101054
|
+
/**
|
|
101055
|
+
* Determines the type of automatic sizing allowed.
|
|
101056
|
+
*
|
|
101057
|
+
* @remarks
|
|
101058
|
+
* [Api set: PowerPointApi 1.4]
|
|
101059
|
+
*/
|
|
101060
|
+
enum ShapeAutoSize {
|
|
101061
|
+
/**
|
|
101062
|
+
* No autosizing.
|
|
101063
|
+
* @remarks
|
|
101064
|
+
* [Api set: PowerPointApi 1.4]
|
|
101065
|
+
*/
|
|
101066
|
+
autoSizeNone = "AutoSizeNone",
|
|
101067
|
+
/**
|
|
101068
|
+
* The text is adjusted to fit the shape.
|
|
101069
|
+
* @remarks
|
|
101070
|
+
* [Api set: PowerPointApi 1.4]
|
|
101071
|
+
*/
|
|
101072
|
+
autoSizeTextToFitShape = "AutoSizeTextToFitShape",
|
|
101073
|
+
/**
|
|
101074
|
+
* The shape is adjusted to fit the text.
|
|
101075
|
+
* @remarks
|
|
101076
|
+
* [Api set: PowerPointApi 1.4]
|
|
101077
|
+
*/
|
|
101078
|
+
autoSizeShapeToFitText = "AutoSizeShapeToFitText",
|
|
101079
|
+
/**
|
|
101080
|
+
* A combination of automatic sizing schemes are used.
|
|
101081
|
+
* @remarks
|
|
101082
|
+
* [Api set: PowerPointApi 1.4]
|
|
101083
|
+
*/
|
|
101084
|
+
autoSizeMixed = "AutoSizeMixed",
|
|
101085
|
+
}
|
|
101086
|
+
/**
|
|
101087
|
+
* Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
|
|
101088
|
+
If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
|
|
101089
|
+
To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
|
|
101090
|
+
*
|
|
101091
|
+
* @remarks
|
|
101092
|
+
* [Api set: PowerPointApi 1.4]
|
|
101093
|
+
*/
|
|
101094
|
+
enum TextVerticalAlignment {
|
|
101095
|
+
/**
|
|
101096
|
+
* Specifies that the `TextFrame` should be top aligned to the `Shape`.
|
|
101097
|
+
* @remarks
|
|
101098
|
+
* [Api set: PowerPointApi 1.4]
|
|
101099
|
+
*/
|
|
101100
|
+
top = "Top",
|
|
101101
|
+
/**
|
|
101102
|
+
* Specifies that the `TextFrame` should be center aligned to the `Shape`.
|
|
101103
|
+
* @remarks
|
|
101104
|
+
* [Api set: PowerPointApi 1.4]
|
|
101105
|
+
*/
|
|
101106
|
+
middle = "Middle",
|
|
101107
|
+
/**
|
|
101108
|
+
* Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
|
|
101109
|
+
* @remarks
|
|
101110
|
+
* [Api set: PowerPointApi 1.4]
|
|
101111
|
+
*/
|
|
101112
|
+
bottom = "Bottom",
|
|
101113
|
+
/**
|
|
101114
|
+
* Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
|
|
101115
|
+
* @remarks
|
|
101116
|
+
* [Api set: PowerPointApi 1.4]
|
|
101117
|
+
*/
|
|
101118
|
+
topCentered = "TopCentered",
|
|
101119
|
+
/**
|
|
101120
|
+
* Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
|
|
101121
|
+
* @remarks
|
|
101122
|
+
* [Api set: PowerPointApi 1.4]
|
|
101123
|
+
*/
|
|
101124
|
+
middleCentered = "MiddleCentered",
|
|
101125
|
+
/**
|
|
101126
|
+
* Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
|
|
101127
|
+
* @remarks
|
|
101128
|
+
* [Api set: PowerPointApi 1.4]
|
|
101129
|
+
*/
|
|
101130
|
+
bottomCentered = "BottomCentered",
|
|
101131
|
+
}
|
|
101132
|
+
/**
|
|
101133
|
+
* The type of underline applied to a font.
|
|
101134
|
+
*
|
|
101135
|
+
* @remarks
|
|
101136
|
+
* [Api set: PowerPointApi 1.4]
|
|
101137
|
+
*/
|
|
101138
|
+
enum ShapeFontUnderlineStyle {
|
|
101139
|
+
/**
|
|
101140
|
+
* No underlining.
|
|
101141
|
+
* @remarks
|
|
101142
|
+
* [Api set: PowerPointApi 1.4]
|
|
101143
|
+
*/
|
|
101144
|
+
none = "None",
|
|
101145
|
+
/**
|
|
101146
|
+
* Regular single line underlining.
|
|
101147
|
+
* @remarks
|
|
101148
|
+
* [Api set: PowerPointApi 1.4]
|
|
101149
|
+
*/
|
|
101150
|
+
single = "Single",
|
|
101151
|
+
/**
|
|
101152
|
+
* Underlining of text with double lines.
|
|
101153
|
+
* @remarks
|
|
101154
|
+
* [Api set: PowerPointApi 1.4]
|
|
101155
|
+
*/
|
|
101156
|
+
double = "Double",
|
|
101157
|
+
/**
|
|
101158
|
+
* Underlining of text with a thick line.
|
|
98971
101159
|
* @remarks
|
|
98972
|
-
* [Api set: PowerPointApi 1.
|
|
101160
|
+
* [Api set: PowerPointApi 1.4]
|
|
98973
101161
|
*/
|
|
98974
|
-
|
|
101162
|
+
heavy = "Heavy",
|
|
98975
101163
|
/**
|
|
98976
|
-
*
|
|
98977
|
-
*
|
|
101164
|
+
* Underlining of text with a dotted line.
|
|
98978
101165
|
* @remarks
|
|
98979
|
-
* [Api set: PowerPointApi 1.
|
|
101166
|
+
* [Api set: PowerPointApi 1.4]
|
|
98980
101167
|
*/
|
|
98981
|
-
|
|
101168
|
+
dotted = "Dotted",
|
|
98982
101169
|
/**
|
|
98983
|
-
*
|
|
98984
|
-
*
|
|
98985
|
-
*
|
|
101170
|
+
* Underlining of text with a thick, dotted line.
|
|
101171
|
+
* @remarks
|
|
101172
|
+
* [Api set: PowerPointApi 1.4]
|
|
98986
101173
|
*/
|
|
98987
|
-
|
|
101174
|
+
dottedHeavy = "DottedHeavy",
|
|
98988
101175
|
/**
|
|
98989
|
-
*
|
|
98990
|
-
*
|
|
98991
|
-
*
|
|
101176
|
+
* Underlining of text with a line containing dashes.
|
|
101177
|
+
* @remarks
|
|
101178
|
+
* [Api set: PowerPointApi 1.4]
|
|
98992
101179
|
*/
|
|
98993
|
-
|
|
101180
|
+
dash = "Dash",
|
|
98994
101181
|
/**
|
|
98995
|
-
*
|
|
98996
|
-
*
|
|
98997
|
-
*
|
|
101182
|
+
* Underlining of text with a thick line containing dashes.
|
|
101183
|
+
* @remarks
|
|
101184
|
+
* [Api set: PowerPointApi 1.4]
|
|
98998
101185
|
*/
|
|
98999
|
-
|
|
99000
|
-
select?: string;
|
|
99001
|
-
expand?: string;
|
|
99002
|
-
}): PowerPoint.SlideLayout;
|
|
101186
|
+
dashHeavy = "DashHeavy",
|
|
99003
101187
|
/**
|
|
99004
|
-
|
|
99005
|
-
|
|
99006
|
-
|
|
99007
|
-
|
|
99008
|
-
|
|
99009
|
-
/**
|
|
99010
|
-
* Represents the collection of layouts provided by the Slide Master for slides.
|
|
99011
|
-
*
|
|
99012
|
-
* @remarks
|
|
99013
|
-
* [Api set: PowerPointApi 1.3]
|
|
99014
|
-
*/
|
|
99015
|
-
class SlideLayoutCollection extends OfficeExtension.ClientObject {
|
|
99016
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
99017
|
-
context: RequestContext;
|
|
99018
|
-
/** Gets the loaded child items in this collection. */
|
|
99019
|
-
readonly items: PowerPoint.SlideLayout[];
|
|
101188
|
+
* Underlining of text with a line containing long dashes.
|
|
101189
|
+
* @remarks
|
|
101190
|
+
* [Api set: PowerPointApi 1.4]
|
|
101191
|
+
*/
|
|
101192
|
+
dashLong = "DashLong",
|
|
99020
101193
|
/**
|
|
99021
|
-
*
|
|
99022
|
-
*
|
|
101194
|
+
* Underlining of text with a thick line containing long dashes.
|
|
99023
101195
|
* @remarks
|
|
99024
|
-
* [Api set: PowerPointApi 1.
|
|
99025
|
-
* @returns The number of layouts in the collection.
|
|
101196
|
+
* [Api set: PowerPointApi 1.4]
|
|
99026
101197
|
*/
|
|
99027
|
-
|
|
101198
|
+
dashLongHeavy = "DashLongHeavy",
|
|
99028
101199
|
/**
|
|
99029
|
-
*
|
|
99030
|
-
*
|
|
101200
|
+
* Underlining of text with a line containing dots and dashes.
|
|
99031
101201
|
* @remarks
|
|
99032
|
-
* [Api set: PowerPointApi 1.
|
|
99033
|
-
*
|
|
99034
|
-
* @param key The ID of the layout.
|
|
99035
|
-
* @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
|
|
101202
|
+
* [Api set: PowerPointApi 1.4]
|
|
99036
101203
|
*/
|
|
99037
|
-
|
|
101204
|
+
dotDash = "DotDash",
|
|
99038
101205
|
/**
|
|
99039
|
-
*
|
|
99040
|
-
*
|
|
101206
|
+
* Underlining of text with a thick line containing dots and dashes.
|
|
99041
101207
|
* @remarks
|
|
99042
|
-
* [Api set: PowerPointApi 1.
|
|
99043
|
-
*
|
|
99044
|
-
* @param index The index of the layout in the collection.
|
|
99045
|
-
* @returns The layout at the given index. An error is thrown if index is out of range.
|
|
101208
|
+
* [Api set: PowerPointApi 1.4]
|
|
99046
101209
|
*/
|
|
99047
|
-
|
|
101210
|
+
dotDashHeavy = "DotDashHeavy",
|
|
99048
101211
|
/**
|
|
99049
|
-
*
|
|
99050
|
-
see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
99051
|
-
*
|
|
101212
|
+
* Underlining of text with a line containing double dots and dashes.
|
|
99052
101213
|
* @remarks
|
|
99053
|
-
* [Api set: PowerPointApi 1.
|
|
99054
|
-
*
|
|
99055
|
-
* @param id The ID of the layout.
|
|
99056
|
-
* @returns The layout with the unique ID.
|
|
101214
|
+
* [Api set: PowerPointApi 1.4]
|
|
99057
101215
|
*/
|
|
99058
|
-
|
|
101216
|
+
dotDotDash = "DotDotDash",
|
|
99059
101217
|
/**
|
|
99060
|
-
*
|
|
99061
|
-
*
|
|
99062
|
-
*
|
|
101218
|
+
* Underlining of text with a thick line containing double dots and dashes.
|
|
101219
|
+
* @remarks
|
|
101220
|
+
* [Api set: PowerPointApi 1.4]
|
|
99063
101221
|
*/
|
|
99064
|
-
|
|
101222
|
+
dotDotDashHeavy = "DotDotDashHeavy",
|
|
99065
101223
|
/**
|
|
99066
|
-
*
|
|
99067
|
-
*
|
|
99068
|
-
*
|
|
101224
|
+
* Underlining of text with a wavy line.
|
|
101225
|
+
* @remarks
|
|
101226
|
+
* [Api set: PowerPointApi 1.4]
|
|
99069
101227
|
*/
|
|
99070
|
-
|
|
101228
|
+
wavy = "Wavy",
|
|
99071
101229
|
/**
|
|
99072
|
-
*
|
|
99073
|
-
*
|
|
99074
|
-
*
|
|
101230
|
+
* Underlining of text with a thick, wavy line.
|
|
101231
|
+
* @remarks
|
|
101232
|
+
* [Api set: PowerPointApi 1.4]
|
|
99075
101233
|
*/
|
|
99076
|
-
|
|
101234
|
+
wavyHeavy = "WavyHeavy",
|
|
99077
101235
|
/**
|
|
99078
|
-
|
|
99079
|
-
|
|
99080
|
-
|
|
99081
|
-
|
|
101236
|
+
* Underlining of text with double wavy lines.
|
|
101237
|
+
* @remarks
|
|
101238
|
+
* [Api set: PowerPointApi 1.4]
|
|
101239
|
+
*/
|
|
101240
|
+
wavyDouble = "WavyDouble",
|
|
99082
101241
|
}
|
|
99083
101242
|
/**
|
|
99084
|
-
* Represents the
|
|
101243
|
+
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
|
|
99085
101244
|
*
|
|
99086
101245
|
* @remarks
|
|
99087
|
-
* [Api set: PowerPointApi 1.
|
|
101246
|
+
* [Api set: PowerPointApi 1.4]
|
|
99088
101247
|
*/
|
|
99089
|
-
class
|
|
101248
|
+
class ShapeFont extends OfficeExtension.ClientObject {
|
|
99090
101249
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
99091
101250
|
context: RequestContext;
|
|
99092
101251
|
/**
|
|
99093
|
-
*
|
|
101252
|
+
* Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
|
|
99094
101253
|
*
|
|
99095
101254
|
* @remarks
|
|
99096
|
-
* [Api set: PowerPointApi 1.
|
|
101255
|
+
* [Api set: PowerPointApi 1.4]
|
|
99097
101256
|
*/
|
|
99098
|
-
|
|
101257
|
+
bold: boolean;
|
|
99099
101258
|
/**
|
|
99100
|
-
*
|
|
101259
|
+
* HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
|
|
99101
101260
|
*
|
|
99102
101261
|
* @remarks
|
|
99103
|
-
* [Api set: PowerPointApi 1.
|
|
101262
|
+
* [Api set: PowerPointApi 1.4]
|
|
99104
101263
|
*/
|
|
99105
|
-
|
|
101264
|
+
color: string;
|
|
99106
101265
|
/**
|
|
99107
|
-
*
|
|
101266
|
+
* Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
|
|
99108
101267
|
*
|
|
99109
101268
|
* @remarks
|
|
99110
|
-
* [Api set: PowerPointApi 1.
|
|
101269
|
+
* [Api set: PowerPointApi 1.4]
|
|
99111
101270
|
*/
|
|
99112
|
-
|
|
101271
|
+
italic: boolean;
|
|
99113
101272
|
/**
|
|
99114
|
-
*
|
|
101273
|
+
* Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
|
|
99115
101274
|
*
|
|
99116
101275
|
* @remarks
|
|
99117
|
-
* [Api set: PowerPointApi 1.
|
|
101276
|
+
* [Api set: PowerPointApi 1.4]
|
|
99118
101277
|
*/
|
|
99119
|
-
|
|
101278
|
+
name: string;
|
|
101279
|
+
/**
|
|
101280
|
+
* Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
|
|
101281
|
+
*
|
|
101282
|
+
* @remarks
|
|
101283
|
+
* [Api set: PowerPointApi 1.4]
|
|
101284
|
+
*/
|
|
101285
|
+
size: number;
|
|
101286
|
+
/**
|
|
101287
|
+
* Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
101288
|
+
*
|
|
101289
|
+
* @remarks
|
|
101290
|
+
* [Api set: PowerPointApi 1.4]
|
|
101291
|
+
*/
|
|
101292
|
+
underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
|
|
99120
101293
|
/**
|
|
99121
101294
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99122
101295
|
*
|
|
99123
101296
|
* @param options Provides options for which properties of the object to load.
|
|
99124
101297
|
*/
|
|
99125
|
-
load(options?: PowerPoint.Interfaces.
|
|
101298
|
+
load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
|
|
99126
101299
|
/**
|
|
99127
101300
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99128
101301
|
*
|
|
99129
101302
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
99130
101303
|
*/
|
|
99131
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
101304
|
+
load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
|
|
99132
101305
|
/**
|
|
99133
101306
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99134
101307
|
*
|
|
@@ -99137,48 +101310,65 @@ declare namespace PowerPoint {
|
|
|
99137
101310
|
load(propertyNamesAndPaths?: {
|
|
99138
101311
|
select?: string;
|
|
99139
101312
|
expand?: string;
|
|
99140
|
-
}): PowerPoint.
|
|
101313
|
+
}): PowerPoint.ShapeFont;
|
|
99141
101314
|
/**
|
|
99142
101315
|
* 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.)
|
|
99143
|
-
* Whereas the original PowerPoint.
|
|
101316
|
+
* Whereas the original PowerPoint.ShapeFont object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object.
|
|
99144
101317
|
*/
|
|
99145
|
-
toJSON(): PowerPoint.Interfaces.
|
|
101318
|
+
toJSON(): PowerPoint.Interfaces.ShapeFontData;
|
|
99146
101319
|
}
|
|
99147
101320
|
/**
|
|
99148
|
-
*
|
|
101321
|
+
* Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
|
|
99149
101322
|
*
|
|
99150
101323
|
* @remarks
|
|
99151
|
-
* [Api set: PowerPointApi 1.
|
|
101324
|
+
* [Api set: PowerPointApi 1.4]
|
|
99152
101325
|
*/
|
|
99153
|
-
class
|
|
101326
|
+
class TextRange extends OfficeExtension.ClientObject {
|
|
99154
101327
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
99155
101328
|
context: RequestContext;
|
|
99156
101329
|
/**
|
|
99157
|
-
*
|
|
101330
|
+
* Returns a `ShapeFont` object that represents the font attributes for the text range.
|
|
99158
101331
|
*
|
|
99159
101332
|
* @remarks
|
|
99160
|
-
* [Api set: PowerPointApi 1.
|
|
101333
|
+
* [Api set: PowerPointApi 1.4]
|
|
99161
101334
|
*/
|
|
99162
|
-
readonly
|
|
101335
|
+
readonly font: PowerPoint.ShapeFont;
|
|
99163
101336
|
/**
|
|
99164
|
-
*
|
|
101337
|
+
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
|
|
99165
101338
|
*
|
|
99166
101339
|
* @remarks
|
|
99167
|
-
* [Api set: PowerPointApi 1.
|
|
101340
|
+
* [Api set: PowerPointApi 1.4]
|
|
99168
101341
|
*/
|
|
99169
|
-
|
|
101342
|
+
readonly paragraphFormat: PowerPoint.ParagraphFormat;
|
|
101343
|
+
/**
|
|
101344
|
+
* Represents the plain text content of the text range.
|
|
101345
|
+
*
|
|
101346
|
+
* @remarks
|
|
101347
|
+
* [Api set: PowerPointApi 1.4]
|
|
101348
|
+
*/
|
|
101349
|
+
text: string;
|
|
101350
|
+
/**
|
|
101351
|
+
* Returns a `TextRange` object for the substring in the given range.
|
|
101352
|
+
*
|
|
101353
|
+
* @remarks
|
|
101354
|
+
* [Api set: PowerPointApi 1.4]
|
|
101355
|
+
*
|
|
101356
|
+
* @param start The zero-based index of the first character to get from the text range.
|
|
101357
|
+
* @param length Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned.
|
|
101358
|
+
*/
|
|
101359
|
+
getSubstring(start: number, length?: number): PowerPoint.TextRange;
|
|
99170
101360
|
/**
|
|
99171
101361
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99172
101362
|
*
|
|
99173
101363
|
* @param options Provides options for which properties of the object to load.
|
|
99174
101364
|
*/
|
|
99175
|
-
load(options?: PowerPoint.Interfaces.
|
|
101365
|
+
load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;
|
|
99176
101366
|
/**
|
|
99177
101367
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99178
101368
|
*
|
|
99179
101369
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
99180
101370
|
*/
|
|
99181
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
101371
|
+
load(propertyNames?: string | string[]): PowerPoint.TextRange;
|
|
99182
101372
|
/**
|
|
99183
101373
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99184
101374
|
*
|
|
@@ -99187,168 +101377,104 @@ declare namespace PowerPoint {
|
|
|
99187
101377
|
load(propertyNamesAndPaths?: {
|
|
99188
101378
|
select?: string;
|
|
99189
101379
|
expand?: string;
|
|
99190
|
-
}): PowerPoint.
|
|
101380
|
+
}): PowerPoint.TextRange;
|
|
99191
101381
|
/**
|
|
99192
101382
|
* 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.)
|
|
99193
|
-
* Whereas the original PowerPoint.
|
|
101383
|
+
* Whereas the original PowerPoint.TextRange object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TextRangeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
99194
101384
|
*/
|
|
99195
|
-
toJSON(): PowerPoint.Interfaces.
|
|
101385
|
+
toJSON(): PowerPoint.Interfaces.TextRangeData;
|
|
99196
101386
|
}
|
|
99197
101387
|
/**
|
|
99198
|
-
* Represents the
|
|
101388
|
+
* Represents the text frame of a shape object.
|
|
99199
101389
|
*
|
|
99200
101390
|
* @remarks
|
|
99201
|
-
* [Api set: PowerPointApi 1.
|
|
101391
|
+
* [Api set: PowerPointApi 1.4]
|
|
99202
101392
|
*/
|
|
99203
|
-
class
|
|
101393
|
+
class TextFrame extends OfficeExtension.ClientObject {
|
|
99204
101394
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
99205
101395
|
context: RequestContext;
|
|
99206
|
-
/** Gets the loaded child items in this collection. */
|
|
99207
|
-
readonly items: PowerPoint.Tag[];
|
|
99208
|
-
/**
|
|
99209
|
-
* Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
|
|
99210
|
-
*
|
|
99211
|
-
* @remarks
|
|
99212
|
-
* [Api set: PowerPointApi 1.3]
|
|
99213
|
-
*
|
|
99214
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
|
|
99215
|
-
* @param value The value of the tag.
|
|
99216
|
-
*/
|
|
99217
|
-
add(key: string, value: string): void;
|
|
99218
|
-
/**
|
|
99219
|
-
* Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
|
|
99220
|
-
*
|
|
99221
|
-
* @remarks
|
|
99222
|
-
* [Api set: PowerPointApi 1.3]
|
|
99223
|
-
*
|
|
99224
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
|
|
99225
|
-
*/
|
|
99226
|
-
delete(key: string): void;
|
|
99227
101396
|
/**
|
|
99228
|
-
*
|
|
101397
|
+
* Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details.
|
|
99229
101398
|
*
|
|
99230
101399
|
* @remarks
|
|
99231
|
-
* [Api set: PowerPointApi 1.
|
|
99232
|
-
* @returns The number of tags in the collection.
|
|
101400
|
+
* [Api set: PowerPointApi 1.4]
|
|
99233
101401
|
*/
|
|
99234
|
-
|
|
101402
|
+
readonly textRange: PowerPoint.TextRange;
|
|
99235
101403
|
/**
|
|
99236
|
-
*
|
|
101404
|
+
* 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.
|
|
99237
101405
|
*
|
|
99238
101406
|
* @remarks
|
|
99239
|
-
* [Api set: PowerPointApi 1.
|
|
99240
|
-
*
|
|
99241
|
-
* @param key The ID of the tag.
|
|
99242
|
-
* @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
|
|
101407
|
+
* [Api set: PowerPointApi 1.4]
|
|
99243
101408
|
*/
|
|
99244
|
-
|
|
101409
|
+
autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
|
|
99245
101410
|
/**
|
|
99246
|
-
*
|
|
101411
|
+
* Represents the bottom margin, in points, of the text frame.
|
|
99247
101412
|
*
|
|
99248
101413
|
* @remarks
|
|
99249
|
-
* [Api set: PowerPointApi 1.
|
|
99250
|
-
*
|
|
99251
|
-
* @param index The index of the tag in the collection.
|
|
99252
|
-
* @returns The tag at the given index. An error is thrown if index is out of range.
|
|
101414
|
+
* [Api set: PowerPointApi 1.4]
|
|
99253
101415
|
*/
|
|
99254
|
-
|
|
101416
|
+
bottomMargin: number;
|
|
99255
101417
|
/**
|
|
99256
|
-
*
|
|
101418
|
+
* Specifies if the text frame contains text.
|
|
99257
101419
|
*
|
|
99258
101420
|
* @remarks
|
|
99259
|
-
* [Api set: PowerPointApi 1.
|
|
99260
|
-
|
|
99261
|
-
|
|
99262
|
-
* @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
|
|
99263
|
-
*/
|
|
99264
|
-
getItemOrNullObject(key: string): PowerPoint.Tag;
|
|
99265
|
-
/**
|
|
99266
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99267
|
-
*
|
|
99268
|
-
* @param options Provides options for which properties of the object to load.
|
|
99269
|
-
*/
|
|
99270
|
-
load(options?: PowerPoint.Interfaces.TagCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TagCollection;
|
|
99271
|
-
/**
|
|
99272
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99273
|
-
*
|
|
99274
|
-
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
99275
|
-
*/
|
|
99276
|
-
load(propertyNames?: string | string[]): PowerPoint.TagCollection;
|
|
99277
|
-
/**
|
|
99278
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99279
|
-
*
|
|
99280
|
-
* @param propertyNamesAndPaths `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.
|
|
99281
|
-
*/
|
|
99282
|
-
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TagCollection;
|
|
99283
|
-
/**
|
|
99284
|
-
* 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.)
|
|
99285
|
-
* Whereas the original `PowerPoint.TagCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TagCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
99286
|
-
*/
|
|
99287
|
-
toJSON(): PowerPoint.Interfaces.TagCollectionData;
|
|
99288
|
-
}
|
|
99289
|
-
/**
|
|
99290
|
-
* Represents a single slide of a presentation.
|
|
99291
|
-
*
|
|
99292
|
-
* @remarks
|
|
99293
|
-
* [Api set: PowerPointApi 1.2]
|
|
99294
|
-
*/
|
|
99295
|
-
class Slide extends OfficeExtension.ClientObject {
|
|
99296
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
99297
|
-
context: RequestContext;
|
|
101421
|
+
* [Api set: PowerPointApi 1.4]
|
|
101422
|
+
*/
|
|
101423
|
+
readonly hasText: boolean;
|
|
99298
101424
|
/**
|
|
99299
|
-
*
|
|
101425
|
+
* Represents the left margin, in points, of the text frame.
|
|
99300
101426
|
*
|
|
99301
101427
|
* @remarks
|
|
99302
|
-
* [Api set: PowerPointApi 1.
|
|
101428
|
+
* [Api set: PowerPointApi 1.4]
|
|
99303
101429
|
*/
|
|
99304
|
-
|
|
101430
|
+
leftMargin: number;
|
|
99305
101431
|
/**
|
|
99306
|
-
*
|
|
101432
|
+
* Represents the right margin, in points, of the text frame.
|
|
99307
101433
|
*
|
|
99308
101434
|
* @remarks
|
|
99309
|
-
* [Api set: PowerPointApi 1.
|
|
101435
|
+
* [Api set: PowerPointApi 1.4]
|
|
99310
101436
|
*/
|
|
99311
|
-
|
|
101437
|
+
rightMargin: number;
|
|
99312
101438
|
/**
|
|
99313
|
-
*
|
|
101439
|
+
* Represents the top margin, in points, of the text frame.
|
|
99314
101440
|
*
|
|
99315
101441
|
* @remarks
|
|
99316
|
-
* [Api set: PowerPointApi 1.
|
|
101442
|
+
* [Api set: PowerPointApi 1.4]
|
|
99317
101443
|
*/
|
|
99318
|
-
|
|
101444
|
+
topMargin: number;
|
|
99319
101445
|
/**
|
|
99320
|
-
*
|
|
101446
|
+
* Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
|
|
99321
101447
|
*
|
|
99322
101448
|
* @remarks
|
|
99323
|
-
* [Api set: PowerPointApi 1.
|
|
101449
|
+
* [Api set: PowerPointApi 1.4]
|
|
99324
101450
|
*/
|
|
99325
|
-
|
|
101451
|
+
verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
|
|
99326
101452
|
/**
|
|
99327
|
-
*
|
|
101453
|
+
* Determines whether lines break automatically to fit text inside the shape.
|
|
99328
101454
|
*
|
|
99329
101455
|
* @remarks
|
|
99330
|
-
* [Api set: PowerPointApi 1.
|
|
101456
|
+
* [Api set: PowerPointApi 1.4]
|
|
99331
101457
|
*/
|
|
99332
|
-
|
|
101458
|
+
wordWrap: boolean;
|
|
99333
101459
|
/**
|
|
99334
|
-
* Deletes
|
|
101460
|
+
* Deletes all the text in the text frame.
|
|
99335
101461
|
*
|
|
99336
101462
|
* @remarks
|
|
99337
|
-
* [Api set: PowerPointApi 1.
|
|
101463
|
+
* [Api set: PowerPointApi 1.4]
|
|
99338
101464
|
*/
|
|
99339
|
-
|
|
101465
|
+
deleteText(): void;
|
|
99340
101466
|
/**
|
|
99341
101467
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99342
101468
|
*
|
|
99343
101469
|
* @param options Provides options for which properties of the object to load.
|
|
99344
101470
|
*/
|
|
99345
|
-
load(options?: PowerPoint.Interfaces.
|
|
101471
|
+
load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;
|
|
99346
101472
|
/**
|
|
99347
101473
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99348
101474
|
*
|
|
99349
101475
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
99350
101476
|
*/
|
|
99351
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
101477
|
+
load(propertyNames?: string | string[]): PowerPoint.TextFrame;
|
|
99352
101478
|
/**
|
|
99353
101479
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
99354
101480
|
*
|
|
@@ -99357,12 +101483,12 @@ declare namespace PowerPoint {
|
|
|
99357
101483
|
load(propertyNamesAndPaths?: {
|
|
99358
101484
|
select?: string;
|
|
99359
101485
|
expand?: string;
|
|
99360
|
-
}): PowerPoint.
|
|
101486
|
+
}): PowerPoint.TextFrame;
|
|
99361
101487
|
/**
|
|
99362
101488
|
* 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.)
|
|
99363
|
-
* Whereas the original PowerPoint.
|
|
101489
|
+
* 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.
|
|
99364
101490
|
*/
|
|
99365
|
-
toJSON(): PowerPoint.Interfaces.
|
|
101491
|
+
toJSON(): PowerPoint.Interfaces.TextFrameData;
|
|
99366
101492
|
}
|
|
99367
101493
|
/**
|
|
99368
101494
|
* Represents a single shape in the slide.
|
|
@@ -99373,6 +101499,20 @@ declare namespace PowerPoint {
|
|
|
99373
101499
|
class Shape extends OfficeExtension.ClientObject {
|
|
99374
101500
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
99375
101501
|
context: RequestContext;
|
|
101502
|
+
/**
|
|
101503
|
+
* Returns the fill formatting of this shape.
|
|
101504
|
+
*
|
|
101505
|
+
* @remarks
|
|
101506
|
+
* [Api set: PowerPointApi 1.4]
|
|
101507
|
+
*/
|
|
101508
|
+
readonly fill: PowerPoint.ShapeFill;
|
|
101509
|
+
/**
|
|
101510
|
+
* Returns the line formatting of this shape.
|
|
101511
|
+
*
|
|
101512
|
+
* @remarks
|
|
101513
|
+
* [Api set: PowerPointApi 1.4]
|
|
101514
|
+
*/
|
|
101515
|
+
readonly lineFormat: PowerPoint.ShapeLineFormat;
|
|
99376
101516
|
/**
|
|
99377
101517
|
* Returns a collection of tags in the shape.
|
|
99378
101518
|
*
|
|
@@ -99380,6 +101520,20 @@ declare namespace PowerPoint {
|
|
|
99380
101520
|
* [Api set: PowerPointApi 1.3]
|
|
99381
101521
|
*/
|
|
99382
101522
|
readonly tags: PowerPoint.TagCollection;
|
|
101523
|
+
/**
|
|
101524
|
+
* Returns the text frame object of this shape.
|
|
101525
|
+
*
|
|
101526
|
+
* @remarks
|
|
101527
|
+
* [Api set: PowerPointApi 1.4]
|
|
101528
|
+
*/
|
|
101529
|
+
readonly textFrame: PowerPoint.TextFrame;
|
|
101530
|
+
/**
|
|
101531
|
+
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
101532
|
+
*
|
|
101533
|
+
* @remarks
|
|
101534
|
+
* [Api set: PowerPointApi 1.4]
|
|
101535
|
+
*/
|
|
101536
|
+
height: number;
|
|
99383
101537
|
/**
|
|
99384
101538
|
* Gets the unique ID of the shape.
|
|
99385
101539
|
*
|
|
@@ -99387,6 +101541,41 @@ declare namespace PowerPoint {
|
|
|
99387
101541
|
* [Api set: PowerPointApi 1.3]
|
|
99388
101542
|
*/
|
|
99389
101543
|
readonly id: string;
|
|
101544
|
+
/**
|
|
101545
|
+
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
101546
|
+
*
|
|
101547
|
+
* @remarks
|
|
101548
|
+
* [Api set: PowerPointApi 1.4]
|
|
101549
|
+
*/
|
|
101550
|
+
left: number;
|
|
101551
|
+
/**
|
|
101552
|
+
* Specifies the name of this shape.
|
|
101553
|
+
*
|
|
101554
|
+
* @remarks
|
|
101555
|
+
* [Api set: PowerPointApi 1.4]
|
|
101556
|
+
*/
|
|
101557
|
+
name: string;
|
|
101558
|
+
/**
|
|
101559
|
+
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
101560
|
+
*
|
|
101561
|
+
* @remarks
|
|
101562
|
+
* [Api set: PowerPointApi 1.4]
|
|
101563
|
+
*/
|
|
101564
|
+
top: number;
|
|
101565
|
+
/**
|
|
101566
|
+
* Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
|
|
101567
|
+
*
|
|
101568
|
+
* @remarks
|
|
101569
|
+
* [Api set: PowerPointApi 1.4]
|
|
101570
|
+
*/
|
|
101571
|
+
readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
|
|
101572
|
+
/**
|
|
101573
|
+
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
101574
|
+
*
|
|
101575
|
+
* @remarks
|
|
101576
|
+
* [Api set: PowerPointApi 1.4]
|
|
101577
|
+
*/
|
|
101578
|
+
width: number;
|
|
99390
101579
|
/**
|
|
99391
101580
|
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
|
|
99392
101581
|
*
|
|
@@ -99597,6 +101786,26 @@ declare namespace PowerPoint {
|
|
|
99597
101786
|
*/
|
|
99598
101787
|
$skip?: number;
|
|
99599
101788
|
}
|
|
101789
|
+
/** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
|
|
101790
|
+
interface BulletFormatUpdateData {
|
|
101791
|
+
/**
|
|
101792
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
101793
|
+
*
|
|
101794
|
+
* @remarks
|
|
101795
|
+
* [Api set: PowerPointApi 1.4]
|
|
101796
|
+
*/
|
|
101797
|
+
visible?: boolean;
|
|
101798
|
+
}
|
|
101799
|
+
/** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
|
|
101800
|
+
interface ParagraphFormatUpdateData {
|
|
101801
|
+
/**
|
|
101802
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
101803
|
+
*
|
|
101804
|
+
* @remarks
|
|
101805
|
+
* [Api set: PowerPointApi 1.4]
|
|
101806
|
+
*/
|
|
101807
|
+
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
101808
|
+
}
|
|
99600
101809
|
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
99601
101810
|
interface ShapeCollectionUpdateData {
|
|
99602
101811
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
@@ -99619,6 +101828,213 @@ declare namespace PowerPoint {
|
|
|
99619
101828
|
interface TagCollectionUpdateData {
|
|
99620
101829
|
items?: PowerPoint.Interfaces.TagData[];
|
|
99621
101830
|
}
|
|
101831
|
+
/** An interface for updating data on the ShapeFill object, for use in `shapeFill.set({ ... })`. */
|
|
101832
|
+
interface ShapeFillUpdateData {
|
|
101833
|
+
/**
|
|
101834
|
+
* Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
101835
|
+
*
|
|
101836
|
+
* @remarks
|
|
101837
|
+
* [Api set: PowerPointApi 1.4]
|
|
101838
|
+
*/
|
|
101839
|
+
foregroundColor?: string;
|
|
101840
|
+
/**
|
|
101841
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
101842
|
+
*
|
|
101843
|
+
* @remarks
|
|
101844
|
+
* [Api set: PowerPointApi 1.4]
|
|
101845
|
+
*/
|
|
101846
|
+
transparency?: number;
|
|
101847
|
+
}
|
|
101848
|
+
/** An interface for updating data on the ShapeLineFormat object, for use in `shapeLineFormat.set({ ... })`. */
|
|
101849
|
+
interface ShapeLineFormatUpdateData {
|
|
101850
|
+
/**
|
|
101851
|
+
* Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
101852
|
+
*
|
|
101853
|
+
* @remarks
|
|
101854
|
+
* [Api set: PowerPointApi 1.4]
|
|
101855
|
+
*/
|
|
101856
|
+
color?: string;
|
|
101857
|
+
/**
|
|
101858
|
+
* Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
|
|
101859
|
+
*
|
|
101860
|
+
* @remarks
|
|
101861
|
+
* [Api set: PowerPointApi 1.4]
|
|
101862
|
+
*/
|
|
101863
|
+
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
|
|
101864
|
+
/**
|
|
101865
|
+
* Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
|
|
101866
|
+
*
|
|
101867
|
+
* @remarks
|
|
101868
|
+
* [Api set: PowerPointApi 1.4]
|
|
101869
|
+
*/
|
|
101870
|
+
style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
|
|
101871
|
+
/**
|
|
101872
|
+
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
|
|
101873
|
+
*
|
|
101874
|
+
* @remarks
|
|
101875
|
+
* [Api set: PowerPointApi 1.4]
|
|
101876
|
+
*/
|
|
101877
|
+
transparency?: number;
|
|
101878
|
+
/**
|
|
101879
|
+
* Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
|
|
101880
|
+
*
|
|
101881
|
+
* @remarks
|
|
101882
|
+
* [Api set: PowerPointApi 1.4]
|
|
101883
|
+
*/
|
|
101884
|
+
visible?: boolean;
|
|
101885
|
+
/**
|
|
101886
|
+
* Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
|
|
101887
|
+
*
|
|
101888
|
+
* @remarks
|
|
101889
|
+
* [Api set: PowerPointApi 1.4]
|
|
101890
|
+
*/
|
|
101891
|
+
weight?: number;
|
|
101892
|
+
}
|
|
101893
|
+
/** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
|
|
101894
|
+
interface ShapeFontUpdateData {
|
|
101895
|
+
/**
|
|
101896
|
+
* Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
|
|
101897
|
+
*
|
|
101898
|
+
* @remarks
|
|
101899
|
+
* [Api set: PowerPointApi 1.4]
|
|
101900
|
+
*/
|
|
101901
|
+
bold?: boolean;
|
|
101902
|
+
/**
|
|
101903
|
+
* HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
|
|
101904
|
+
*
|
|
101905
|
+
* @remarks
|
|
101906
|
+
* [Api set: PowerPointApi 1.4]
|
|
101907
|
+
*/
|
|
101908
|
+
color?: string;
|
|
101909
|
+
/**
|
|
101910
|
+
* Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
|
|
101911
|
+
*
|
|
101912
|
+
* @remarks
|
|
101913
|
+
* [Api set: PowerPointApi 1.4]
|
|
101914
|
+
*/
|
|
101915
|
+
italic?: boolean;
|
|
101916
|
+
/**
|
|
101917
|
+
* Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
|
|
101918
|
+
*
|
|
101919
|
+
* @remarks
|
|
101920
|
+
* [Api set: PowerPointApi 1.4]
|
|
101921
|
+
*/
|
|
101922
|
+
name?: string;
|
|
101923
|
+
/**
|
|
101924
|
+
* Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
|
|
101925
|
+
*
|
|
101926
|
+
* @remarks
|
|
101927
|
+
* [Api set: PowerPointApi 1.4]
|
|
101928
|
+
*/
|
|
101929
|
+
size?: number;
|
|
101930
|
+
/**
|
|
101931
|
+
* Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
101932
|
+
*
|
|
101933
|
+
* @remarks
|
|
101934
|
+
* [Api set: PowerPointApi 1.4]
|
|
101935
|
+
*/
|
|
101936
|
+
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
|
|
101937
|
+
}
|
|
101938
|
+
/** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */
|
|
101939
|
+
interface TextRangeUpdateData {
|
|
101940
|
+
/**
|
|
101941
|
+
* Represents the plain text content of the text range.
|
|
101942
|
+
*
|
|
101943
|
+
* @remarks
|
|
101944
|
+
* [Api set: PowerPointApi 1.4]
|
|
101945
|
+
*/
|
|
101946
|
+
text?: string;
|
|
101947
|
+
}
|
|
101948
|
+
/** An interface for updating data on the TextFrame object, for use in `textFrame.set({ ... })`. */
|
|
101949
|
+
interface TextFrameUpdateData {
|
|
101950
|
+
/**
|
|
101951
|
+
* 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.
|
|
101952
|
+
*
|
|
101953
|
+
* @remarks
|
|
101954
|
+
* [Api set: PowerPointApi 1.4]
|
|
101955
|
+
*/
|
|
101956
|
+
autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
|
|
101957
|
+
/**
|
|
101958
|
+
* Represents the bottom margin, in points, of the text frame.
|
|
101959
|
+
*
|
|
101960
|
+
* @remarks
|
|
101961
|
+
* [Api set: PowerPointApi 1.4]
|
|
101962
|
+
*/
|
|
101963
|
+
bottomMargin?: number;
|
|
101964
|
+
/**
|
|
101965
|
+
* Represents the left margin, in points, of the text frame.
|
|
101966
|
+
*
|
|
101967
|
+
* @remarks
|
|
101968
|
+
* [Api set: PowerPointApi 1.4]
|
|
101969
|
+
*/
|
|
101970
|
+
leftMargin?: number;
|
|
101971
|
+
/**
|
|
101972
|
+
* Represents the right margin, in points, of the text frame.
|
|
101973
|
+
*
|
|
101974
|
+
* @remarks
|
|
101975
|
+
* [Api set: PowerPointApi 1.4]
|
|
101976
|
+
*/
|
|
101977
|
+
rightMargin?: number;
|
|
101978
|
+
/**
|
|
101979
|
+
* Represents the top margin, in points, of the text frame.
|
|
101980
|
+
*
|
|
101981
|
+
* @remarks
|
|
101982
|
+
* [Api set: PowerPointApi 1.4]
|
|
101983
|
+
*/
|
|
101984
|
+
topMargin?: number;
|
|
101985
|
+
/**
|
|
101986
|
+
* Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
|
|
101987
|
+
*
|
|
101988
|
+
* @remarks
|
|
101989
|
+
* [Api set: PowerPointApi 1.4]
|
|
101990
|
+
*/
|
|
101991
|
+
verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
|
|
101992
|
+
/**
|
|
101993
|
+
* Determines whether lines break automatically to fit text inside the shape.
|
|
101994
|
+
*
|
|
101995
|
+
* @remarks
|
|
101996
|
+
* [Api set: PowerPointApi 1.4]
|
|
101997
|
+
*/
|
|
101998
|
+
wordWrap?: boolean;
|
|
101999
|
+
}
|
|
102000
|
+
/** An interface for updating data on the Shape object, for use in `shape.set({ ... })`. */
|
|
102001
|
+
interface ShapeUpdateData {
|
|
102002
|
+
/**
|
|
102003
|
+
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
102004
|
+
*
|
|
102005
|
+
* @remarks
|
|
102006
|
+
* [Api set: PowerPointApi 1.4]
|
|
102007
|
+
*/
|
|
102008
|
+
height?: number;
|
|
102009
|
+
/**
|
|
102010
|
+
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
102011
|
+
*
|
|
102012
|
+
* @remarks
|
|
102013
|
+
* [Api set: PowerPointApi 1.4]
|
|
102014
|
+
*/
|
|
102015
|
+
left?: number;
|
|
102016
|
+
/**
|
|
102017
|
+
* Specifies the name of this shape.
|
|
102018
|
+
*
|
|
102019
|
+
* @remarks
|
|
102020
|
+
* [Api set: PowerPointApi 1.4]
|
|
102021
|
+
*/
|
|
102022
|
+
name?: string;
|
|
102023
|
+
/**
|
|
102024
|
+
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
102025
|
+
*
|
|
102026
|
+
* @remarks
|
|
102027
|
+
* [Api set: PowerPointApi 1.4]
|
|
102028
|
+
*/
|
|
102029
|
+
top?: number;
|
|
102030
|
+
/**
|
|
102031
|
+
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
102032
|
+
*
|
|
102033
|
+
* @remarks
|
|
102034
|
+
* [Api set: PowerPointApi 1.4]
|
|
102035
|
+
*/
|
|
102036
|
+
width?: number;
|
|
102037
|
+
}
|
|
99622
102038
|
/** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
|
|
99623
102039
|
interface SlideCollectionUpdateData {
|
|
99624
102040
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -99627,9 +102043,29 @@ declare namespace PowerPoint {
|
|
|
99627
102043
|
interface SlideMasterCollectionUpdateData {
|
|
99628
102044
|
items?: PowerPoint.Interfaces.SlideMasterData[];
|
|
99629
102045
|
}
|
|
99630
|
-
/** An interface describing the data returned by calling `presentation.toJSON()`. */
|
|
99631
|
-
interface PresentationData {
|
|
99632
|
-
title?: string;
|
|
102046
|
+
/** An interface describing the data returned by calling `presentation.toJSON()`. */
|
|
102047
|
+
interface PresentationData {
|
|
102048
|
+
title?: string;
|
|
102049
|
+
}
|
|
102050
|
+
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
|
|
102051
|
+
interface BulletFormatData {
|
|
102052
|
+
/**
|
|
102053
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
102054
|
+
*
|
|
102055
|
+
* @remarks
|
|
102056
|
+
* [Api set: PowerPointApi 1.4]
|
|
102057
|
+
*/
|
|
102058
|
+
visible?: boolean;
|
|
102059
|
+
}
|
|
102060
|
+
/** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
|
|
102061
|
+
interface ParagraphFormatData {
|
|
102062
|
+
/**
|
|
102063
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
102064
|
+
*
|
|
102065
|
+
* @remarks
|
|
102066
|
+
* [Api set: PowerPointApi 1.4]
|
|
102067
|
+
*/
|
|
102068
|
+
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
99633
102069
|
}
|
|
99634
102070
|
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
|
|
99635
102071
|
interface ShapeCollectionData {
|
|
@@ -99704,8 +102140,198 @@ declare namespace PowerPoint {
|
|
|
99704
102140
|
*/
|
|
99705
102141
|
id?: string;
|
|
99706
102142
|
}
|
|
102143
|
+
/** An interface describing the data returned by calling `shapeFill.toJSON()`. */
|
|
102144
|
+
interface ShapeFillData {
|
|
102145
|
+
/**
|
|
102146
|
+
* Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
102147
|
+
*
|
|
102148
|
+
* @remarks
|
|
102149
|
+
* [Api set: PowerPointApi 1.4]
|
|
102150
|
+
*/
|
|
102151
|
+
foregroundColor?: string;
|
|
102152
|
+
/**
|
|
102153
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
102154
|
+
*
|
|
102155
|
+
* @remarks
|
|
102156
|
+
* [Api set: PowerPointApi 1.4]
|
|
102157
|
+
*/
|
|
102158
|
+
transparency?: number;
|
|
102159
|
+
/**
|
|
102160
|
+
* Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
|
|
102161
|
+
*
|
|
102162
|
+
* @remarks
|
|
102163
|
+
* [Api set: PowerPointApi 1.4]
|
|
102164
|
+
*/
|
|
102165
|
+
type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
|
|
102166
|
+
}
|
|
102167
|
+
/** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
|
|
102168
|
+
interface ShapeLineFormatData {
|
|
102169
|
+
/**
|
|
102170
|
+
* Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
102171
|
+
*
|
|
102172
|
+
* @remarks
|
|
102173
|
+
* [Api set: PowerPointApi 1.4]
|
|
102174
|
+
*/
|
|
102175
|
+
color?: string;
|
|
102176
|
+
/**
|
|
102177
|
+
* Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
|
|
102178
|
+
*
|
|
102179
|
+
* @remarks
|
|
102180
|
+
* [Api set: PowerPointApi 1.4]
|
|
102181
|
+
*/
|
|
102182
|
+
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
|
|
102183
|
+
/**
|
|
102184
|
+
* Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
|
|
102185
|
+
*
|
|
102186
|
+
* @remarks
|
|
102187
|
+
* [Api set: PowerPointApi 1.4]
|
|
102188
|
+
*/
|
|
102189
|
+
style?: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
|
|
102190
|
+
/**
|
|
102191
|
+
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
|
|
102192
|
+
*
|
|
102193
|
+
* @remarks
|
|
102194
|
+
* [Api set: PowerPointApi 1.4]
|
|
102195
|
+
*/
|
|
102196
|
+
transparency?: number;
|
|
102197
|
+
/**
|
|
102198
|
+
* Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
|
|
102199
|
+
*
|
|
102200
|
+
* @remarks
|
|
102201
|
+
* [Api set: PowerPointApi 1.4]
|
|
102202
|
+
*/
|
|
102203
|
+
visible?: boolean;
|
|
102204
|
+
/**
|
|
102205
|
+
* Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
|
|
102206
|
+
*
|
|
102207
|
+
* @remarks
|
|
102208
|
+
* [Api set: PowerPointApi 1.4]
|
|
102209
|
+
*/
|
|
102210
|
+
weight?: number;
|
|
102211
|
+
}
|
|
102212
|
+
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
|
|
102213
|
+
interface ShapeFontData {
|
|
102214
|
+
/**
|
|
102215
|
+
* Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
|
|
102216
|
+
*
|
|
102217
|
+
* @remarks
|
|
102218
|
+
* [Api set: PowerPointApi 1.4]
|
|
102219
|
+
*/
|
|
102220
|
+
bold?: boolean;
|
|
102221
|
+
/**
|
|
102222
|
+
* HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
|
|
102223
|
+
*
|
|
102224
|
+
* @remarks
|
|
102225
|
+
* [Api set: PowerPointApi 1.4]
|
|
102226
|
+
*/
|
|
102227
|
+
color?: string;
|
|
102228
|
+
/**
|
|
102229
|
+
* Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
|
|
102230
|
+
*
|
|
102231
|
+
* @remarks
|
|
102232
|
+
* [Api set: PowerPointApi 1.4]
|
|
102233
|
+
*/
|
|
102234
|
+
italic?: boolean;
|
|
102235
|
+
/**
|
|
102236
|
+
* Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
|
|
102237
|
+
*
|
|
102238
|
+
* @remarks
|
|
102239
|
+
* [Api set: PowerPointApi 1.4]
|
|
102240
|
+
*/
|
|
102241
|
+
name?: string;
|
|
102242
|
+
/**
|
|
102243
|
+
* Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
|
|
102244
|
+
*
|
|
102245
|
+
* @remarks
|
|
102246
|
+
* [Api set: PowerPointApi 1.4]
|
|
102247
|
+
*/
|
|
102248
|
+
size?: number;
|
|
102249
|
+
/**
|
|
102250
|
+
* Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
102251
|
+
*
|
|
102252
|
+
* @remarks
|
|
102253
|
+
* [Api set: PowerPointApi 1.4]
|
|
102254
|
+
*/
|
|
102255
|
+
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
|
|
102256
|
+
}
|
|
102257
|
+
/** An interface describing the data returned by calling `textRange.toJSON()`. */
|
|
102258
|
+
interface TextRangeData {
|
|
102259
|
+
/**
|
|
102260
|
+
* Represents the plain text content of the text range.
|
|
102261
|
+
*
|
|
102262
|
+
* @remarks
|
|
102263
|
+
* [Api set: PowerPointApi 1.4]
|
|
102264
|
+
*/
|
|
102265
|
+
text?: string;
|
|
102266
|
+
}
|
|
102267
|
+
/** An interface describing the data returned by calling `textFrame.toJSON()`. */
|
|
102268
|
+
interface TextFrameData {
|
|
102269
|
+
/**
|
|
102270
|
+
* 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.
|
|
102271
|
+
*
|
|
102272
|
+
* @remarks
|
|
102273
|
+
* [Api set: PowerPointApi 1.4]
|
|
102274
|
+
*/
|
|
102275
|
+
autoSizeSetting?: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
|
|
102276
|
+
/**
|
|
102277
|
+
* Represents the bottom margin, in points, of the text frame.
|
|
102278
|
+
*
|
|
102279
|
+
* @remarks
|
|
102280
|
+
* [Api set: PowerPointApi 1.4]
|
|
102281
|
+
*/
|
|
102282
|
+
bottomMargin?: number;
|
|
102283
|
+
/**
|
|
102284
|
+
* Specifies if the text frame contains text.
|
|
102285
|
+
*
|
|
102286
|
+
* @remarks
|
|
102287
|
+
* [Api set: PowerPointApi 1.4]
|
|
102288
|
+
*/
|
|
102289
|
+
hasText?: boolean;
|
|
102290
|
+
/**
|
|
102291
|
+
* Represents the left margin, in points, of the text frame.
|
|
102292
|
+
*
|
|
102293
|
+
* @remarks
|
|
102294
|
+
* [Api set: PowerPointApi 1.4]
|
|
102295
|
+
*/
|
|
102296
|
+
leftMargin?: number;
|
|
102297
|
+
/**
|
|
102298
|
+
* Represents the right margin, in points, of the text frame.
|
|
102299
|
+
*
|
|
102300
|
+
* @remarks
|
|
102301
|
+
* [Api set: PowerPointApi 1.4]
|
|
102302
|
+
*/
|
|
102303
|
+
rightMargin?: number;
|
|
102304
|
+
/**
|
|
102305
|
+
* Represents the top margin, in points, of the text frame.
|
|
102306
|
+
*
|
|
102307
|
+
* @remarks
|
|
102308
|
+
* [Api set: PowerPointApi 1.4]
|
|
102309
|
+
*/
|
|
102310
|
+
topMargin?: number;
|
|
102311
|
+
/**
|
|
102312
|
+
* Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
|
|
102313
|
+
*
|
|
102314
|
+
* @remarks
|
|
102315
|
+
* [Api set: PowerPointApi 1.4]
|
|
102316
|
+
*/
|
|
102317
|
+
verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";
|
|
102318
|
+
/**
|
|
102319
|
+
* Determines whether lines break automatically to fit text inside the shape.
|
|
102320
|
+
*
|
|
102321
|
+
* @remarks
|
|
102322
|
+
* [Api set: PowerPointApi 1.4]
|
|
102323
|
+
*/
|
|
102324
|
+
wordWrap?: boolean;
|
|
102325
|
+
}
|
|
99707
102326
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
99708
102327
|
interface ShapeData {
|
|
102328
|
+
/**
|
|
102329
|
+
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
102330
|
+
*
|
|
102331
|
+
* @remarks
|
|
102332
|
+
* [Api set: PowerPointApi 1.4]
|
|
102333
|
+
*/
|
|
102334
|
+
height?: number;
|
|
99709
102335
|
/**
|
|
99710
102336
|
* Gets the unique ID of the shape.
|
|
99711
102337
|
*
|
|
@@ -99713,6 +102339,41 @@ declare namespace PowerPoint {
|
|
|
99713
102339
|
* [Api set: PowerPointApi 1.3]
|
|
99714
102340
|
*/
|
|
99715
102341
|
id?: string;
|
|
102342
|
+
/**
|
|
102343
|
+
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
102344
|
+
*
|
|
102345
|
+
* @remarks
|
|
102346
|
+
* [Api set: PowerPointApi 1.4]
|
|
102347
|
+
*/
|
|
102348
|
+
left?: number;
|
|
102349
|
+
/**
|
|
102350
|
+
* Specifies the name of this shape.
|
|
102351
|
+
*
|
|
102352
|
+
* @remarks
|
|
102353
|
+
* [Api set: PowerPointApi 1.4]
|
|
102354
|
+
*/
|
|
102355
|
+
name?: string;
|
|
102356
|
+
/**
|
|
102357
|
+
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
102358
|
+
*
|
|
102359
|
+
* @remarks
|
|
102360
|
+
* [Api set: PowerPointApi 1.4]
|
|
102361
|
+
*/
|
|
102362
|
+
top?: number;
|
|
102363
|
+
/**
|
|
102364
|
+
* Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
|
|
102365
|
+
*
|
|
102366
|
+
* @remarks
|
|
102367
|
+
* [Api set: PowerPointApi 1.4]
|
|
102368
|
+
*/
|
|
102369
|
+
type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
|
|
102370
|
+
/**
|
|
102371
|
+
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
102372
|
+
*
|
|
102373
|
+
* @remarks
|
|
102374
|
+
* [Api set: PowerPointApi 1.4]
|
|
102375
|
+
*/
|
|
102376
|
+
width?: number;
|
|
99716
102377
|
}
|
|
99717
102378
|
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
|
|
99718
102379
|
interface SlideCollectionData {
|
|
@@ -99733,6 +102394,51 @@ declare namespace PowerPoint {
|
|
|
99733
102394
|
$all?: boolean;
|
|
99734
102395
|
title?: boolean;
|
|
99735
102396
|
}
|
|
102397
|
+
/**
|
|
102398
|
+
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
|
|
102399
|
+
*
|
|
102400
|
+
* @remarks
|
|
102401
|
+
* [Api set: PowerPointApi 1.4]
|
|
102402
|
+
*/
|
|
102403
|
+
interface BulletFormatLoadOptions {
|
|
102404
|
+
/**
|
|
102405
|
+
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`).
|
|
102406
|
+
*/
|
|
102407
|
+
$all?: boolean;
|
|
102408
|
+
/**
|
|
102409
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
102410
|
+
*
|
|
102411
|
+
* @remarks
|
|
102412
|
+
* [Api set: PowerPointApi 1.4]
|
|
102413
|
+
*/
|
|
102414
|
+
visible?: boolean;
|
|
102415
|
+
}
|
|
102416
|
+
/**
|
|
102417
|
+
* Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
|
|
102418
|
+
*
|
|
102419
|
+
* @remarks
|
|
102420
|
+
* [Api set: PowerPointApi 1.4]
|
|
102421
|
+
*/
|
|
102422
|
+
interface ParagraphFormatLoadOptions {
|
|
102423
|
+
/**
|
|
102424
|
+
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`).
|
|
102425
|
+
*/
|
|
102426
|
+
$all?: boolean;
|
|
102427
|
+
/**
|
|
102428
|
+
* Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
|
|
102429
|
+
*
|
|
102430
|
+
* @remarks
|
|
102431
|
+
* [Api set: PowerPointApi 1.4]
|
|
102432
|
+
*/
|
|
102433
|
+
bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
|
|
102434
|
+
/**
|
|
102435
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
102436
|
+
*
|
|
102437
|
+
* @remarks
|
|
102438
|
+
* [Api set: PowerPointApi 1.4]
|
|
102439
|
+
*/
|
|
102440
|
+
horizontalAlignment?: boolean;
|
|
102441
|
+
}
|
|
99736
102442
|
/**
|
|
99737
102443
|
* Represents the collection of shapes.
|
|
99738
102444
|
*
|
|
@@ -99741,16 +102447,79 @@ declare namespace PowerPoint {
|
|
|
99741
102447
|
*/
|
|
99742
102448
|
interface ShapeCollectionLoadOptions {
|
|
99743
102449
|
/**
|
|
99744
|
-
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`).
|
|
102450
|
+
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`).
|
|
102451
|
+
*/
|
|
102452
|
+
$all?: boolean;
|
|
102453
|
+
/**
|
|
102454
|
+
* For EACH ITEM in the collection: Returns the fill formatting of this shape.
|
|
102455
|
+
*
|
|
102456
|
+
* @remarks
|
|
102457
|
+
* [Api set: PowerPointApi 1.4]
|
|
102458
|
+
*/
|
|
102459
|
+
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
102460
|
+
/**
|
|
102461
|
+
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
102462
|
+
*
|
|
102463
|
+
* @remarks
|
|
102464
|
+
* [Api set: PowerPointApi 1.4]
|
|
102465
|
+
*/
|
|
102466
|
+
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
102467
|
+
/**
|
|
102468
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
102469
|
+
*
|
|
102470
|
+
* @remarks
|
|
102471
|
+
* [Api set: PowerPointApi 1.4]
|
|
102472
|
+
*/
|
|
102473
|
+
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
102474
|
+
/**
|
|
102475
|
+
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
102476
|
+
*
|
|
102477
|
+
* @remarks
|
|
102478
|
+
* [Api set: PowerPointApi 1.4]
|
|
102479
|
+
*/
|
|
102480
|
+
height?: boolean;
|
|
102481
|
+
/**
|
|
102482
|
+
* For EACH ITEM in the collection: Gets the unique ID of the shape.
|
|
102483
|
+
*
|
|
102484
|
+
* @remarks
|
|
102485
|
+
* [Api set: PowerPointApi 1.3]
|
|
102486
|
+
*/
|
|
102487
|
+
id?: boolean;
|
|
102488
|
+
/**
|
|
102489
|
+
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
|
|
102490
|
+
*
|
|
102491
|
+
* @remarks
|
|
102492
|
+
* [Api set: PowerPointApi 1.4]
|
|
102493
|
+
*/
|
|
102494
|
+
left?: boolean;
|
|
102495
|
+
/**
|
|
102496
|
+
* For EACH ITEM in the collection: Specifies the name of this shape.
|
|
102497
|
+
*
|
|
102498
|
+
* @remarks
|
|
102499
|
+
* [Api set: PowerPointApi 1.4]
|
|
102500
|
+
*/
|
|
102501
|
+
name?: boolean;
|
|
102502
|
+
/**
|
|
102503
|
+
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
102504
|
+
*
|
|
102505
|
+
* @remarks
|
|
102506
|
+
* [Api set: PowerPointApi 1.4]
|
|
102507
|
+
*/
|
|
102508
|
+
top?: boolean;
|
|
102509
|
+
/**
|
|
102510
|
+
* For EACH ITEM in the collection: Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
|
|
102511
|
+
*
|
|
102512
|
+
* @remarks
|
|
102513
|
+
* [Api set: PowerPointApi 1.4]
|
|
99745
102514
|
*/
|
|
99746
|
-
|
|
102515
|
+
type?: boolean;
|
|
99747
102516
|
/**
|
|
99748
|
-
* For EACH ITEM in the collection:
|
|
102517
|
+
* For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
99749
102518
|
*
|
|
99750
102519
|
* @remarks
|
|
99751
|
-
* [Api set: PowerPointApi 1.
|
|
102520
|
+
* [Api set: PowerPointApi 1.4]
|
|
99752
102521
|
*/
|
|
99753
|
-
|
|
102522
|
+
width?: boolean;
|
|
99754
102523
|
}
|
|
99755
102524
|
/**
|
|
99756
102525
|
* Represents the layout of a slide.
|
|
@@ -99915,6 +102684,255 @@ declare namespace PowerPoint {
|
|
|
99915
102684
|
*/
|
|
99916
102685
|
id?: boolean;
|
|
99917
102686
|
}
|
|
102687
|
+
/**
|
|
102688
|
+
* Represents the fill formatting of a shape object.
|
|
102689
|
+
*
|
|
102690
|
+
* @remarks
|
|
102691
|
+
* [Api set: PowerPointApi 1.4]
|
|
102692
|
+
*/
|
|
102693
|
+
interface ShapeFillLoadOptions {
|
|
102694
|
+
/**
|
|
102695
|
+
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`).
|
|
102696
|
+
*/
|
|
102697
|
+
$all?: boolean;
|
|
102698
|
+
/**
|
|
102699
|
+
* Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
102700
|
+
*
|
|
102701
|
+
* @remarks
|
|
102702
|
+
* [Api set: PowerPointApi 1.4]
|
|
102703
|
+
*/
|
|
102704
|
+
foregroundColor?: boolean;
|
|
102705
|
+
/**
|
|
102706
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
102707
|
+
*
|
|
102708
|
+
* @remarks
|
|
102709
|
+
* [Api set: PowerPointApi 1.4]
|
|
102710
|
+
*/
|
|
102711
|
+
transparency?: boolean;
|
|
102712
|
+
/**
|
|
102713
|
+
* Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
|
|
102714
|
+
*
|
|
102715
|
+
* @remarks
|
|
102716
|
+
* [Api set: PowerPointApi 1.4]
|
|
102717
|
+
*/
|
|
102718
|
+
type?: boolean;
|
|
102719
|
+
}
|
|
102720
|
+
/**
|
|
102721
|
+
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
|
|
102722
|
+
*
|
|
102723
|
+
* @remarks
|
|
102724
|
+
* [Api set: PowerPointApi 1.4]
|
|
102725
|
+
*/
|
|
102726
|
+
interface ShapeLineFormatLoadOptions {
|
|
102727
|
+
/**
|
|
102728
|
+
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`).
|
|
102729
|
+
*/
|
|
102730
|
+
$all?: boolean;
|
|
102731
|
+
/**
|
|
102732
|
+
* Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
102733
|
+
*
|
|
102734
|
+
* @remarks
|
|
102735
|
+
* [Api set: PowerPointApi 1.4]
|
|
102736
|
+
*/
|
|
102737
|
+
color?: boolean;
|
|
102738
|
+
/**
|
|
102739
|
+
* Represents the dash style of the line. Returns null when the line is not visible or there are inconsistent dash styles. See PowerPoint.ShapeLineDashStyle for details.
|
|
102740
|
+
*
|
|
102741
|
+
* @remarks
|
|
102742
|
+
* [Api set: PowerPointApi 1.4]
|
|
102743
|
+
*/
|
|
102744
|
+
dashStyle?: boolean;
|
|
102745
|
+
/**
|
|
102746
|
+
* Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See PowerPoint.ShapeLineStyle for details.
|
|
102747
|
+
*
|
|
102748
|
+
* @remarks
|
|
102749
|
+
* [Api set: PowerPointApi 1.4]
|
|
102750
|
+
*/
|
|
102751
|
+
style?: boolean;
|
|
102752
|
+
/**
|
|
102753
|
+
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
|
|
102754
|
+
*
|
|
102755
|
+
* @remarks
|
|
102756
|
+
* [Api set: PowerPointApi 1.4]
|
|
102757
|
+
*/
|
|
102758
|
+
transparency?: boolean;
|
|
102759
|
+
/**
|
|
102760
|
+
* Specifies if the line formatting of a shape element is visible. Returns `null` when the shape has inconsistent visibilities.
|
|
102761
|
+
*
|
|
102762
|
+
* @remarks
|
|
102763
|
+
* [Api set: PowerPointApi 1.4]
|
|
102764
|
+
*/
|
|
102765
|
+
visible?: boolean;
|
|
102766
|
+
/**
|
|
102767
|
+
* Represents the weight of the line, in points. Returns `null` when the line is not visible or there are inconsistent line weights.
|
|
102768
|
+
*
|
|
102769
|
+
* @remarks
|
|
102770
|
+
* [Api set: PowerPointApi 1.4]
|
|
102771
|
+
*/
|
|
102772
|
+
weight?: boolean;
|
|
102773
|
+
}
|
|
102774
|
+
/**
|
|
102775
|
+
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
|
|
102776
|
+
*
|
|
102777
|
+
* @remarks
|
|
102778
|
+
* [Api set: PowerPointApi 1.4]
|
|
102779
|
+
*/
|
|
102780
|
+
interface ShapeFontLoadOptions {
|
|
102781
|
+
/**
|
|
102782
|
+
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`).
|
|
102783
|
+
*/
|
|
102784
|
+
$all?: boolean;
|
|
102785
|
+
/**
|
|
102786
|
+
* Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
|
|
102787
|
+
*
|
|
102788
|
+
* @remarks
|
|
102789
|
+
* [Api set: PowerPointApi 1.4]
|
|
102790
|
+
*/
|
|
102791
|
+
bold?: boolean;
|
|
102792
|
+
/**
|
|
102793
|
+
* HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
|
|
102794
|
+
*
|
|
102795
|
+
* @remarks
|
|
102796
|
+
* [Api set: PowerPointApi 1.4]
|
|
102797
|
+
*/
|
|
102798
|
+
color?: boolean;
|
|
102799
|
+
/**
|
|
102800
|
+
* Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
|
|
102801
|
+
*
|
|
102802
|
+
* @remarks
|
|
102803
|
+
* [Api set: PowerPointApi 1.4]
|
|
102804
|
+
*/
|
|
102805
|
+
italic?: boolean;
|
|
102806
|
+
/**
|
|
102807
|
+
* Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
|
|
102808
|
+
*
|
|
102809
|
+
* @remarks
|
|
102810
|
+
* [Api set: PowerPointApi 1.4]
|
|
102811
|
+
*/
|
|
102812
|
+
name?: boolean;
|
|
102813
|
+
/**
|
|
102814
|
+
* Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
|
|
102815
|
+
*
|
|
102816
|
+
* @remarks
|
|
102817
|
+
* [Api set: PowerPointApi 1.4]
|
|
102818
|
+
*/
|
|
102819
|
+
size?: boolean;
|
|
102820
|
+
/**
|
|
102821
|
+
* Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
102822
|
+
*
|
|
102823
|
+
* @remarks
|
|
102824
|
+
* [Api set: PowerPointApi 1.4]
|
|
102825
|
+
*/
|
|
102826
|
+
underline?: boolean;
|
|
102827
|
+
}
|
|
102828
|
+
/**
|
|
102829
|
+
* Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
|
|
102830
|
+
*
|
|
102831
|
+
* @remarks
|
|
102832
|
+
* [Api set: PowerPointApi 1.4]
|
|
102833
|
+
*/
|
|
102834
|
+
interface TextRangeLoadOptions {
|
|
102835
|
+
/**
|
|
102836
|
+
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`).
|
|
102837
|
+
*/
|
|
102838
|
+
$all?: boolean;
|
|
102839
|
+
/**
|
|
102840
|
+
* Returns a `ShapeFont` object that represents the font attributes for the text range.
|
|
102841
|
+
*
|
|
102842
|
+
* @remarks
|
|
102843
|
+
* [Api set: PowerPointApi 1.4]
|
|
102844
|
+
*/
|
|
102845
|
+
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
|
|
102846
|
+
/**
|
|
102847
|
+
* Represents the paragraph format of the text range. See {@link PowerPoint.ParagraphFormat} for details.
|
|
102848
|
+
*
|
|
102849
|
+
* @remarks
|
|
102850
|
+
* [Api set: PowerPointApi 1.4]
|
|
102851
|
+
*/
|
|
102852
|
+
paragraphFormat?: PowerPoint.Interfaces.ParagraphFormatLoadOptions;
|
|
102853
|
+
/**
|
|
102854
|
+
* Represents the plain text content of the text range.
|
|
102855
|
+
*
|
|
102856
|
+
* @remarks
|
|
102857
|
+
* [Api set: PowerPointApi 1.4]
|
|
102858
|
+
*/
|
|
102859
|
+
text?: boolean;
|
|
102860
|
+
}
|
|
102861
|
+
/**
|
|
102862
|
+
* Represents the text frame of a shape object.
|
|
102863
|
+
*
|
|
102864
|
+
* @remarks
|
|
102865
|
+
* [Api set: PowerPointApi 1.4]
|
|
102866
|
+
*/
|
|
102867
|
+
interface TextFrameLoadOptions {
|
|
102868
|
+
/**
|
|
102869
|
+
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`).
|
|
102870
|
+
*/
|
|
102871
|
+
$all?: boolean;
|
|
102872
|
+
/**
|
|
102873
|
+
* Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See {@link PowerPoint.TextRange} for details.
|
|
102874
|
+
*
|
|
102875
|
+
* @remarks
|
|
102876
|
+
* [Api set: PowerPointApi 1.4]
|
|
102877
|
+
*/
|
|
102878
|
+
textRange?: PowerPoint.Interfaces.TextRangeLoadOptions;
|
|
102879
|
+
/**
|
|
102880
|
+
* 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.
|
|
102881
|
+
*
|
|
102882
|
+
* @remarks
|
|
102883
|
+
* [Api set: PowerPointApi 1.4]
|
|
102884
|
+
*/
|
|
102885
|
+
autoSizeSetting?: boolean;
|
|
102886
|
+
/**
|
|
102887
|
+
* Represents the bottom margin, in points, of the text frame.
|
|
102888
|
+
*
|
|
102889
|
+
* @remarks
|
|
102890
|
+
* [Api set: PowerPointApi 1.4]
|
|
102891
|
+
*/
|
|
102892
|
+
bottomMargin?: boolean;
|
|
102893
|
+
/**
|
|
102894
|
+
* Specifies if the text frame contains text.
|
|
102895
|
+
*
|
|
102896
|
+
* @remarks
|
|
102897
|
+
* [Api set: PowerPointApi 1.4]
|
|
102898
|
+
*/
|
|
102899
|
+
hasText?: boolean;
|
|
102900
|
+
/**
|
|
102901
|
+
* Represents the left margin, in points, of the text frame.
|
|
102902
|
+
*
|
|
102903
|
+
* @remarks
|
|
102904
|
+
* [Api set: PowerPointApi 1.4]
|
|
102905
|
+
*/
|
|
102906
|
+
leftMargin?: boolean;
|
|
102907
|
+
/**
|
|
102908
|
+
* Represents the right margin, in points, of the text frame.
|
|
102909
|
+
*
|
|
102910
|
+
* @remarks
|
|
102911
|
+
* [Api set: PowerPointApi 1.4]
|
|
102912
|
+
*/
|
|
102913
|
+
rightMargin?: boolean;
|
|
102914
|
+
/**
|
|
102915
|
+
* Represents the top margin, in points, of the text frame.
|
|
102916
|
+
*
|
|
102917
|
+
* @remarks
|
|
102918
|
+
* [Api set: PowerPointApi 1.4]
|
|
102919
|
+
*/
|
|
102920
|
+
topMargin?: boolean;
|
|
102921
|
+
/**
|
|
102922
|
+
* Represents the vertical alignment of the text frame. See {@link PowerPoint.TextVerticalAlignment} for details.
|
|
102923
|
+
*
|
|
102924
|
+
* @remarks
|
|
102925
|
+
* [Api set: PowerPointApi 1.4]
|
|
102926
|
+
*/
|
|
102927
|
+
verticalAlignment?: boolean;
|
|
102928
|
+
/**
|
|
102929
|
+
* Determines whether lines break automatically to fit text inside the shape.
|
|
102930
|
+
*
|
|
102931
|
+
* @remarks
|
|
102932
|
+
* [Api set: PowerPointApi 1.4]
|
|
102933
|
+
*/
|
|
102934
|
+
wordWrap?: boolean;
|
|
102935
|
+
}
|
|
99918
102936
|
/**
|
|
99919
102937
|
* Represents a single shape in the slide.
|
|
99920
102938
|
*
|
|
@@ -99926,6 +102944,34 @@ declare namespace PowerPoint {
|
|
|
99926
102944
|
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`).
|
|
99927
102945
|
*/
|
|
99928
102946
|
$all?: boolean;
|
|
102947
|
+
/**
|
|
102948
|
+
* Returns the fill formatting of this shape.
|
|
102949
|
+
*
|
|
102950
|
+
* @remarks
|
|
102951
|
+
* [Api set: PowerPointApi 1.4]
|
|
102952
|
+
*/
|
|
102953
|
+
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
102954
|
+
/**
|
|
102955
|
+
* Returns the line formatting of this shape.
|
|
102956
|
+
*
|
|
102957
|
+
* @remarks
|
|
102958
|
+
* [Api set: PowerPointApi 1.4]
|
|
102959
|
+
*/
|
|
102960
|
+
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
102961
|
+
/**
|
|
102962
|
+
* Returns the text frame object of this shape.
|
|
102963
|
+
*
|
|
102964
|
+
* @remarks
|
|
102965
|
+
* [Api set: PowerPointApi 1.4]
|
|
102966
|
+
*/
|
|
102967
|
+
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
102968
|
+
/**
|
|
102969
|
+
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
102970
|
+
*
|
|
102971
|
+
* @remarks
|
|
102972
|
+
* [Api set: PowerPointApi 1.4]
|
|
102973
|
+
*/
|
|
102974
|
+
height?: boolean;
|
|
99929
102975
|
/**
|
|
99930
102976
|
* Gets the unique ID of the shape.
|
|
99931
102977
|
*
|
|
@@ -99933,6 +102979,41 @@ declare namespace PowerPoint {
|
|
|
99933
102979
|
* [Api set: PowerPointApi 1.3]
|
|
99934
102980
|
*/
|
|
99935
102981
|
id?: boolean;
|
|
102982
|
+
/**
|
|
102983
|
+
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
102984
|
+
*
|
|
102985
|
+
* @remarks
|
|
102986
|
+
* [Api set: PowerPointApi 1.4]
|
|
102987
|
+
*/
|
|
102988
|
+
left?: boolean;
|
|
102989
|
+
/**
|
|
102990
|
+
* Specifies the name of this shape.
|
|
102991
|
+
*
|
|
102992
|
+
* @remarks
|
|
102993
|
+
* [Api set: PowerPointApi 1.4]
|
|
102994
|
+
*/
|
|
102995
|
+
name?: boolean;
|
|
102996
|
+
/**
|
|
102997
|
+
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
102998
|
+
*
|
|
102999
|
+
* @remarks
|
|
103000
|
+
* [Api set: PowerPointApi 1.4]
|
|
103001
|
+
*/
|
|
103002
|
+
top?: boolean;
|
|
103003
|
+
/**
|
|
103004
|
+
* Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
|
|
103005
|
+
*
|
|
103006
|
+
* @remarks
|
|
103007
|
+
* [Api set: PowerPointApi 1.4]
|
|
103008
|
+
*/
|
|
103009
|
+
type?: boolean;
|
|
103010
|
+
/**
|
|
103011
|
+
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
103012
|
+
*
|
|
103013
|
+
* @remarks
|
|
103014
|
+
* [Api set: PowerPointApi 1.4]
|
|
103015
|
+
*/
|
|
103016
|
+
width?: boolean;
|
|
99936
103017
|
}
|
|
99937
103018
|
/**
|
|
99938
103019
|
* Represents the collection of slides in the presentation.
|