GraphicsCache.GetGradientBrush(Rectangle, Color, Color, LinearGradientMode) Method

Returns a linear gradient brush with specified settings.

Namespace: DevExpress.Utils.Drawing

Assembly: DevExpress.Utils.v18.2.dll

Declaration

C#

public Brush GetGradientBrush(
    Rectangle rect,
    Color startColor,
    Color endColor,
    LinearGradientMode mode
)

VB.NET

Public Function GetGradientBrush(
    rect As Rectangle,
    startColor As Color,
    endColor As Color,
    mode As LinearGradientMode
) As Brush

Parameters

Name	Type	Description
rect	Rectangle	A System.Drawing.Rectangle structure that specifies the endpoints of the linear gradient. The starting point is the upper-left corner of the rectangle, and the endpoint is the upper-right corner of the rectangle.
startColor	Color	A System.Drawing.Color object that represents the starting color for the gradient.
endColor	Color	A System.Drawing.Color object that represents the ending color for the gradient.
mode	LinearGradientMode	A System.Drawing.Drawing2D.LinearGradientMode enumeration value specifying the gradient orientation.

Returns

Type	Description
Brush	A System.Drawing.Brush descendant representing the requested linear gradient brush (typically a System.Drawing.Drawing2D.LinearGradientBrush object).

Remarks

When the GetGradientBrush method is called, it checks whether the requested brush is already contained in an internal hash table of linear gradient brushes. If so, the found brush is returned. Otherwise a new brush with specified parameters is created and added to an internal hash table. The hash table is initially empty. The introduced technique allows you to provide quick access to recently used linear gradient brushes.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetGradientBrush(Rectangle, Color, Color, LinearGradientMode) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-a-circled-progress-bar-e3656/CS/CircledProgressBarObjectPainter.cs#L31

Rectangle rectForPie = CircledProgressBarPainter.CalcProportionalBorderRectangle(e.Bounds, currentWidthHeightProportion);
Brush brush = e.Cache.GetGradientBrush(e.Bounds, e.StartColor, e.EndColor, System.Drawing.Drawing2D.LinearGradientMode.Vertical);
float beginAngle = -90 + 90 * (int)currentAngle;

scheduler-reporting-custom-painting-using-customdraw-events-e2758/CS/SchedulerReportCustomDraw/XtraSchedulerReport1.cs#L128

rect.Inflate(-vi.LeftBorderBounds.Width, -vi.TopBorderBounds.Height);
Brush brush = e.Cache.GetGradientBrush(rect, Color.White, vi.Appearance.BackColor,
    System.Drawing.Drawing2D.LinearGradientMode.Vertical);

VB.NET

how-to-create-a-circled-progress-bar-e3656/VB/CircledProgressBarObjectPainter.vb#L31

Dim rectForPie As Rectangle = CircledProgressBarPainter.CalcProportionalBorderRectangle(e.Bounds, currentWidthHeightProportion)
Dim brush As Brush = e.Cache.GetGradientBrush(e.Bounds, e.StartColor, e.EndColor, System.Drawing.Drawing2D.LinearGradientMode.Vertical)
Dim beginAngle As Single = -90 + 90 * CInt(Fix(currentAngle))

scheduler-reporting-custom-painting-using-customdraw-events-e2758/VB/SchedulerReportCustomDraw/XtraSchedulerReport1.vb#L109

rect.Inflate(-vi.LeftBorderBounds.Width, -vi.TopBorderBounds.Height)
Dim brush As Brush = e.Cache.GetGradientBrush(rect, Color.White, vi.Appearance.BackColor, System.Drawing.Drawing2D.LinearGradientMode.Vertical)
e.Cache.FillRectangle(brush, rect)