BrickStringFormat.ChangeAlignment(StringAlignment) Method

Returns a BrickStringFormat object cloned from the current BrickStringFormat object, with the new string alignment applied.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

public BrickStringFormat ChangeAlignment(
    StringAlignment newAlignment
)

VB.NET

Public Function ChangeAlignment(
    newAlignment As StringAlignment
) As BrickStringFormat

Parameters

Name	Type	Description
newAlignment	StringAlignment	A StringAlignment enumeration value, representing new string alignment.

Returns

Type	Description
BrickStringFormat	A cloned BrickStringFormat object.

Remarks

This method clones the current BrickStringFormat object and replaces the current value of the BrickStringFormat.Alignment property with the value specified by the alignment parameter.

Example

This example illustrates use of the BrickStringFormat.ChangeAlignment and BrickStringFormat.ChangeLineAlignment methods to change horizontal and vertical alignment of text within the brick. It creates and displays two bricks - the first brick has default settings, the second one has its text alignment modified.

C#

using DevExpress.XtraPrinting;
// ...

    VisualBrick visBrick;
    BrickGraphics brickGraph = printingSystem1.Graph;
    string s = "Developer Express Inc.";
    BrickStringFormat brickSFormat = new BrickStringFormat();

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

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

    // Create a rectangle.
    RectangleF rect = new RectangleF(new PointF(0, 0), new SizeF(180, 50));
    // Add a brick to the report.
    visBrick = brickGraph.DrawString(s, Color.MidnightBlue, rect, BorderSide.All);

    // Change the text alignment within the brick
    brickSFormat = visBrick.Style.StringFormat.ChangeAlignment(StringAlignment.Far);
    brickSFormat = brickSFormat.ChangeLineAlignment(StringAlignment.Far);
    brickGraph.StringFormat = brickSFormat;

    // Create a second rectangle.
    RectangleF rect1 = new RectangleF(new PointF(0,50), new SizeF(180, 50));
    // Add the next brick to the report.
    visBrick = brickGraph.DrawString(s, Color.MidnightBlue, rect1, 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."
    Dim brickSFormat As BrickStringFormat = New BrickStringFormat()

    ' Start the report generation.
    printingSystem1.Begin()

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

    ' Create a rectangle.
    Dim rect As RectangleF = New RectangleF(New PointF(0, 0), New SizeF(180, 50))
    ' Add a brick to the report.
    visBrick = brickGraph.DrawString(s, Color.MidnightBlue, rect, BorderSide.All)

    ' Change the text alignment within the brick
    brickSFormat = visBrick.Style.StringFormat.ChangeAlignment(StringAlignment.Far)
    brickSFormat = brickSFormat.ChangeLineAlignment(StringAlignment.Far)
    brickGraph.StringFormat = brickSFormat

    ' Create a second rectangle.
    Dim rect1 As RectangleF = New RectangleF(New PointF(0,50), New SizeF(180, 50))
    ' Add the next brick to the report.
    visBrick = brickGraph.DrawString(s, Color.MidnightBlue, rect1, 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 ChangeAlignment(StringAlignment) 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-winforms-handle-link-events/CS/UseLinkEvents/Form1.cs#L71

// Change string format settings for the brick graphics.
e.Graph.StringFormat = e.Graph.StringFormat.ChangeAlignment(StringAlignment.Near);
e.Graph.StringFormat = e.Graph.StringFormat.ChangeLineAlignment(StringAlignment.Center);

reporting-printing-library-get-started/CS/Form1.cs#L242

    // Set the line alignment.
    graph.StringFormat = graph.StringFormat.ChangeAlignment(StringAlignment.Near);
}

VB.NET

reporting-winforms-handle-link-events/VB/UseLinkEvents/Form1.vb#L75

' Change string format settings for the brick graphics.
e.Graph.StringFormat = e.Graph.StringFormat.ChangeAlignment(StringAlignment.Near)
e.Graph.StringFormat = e.Graph.StringFormat.ChangeLineAlignment(StringAlignment.Center)

reporting-printing-library-get-started/VB/Form1.vb#L288

' Set the line alignment.
graph.StringFormat = graph.StringFormat.ChangeAlignment(StringAlignment.Near)