Interface IUnderline
Assembly: IronPPT.dll
Syntax
public interface IUnderline
IUnderline is the contract for the underline applied to a run of text, the surface a developer sets when an underline needs a specific style, color, or dash pattern rather than a plain line. It controls how the underline is drawn, not whether the text is underlined in passing, so it is where finer underline choices are made.
A developer reaches it as the Underline property of an ITextStyle; Underline is the concrete implementor. Editing this contract on a run's text style changes how that run's underline renders, and because the underline lives inside the text style it travels with the run wherever that style is applied. Keeping the underline as its own object is what lets a dashed, colored, or gradient line be configured fully and then copied to other runs. The members describe the line. LineValue is a Nullable<UnderlineValues> choosing the underline kind (single, double, and so on), PresetDash is a Nullable<PresetLineDashValues> for the dash pattern, and LineJoinBevel is a flag for bevelled joins. Color is handled by three members that work together: Color is an IColor for an explicit color, FillColorFollowText makes the underline track the text color, and NoFill leaves it unpainted. For a gradient line, GradientFill is an IGradient. Clone copies the whole configuration, returning an IUnderline, so one styled underline can be reused on another run.
IUnderline underline = run.TextStyle.Underline;
underline.LineValue = UnderlineValues.Double;
underline.FillColorFollowText = true;
The add text how-to places styled text, the paragraph style example formats text, and the slide element tutorial covers slide elements.
Properties
Color
Declaration
IColor Color { get; set; }
Property Value
FillColorFollowText
Declaration
Nullable<bool> FillColorFollowText { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
GradientFill
Declaration
IGradient GradientFill { get; set; }
Property Value
LineJoinBevel
Declaration
Nullable<bool> LineJoinBevel { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
LineValue
Declaration
Nullable<UnderlineValues> LineValue { get; set; }
Property Value
NoFill
Declaration
Nullable<bool> NoFill { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Boolean> |
|
PresetDash
Declaration
Nullable<PresetLineDashValues> PresetDash { get; set; }
Property Value
Methods
Clone()
Declaration
Returns