Class TextOutlineEffect
Represents the outline effect applied to text in a Word document.
Inheritance
Namespace: IronWord.Models
Assembly: IronWord.dll
Syntax
public class TextOutlineEffect : ObjectConstructors
TextOutlineEffect()
Create a TextOutlineEffect instance.
Declaration
public TextOutlineEffect()Fields
DefaultEffect
Create a predefined outline effect instance.
Declaration
public static TextOutlineEffect DefaultEffectField Value
| Type | Description |
|---|---|
| TextOutlineEffect |
Properties
Color
Gets or sets the solid fill color for the outline effect.
Declaration
public Color Color { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
CompoundLineType
Gets or sets the type of compound line used for the outline effect.
Declaration
public CompoundLineValues CompoundLineType { get; set; }Property Value
| Type | Description |
|---|---|
| CompoundLineValues |
LineCapType
Gets or sets the type of line cap used for the outline effect.
Declaration
public LineCapValues LineCapType { get; set; }Property Value
| Type | Description |
|---|---|
| LineCapValues |
LineJoin
Gets or sets the stroke join style used for the outline effect.
Declaration
public StrokeJoinStyleValues LineJoin { get; set; }Property Value
| Type | Description |
|---|---|
| StrokeJoinStyleValues |
LineWidth
Gets or sets the width of the outline effect line.
Declaration
public double LineWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double |
Remarks
The width is specified in points (1/72 inch).
PenAlignment
Gets or sets the alignment of the pen used for the outline effect.
Declaration
public PenAlignmentValues PenAlignment { get; set; }Property Value
| Type | Description |
|---|---|
| PenAlignmentValues |
presetLineDash
Gets or sets the preset line dash style for the outline effect.
Declaration
public PresetLineDashValues presetLineDash { get; set; }Property Value
| Type | Description |
|---|---|
| PresetLineDashValues |
Methods
GetLineWidth(MeasurementUnit)
Gets the width of the outline effect line in the specified measurement unit.
Declaration
public double GetLineWidth(MeasurementUnit measurementUnit)Parameters
| Type | Name | Description |
|---|---|---|
| MeasurementUnit | measurementUnit | The measurement unit to convert the width to. |
Returns
| Type | Description |
|---|---|
| System.Double | The width of the outline effect line. |
SetLineWidth(Double, MeasurementUnit)
Sets the width of the outline effect line to the specified value in the specified measurement unit.
Declaration
public void SetLineWidth(double lineWidth, MeasurementUnit measurementUnit)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | lineWidth | The width of the outline effect line. |
| MeasurementUnit | measurementUnit | The measurement unit of the specified width. |