Word.Interfaces.LineFormatLoadOptions interface
Represents line and arrowhead formatting. For a line, the LineFormat object contains formatting information for the line itself; for a shape with a border, this object contains formatting information for the shape's border.
Remarks
Properties
| $all | Specifying |
| background |
Gets a |
| begin |
Specifies the length of the arrowhead at the beginning of the line. |
| begin |
Specifies the style of the arrowhead at the beginning of the line. |
| begin |
Specifies the width of the arrowhead at the beginning of the line. |
| dash |
Specifies the dash style for the line. |
| end |
Specifies the length of the arrowhead at the end of the line. |
| end |
Specifies the style of the arrowhead at the end of the line. |
| end |
Specifies the width of the arrowhead at the end of the line. |
| foreground |
Gets a |
| inset |
Specifies if to draw lines inside a shape. |
| is |
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
$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).
$all?: boolean;Property Value
boolean
backgroundColor
Gets a ColorFormat object that represents the background color for a patterned line.
backgroundColor?: Word.Interfaces.ColorFormatLoadOptions;Property Value
Remarks
beginArrowheadLength
Specifies the length of the arrowhead at the beginning of the line.
beginArrowheadLength?: boolean;Property Value
boolean
Remarks
beginArrowheadStyle
Specifies the style of the arrowhead at the beginning of the line.
beginArrowheadStyle?: boolean;Property Value
boolean
Remarks
beginArrowheadWidth
Specifies the width of the arrowhead at the beginning of the line.
beginArrowheadWidth?: boolean;Property Value
boolean
Remarks
dashStyle
Specifies the dash style for the line.
dashStyle?: boolean;Property Value
boolean
Remarks
endArrowheadLength
Specifies the length of the arrowhead at the end of the line.
endArrowheadLength?: boolean;Property Value
boolean
Remarks
endArrowheadStyle
Specifies the style of the arrowhead at the end of the line.
endArrowheadStyle?: boolean;Property Value
boolean
Remarks
endArrowheadWidth
Specifies the width of the arrowhead at the end of the line.
endArrowheadWidth?: boolean;Property Value
boolean
Remarks
foregroundColor
Gets a ColorFormat object that represents the foreground color for the line.
foregroundColor?: Word.Interfaces.ColorFormatLoadOptions;Property Value
Remarks
insetPen
Specifies if to draw lines inside a shape.
insetPen?: boolean;Property Value
boolean
Remarks
isVisible
Specifies if the object, or the formatting applied to it, is visible.
isVisible?: boolean;Property Value
boolean
Remarks
pattern
Specifies the pattern applied to the line.
pattern?: boolean;Property Value
boolean
Remarks
style
Specifies the line format style.
style?: boolean;Property Value
boolean
Remarks
transparency
Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear).
transparency?: boolean;Property Value
boolean
Remarks
weight
Specifies the thickness of the line in points.
weight?: boolean;Property Value
boolean