Brick.Tag Property

Gets or sets the object that contains additional data associated with the control.

Namespace: DevExpress.XtraPrinting

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

[DefaultValue("")]
public object Tag { get; set; }

VB.NET

<DefaultValue("")>
Public Property Tag As Object

Property Value

Type	Default	Description
Object	String.Empty	An object that contains arbitrary information.

Remarks

The Tag value is retrived from the XRControl.Tag property value when the report is rendered.

You can use the Tag property as follows: specify the XRControl.Tag value in the Report Designer and examine the Brick.Tag value in the AfterPrint event handler to locate bricks originated from the tagged report controls and highlight them.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Tag 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-winforms-custom-table-of-contents/CS/CustomTableOfContents/Form1.cs#L44

foreach (VisualBrick brick in BrickSelector.GetBricks(page)) {
    if (brick.Tag != null) {
        string tagString = brick.Tag.ToString();

VB.NET

reporting-winforms-custom-table-of-contents/VB/CustomTableOfContents/Form1.vb#L39

For Each brick As DevExpress.XtraPrinting.VisualBrick In DevExpress.XtraPrinting.BrickSelector.GetBricks(page)
    If brick.Tag IsNot Nothing Then
        Dim tagString As String = brick.Tag.ToString()