GraphicsCache.GetPen(Color) Method

Returns the pixel-wide pen with a specified color.

Namespace: DevExpress.Utils.Drawing

Assembly: DevExpress.Utils.v23.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

C#

public Pen GetPen(
    Color color
)

VB.NET

Public Function GetPen(
    color As Color
) As Pen

Parameters

Name	Type	Description
color	Color	A System.Drawing.Color object specifying the pen color.

Returns

Type	Description
Pen	A System.Drawing.Pen object representing the requested pen.

Remarks

When the GetPen method is called, it checks whether the requested pen is already contained in an internal pens hash table. If so, the found pen is returned. Otherwise a new pen 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 pens.

The returned pen has a width of one pixel.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetPen(Color) 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#

winforms-grid-hide-vertical-lines-between-certain-columns/CS/E3647/ColumnLineHelper.cs#L51

GridViewInfo vi = view.GetViewInfo() as GridViewInfo;
Pen standardPen = e.Cache.GetPen(view.PaintAppearance.Row.BackColor);
Pen pen;

winforms-grid-move-cell-using-drag-drop/CS/Classes/GridViewHelper.cs#L64

if (e.RowHandle == lastMouseDownMoveCell.RowHandle && e.Column == lastMouseDownMoveCell.Column)
    e.Cache.DrawRectangle(e.Cache.GetPen(Color.Gray), new Rectangle(e.Bounds.X, e.Bounds.Y, e.Bounds.Width, e.Bounds.Height));

winforms-treelist-implement-group-level-style-feature/CS/Q220534/Form1.cs#L30

if (e.Node.ParentNode == null) {
    Pen linePen = e.Cache.GetPen(tree.ViewInfo.PaintAppearance.HorzLine.BackColor);
    e.Cache.DrawLine(linePen, e.Bounds.Location, new Point(e.Bounds.Right, e.Bounds.Y));

VB.NET

winforms-grid-hide-vertical-lines-between-certain-columns/VB/E3647/ColumnLineHelper.vb#L51

Dim vi As GridViewInfo = TryCast(view.GetViewInfo(), GridViewInfo)
Dim standardPen As Pen = e.Cache.GetPen(view.PaintAppearance.Row.BackColor)
Dim pen As Pen

winforms-grid-move-cell-using-drag-drop/VB/Classes/GridViewHelper.vb#L61

If e.RowHandle = lastMouseDownMoveCell.RowHandle AndAlso e.Column Is lastMouseDownMoveCell.Column Then
    e.Cache.DrawRectangle(e.Cache.GetPen(Color.Gray), New Rectangle(e.Bounds.X, e.Bounds.Y, e.Bounds.Width, e.Bounds.Height))
End If

winforms-treelist-implement-group-level-style-feature/VB/Q220534/Form1.vb#L29

If e.Node.ParentNode Is Nothing Then
    Dim linePen As Pen = e.Cache.GetPen(tree.ViewInfo.PaintAppearance.HorzLine.BackColor)
    e.Cache.DrawLine(linePen, e.Bounds.Location, New Point(e.Bounds.Right, e.Bounds.Y))