Edit

Word.Interfaces.LineFormatUpdateData interface

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

Remarks

Used by

Properties

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

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

foregroundColor

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

foregroundColor?: Word.Interfaces.ColorFormatUpdateData;

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