XRControl.Controls Property

Gets the collection of XRControl objects or their descendants that are contained in this control.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

[Browsable(false)]
public virtual XRControlCollection Controls { get; }

VB.NET

<Browsable(False)>
Public Overridable ReadOnly Property Controls As XRControlCollection

Property Value

Type	Description
XRControlCollection	An object of the XRControlCollection class representing the collection of contained controls.

Remarks

An XRControl object acts as a parent for any control contained within its collection. This collection is returned by its Controls property. Objects in this collection are considered to be child controls of the XRControl object. If a control can have child controls then its XRControl.CanHaveChildren property is equal to true.

Example

The following method aligns controls contained in an XRControl object. The controls are aligned with the topmost control. Access to the controls is provided via the XRControl.Controls property.

Tip

Online Example: How to align controls contained in an XRControl object

C#

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

public void AlignHorizontally(XRControl container) {

    // Make sure that the collection is not empty.
    if(container.Controls.Count > 0) {

        // Assign the Y-coordinate of the first control in the collection to a variable.
        int y = container.Controls[0].Top;

        // Find the Y-coordinate of the topmost control.
        foreach(XRControl control in container.Controls) 
            if(control.Top < y)
                y = control.Top;

        // Align the controls with the topmost control.
        foreach(XRControl control in container.Controls) 
            control.Location = new Point(control.Left, y);
    }
}

VB.NET

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

Public Sub AlignHorizontally(ByRef container As XRControl)

    ' Make sure that the collection is not empty.
    If container.Controls.Count > 0 Then

        ' Assign the Y-coordinate of the first control in the collection to a variable.
        Dim y As Integer = container.Controls(0).Top

        Dim control As XRControl
        ' Find the Y-coordinate of the topmost control.
        For Each control In container.Controls
            If (control.Top < y) Then
                y = control.Top
            End If
        Next

        ' Align the controls with the topmost control.
        For Each control In container.Controls
            control.Location = New Point(control.Left, y)
        Next
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Controls 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_how-to-use-the-web-document-viewer-in-javascript-with-reactjs-t561300/CS/ServerSide/XtraReport2.cs#L128

//
this.bottomMarginBand1.Controls.AddRange(new DevExpress.XtraReports.UI.XRControl[] {
this.xrPageInfo1,

Reporting_how-to-use-the-web-report-designer-in-javascript-with-reactjs-t561295/CS/ServerSide/XtraReport1.cs#L134

//
this.bottomMarginBand1.Controls.AddRange(new DevExpress.XtraReports.UI.XRControl[] {
this.xrPageInfo1,

Reporting_how-to-align-controls-contained-in-an-xrcontrol-object-e128/CS/XtraReport1.cs#L129

// Find the Y-coordinate of the control located above other controls.
foreach(XRControl control in container.Controls)
    if(control.Top < height)

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

MyCompositeControl panel = this.XRControl as MyCompositeControl;
foreach(XRControl childControl in panel.Controls) {
    System.Drawing.PointF loc = childControl.LocationF;

Reporting_how-to-anchor-controls-to-the-top-right-side-when-document-margins-are-changed-in-the-e632/CS/XtraReport1.cs#L33

foreach (Band _band in base.Bands) {
    foreach (XRControl _control in _band.Controls) {
        isLocationChanged = true;

VB.NET

Reporting_how-to-use-the-web-document-viewer-in-javascript-with-reactjs-t561300/VB/ServerSide/XtraReport2.vb#L129

'
Me.bottomMarginBand1.Controls.AddRange(New DevExpress.XtraReports.UI.XRControl() { Me.xrPageInfo1, Me.xrPageInfo2})
Me.bottomMarginBand1.HeightF = 100F

Reporting_how-to-use-the-web-report-designer-in-javascript-with-reactjs-t561295/VB/ServerSide/XtraReport1.vb#L135

'
Me.bottomMarginBand1.Controls.AddRange(New DevExpress.XtraReports.UI.XRControl() { Me.xrPageInfo1, Me.xrPageInfo2})
Me.bottomMarginBand1.HeightF = 100F

Reporting_how-to-align-controls-contained-in-an-xrcontrol-object-e128/VB/XtraReport1.vb#L124

' Find the Y-coordinate of the control located above other controls.
For Each control As XRControl In container.Controls
    If control.Top < height Then

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

Dim panel As MyCompositeControl = TryCast(Me.XRControl, MyCompositeControl)
For Each childControl As XRControl In panel.Controls
    Dim loc As System.Drawing.PointF = childControl.LocationF

Reporting_how-to-anchor-controls-to-the-top-right-side-when-document-margins-are-changed-in-the-e632/VB/XtraReport1.vb#L32

For Each _band As Band In Bands
    For Each _control As XRControl In _band.Controls
        isLocationChanged = True