BrickSelector.GetBricksByTag(Document, Object) Method

A static method that returns an enumeration of visual bricks with the specified tag from a document.

Namespace: DevExpress.XtraPrinting

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

Declaration

C#

public static IEnumerable<VisualBrick> GetBricksByTag(
    Document document,
    object tag
)

VB.NET

Public Shared Function GetBricksByTag(
    document As Document,
    tag As Object
) As IEnumerable(Of VisualBrick)

Parameters

Name	Type	Description
document	Document	The document from which to return bricks.
tag	Object	The tag value. A brick is returned if its tag value matches the specified value.

Returns

Type	Description
IEnumerable<VisualBrick>	Bricks from the specified document.

Remarks

BrickSelector methods can be used to post-process a generated document. The basic idea is to first use the Tag property to tag controls on the report page, and then use the GetBricksByTag method to find bricks generated by tagged controls on the report page and adjust their size and position.

For more information on document bricks, review the following help topic: Bricks.

Example - Set Control Height to Maximum Cell Height in a Table

The following code snippet uses BrickSelector to determine the maximum brick height of a table cell. Upon completion, it converts the height value to a ReportUnit unit and sets the height of the XRRichText report control. The document is then rebuilt from the updated report. The cells that should be measured are tagged with the ‘richTextCell’ value. ‘richTextCell’.

C#

using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
using System.Collections.Generic;
// ...
var report = new XtrReport1();
report.CreateDocument();
var bricks = BrickSelector.GetBricksByTag(report.PrintingSystem.Document, "richTextCell");
float maxHeight = 0;
foreach (VisualBrick b in bricks) {
    var brickHeight = b.Size.Height;
    if (brickHeight > maxHeight) {
        maxHeight = brickHeight;
    }
}
var heighInReportUnits = GraphicsUnitConverter.Convert(maxHeight, GraphicsDpi.Document, GraphicsDpi.HundredthsOfAnInch);
var richTextCell = report.FindControl("xrRichText1", true) as XRControl;
richTextCell.SizeF = new SizeF(richTextCell.WidthF, heighInReportUnits);
report.CreateDocument();
ReportPrintTool reportTool = new ReportPrintTool(report)
reportTool.ShowRibbonPreviewDialog(); 

VB.NET

Option Infer On

Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
Imports System.Collections.Generic
' ...
Private report = New XtrReport1()
report.CreateDocument()
Dim bricks = BrickSelector.GetBricksByTag(report.PrintingSystem.Document, "richTextCell")
Dim maxHeight As Single = 0
For Each b As VisualBrick In bricks
    Dim brickHeight = b.Size.Height
    If brickHeight > maxHeight Then
        maxHeight = brickHeight
    End If
Next b
Dim heighInReportUnits = GraphicsUnitConverter.Convert(maxHeight, GraphicsDpi.Document, GraphicsDpi.HundredthsOfAnInch)
Dim richTextCell = TryCast(report.FindControl("xrRichText1", True), XRControl)
richTextCell.SizeF = New SizeF(richTextCell.WidthF, heighInReportUnits)
report.CreateDocument()
Dim reportTool As New ReportPrintTool(report) reportTool.ShowRibbonPreviewDialog()