Class GradientStop

Represents a gradient stop in a gradient fill.

Inheritance

System.Object

GradientStop

Namespace: IronWord.Models

Assembly: IronWord.dll

Syntax

public class GradientStop : Object

GradientStop is the single color-and-position record that a Gradient blends between. Each stop pairs one color with a point along the gradient line, and a Gradient holds an ordered List<GradientStop> in its StopPoints property. Where the surrounding Gradient describes the whole blend, a GradientStop describes one anchor of it.

A stop sits inside the gradient workflow rather than standing alone: you create the stops, add them to a Gradient.StopPoints list, then attach that gradient to a TextEffect so the run renders with the blend. The position of each stop, together with the order of the list, determines how the colors transition across the text. A simple two-color blend needs only two stops, one at each end, while a richer transition adds intermediate stops at the positions where you want the color to shift.

Two properties carry the data. Color holds the color at this anchor, and StopPoint holds its position as a double. Because the position is unit-sensitive, read and write it through GetStopPoint and SetStopPoint, which both take a MeasurementUnit so the value is interpreted in points, centimeters, or inches rather than a bare number. For a quick start, the static FirstDefault and SecondDefault return two ready-made stops that form a usable two-color blend, which you can apply as-is or adjust before adding more. Keep the list ordered by StopPoint so colors blend in the intended sequence.

GradientStop stop = new GradientStop();
stop.Color = Color.Red;
stop.SetStopPoint(0, MeasurementUnit.Point);

The gradient text effect how-to builds a blend from stops, the gradient effect example shows a working run, and the styled text how-to sets surrounding run formatting.

Constructors

GradientStop()

Declaration

public GradientStop()

Fields

FirstDefault

Return the default instance of the gradient stop.

Declaration

public static GradientStop FirstDefault

Field Value

Type	Description
GradientStop

SecondDefault

Return the default instance of the gradient stop.

Declaration

public static GradientStop SecondDefault

Field Value

Type	Description
GradientStop

Properties

Color

Gets or sets the scheme color of the gradient stop.

Declaration

public Color Color { get; set; }

Property Value

Type	Description
Color

StopPoint

Gets or sets the position of the gradient stop.

Declaration

public double StopPoint { get; set; }

Property Value

Type	Description
System.Double

Methods

GetStopPoint(MeasurementUnit)

Gets the position of the gradient stop.

Declaration

public double GetStopPoint(MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
MeasurementUnit	measurementUnit	The measurement unit for the position.

Returns

Type	Description
System.Double	The position of the gradient stop.

SetStopPoint(Double, MeasurementUnit)

Sets the position of the gradient stop.

Declaration

public void SetStopPoint(double stopPoint, MeasurementUnit measurementUnit)

Parameters

Type	Name	Description
System.Double	stopPoint	The position of the gradient stop.
MeasurementUnit	measurementUnit	The measurement unit of the position.