Edit

Share via

Word.Interfaces.LineFormatUpdateData interface

Package:
word

An interface for updating data on the LineFormat object, for use in lineFormat.set({ ... }).

Properties

backgroundColor

Gets a ColorFormat object that represents the background color for a patterned line.
beginArrowheadLength

Specifies the length of the arrowhead at the beginning of the line.
beginArrowheadStyle

Specifies the style of the arrowhead at the beginning of the line.
beginArrowheadWidth

Specifies the width of the arrowhead at the beginning of the line.
dashStyle

Specifies the dash style for the line.
endArrowheadLength

Specifies the length of the arrowhead at the end of the line.
endArrowheadStyle

Specifies the style of the arrowhead at the end of the line.
endArrowheadWidth

Specifies the width of the arrowhead at the end of the line.
foregroundColor

Gets a ColorFormat object that represents the foreground color for the line.
insetPen

Specifies if to draw lines inside a shape.
isVisible

Specifies if the object, or the formatting applied to it, is visible.
pattern

Specifies the pattern applied to the line.
style

Specifies the line format style.
transparency

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

Specifies the thickness of the line in points.

Property Details

backgroundColor

Gets a ColorFormat object that represents the background color for a patterned line.

backgroundColor?: Word.Interfaces.ColorFormatUpdateData;

Property Value

Word.Interfaces.ColorFormatUpdateData

Remarks

[ API set: WordApiDesktop 1.3 ]

beginArrowheadLength

Specifies the length of the arrowhead at the beginning of the line.

beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

Property Value

Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"

Remarks

[ API set: WordApiDesktop 1.3 ]

beginArrowheadStyle

Specifies the style of the arrowhead at the beginning of the line.

beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

Property Value

Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"

Remarks

[ API set: WordApiDesktop 1.3 ]

beginArrowheadWidth

Specifies the width of the arrowhead at the beginning of the line.

beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

Property Value

Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"

Remarks

[ API set: WordApiDesktop 1.3 ]

dashStyle

Specifies the dash style for the line.

dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot";

Property Value

Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"

Remarks

[ API set: WordApiDesktop 1.3 ]

endArrowheadLength

Specifies the length of the arrowhead at the end of the line.

endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

Property Value

Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"

Remarks

[ API set: WordApiDesktop 1.3 ]

endArrowheadStyle

Specifies the style of the arrowhead at the end of the line.

endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

Property Value

Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"

Remarks

[ API set: WordApiDesktop 1.3 ]

endArrowheadWidth

Specifies the width of the arrowhead at the end of the line.

endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

Property Value

Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"

Remarks

[ API set: WordApiDesktop 1.3 ]

foregroundColor

Gets a ColorFormat object that represents the foreground color for the line.

foregroundColor?: Word.Interfaces.ColorFormatUpdateData;

Property Value

Word.Interfaces.ColorFormatUpdateData

Remarks

[ API set: WordApiDesktop 1.3 ]

insetPen

Specifies if to draw lines inside a shape.

insetPen?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

isVisible

Specifies if the object, or the formatting applied to it, is visible.

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

pattern

Specifies the pattern applied to the line.

pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";

Property Value

Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"

Remarks

[ API set: WordApiDesktop 1.3 ]

style

Specifies the line format style.

style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin";

Property Value

Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"

Remarks

[ API set: WordApiDesktop 1.3 ]

transparency

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

transparency?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

weight

Specifies the thickness of the line in points.

weight?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]