GradientFill.GradientStops Property

Provides access to the collection of gradient stops.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

GradientStopCollection GradientStops { get; }

VB.NET

ReadOnly Property GradientStops As GradientStopCollection

Property Value

Type	Description
GradientStopCollection	A gradient stop collection.

Remarks

Use the following methods to apply a gradient to a shape or its border:

• Shape.Fill.SetGradientFill - fills a shape with a gradient.

• Shape.Line.Fill.SetGradientFill - applies a gradient to a line or a shape’s border.

The GradientFill.GradientStops property allows you to access a GradientStopCollection object that stores existing gradient stops. The collection’s methods allow you to add and remove gradient stops.

The example below shows how to apply a two-color gradient to a rectangle and then specify an additional gradient stop.

C#

// Create a rectangle.
Shape rectangle = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.Rectangle, new RectangleF(300, 200, 500, 300));
// Apply a gradient to the rectangle.
rectangle.Fill.SetGradientFill(GradientType.Shape, Color.FromArgb(0xFE, 0xD7, 0x66), Color.FromArgb(0x2A, 0x4D, 0x69));
// Access gradient fill settings.
GradientFill gradientFill = rectangle.Fill.GradientFill;
// Add another gradient stop.
gradientFill.GradientStops.Add(new GradientStop(0.5f, Color.FromArgb(0xFF, 0x33, 0x77)));

VB.NET

' Create a rectangle.
Dim rectangle As Shape = document.Shapes.InsertShape(document.Range.Start, ShapeGeometryPreset.Rectangle, New RectangleF(300, 200, 500, 300))
' Apply a gradient to the rectangle.
rectangle.Fill.SetGradientFill(GradientType.Shape, Color.FromArgb(&HFE, &HD7, &H66), Color.FromArgb(&H2A, &H4D, &H69))
' Access gradient fill settings.
Dim gradientFill As GradientFill = rectangle.Fill.GradientFill
' Add another gradient stop.
gradientFill.GradientStops.Add(New GradientStop(0.5F, Color.FromArgb(&HFF, &H33, &H77)))