BrickGraphics.DrawString(String, Color, RectangleF, BorderSide) Method

Adds a specific TextBrick to a report.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

public TextBrick DrawString(
    string text,
    Color foreColor,
    RectangleF rect,
    BorderSide sides
)

VB.NET

Public Function DrawString(
    text As String,
    foreColor As Color,
    rect As RectangleF,
    sides As BorderSide
) As TextBrick

Parameters

Name	Type	Description
text	String	The text displayed in a specific TextBrick.
foreColor	Color	The color used to draw text.
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 TextBrick.

Returns

Type	Description
TextBrick	The TextBrick added to a report.

Remarks

This method adds a specific TextBrick to a report. TextBrick position and size are specified via the rect parameter. The area of the brick rectangle not used by the brick’s text is filled with the color defined via BrickGraphics.BackColor. The text color is specified via the foreColor parameter. Text is specified via the TextBrick.Font property value. If the foreColor parameter is set to Color.Empty, text color is defined via the BrickGraphics.ForeColor 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 a TextBrick using the BrickGraphics.DrawString method.

C#

using DevExpress.XtraPrinting;
// ...

    VisualBrick visBrick;
    BrickGraphics brickGraph = printingSystem1.Graph;
    string s = "Developer Express Inc.";

    // Measure the string.
    SizeF sz = brickGraph.MeasureString(s);

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

    // Create a rectangle of the calculated size.
    RectangleF rect = new RectangleF(new PointF(0, 0), sz);
    // Specify a page area.
    brickGraph.Modifier = BrickModifier.Detail;
    // Create a text brick.
    visBrick = brickGraph.DrawString(s, Color.Black, rect, BorderSide.All);

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

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

VB.NET

Imports DevExpress.XtraPrinting
' ...

    Dim visBrick As VisualBrick
    Dim brickGraph As BrickGraphics = printingSystem1.Graph
    Dim s As String = "Developer Express Inc."

    ' Measure the string.
    Dim sz As SizeF = brickGraph.MeasureString(s)

    ' Start the report generation.
    printingSystem1.Begin()

    ' Create a rectangle of the calculated size.
    Dim rect As RectangleF = New RectangleF(New PointF(0, 0), sz)
    ' Specify a page area.
    brickGraph.Modifier = BrickModifier.Detail
    ' Create a text brick.
    visBrick = brickGraph.DrawString(s, Color.Black, rect, BorderSide.All)

    ' 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 DrawString(String, Color, RectangleF, BorderSide) 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_xtraprinting-getting-started-e161/CS/Form1.cs#L105

protected override void CreateDetail(BrickGraphics graph) {
    graph.DrawString(caption, Color.Black, r, BorderSide.None);
}

Reporting_how-to-create-a-custom-link-e21/CS/CustomLink.cs#L57

gr.Font = new Font("Arial", 16);
textBrick = gr.DrawString("ListView Report", Color.Red, r, BorderSide.None);
textBrick.StringFormat.ChangeAlignment(StringAlignment.Center);

Reporting_how-to-control-the-size-of-printable-objects-in-the-xtraprinting-library-e317/CS/Form1.cs#L60

e.Graph.DrawString("Very small size", Color.Red,
    new RectangleF(0, pageHeightInPixels/2, pageWidthInPixels, pageHeightInPixels/2), BorderSide.None);

aspxtreelist-how-display-report-header-and-report-footer-in-an-exported-document-t106500/CS/!ASPxTreeList/Default.aspx.cs#L20

link.CreateReportHeaderArea += (s, args) => {
    args.Graph.DrawString("Report Header Text", Color.Empty, new RectangleF(Point.Empty, new SizeF(args.Graph.ClientPageSize.Width, height)), BorderSide.Top);
    args.Graph.DrawRect(new RectangleF(new Point(0, height), new SizeF(args.Graph.ClientPageSize.Width, height)), BorderSide.Top, Color.Empty, Color.Empty);

Reporting_how-to-measure-the-size-of-the-text-block-e78/CS/Form1.cs#L60

// Add a text brick to the report
visBrick = brickGraph.DrawString(s, Color.Black, rect, BorderSide.All);

VB.NET

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

    Dim s As String = "Hello World!"
    graph.DrawString(s, Color.Black, r, BorderSide.None)
End Sub

Reporting_how-to-create-a-custom-link-e21/VB/CustomLink.vb#L65

gr.Font = New Font("Arial", 16)
textBrick = gr.DrawString("ListView Report", Color.Red, r, BorderSide.None)
textBrick.StringFormat.ChangeAlignment(StringAlignment.Center)

Reporting_how-to-control-the-size-of-printable-objects-in-the-xtraprinting-library-e317/VB/Form1.vb#L55

e.Graph.DrawString("Very small size", Color.Red, New RectangleF(0, pageHeightInPixels\2, pageWidthInPixels, pageHeightInPixels\2), BorderSide.None)

aspxtreelist-how-display-report-header-and-report-footer-in-an-exported-document-t106500/VB/!ASPxTreeList/Default.aspx.vb#L31

Private Function AnonymousMethod1(ByVal s As Object, ByVal args As CreateAreaEventArgs, ByVal height As Integer) As Boolean
    args.Graph.DrawString("Report Header Text", Color.Empty, New RectangleF(Point.Empty, New SizeF(args.Graph.ClientPageSize.Width, height)), BorderSide.Top)
    args.Graph.DrawRect(New RectangleF(New Point(0, height), New SizeF(args.Graph.ClientPageSize.Width, height)), BorderSide.Top, Color.Empty, Color.Empty)

Reporting_how-to-measure-the-size-of-the-text-block-e78/VB/Form1.vb#L62

' Add a text brick to the report
visBrick = brickGraph.DrawString(s, Color.Black, rect, BorderSide.All)