MsoLineFormatHelper

MsoLineFormatHelper class

Represents line and arrowhead formatting.

class MsoLineFormatHelper;

Methods

MethodDescription
isVisible()Indicates whether the object is visible.
setIsVisible(boolean)Indicates whether the object is visible.
getStyle()Returns a Style object that represents the style of the specified range.
setStyle(MsoLineStyle)Returns a Style object that represents the style of the specified range.
getForeColor()Gets and sets the border line fore color.
setForeColor(Color)Gets and sets the border line fore color.
getBackColor()Gets and sets the border line back color.
setBackColor(Color)Gets and sets the border line back color.
getDashStyle()Gets or sets the dash style for the specified line.
setDashStyle(MsoLineDashStyle)Gets or sets the dash style for the specified line.
getTransparency()Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
setTransparency(number)Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
getWeight()Returns or sets the weight of the line ,in units of pt.
setWeight(number)Returns or sets the weight of the line ,in units of pt.
isNull()Checks whether the implementation object is null.

isVisible()

Indicates whether the object is visible.

isVisible() : boolean;

setIsVisible(boolean)

Indicates whether the object is visible.

setIsVisible(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getStyle()

Returns a Style object that represents the style of the specified range.

getStyle() : MsoLineStyle;

Returns

MsoLineStyle

setStyle(MsoLineStyle)

Returns a Style object that represents the style of the specified range.

setStyle(value: MsoLineStyle) : void;

Parameters:

ParameterTypeDescription
valueMsoLineStyleThe value to set.

getForeColor()

Gets and sets the border line fore color.

getForeColor() : Color;

Returns

Color

setForeColor(Color)

Gets and sets the border line fore color.

setForeColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getBackColor()

Gets and sets the border line back color.

getBackColor() : Color;

Returns

Color

setBackColor(Color)

Gets and sets the border line back color.

setBackColor(value: Color) : void;

Parameters:

ParameterTypeDescription
valueColorThe value to set.

getDashStyle()

Gets or sets the dash style for the specified line.

getDashStyle() : MsoLineDashStyle;

Returns

MsoLineDashStyle

setDashStyle(MsoLineDashStyle)

Gets or sets the dash style for the specified line.

setDashStyle(value: MsoLineDashStyle) : void;

Parameters:

ParameterTypeDescription
valueMsoLineDashStyleThe value to set.

getTransparency()

Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

getTransparency() : number;

setTransparency(number)

Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

setTransparency(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getWeight()

Returns or sets the weight of the line ,in units of pt.

getWeight() : number;

setWeight(number)

Returns or sets the weight of the line ,in units of pt.

setWeight(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;