toggleButton Element

The toggleButton Element specifies a toggle button control that can be toggled between the pressed and un-pressed states by the end-user.

Graphical View of toggleButton Attributes

The following figure shows all the visible graphical attributes you can set on the toggleButton control.

This is specified using the following XML:

<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui">
	<!-- true: show only your tab in Excel -->
	<ribbon startFromScratch="true">
		<tabs>
			<tab id="customTab"
			     label="Custom Tab">
				<group id="customGroup"
				       label="Custom Group">
					<toggleButton id="tgbDemo1"
					              image="custom-icon"
					              label="toggleButton Label 1"
					              size="large"
					              onAction="tgbDemo1_Action"/>
					<toggleButton id="tgbDemo2"
					              imageMso="HappyFace"
					              label="toggleButton Label 2"
					              size="normal"
					              keytip="T"
					              screentip="screentip string"
					              supertip="supertip string"
					              onAction="tgbDemo2_Action"/>
				</group>
			</tab>
		</tabs>
	</ribbon>
</customUI>

Note: image="custom-icon": you need to create a custom icon yourself.

Parent Elements

• box
• buttonGroup
• dynamicMenu
• group
• menu
• officeMenu
• splitButton

Children Elements

The toggleButton control does not support child objects of any kind.

Required Attributes

The id, idQ, and idMso attributes are mutually exclusive. At least one of these attributes MUST be specified.

Required Callback

Optional insert Attributes

The insertAfterMso, insertAfterQ, insertBeforeMso, and insertBeforeQ attributes are mutually exclusive. If none of these attributes are specified, the controls SHOULD be appended to the existing set of controls, in the order they are defined in the XML.

Optional Attributes and Callbacks

Using Built-in toggleButton Controls

The following example adds four built-in toggleButtons to a custom tab. The horizontal box contains the Bold, Italic, Underline and Double Underline toggleButton controls.

This is specified using the following XML:

<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui">
	<!-- true: show only your tab in Excel -->
	<ribbon startFromScratch="true">
		<tabs>
			<tab id="customTab"
			     label="Custom Tab">
				<group id="customGroup"
				       label="Custom Group">
					<box id="box"
					     boxStyle="horizontal">
						<toggleButton idMso="Bold"/>
						<toggleButton idMso="Italic"/>
						<toggleButton idMso="Underline"/>
						<toggleButton idMso="UnderlineDouble"/>
					</box>
				</group>
			</tab>
		</tabs>
	</ribbon>
</customUI>

Creating Custom toggleButton Controls

The following example creats an toggleButton that enables the user to switch from the Page Break view in Excel.

XML

Copy and paste the following XML code into customUI14.xml:

<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui"
          onLoad="IRibbonUI_onLoad">
	<!--true: show only your tab in Excel-->
	<ribbon startFromScratch="true">
		<tabs>
			<tab id="customTab"
			     label="Custom Tab">
				<group id="customGroup"
				       label="Custom Group">
					<toggleButton id="PageBreakPreview"
					              imageMso="ViewPageBreakPreviewView"
					              label="Page Break Preview"
					              keytip="I"
					              size="large"
					              getPressed="PageBreakPreview_getPressed"
					              onAction="PageBreakPrevie_Action"/>
				</group>
			</tab>
		</tabs>
	</ribbon>
</customUI>

VBA

Copy and paste the following VBA code into a normal module:

'------------------ Modules ------------------

Option Explicit

Public MyRibbon As IRibbonUI

'Callback for customUI.onLoad
Sub IRibbonUI_onLoad(ribbon As IRibbonUI)
    Set MyRibbon = ribbon
End Sub

'Callback for PageBreakPreview getPressed
Sub PageBreakPreview_getPressed(control As IRibbonControl, ByRef returnedVal)
    If ActiveWindow.View = xlPageBreakPreview Then returnedVal = True
End Sub

'Callback for PageBreakPrevie onAction
Sub PageBreakPrevie_Action(control As IRibbonControl, pressed As Boolean)
    Select Case pressed
        Case True
            ActiveWindow.View = xlPageBreakPreview
        Case False
            ActiveWindow.View = xlNormalView
    End Select
End Sub

Copy and paste the following VBA code into ThisWorkbook:

'------------------ ThisWorkbook ------------------
Option Explicit

Private Sub Workbook_SheetActivate(ByVal Sh As Object)
    'Invalidate the tab each time a worksheet is activated
    MyRibbon.InvalidateControl ("PageBreakPreview") ' Invalidates the cache of a single control
End Sub

Download

Download Custom toggleButton Demo.