XRControlCollection.Add(XRControl) Method

Adds the specified control to the collection.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

public int Add(
    XRControl child
)

VB.NET

Public Function Add(
    child As XRControl
) As Integer

Parameters

Name	Type	Description
child	XRControl	An XRControl object to add to the collection.

Returns

Type	Description
Int32	An integer value indicating the position into which the new element was inserted. If the control is already included in the collection the return value indicates the existing position of the control inside the collection.

Remarks

This method adds the control to the end of the collection.

Example

The following example shows two methods that use the XRControlCollection.Add, XRControlCollection.Remove and XRControlCollection.Contains methods of the XRControlCollection class. The first method adds a control to the control collection of the XRPanel object at the specified location. The second method checks if the specified control belongs to the specified collection, and if it does, it removes the control from the collection.

C#

using System.Drawing;
using DevExpress.XtraReports.UI;
// ...

public void AddControl(XRPanel panel, XRControl item, int x, int y) {
    // Add a control to the collection.
    panel.Controls.Add(item);

    // Set the control's location within the panel.
    item.Location = new Point(x, y);
}

public void RemoveControl(XRPanel panel, XRControl item) {
    // Check if the control belongs to the collection.
    if(panel.Controls.Contains(item))

        // Remove the control from the collection.
        panel.Controls.Remove(item);
}

VB.NET

Imports System.Drawing
Imports DevExpress.XtraReports.UI
' ...

Public Sub AddControl(ByRef panel As XRPanel, ByRef item As XRControl, _
ByVal x As Integer, ByVal y As Integer)
    ' Add a control to the collection.
    panel.Controls.Add(item)

    ' Set the control's location within the panel.
    item.Location = New Point(x, y)
End Sub

Public Sub RemoveControl(ByRef panel As XRPanel, ByRef item As XRControl)
    ' Check if the control belongs to the collection.
    If (panel.Controls.Contains(item)) Then

         ' Remove the control from the collection.
         panel.Controls.Remove(item)
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(XRControl) 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_how-to-insert-a-shape-control-into-a-report-e160/CS/Form1.cs#L37

// Preview the report.
report.Detail.Controls.Add(shape);
report.ShowPreview();

asp-net-mvc-grid-create-report-based-on-grid-layout/CS/E4755/Controllers/HomeController.cs#L47

control.LocationF = new System.Drawing.PointF(0, 0);
e.Owner.Controls.Add(control);
control.Shape = new ShapeStar() {

Reporting_how-to-create-a-label-in-the-pageheader-band-when-a-field-is-dragged-from-the-t457241/CS/T457241/Form1.cs#L49

XRLabel newLabel = CopyLabel(label, headerBand);
headerBand.Controls.Add(newLabel);
DesignTool.AddToContainer(host, newLabel);

Reporting_how-to-create-a-custom-composite-control-e4583/CS/docCustomControls/MyCompositeControl.cs#L38

label1.SizeF = new System.Drawing.SizeF(200, 25);
panel.Controls.Add(label1);
XRLabel label2 = new XRLabel();

winforms-create-a-custom-exporter-for-pivotgridcontrol-with-xtrareport/CS/Report_at_Runtime/PivotReportGenerator.cs#L220

detail.Rows.Add(detailRow);
report.Bands[BandKind.PageHeader].Controls.Add(header);
report.Bands[BandKind.Detail].Controls.Add(detail);

VB.NET

Reporting_how-to-insert-a-shape-control-into-a-report-e160/VB/Form1.vb#L39

' Preview the report.
report.Detail.Controls.Add(shape)
report.ShowPreview()

asp-net-mvc-grid-create-report-based-on-grid-layout/VB/E4755/Controllers/HomeController.vb#L49

control.LocationF = New System.Drawing.PointF(0, 0)
e.Owner.Controls.Add(control)
control.Shape = New ShapeStar() With {.StarPointCount = 5, .Concavity = 30}

Reporting_how-to-create-a-report-based-on-hierarchical-data-e1741/VB/Form1.vb#L49

title.Text = "Hierarchical Data Report"
headerBand.Controls.Add(title)
report.Bands.Add(headerBand)

Reporting_how-to-create-a-custom-composite-control-e4583/VB/docCustomControls/MyCompositeControl.vb#L38

label1.SizeF = New System.Drawing.SizeF(200, 25)
panel.Controls.Add(label1)
Dim label2 As New XRLabel()

winforms-create-a-custom-exporter-for-pivotgridcontrol-with-xtrareport/VB/Report_at_Runtime/PivotReportGenerator.vb#L212

detail.Rows.Add(detailRow)
report.Bands(BandKind.PageHeader).Controls.Add(header)
report.Bands(BandKind.Detail).Controls.Add(detail)