PageCanvas.DrawImage(OfficeImage, Rectangle, ImageSizeMode) Method

Draws a custom image.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

Declaration

C#

public void DrawImage(
    OfficeImage image,
    Rectangle bounds,
    ImageSizeMode sizeMode
)

VB.NET

Public Sub DrawImage(
    image As OfficeImage,
    bounds As Rectangle,
    sizeMode As ImageSizeMode
)

Parameters

Name	Type	Description
image	OfficeImage	The OfficeImage object that will be placed at the selected position.
bounds	Rectangle	Sets the location and size of the image.
sizeMode	ImageSizeMode	Specifies the image position within the stated bounds.

Example

This code snippet illustrates the implementation of the PageCanvas.DrawImage and PageCanvas.FillEllipse methods. They draw a filled color ellipse and a custom image over the table cell.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/layout-api-simple-example-t245818

MyLayoutPainter.vb

Public Overrides Sub DrawTableCell(ByVal tableCell As LayoutTableCell)
    If Form1.customDrawTable = True Then
        Dim Tbounds As Rectangle = tableCell.Bounds
        Dim tableRectangle As New Rectangle(New Point(Tbounds.X + Tbounds.Width \ 2 - 10, Tbounds.Y + Tbounds.Height \ 2 - 10), New Size(20, 20))
        Canvas.FillEllipse(New RichEditBrush(Color.MediumAquamarine), Canvas.ConvertToDrawingLayoutUnits(tableRectangle, DocumentLayoutUnit.Pixel))
        Canvas.DrawImage(OfficeImage.CreateImage(DevExpress.Images.ImageResourceCache.Default.GetImage("devav/people/employeeaward_16x16.png")), tableCell.Bounds, ImageSizeMode.Squeeze)
        MyBase.DrawTableCell(tableCell)
    Else
        MyBase.DrawTableCell(tableCell)
    End If
End Sub

MyLayoutPainter.cs

public override void DrawTableCell(LayoutTableCell tableCell)
{
    if (Form1.customDrawTable == true)
    {
        Rectangle Tbounds = tableCell.Bounds;
        Rectangle tableRectangle = new Rectangle(new Point(Tbounds.X + Tbounds.Width / 2 - 10, Tbounds.Y + Tbounds.Height / 2 - 10), new Size(20, 20));
        Canvas.FillEllipse(new RichEditBrush(Color.MediumAquamarine), Canvas.ConvertToDrawingLayoutUnits(tableRectangle, DocumentLayoutUnit.Pixel));
        Canvas.DrawImage(OfficeImage.CreateImage(DevExpress.Images.ImageResourceCache.Default.GetImage("devav/people/employeeaward_16x16.png")), tableCell.Bounds, ImageSizeMode.Squeeze);
        base.DrawTableCell(tableCell);
    }
    else
        base.DrawTableCell(tableCell);
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DrawImage(OfficeImage, Rectangle, ImageSizeMode) 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#

layout-api-simple-example-t245818/CS/LayoutApiSimpleExample/MyLayoutPainter.cs#L50

Canvas.FillEllipse(new RichEditBrush(Color.MediumAquamarine), Canvas.ConvertToDrawingLayoutUnits(tableRectangle, DocumentLayoutUnit.Pixel));
Canvas.DrawImage(OfficeImage.CreateImage(DevExpress.Images.ImageResourceCache.Default.GetImage("devav/people/employeeaward_16x16.png")), tableCell.Bounds, ImageSizeMode.Squeeze);
base.DrawTableCell(tableCell);

VB.NET

layout-api-simple-example-t245818/VB/LayoutApiSimpleExample/MyLayoutPainter.vb#L45

Canvas.FillEllipse(New RichEditBrush(Color.MediumAquamarine), Canvas.ConvertToDrawingLayoutUnits(tableRectangle, DocumentLayoutUnit.Pixel))
Canvas.DrawImage(OfficeImage.CreateImage(DevExpress.Images.ImageResourceCache.Default.GetImage("devav/people/employeeaward_16x16.png")), tableCell.Bounds, ImageSizeMode.Squeeze)
MyBase.DrawTableCell(tableCell)