WorkbookBase.CommandBars Property

Reference

Definition

Namespace:: Microsoft.Office.Tools.Excel

Assembly:: Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a Microsoft.Office.Core.CommandBars object that represents the Microsoft Office Excel command bars.

public:
 property Microsoft::Office::Core::CommandBars ^ CommandBars { Microsoft::Office::Core::CommandBars ^ get(); };

public Microsoft.Office.Core.CommandBars CommandBars { get; }

member this.CommandBars : Microsoft.Office.Core.CommandBars

Public ReadOnly Property CommandBars As CommandBars

Property Value

CommandBars

A Microsoft.Office.Core.CommandBars object that represents the Microsoft Office Excel command bars.

Examples

The following code example uses the CommandBars property to delete all custom command bars that are not visible. This example assumes that the current workbook is embedded in another application.

This example is for a document-level customization.

private void WorkbookCommandBars()
{
    if (this.CommandBars != null)
    {
        for (int i = 1; i <= this.CommandBars.Count; i++)
        {
            if (!this.CommandBars[i].BuiltIn &&
                !this.CommandBars[i].Visible)
            {
                this.CommandBars[i].Delete();
            }
        }
    }
    else
    {
        MessageBox.Show("This workbook must be opened in another " +
            "application to use the CommandBars property.");
    }
}

Private Sub WorkbookCommandBars()
    If Not (Me.CommandBars Is Nothing) Then
        Dim i As Integer
        For i = 1 To Me.CommandBars.Count
            If Not Me.CommandBars(i).BuiltIn AndAlso Not _
                Me.CommandBars(i).Visible Then
                Me.CommandBars(i).Delete()
            End If
        Next i
    Else
        MsgBox("This workbook must be opened in another " & _
            "application to use the CommandBars property.")
    End If
End Sub

Remarks

When a workbook is embedded in another application and activated by the user by double-clicking the workbook, using the property with a Workbook object returns the set of Excel command bars available within the other application. At all other times, using this property with a Workbook object returns null. There is no programmatic way to return the set of command bars attached to a workbook. Command bars are associated with the application and not the workbook. This property exists on the workbook so you can access Excel application command bars when Excel is not the application.

Applies to

Share via