Word.ShadowFormat class

Specifies the blur level for a shadow format as a value between 0.0 and 100.0.

blur: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Returns a ColorFormat object that represents the foreground color for the fill, line, or shadow.

readonly foregroundColor: Word.ColorFormat;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies whether the object or the formatting applied to it is visible.

isVisible: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies true if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, false if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill.

obscured: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the horizontal offset (in points) of the shadow from the shape. A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left.

offsetX: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the vertical offset (in points) of the shadow from the shape. A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom.

offsetY: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies whether to rotate the shadow when rotating the shape.

rotateWithShape: boolean;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the width of the shadow.

size: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the type of shadow formatting to apply to a shape.

style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).

transparency: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Specifies the shape shadow type.

type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Changes the horizontal offset of the shadow by the number of points. Increment The number of points to adjust.

incrementOffsetX(increment: number): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Changes the vertical offset of the shadow by the specified number of points. Increment The number of points to adjust.

incrementOffsetY(increment: number): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.ShadowFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ShadowFormat;

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.ShadowFormat): void;

Parameters

Returns

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's passed to it.) Whereas the original Word.ShadowFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.ShadowFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.ShadowFormatData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.ShadowFormat;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.ShadowFormat;

Returns