toggleButton

In the object model this is RibbonToggleButton.
A toggleButton is a clickable item that toggles between being pressed and not pressed.
There is a Click event that is raised when the user clicks the togglebutton

<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui"

onLoad="Ribbon_OnLoad">

<ribbon startFromScratch="false">

<tabs>

<tab id="CustomTab"

label="Toggle Letter/A4"

insertAfterMso="TabHome">

<group id="Group1"

label="Toggle Paper Size">

<toggleButton id="MyToggleButton1"

imageMso="ObjectNudgeRight"

label="Letter Paper Size"

size="large"

onAction="ToggleButton1_OnAction"

getPressed="ToggleButton1_OnGetPressed"/>

<separator id="Separator1"/>

<toggleButton id="MyToggleButton2"

imageMso="ObjectNudgeLeft"

label="A4 Paper Size"

size="large"

onAction="ToggleButton2_OnAction"

getPressed="ToggleButton2_OnGetPressed"/>

</group>

</tab>

</tabs>

</ribbon>

</customUI>


Attributes (Properties)

description(Description)
enabled"true" | "false"
id 
idMso(OfficeImageID)
idQ 
image 
imageMso 
insertAfterMso 
insertAfterQ 
insertBeforeMso 
insertBeforeQ 
keytip 
label(Label)
screentip(ScreenTip)
showImage"true" | "false"
showLabel(ShowLabel) "true" | "false"
size(ControlSize)
supertip(SuperTip)
tag(Tag)
visible"true" | "false"
 (Checked)

Callbacks

onActionToggleButton_OnAction
getDescriptionToggleButton_OnGetDescription
getEnabledToggleButton_OnGetEnabled
getImageToggleButton_OnGetImage
getImageMsoToggleButton_On
getKeytipToggleButton_OnGetKeytip
getLabelToggleButton_OnGetLabel
getPressedToggleButton_OnGetPressed
getScreentipToggleButton_OnGetScreentip
getShowImageToggleButton_OnGetShowImage
getShowLabelToggleButton_OnGetShowLabel
getSizeToggleButton_On
getSupertipToggleButton_OnGetSupertip
getVisibleToggleButton_OnGetVisible
















© 2026 Better Solutions Limited. All Rights Reserved. © 2026 Better Solutions Limited TopPrevNext