checkBox

In the object model this is RibbonCheckBox.
clickable control that toggles between on and off often used to switch UI elements on and off.
a box that is selected or cleared to turn an option on or off.
The checkbox control allows the user to check or uncheck an option.


<customUI xmlns="http://schemas.microsoft.com/office/2009/07/customui"> 
  <ribbon startFromScratch="true">
    <tabs>
      <tab id="CustomTab" label="My Tab">
        <group id="Group1" label="MyGroup">
           <checkBox id="mycheckbox"
                     label="Prompt on Saving"
                     onAction="CheckBox_OnAction"/>
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

Attributes (properties)

description(Description) 
enabled(Enabled) "true" | "false" 
id(Id) 
idMso(OfficeImageId) 
idQ  
insertAfterMso  
insertAfterQ  
insertBeforeMso  
insertBeforeQ  
keytip(Keytip) 
label(Label) 
screentip(ScreenTip) 
showLabel(ShowLabel) "true" | "false" 
supertip(SuperTip) 
tag(Tag) 
visible(Visible) "true" | "false" 
 (GenerateMember) 
 (Checked) 
 (Position) 

C# Events (design-time)

The RibbonCheckBox has a Click event that takes a parameter of type RibbonControlEventArgs


Callbacks (run-time)

onActionCheckBox_OnAction -  
getDescriptionCheckBox_OnGetDescription -  
getEnabledCheckBox_OnGetEnabled -  
getKeytipCheckBox_OnGetKeytip -  
getLabelCheckBox_OnGetLabel -  
getPressedCheckBox_OnGetPressed - determines if the checkbox is checked or not when the ribbon is loaded 
getScreentipCheckBox_OnGetScreentip -  
getShowImageCheckBox_OnGetShowImage -  
getShowLabelCheckBox_OnGetShowLabel -  
getSizeCheckBox_OnGetSize -  
getSupertipCheckBox_OnGetSupertip -  
getVisibleCheckBox_OnGetVisible -  

Public Sub CheckBox_OnAction( _ 
   ByRef control As IRibbonControl, _
   ByRef Pressed As Boolean)

End Sub

' C# Equivalent
void CheckBox_OnAction(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetDescription( _ 
   ByRef control As IRibbonControl, _
   ByRef Description As Variant)

End Sub

' C# Equivalent
string CheckBox_OnGetDescription(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetEnabled( _ 
   ByRef control As IRibbonControl, _
   ByRef Enabled As Variant)

End Sub

' C# Equivalent
bool CheckBox_OnGetEnabled(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetKeytip( _ 
   ByRef control As IRibbonControl, _
   ByRef Keytip As Variant)

End Sub

' C# Equivalent
string CheckBox_OnGetKeytip(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetLabel( _ 
   ByRef control As IRibbonControl, _
   ByRef Label As Variant)

End Sub

' C# Equivalent
string CheckBox_OnGetLabel(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetPressed( _ 
   ByRef control As IRibbonControl, _
   ByRef pressed As Variant)

End Sub

' C# Equivalent
bool CheckBox_OnGetPressed(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetScreentip( _ 
   ByRef control As IRibbonControl, _
   ByRef Screentip As Variant)

End Sub

' C# Equivalent
string CheckBox_OnGetScreentip(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetSupertip( _ 
   ByRef control As IRibbonControl, _
   ByRef Supertip As Variant)

End Sub

' C# Equivalent
string CheckBox_OnGetSupertip(
   Office.IRibbonControl control)
{
}

Public Sub CheckBox_OnGetVisible( _ 
   ByRef control As IRibbonControl, _
   ByRef Visible Variant)

End Sub

' C# Equivalent
bool CheckBox_OnGetVisible(
   Office.IRibbonControl control)
{
}


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