LineFillFormat.GradientFill Property

Provides access to gradient fill settings.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

GradientFill GradientFill { get; }

VB.NET

ReadOnly Property GradientFill As GradientFill

Property Value

Type	Description
GradientFill	An object that stores gradient fill settings.

Remarks

Call the Shape.Line.Fill.SetGradientFill method to apply a gradient of two or more colors to a line or a shape’s border. The GradientFill property allows you to access and change the applied gradient:

• GradientFill.GradientType - returns the gradient type.

• GradientFill.GradientStops - allows you to add or remove gradient stops.

• GradientFill.Angle - defines the angle of the linear gradient.

• GradientFill.RotateWithShape - specifies whether to rotate the gradient fill with the shape.

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 to the outline.
border.Fill.SetGradientFill(GradientType.Linear, Color.FromArgb(0x1B, 0x98, 0xE0), Color.FromArgb(0xFF, 0x16, 0x54));
// Access gradient fill settings.
GradientFill gradientFill = border.Fill.GradientFill;
// Add another gradient stop.
gradientFill.GradientStops.Add(new GradientStop(0.5f, Color.FromArgb(0xF3, 0xFF, 0xBD)));
// Specify the gradient angle.
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 to the outline.
border.Fill.SetGradientFill(GradientType.Linear, Color.FromArgb(&H1B, &H98, &HE0), Color.FromArgb(&HFF, &H16, &H54))
' Access gradient fill settings.
Dim gradientFill As GradientFill = border.Fill.GradientFill
' Add another gradient stop.
gradientFill.GradientStops.Add(New GradientStop(0.5F, Color.FromArgb(&HF3, &HFF, &HBD)))
' Specify the gradient angle.
gradientFill.Angle = 30
' Set the line width.
border.Thickness = 6