Edit

Word.Interfaces.ShadingLoadOptions interface

  • Reference
Package:
word

Represents the shading object.

Remarks

[ API set: WordApi 1.6 ]

Properties

$all

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).
backgroundPatternColor

Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.
foregroundPatternColor

Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.
texture

Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see Add, change, or delete the background color in Word.

Property Details

$all

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).

$all?: boolean;

Property Value

boolean

backgroundPatternColor

Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name.

backgroundPatternColor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.6 ]

foregroundPatternColor

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name.

foregroundPatternColor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

texture

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see Add, change, or delete the background color in Word.

texture?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]