MsoLineFormatHelper
MsoLineFormatHelper class
Represents line and arrowhead formatting.
class MsoLineFormatHelper;
Properties
| Property | Type | Description |
|---|---|---|
| isVisible | boolean | Indicates whether the object is visible. |
| style | MsoLineStyle | Returns a Style object that represents the style of the specified range. |
| foreColor | Color | Gets and sets the border line fore color. |
| backColor | Color | Gets and sets the border line back color. |
| dashStyle | MsoLineDashStyle | Gets or sets the dash style for the specified line. |
| transparency | number | Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). |
| weight | number | Returns or sets the weight of the line ,in units of pt. |
Methods
| Method | Description |
|---|---|
| isVisible() | @deprecated. Please use the ‘isVisible’ property instead. Indicates whether the object is visible. |
| setIsVisible(boolean) | @deprecated. Please use the ‘isVisible’ property instead. Indicates whether the object is visible. |
| getStyle() | @deprecated. Please use the ‘style’ property instead. Returns a Style object that represents the style of the specified range. |
| setStyle(MsoLineStyle) | @deprecated. Please use the ‘style’ property instead. Returns a Style object that represents the style of the specified range. |
| getForeColor() | @deprecated. Please use the ‘foreColor’ property instead. Gets and sets the border line fore color. |
| setForeColor(Color) | @deprecated. Please use the ‘foreColor’ property instead. Gets and sets the border line fore color. |
| getBackColor() | @deprecated. Please use the ‘backColor’ property instead. Gets and sets the border line back color. |
| setBackColor(Color) | @deprecated. Please use the ‘backColor’ property instead. Gets and sets the border line back color. |
| getDashStyle() | @deprecated. Please use the ‘dashStyle’ property instead. Gets or sets the dash style for the specified line. |
| setDashStyle(MsoLineDashStyle) | @deprecated. Please use the ‘dashStyle’ property instead. Gets or sets the dash style for the specified line. |
| getTransparency() | @deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). |
| setTransparency(number) | @deprecated. Please use the ’transparency’ property instead. Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). |
| getWeight() | @deprecated. Please use the ‘weight’ property instead. Returns or sets the weight of the line ,in units of pt. |
| setWeight(number) | @deprecated. Please use the ‘weight’ property instead. 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;
style
Returns a Style object that represents the style of the specified range.
style : MsoLineStyle;
foreColor
Gets and sets the border line fore color.
foreColor : Color;
backColor
Gets and sets the border line back color.
backColor : Color;
dashStyle
Gets or sets the dash style for the specified line.
dashStyle : MsoLineDashStyle;
transparency
Returns or sets the degree of transparency of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
transparency : number;
weight
Returns or sets the weight of the line ,in units of pt.
weight : number;
isVisible()
@deprecated. Please use the ‘isVisible’ property instead. Indicates whether the object is visible.
isVisible() : boolean;
setIsVisible(boolean)
@deprecated. Please use the ‘isVisible’ property instead. Indicates whether the object is visible.
setIsVisible(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getStyle()
@deprecated. Please use the ‘style’ property instead. Returns a Style object that represents the style of the specified range.
getStyle() : MsoLineStyle;
Returns
setStyle(MsoLineStyle)
@deprecated. Please use the ‘style’ property instead. Returns a Style object that represents the style of the specified range.
setStyle(value: MsoLineStyle) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MsoLineStyle | The value to set. |
getForeColor()
@deprecated. Please use the ‘foreColor’ property instead. Gets and sets the border line fore color.
getForeColor() : Color;
Returns
setForeColor(Color)
@deprecated. Please use the ‘foreColor’ property instead. Gets and sets the border line fore color.
setForeColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getBackColor()
@deprecated. Please use the ‘backColor’ property instead. Gets and sets the border line back color.
getBackColor() : Color;
Returns
setBackColor(Color)
@deprecated. Please use the ‘backColor’ property instead. Gets and sets the border line back color.
setBackColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getDashStyle()
@deprecated. Please use the ‘dashStyle’ property instead. Gets or sets the dash style for the specified line.
getDashStyle() : MsoLineDashStyle;
Returns
setDashStyle(MsoLineDashStyle)
@deprecated. Please use the ‘dashStyle’ property instead. Gets or sets the dash style for the specified line.
setDashStyle(value: MsoLineDashStyle) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MsoLineDashStyle | The value to set. |
getTransparency()
@deprecated. Please use the ’transparency’ property instead. 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)
@deprecated. Please use the ’transparency’ property instead. 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:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getWeight()
@deprecated. Please use the ‘weight’ property instead. Returns or sets the weight of the line ,in units of pt.
getWeight() : number;
setWeight(number)
@deprecated. Please use the ‘weight’ property instead. Returns or sets the weight of the line ,in units of pt.
setWeight(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;