Window.CommandBars Property
Gets a reference to the Microsoft Office CommandBars collection of the window that is associated with the Window object.
Namespace: Microsoft.Office.InfoPath
Assembly: Microsoft.Office.InfoPath (in Microsoft.Office.InfoPath.dll)
Syntax
'Declaration
Public MustOverride ReadOnly Property CommandBars As Object
Get
'Usage
Dim instance As Window
Dim value As Object
value = instance.CommandBars
public abstract Object CommandBars { get; }
Property Value
Type: System.Object
A reference to the Microsoft Office CommandBars collection of the window that is associated with the Window object.
Exceptions
| Exception | Condition |
|---|---|
| SecurityException | The form template is not configured for Full Trust using the Security and Trust category of the Form Options dialog box. |
Remarks
After you establish a reference to the CommandBars collection, you can access all the properties and methods of this class.
Important
For the CommandBars property to work, you must establish a reference to the Microsoft Office 14.0 Object Library using the COM tab of the Add Reference dialog box in Microsoft Visual Studio Tools for Applications. This will establish a reference to the Microsoft.Office.Core namespace, which contains the CommandBars class. Additionally, the form must be running as Full Trust.
This member can be accessed only by forms opened from a form template that has been configured to run with full trust using the Security and Trust category of the Form Options dialog box. This member requires full trust for the immediate caller and cannot be used by partially trusted code. For more information, see "Using Libraries from Partially Trusted Code" on MSDN.
This type or member can be accessed only from code running in forms opened in Microsoft InfoPath Filler.
Examples
In the following example, the CommandBars property of the Window class is use to get a CommandBars collection and display the count of Command Bars.
This example requires a using or Imports directive for the Microsoft.Office.Core namespace in the declarations section of the form code module.
// Get CommandBars collection casting to
// Microsoft.Office.Core.CommandBars type.
CommandBars myCommandBars =
(CommandBars)this.Application.ActiveWindow.CommandBars;
// Get count using CommandBars Count property.
int commandBarsCount = myCommandBars.Count;
// Display count of command bars.
MessageBox.Show("There are " + commandBarsCount.ToString() +
" Command Bars");
' Get CommandBars collection casting to
' Microsoft.Office.Core.CommandBars type.
Dim myCommandBars As CommandBars =
DirectCast(Me.Application.ActiveWindow.CommandBars, CommandBars)
' Get count using CommandBars Count property.
Dim commandBarsCount As Integer = myCommandBars.Count
' Display count of command bars.
MessageBox.Show("There are " & commandBarsCount.ToString() &
" Command Bars")