ShapeFill.GradientFill Property

Provides access to gradient fill settings.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

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.Fill.SetGradientFill method to apply a gradient of two or more colors to a shape. 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.

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)))