Back to Devexpress

BarDockControl.Controls Property

windowsforms-devexpress-dot-xtrabars-dot-bardockcontrol.md

latest3.5 KB
Original Source

BarDockControl.Controls Property

Gets the collection of bars displayed within the bar dock control.

Namespace : DevExpress.XtraBars

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
public Control.ControlCollection Controls { get; }
vb
<Browsable(False)>
Public ReadOnly Property Controls As Control.ControlCollection

Property Value

TypeDescription
Control.ControlCollection

The collection of bars displayed within the bar dock control.

|

Remarks

Use the BarDockControl.Controls property to access bars that are displayed within the bar dock control.

The BarDockControl.Controls property stores a collection of DevExpress.XtraBars.Controls.DockedBarControl objects that refer to bars (DockedBarControl.Bar).

The following example iterates through all bar item links displayed in toolbars and disables bar item links that correspond to ‘save’ commands:

csharp
using DevExpress.XtraBars;
using DevExpress.XtraBars.Controls;
using DevExpress.XtraEditors;
using System;

namespace DXApplication
{
    public partial class Form1 : XtraForm
    {
        public Form1()
        {
            InitializeComponent();
            barManager1.ForceInitialize();
        }
        void Form1_Load(object sender, EventArgs e)
        {
            foreach(BarDockControl dockControl in barManager1.DockControls)
                foreach(DockedBarControl dockContainer in dockControl.Controls)
                    foreach(BarItemLink link in dockContainer.Bar.ItemLinks) {
                        if (link.Caption.ToLower().Contains("save"))
                            link.Item.Enabled = false;
                    }
        }
    }
}
vb
Imports DevExpress.XtraBars
Imports DevExpress.XtraBars.Controls
Imports DevExpress.XtraEditors
Imports System

Namespace DXApplication
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            barManager1.ForceInitialize()
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
            For Each dockControl As BarDockControl In barManager1.DockControls
                For Each dockContainer As DockedBarControl In dockControl.Controls
                    For Each link As BarItemLink In dockContainer.Bar.ItemLinks
                        If link.Caption.ToLower().Contains("save") Then
                            link.Item.Enabled = False
                        End If
                    Next link
                Next dockContainer
            Next dockControl
        End Sub
    End Class
End Namespace

See Also

BarDockControl Class

BarDockControl Members

DevExpress.XtraBars Namespace