LineFillFormat.SetGradientFill(GradientType, IEnumerable<GradientStop>) Method

Applies a complex gradient to a line or a shape’s border.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v23.2.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

void SetGradientFill(
    GradientType gradientType,
    IEnumerable<GradientStop> gradientStops
)

VB.NET

Sub SetGradientFill(
    gradientType As GradientType,
    gradientStops As IEnumerable(Of GradientStop)
)

Parameters

Name	Type	Description
gradientType	GradientType	An enumeration member that specifies the gradient type.
gradientStops	IEnumerable<GradientStop>	A list of objects that contain information about gradient stops.

Remarks

The example below shows how to apply a gradient of three colors to a rectangle’s outline.

C#

// Create a rectangle.
Shape rectangle = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.Rectangle, new RectangleF(300, 200, 500, 300));
rectangle.Fill.SetNoFill();
// Format the rectangle's outline.
ShapeLine border = rectangle.Line;
// Apply a linear gradient of three colors to the outline.
GradientStop stop1 = new GradientStop(0f, Color.FromArgb(0x1B, 0x98, 0xE0));
GradientStop stop2 = new GradientStop(0.5f, Color.FromArgb(0xF3, 0xFF, 0xBD));
GradientStop stop3 = new GradientStop(1f, Color.FromArgb(0xFF, 0x16, 0x54));
border.Fill.SetGradientFill(GradientType.Linear, new GradientStop[] { stop1, stop2, stop3 });
border.Fill.GradientFill.Angle = 30;
// Set the line width.
border.Thickness = 6;

VB.NET

' Create a rectangle.
Dim rectangle As Shape = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.Rectangle, New RectangleF(300, 200, 500, 300))
rectangle.Fill.SetNoFill()
' Format the rectangle's outline.
Dim border As ShapeLine = rectangle.Line
' Apply a linear gradient of three colors to the outline.
Dim stop1 As New GradientStop(0F, Color.FromArgb(&H1B, &H98, &HE0))
Dim stop2 As New GradientStop(0.5F, Color.FromArgb(&HF3, &HFF, &HBD))
Dim stop3 As New GradientStop(1F, Color.FromArgb(&HFF, &H16, &H54))
border.Fill.SetGradientFill(GradientType.Linear, New GradientStop() { stop1, stop2, stop3 })
border.Fill.GradientFill.Angle = 30
' Set the line width.
border.Thickness = 6

Use the LineFillFormat.GradientFill property to adjust existing gradient settings or add more gradient stops.