Edit

Share via

Word.Interfaces.LineFormatLoadOptions interface

Package:
word

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

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

$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

backgroundColor

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.

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

backgroundColor?: Word.Interfaces.ColorFormatLoadOptions;

Property Value

Word.Interfaces.ColorFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

beginArrowheadLength

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 length of the arrowhead at the beginning of the line.

beginArrowheadLength?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

beginArrowheadStyle

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 style of the arrowhead at the beginning of the line.

beginArrowheadStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

beginArrowheadWidth

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 width of the arrowhead at the beginning of the line.

beginArrowheadWidth?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

dashStyle

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 dash style for the line.

dashStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

endArrowheadLength

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 length of the arrowhead at the end of the line.

endArrowheadLength?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

endArrowheadStyle

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 style of the arrowhead at the end of the line.

endArrowheadStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

endArrowheadWidth

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 width of the arrowhead at the end of the line.

endArrowheadWidth?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

foregroundColor

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.

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

foregroundColor?: Word.Interfaces.ColorFormatLoadOptions;

Property Value

Word.Interfaces.ColorFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

insetPen

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 if to draw lines inside a shape.

insetPen?: 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.

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

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

pattern

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 pattern applied to the line.

pattern?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

style

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 line format style.

style?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

transparency

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 degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear).

transparency?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

weight

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 thickness of the line in points.

weight?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]