GradientStopCollection Interface

A collection of gradient stops.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public interface GradientStopCollection :
    IList<GradientStop>,
    ICollection<GradientStop>,
    IEnumerable<GradientStop>,
    IEnumerable

VB.NET

Public Interface GradientStopCollection
    Inherits IList(Of GradientStop),
             ICollection(Of GradientStop),
             IEnumerable(Of GradientStop),
             IEnumerable

Related API Members

The following members return GradientStopCollection objects:

• GradientFill.GradientStops

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 object contains settings of the applied gradient fill. Use the GradientFill.GradientStops property to access the GradientStopCollection collection that stores existing gradient stops. The collection’s methods allow you to add and delete 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)))