BrickStringFormat.ChangeFormatFlags(StringFormatFlags) Method

Returns a BrickStringFormat object cloned from the current BrickStringFormat object.

Namespace: DevExpress.XtraPrinting

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public BrickStringFormat ChangeFormatFlags(
    StringFormatFlags options
)

VB.NET

Public Function ChangeFormatFlags(
    options As StringFormatFlags
) As BrickStringFormat

Parameters

Name	Type	Description
options	StringFormatFlags	A StringFormatFlags enumeration value containing formatting information.

Returns

Type	Description
BrickStringFormat	A cloned BrickStringFormat object.

Remarks

This method clones the current BrickStringFormat object and replaces the current value of BrickStringFormat.FormatFlags with the value specified via the parameter.

Example

This example illustrates use of the BrickStringFormat.ChangeFormatFlags method to change the text orientation within the brick. It creates and displays two bricks - the first brick has default settings, the second one has its text orientation 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, 75));

// 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.ChangeFormatFlags(StringFormatFlags.DirectionVertical
    | StringFormatFlags.DirectionRightToLeft);
brickGraph.StringFormat = brickSFormat;

// Create a second rectangle.
RectangleF rect1 = new RectangleF(new PointF(0, 75), new SizeF(180, 75));

// 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, 75))

' 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.ChangeFormatFlags(StringFormatFlags.DirectionVertical _
    Or StringFormatFlags.DirectionRightToLeft)
brickGraph.StringFormat = brickSFormat

' Create a second rectangle.
Dim rect1 As RectangleF = New RectangleF(New PointF(0, 75), New SizeF(180, 75))

' 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()