RibbonToolbarHelpPaneToggleButton Class

A RibbonToolbarControl HelpPane’s toggle button.

Assembly: DevExpress.WinUI.Ribbon.v21.1.dll

Declaration

C#
VB.NET

public class RibbonToolbarHelpPaneToggleButton :
    RibbonToggleItemBase,
    IRibbonToolbarHelpPaneItem,
    IHelpPaneItem,
    IRibbonItemBase,
    IVisualItem

Public Class RibbonToolbarHelpPaneToggleButton
    Inherits RibbonToggleItemBase
    Implements IRibbonToolbarHelpPaneItem,
               IHelpPaneItem,
               IRibbonItemBase,
               IVisualItem

Remarks

You can add the following items to the RibbonToolbarHelpPane:

Regular Help Pane Button
Help Pane Radio Button
Help Pane Toggle Button

The following code sample displays a Help Pane with the Bold toggle button and Undo/Redo buttons.

XAML

<Ribbon:RibbonToolbarControl>
    <Ribbon:RibbonToolbarControl.HelpPane>
        <Ribbon:RibbonToolbarHelpPane>
            <Ribbon:RibbonToolbarHelpPaneToggleButton>
                <Ribbon:RibbonToolbarHelpPaneToggleButton.Icon>
                    <SymbolIcon Symbol="Bold"/>
                </Ribbon:RibbonToolbarHelpPaneToggleButton.Icon>
            </Ribbon:RibbonToolbarHelpPaneToggleButton>
            <Ribbon:RibbonToolbarHelpPaneButton Content="Undo">
                <Ribbon:RibbonToolbarHelpPaneButton.Icon>
                    <SymbolIcon Symbol="Undo"/>
                </Ribbon:RibbonToolbarHelpPaneButton.Icon>
            </Ribbon:RibbonToolbarHelpPaneButton>
            <Ribbon:RibbonToolbarHelpPaneButton Content="Redo">
                <Ribbon:RibbonToolbarHelpPaneButton.Icon>
                    <SymbolIcon Symbol="Redo"/>
                </Ribbon:RibbonToolbarHelpPaneButton.Icon>
            </Ribbon:RibbonToolbarHelpPaneButton>
        </Ribbon:RibbonToolbarHelpPane>
    </Ribbon:RibbonToolbarControl.HelpPane>
    <Ribbon:RibbonToolbarTab Caption="Home" >
        <Ribbon:RibbonToolbarGroup Caption="File">
            <Ribbon:RibbonToolbarButton Content="Open" IconWidth="32" IconHeight="32">
                <Ribbon:RibbonToolbarButton.Icon>
                    <SymbolIcon Symbol="OpenFile"/>
                </Ribbon:RibbonToolbarButton.Icon>
            </Ribbon:RibbonToolbarButton>
        </Ribbon:RibbonToolbarGroup>
    </Ribbon:RibbonToolbarTab>
</Ribbon:RibbonToolbarControl>

Customize Appearance

You can use the folloowing properties to customize the button appearance:

Property	Description
Background	Gets or sets a RibbonToolbarHelpPaneToggleButton unfocused state background.
BorderBrush	Gets or sets a RibbonToolbarHelpPaneToggleButton unfocused state border brush.
BorderThickness	Gets or sets a RibbonToolbarHelpPaneToggleButton unfocused border thickness.
Foreground	Gets or sets a RibbonToolbarHelpPaneToggleButton unfocused state foreground.
Height	Gets or sets a RibbonToolbarHelpPaneToggleButton height.
Margin	Gets or sets a RibbonToolbarHelpPaneToggleButton margin.
Opacity	Gets or sets RibbonToolbarHelpPaneToggleButton opacity.
ToolTipService.ToolTip	Gets or sets a RibbonToolbarHelpPaneToggleButton tooltip.
ToolTipService.Placement	Gets or sets a RibbonToolbarHelpPaneToggleButton tooltip position.
Visibility	Gets or sets RibbonToolbarHelpPaneToggleButton visibility.
Width	Gets or sets a RibbonToolbarHelpPaneToggleButton width.

Button Icon

You can use the following properties to display and customize a button icon:

Property	Description
Icon	Gets or sets a RibbonToolbarHelpPaneToggleButton IconElement.
IconSource	Gets or sets a RibbonToolbarHelpPaneToggleButton icon source object.
IconTemplate	Gets or sets a RibbonToolbarHelpPaneToggleButton icon template.
TemplateSelector	Gets or sets a RibbonToolbarHelpPaneToggleButton icon template selector.
IconWidth	Gets or sets a RibbonToolbarHelpPaneToggleButton icon width.
IconHeight	Gets or sets a RibbonToolbarHelpPaneToggleButton icon height.