BrickGraphics.MeasureString(String, Int32) Method

Measures the specified string when drawn with the specified maximum width.

Namespace: DevExpress.XtraPrinting

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

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

Declaration

C#

public SizeF MeasureString(
    string text,
    int width
)

VB.NET

Public Function MeasureString(
    text As String,
    width As Integer
) As SizeF

Parameters

Name	Type	Description
text	String	String to measure.
width	Int32	An integer value specifying the maximum width of the measured string.

Returns

Type	Description
SizeF	This method returns a SizeF structure that represents the size, measured in pixels.

Remarks

This method measures a text string specified via the parameter. The resulting string size is determined not only by the string’s contents, but also by the BrickGraphics.Font property value. If measured string width exceeds the width parameter value, then the height parameter value of the returned SizeF structure is increased, in order to fit inside the measured string.

Example

This example calculates the dimensions of the rectangle to fit the specified string with a limitation on maximum width (75 measurement units). Then, a report with the VisualBrick, containing the string, is created and displayed.

Tip

A complete sample project is available in the DevExpress Code Examples database at https://supportcenter.devexpress.com/ticket/details/e78/how-to-measure-the-size-of-the-text-block.

C#

using DevExpress.XtraPrinting;
// ...

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

    // Measure the string, specifying the maximum width.
    SizeF sz = brickGraph.MeasureString(s, 75);

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

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

    // Create a rectangle of the calculated size plus the border dimensions.
    RectangleF rect = new RectangleF(new PointF(0, 0), sz);
    rect = brickGraph.DefaultBrickStyle.InflateBorderWidth(rect, GraphicsDpi.Pixel);
    rect.Offset(-rect.X, -rect.Y);

    // Add a text brick to the report.
    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, specifying the maximum width.
    Dim sz As SizeF = brickGraph.MeasureString(s, 75)

    ' 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

    ' Add a text brick to the report.
    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 MeasureString(String, Int32) 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-scroll-a-document-in-the-print-preview-to-a-specific-page-or-brick-e2386/CS/SimpleLink.cs#L34

SizeF textSize = graph.MeasureString(Text, (int)graph.ClientPageSize.Width);

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

// Measure the string, specifying the maximum width
SizeF sz = brickGraph.MeasureString(s, 75);

Reporting_how-to-specify-a-custom-paper-size-e2462/CS/SimpleLink.cs#L32

SizeF textSize = graph.MeasureString(Text, (int)Math.Round(graph.ClientPageSize.Width));

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

SizeF size = e.Graph.MeasureString(textEdit1.Text, pageWidthInPixels);

VB.NET

Reporting_how-to-scroll-a-document-in-the-print-preview-to-a-specific-page-or-brick-e2386/VB/SimpleLink.vb#L35

Dim textSize As SizeF = graph.MeasureString(Text, CInt(Fix(graph.ClientPageSize.Width)))

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

' Measure the string, specifying the maximum width
Dim sz As SizeF = brickGraph.MeasureString(s, 75)

Reporting_how-to-specify-a-custom-paper-size-e2462/VB/SimpleLink.vb#L32

Dim textSize As SizeF = graph.MeasureString(Text, CInt(Fix(Math.Round(graph.ClientPageSize.Width))))

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

Dim size As SizeF = e.Graph.MeasureString(textEdit1.Text, pageWidthInPixels)
e.Graph.DrawString(textEdit1.Text, Color.Blue, New RectangleF(0, 0, pageWidthInPixels, size.Height), BorderSide.All)