Edit

Share via


Word.Interfaces.BorderUniversalCollectionLoadOptions interface

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.

Represents the collection of Word.BorderUniversal objects.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

artStyle

For EACH ITEM in the collection: Specifies the graphical page-border design for the document.

artWidth

For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the artStyle property.

color

For EACH ITEM in the collection: Specifies the color for the BorderUniversal object. You can provide the value in the '#RRGGBB' format.

colorIndex

For EACH ITEM in the collection: Specifies the color for the BorderUniversal or Word.Font object.

inside

For EACH ITEM in the collection: Returns true if an inside border can be applied to the specified object.

isVisible

For EACH ITEM in the collection: Specifies whether the border is visible.

lineStyle

For EACH ITEM in the collection: Specifies the line style of the border.

lineWidth

For EACH ITEM in the collection: Specifies the line width of an object's border.

Property Details

$all

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.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

artStyle

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.

For EACH ITEM in the collection: Specifies the graphical page-border design for the document.

artStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

artWidth

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.

For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the artStyle property.

artWidth?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

color

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.

For EACH ITEM in the collection: Specifies the color for the BorderUniversal object. You can provide the value in the '#RRGGBB' format.

color?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

colorIndex

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.

For EACH ITEM in the collection: Specifies the color for the BorderUniversal or Word.Font object.

colorIndex?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

inside

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.

For EACH ITEM in the collection: Returns true if an inside border can be applied to the specified object.

inside?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isVisible

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.

For EACH ITEM in the collection: Specifies whether the border is visible.

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

lineStyle

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.

For EACH ITEM in the collection: Specifies the line style of the border.

lineStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

lineWidth

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.

For EACH ITEM in the collection: Specifies the line width of an object's border.

lineWidth?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]