Edit

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.

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

dashStyle

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

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

dashStyle

Specifies the dash style for the line.

dashStyle?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.3

foregroundColor

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

foregroundColor?: Word.Interfaces.ColorFormatLoadOptions;

Property Value

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

style

Specifies the line format style.

style?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.3

weight

Specifies the thickness of the line in points.

weight?: boolean;

Property Value

boolean

Remarks

API set: WordApiDesktop 1.3