Infragistics2.Win.UltraWinToolbars.v8.2
IsMainMenuBar Property
See Also  Example
Infragistics.Win.UltraWinToolbars Namespace > UltraToolbar Class : IsMainMenuBar Property

Gets or sets the value indicating whether the UltraToolbar is the main menu bar.

Syntax

Visual Basic (Declaration) 
Public Property IsMainMenuBar As Boolean
C# 
public bool IsMainMenuBar {get; set;}

Return Value

True if the toolbar is the main menu bar; False otherwise.

Exceptions

ExceptionDescription
InvalidOperationException The value is assigned when the UltraToolbarsManager to which the toolbar belongs is current merged into a parent manager or has a child manager merged into it.
NotSupportedException The property is modified at design-time for a toolbar in an UltraToolbarsManager defined on a base Form or UserControl. Inherited toolbars must be modified at run-time or at design-time through the designer of the Form or UserControl they were created on.
InvalidOperationException The value assigned is True and another toolbar in the UltraToolbarsManager has IsMainMenuBar set to True.
InvalidOperationException The value is assigned to True and the toolbar is an UltraTaskPaneToolbar instance.

Remarks

The main menu bar is always visible and always fills the entire logical row when it is docked to the container of the UltraToolbarsManager.

Note: Only one toolbar in an UltraToolbarsManager can have IsMainMenuBar set to True. Setting the value to True on multiple UltraToolbar instances will cause an error.

Example

The following code shows how to access various toolbar properties.

Visual BasicCopy Code
Imports System.Diagnostics
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinToolbars

    Private Sub Button16_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button16.Click

        Debug.WriteLine("Properties of all currently defined toolbars ------------------------")

        Debug.IndentLevel += 1

        Dim toolbar As UltraToolbar
        For Each toolbar In Me.UltraToolbarsManager1.Toolbars
            If toolbar Is Nothing Then
                GoTo NextToolbar
            End If

            Debug.WriteLine("Toolbar '" + toolbar.Key + "'")

            Debug.IndentLevel += 1

            ' Access the DockedColumn, DockedRow, DockedPosition, FloatingLocation and FloatingSize
            ' properties of a toolbar.
            Select Case toolbar.DockedPosition
                Case DockedPosition.Floating
                    Dim rectFloating As New Rectangle(toolbar.FloatingLocation, toolbar.FloatingSize)

                    Debug.WriteLine("Toolbar '" + toolbar.Key + "' is floating. Its position and size are: " + rectFloating.ToString())

                Case DockedPosition.Top
                Case DockedPosition.Bottom
                Case DockedPosition.Left
                Case DockedPosition.Right
                    Debug.WriteLine("Toolbar '" + toolbar.Key + "' is docked in position '" + toolbar.DockedPosition.ToString() + "'. Its DockedRow is: " + toolbar.DockedRow.ToString() + ", and its DockedColumn is: " + toolbar.DockedColumn.ToString())
            End Select

            ' Access the Index property of a toolbar.
            Debug.WriteLine("Toolbar '" + toolbar.Key + "' has an Index in its parent collection of: " + toolbar.Index.ToString())


            ' Access the IsMainMenuBar property of a toolbar.
            If toolbar.IsMainMenuBar = True Then
                Debug.WriteLine("Toolbar '" + toolbar.Key + "' is a main menu bar!")
            Else
                Debug.WriteLine("Toolbar '" + toolbar.Key + "' is NOT a main menu bar!")
            End If


            ' Access the IsStockToolbar property of a toolbar.
            If toolbar.IsStockToolbar = True Then
                Debug.WriteLine("Toolbar '" + toolbar.Key + "' is a stock toolbar!")
            Else
                Debug.WriteLine("Toolbar '" + toolbar.Key + "' is NOT a stock toolbar!")
            End If


            ' Access the ParentCollection property of a toolbar.
            If Not toolbar.ParentCollection Is Nothing Then
                Debug.WriteLine("Toolbar '" + toolbar.Key + "' is in a collection that contains a total of " + toolbar.ParentCollection.Count.ToString() + " entries")
            End If


            ' Access the ShowInToolbarList property of a toolbar.
            If toolbar.ShowInToolbarList = True Then
                Debug.WriteLine("Toolbar '" + toolbar.Key + "' will appear in the toolbar list")
            Else
                Debug.WriteLine("Toolbar '" + toolbar.Key + "' will NOT appear in the toolbar list!")
            End If

            Debug.IndentLevel -= 1

NextToolbar:
        Next

        Debug.IndentLevel -= 1

    End Sub
C#Copy Code
using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinToolbars;

       private void button16_Click(object sender, System.EventArgs e)
       {

           Debug.WriteLine("Properties of all currently defined toolbars ------------------------");

           Debug.IndentLevel++;

           foreach(UltraToolbar toolbar in this.ultraToolbarsManager1.Toolbars)
           {
               if (toolbar == null)
                   continue;

               Debug.WriteLine("Toolbar '" + toolbar.Key + "'");

               Debug.IndentLevel ++;


               // Access the DockedColumn, DockedRow, DockedPosition, FloatingLocation and FloatingSize
               // properties of a toolbar.
               switch (toolbar.DockedPosition)
               {
                   case DockedPosition.Floating:
                       Rectangle rectFloating = new Rectangle(toolbar.FloatingLocation, toolbar.FloatingSize);

                       Debug.WriteLine("Toolbar '" + toolbar.Key + "' is floating.  Its position and size are: " + rectFloating.ToString());
                       break;

                   case DockedPosition.Top:
                   case DockedPosition.Bottom:
                   case DockedPosition.Left:
                   case DockedPosition.Right:
                       Debug.WriteLine("Toolbar '" + toolbar.Key + "' is docked in position '" + toolbar.DockedPosition.ToString() + "'.  Its DockedRow is: " + toolbar.DockedRow.ToString() + ", and its DockedColumn is: " + toolbar.DockedColumn.ToString());
                       break;
               }


               // Access the Index property of a toolbar.
               Debug.WriteLine("Toolbar '" + toolbar.Key + "' has an Index in its parent collection of: " + toolbar.Index.ToString());


               // Access the IsMainMenuBar property of a toolbar.
               if (toolbar.IsMainMenuBar == true)
                   Debug.WriteLine("Toolbar '" + toolbar.Key + "' is a main menu bar!");
               else
                   Debug.WriteLine("Toolbar '" + toolbar.Key + "' is NOT a main menu bar!");


               // Access the IsStockToolbar property of a toolbar.
               if (toolbar.IsStockToolbar == true)
                   Debug.WriteLine("Toolbar '" + toolbar.Key + "' is a stock toolbar!");
               else
                   Debug.WriteLine("Toolbar '" + toolbar.Key + "' is NOT a stock toolbar!");


               // Access the ParentCollection property of a toolbar.
               if (toolbar.ParentCollection != null)
                   Debug.WriteLine("Toolbar '" + toolbar.Key + "' is in a collection that contains a total of " + toolbar.ParentCollection.Count.ToString() + " entries");


               // Access the ShowInToolbarList property of a toolbar.
               if (toolbar.ShowInToolbarList == true)
                   Debug.WriteLine("Toolbar '" + toolbar.Key + "' will appear in the toolbar list");
               else
                   Debug.WriteLine("Toolbar '" + toolbar.Key + "' will NOT appear in the toolbar list!");

               Debug.IndentLevel--;
           }

           Debug.IndentLevel--;

       }

See Also