BrickGraphics.DrawImage(Image, RectangleF, BorderSide, Color) Method

Adds a specific ImageBrick brick to a report.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v22.2.Core.dll

NuGet Packages: DevExpress.Printing.Core, DevExpress.Win.Dashboard.Design

Declaration

C#

public ImageBrick DrawImage(
    Image image,
    RectangleF rect,
    BorderSide sides,
    Color backColor
)

VB.NET

Public Function DrawImage(
    image As Image,
    rect As RectangleF,
    sides As BorderSide,
    backColor As Color
) As ImageBrick

Parameters

Name	Type	Description
image	Image	The image to draw within a specifc brick.
rect	RectangleF	The RectangleF structure that specifies the location and size of the current brick in measurement units, specified via the BrickGraphics.PageUnit property value.
sides	BorderSide	Border settings for a specific ImageBrick.
backColor	Color	The color to be displayed in the transparent image.

Returns

Type	Description
ImageBrick	The ImageBrick added to a report.

Remarks

This method adds a specific ImageBrick to a report. The brick’s position is defined via the rect parameter. This parameter also defines brick size. If the rectanlge’s dimensions and actual brick image dimensions are different, the image is stretched or shrunk to fit inside the specified rectangle. To prevent this, the rect dimensions must exactly match the image dimensions. If an image has transparent areas, then these areas are filled with the color specified via the backColor parameter value. If the backColor parameter value is set to Color.Empty, the color used to fill the transparent areas is defined via the BrickGraphics.BackColor property value. Graphical settings which are not defined via these method parameters are obtained from the corresponding BrickGraphics properties.

Example

This example demonstrates how to create an ImageBrick using the BrickGraphics.DrawImage method.

C#

using DevExpress.XtraPrinting;
// ...

    VisualBrick visBrick;
    Image img = imageList1.Images[0];   
    BrickGraphics brickGraph = printingSystem1.Graph;

    // Start the report generation.
    printingSystem1.Begin();

    // Create a rectangle.
    RectangleF rect = new RectangleF(new PointF(0, 0), new SizeF(96, 96));

    // Specify a page area.
    brickGraph.Modifier = BrickModifier.Detail;

    // Add an image brick to the report.
    visBrick = brickGraph.DrawImage(img, rect, BorderSide.All, Color.White);

    // Finish the report generation.
    printingSystem1.End();

    // Preview the report.
    printingSystem1.PreviewFormEx.Show();

VB.NET

Imports DevExpress.XtraPrinting
' ...

    Dim visBrick As VisualBrick
    Dim img As Image = imageList1.Images(0)
    Dim brickGraph As BrickGraphics = printingSystem1.Graph

    ' Start the report generation.
    printingSystem1.Begin()

    ' Create a rectangle.
    Dim rect As RectangleF = New RectangleF(New PointF(0, 0), New SizeF(96, 96))

    ' Specify a page area.
    brickGraph.Modifier = BrickModifier.Detail

    ' Add an image brick to the report.
    visBrick = brickGraph.DrawImage(img, rect, BorderSide.All, Color.White)

    ' Finish the report generation.
    printingSystem1.End()

    ' Preview the report.
    printingSystem1.PreviewFormEx.Show()

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DrawImage(Image, RectangleF, BorderSide, 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#

Reporting_how-to-create-bricks-of-different-types-e151/CS/Form1.cs#L49

// Add an image brick to the report.
visBrick = brickGraph.DrawImage(img, rect, BorderSide.All, Color.White);

Reporting_how-to-print-multi-frame-images-via-the-xtraprinting-library-e1839/CS/Form1.cs#L83

// Add an image to a specific location.
graph.DrawImage(Image, new Rectangle(0, 0, Image.Width, Image.Height),
    BorderSide.None, Color.Transparent);

Reporting_xtraprinting-getting-started-e161/CS/Form1.cs#L209

// to a specific location using a Transparent color.
graph.DrawImage(img,
    new Rectangle(200 + (50 - img.Width) / 2, top + (50 - img.Height) / 2, img.Width, img.Height),

VB.NET

Reporting_how-to-create-bricks-of-different-types-e151/VB/Form1.vb#L51

' Add an image brick to the report.
visBrick = brickGraph.DrawImage(img, rect, BorderSide.All, Color.White)

Reporting_how-to-print-multi-frame-images-via-the-xtraprinting-library-e1839/VB/Form1.vb#L94

' Add an image to a specific location.
graph.DrawImage(Image, New Rectangle(0, 0, Image.Width, Image.Height), BorderSide.None, Color.Transparent)

Reporting_xtraprinting-getting-started-e161/VB/Form1.vb#L250

If Not img Is Nothing Then
    graph.DrawImage(img, New RectangleF(Convert.ToSingle(200 + (50 - img.Width) / 2), _
        Convert.ToSingle(top + (50 - img.Height) / 2), img.Width, img.Height), _