Class TextOutlineEffect
Inheritance
System.Object
TextOutlineEffect
Assembly: IronPPT.dll
Syntax
public class TextOutlineEffect : Object
Outlining the glyphs of a run of text in a slide runs through TextOutlineEffect. The object describes the stroke drawn around each character, so a heading or callout can carry a colored, weighted border rather than a flat fill. Use it whenever a title needs more visual weight than a plain font color delivers, and pull TextOutlineEffect.DefaultEffect for a sensible starting stroke instead of setting every field by hand.
The effect attaches to the text styling of a run and is read when the slide renders, so a developer builds the stroke once and assigns it where the run's outline is expected. A fresh instance comes from new TextOutlineEffect(), and the static DefaultEffect returns a preconfigured stroke that you can adjust from there.
Color sets the stroke color and LineWidth its thickness, with GetLineWidth and SetLineWidth reading and writing that width in a chosen Units so a value can be expressed in points or another measure. CompoundLineType, LineCapType, LineJoin, and PenAlignment shape how the stroke is drawn, joined, and positioned relative to the glyph edge, taking CompoundLineValues, LineCapValues, StrokeJoinStyleValues, and PenAlignmentValues respectively. The presetLineDash property selects a dash pattern from PresetLineDashValues for a dotted or dashed outline. Keep widths modest so the outline frames the text rather than swallowing it, and prefer the unit-aware SetLineWidth over assigning LineWidth raw when the rest of the document works in points.
var outline = TextOutlineEffect.DefaultEffect;
outline.Color = Color.Black;
outline.SetLineWidth(1.5, Units.Point);
The add text how-to walks through placing and styling text on a slide, the paragraph style example shows run-level formatting in context, and the TextStyle reference covers the wider text styling surface this outline sits within.
Constructors
TextOutlineEffect()
Declaration
public TextOutlineEffect()
Fields
DefaultEffect
Declaration
public static TextOutlineEffect DefaultEffect
Field Value
Properties
Color
Declaration
public Color Color { get; set; }
Property Value
CompoundLineType
Declaration
public CompoundLineValues CompoundLineType { get; set; }
Property Value
LineCapType
Declaration
public LineCapValues LineCapType { get; set; }
Property Value
LineJoin
Declaration
public StrokeJoinStyleValues LineJoin { get; set; }
Property Value
LineWidth
Declaration
public double LineWidth { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
PenAlignment
Declaration
public PenAlignmentValues PenAlignment { get; set; }
Property Value
presetLineDash
Declaration
public PresetLineDashValues presetLineDash { get; set; }
Property Value
Methods
GetLineWidth(Units)
Declaration
public double GetLineWidth(Units measurementUnit)
Parameters
| Type |
Name |
Description |
| Units |
measurementUnit |
|
Returns
| Type |
Description |
| System.Double |
|
SetLineWidth(Double, Units)
Declaration
public void SetLineWidth(double lineWidth, Units measurementUnit)
Parameters
| Type |
Name |
Description |
| System.Double |
lineWidth |
|
| Units |
measurementUnit |
|