Word.Interfaces.BorderData interface

  • Reference
Package:
word

An interface describing the data returned by calling border.toJSON().

Properties

color

Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.
location

Gets the location of the border.
type

Specifies the border type for the border.
visible

Specifies whether the border is visible.
width

Specifies the width for the border.

Property Details

color

Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name.

color?: string;

Property Value

string

Remarks

[ API set: WordApiDesktop 1.1 ]

location

Gets the location of the border.

location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All";

Property Value

Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"

Remarks

[ API set: WordApiDesktop 1.1 ]

type

Specifies the border type for the border.

type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";

Property Value

Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"

Remarks

[ API set: WordApiDesktop 1.1 ]

visible

Specifies whether the border is visible.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.1 ]

width

Specifies the width for the border.

width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";

Property Value

Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"

Remarks

[ API set: WordApiDesktop 1.1 ]