BrickGraphics.StringFormat Property

Gets or sets text layout information (such as alignment, orientation and tab stops) and display manipulations (such as ellipsis insertion and national digit substitution).

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

public BrickStringFormat StringFormat { get; set; }

VB.NET

Public Property StringFormat As BrickStringFormat

Property Value

Type	Description
BrickStringFormat	A BrickStringFormat object containing text information.

Example

The following code demonstrates use of the BrickStringFormat. It creates a new BrickStringFormat object, sets the text alignment to Center, and text direction to DirectionVertical.

C#

using DevExpress.XtraPrinting;
// ...

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

    // Specify the string format.
    StringFormat sFormat = new StringFormat(StringFormatFlags.DirectionVertical);
    sFormat.Alignment = StringAlignment.Center;
    sFormat.LineAlignment = StringAlignment.Center;

    // Create the BrickStringFormat object.
    BrickStringFormat brickSFormat = new BrickStringFormat(sFormat);

    // Measure the string according to the specified format
    SizeF sz = brickGraph.MeasureString(s, 30, sFormat);

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

    // Set the brick string format
    brickGraph.StringFormat = brickSFormat;

    // Create a rectangle.
    RectangleF rect = new RectangleF(new PointF(0, 0), new SizeF(30, 150));
    // Specify a page area.
    brickGraph.Modifier = BrickModifier.Detail;
    // Add a brick to the report.
    visBrick = brickGraph.DrawString(s, Color.MidnightBlue, 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."

    ' Specify the string format.
    Dim sFormat As StringFormat = New StringFormat(StringFormatFlags.DirectionVertical)
    sFormat.Alignment = StringAlignment.Center
    sFormat.LineAlignment = StringAlignment.Center

    ' Create the BrickStringFormat object.
    Dim brickSFormat As BrickStringFormat = New BrickStringFormat(sFormat)

    ' Measure the string according to the specified format
    Dim sz As SizeF = brickGraph.MeasureString(s, 30, sFormat)

    ' Start the report generation.
    printingSystem1.Begin()

    ' Set the brick string format
    brickGraph.StringFormat = brickSFormat

    ' Create a rectangle.
    Dim rect As RectangleF = New RectangleF(New PointF(0, 0), New SizeF(30, 150))
    ' Specify a page area.
    brickGraph.Modifier = BrickModifier.Detail
    ' Add a brick to the report.
    visBrick = brickGraph.DrawString(s, Color.MidnightBlue, 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 StringFormat property.

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-a-custom-link-e21/CS/CustomLink.cs#L52

gr.BackColor = Color.White;
gr.StringFormat =
    new BrickStringFormat(StringFormatFlags.NoWrap | StringFormatFlags.LineLimit);

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

    // Set the line alignment.
    g.StringFormat = g.StringFormat.ChangeLineAlignment(StringAlignment.Near);
}

Reporting_how-to-use-link-events-e1129/CS/UseLinkEvents/Form1.cs#L52

e.Graph.Font = new Font("Comic Sans MS", 12);
e.Graph.StringFormat = new BrickStringFormat(StringAlignment.Center, StringAlignment.Center);

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

{
    e.Graph.StringFormat = new BrickStringFormat(StringAlignment.Center);

VB.NET

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

gr.BackColor = Color.White
gr.StringFormat = New BrickStringFormat(StringFormatFlags.NoWrap Or StringFormatFlags.LineLimit)
gr.StringFormat = gr.StringFormat.ChangeAlignment(StringAlignment.Center)

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

    ' Set the line alignment.
    g.StringFormat = g.StringFormat.ChangeLineAlignment(StringAlignment.Near)
End If

Reporting_how-to-use-link-events-e1129/VB/UseLinkEvents/Form1.vb#L55

e.Graph.Font = New Font("Comic Sans MS", 12)
e.Graph.StringFormat = New BrickStringFormat(StringAlignment.Center, StringAlignment.Center)

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

If pageWidthInPixels < 100 OrElse pageHeightInPixels < 100 Then
    e.Graph.StringFormat = New BrickStringFormat(StringAlignment.Center)