ReplaceSidebar Property

Description

Specifies the name of the vertical sidebar that is connected to the RibbonFormattingTab's TXITEM_Replace button. The property value is String.Empty, if there is no sidebar connected.

Syntax

public string ReplaceSidebar { get; set; }

Public Property ReplaceSidebar As String

Examples

The following example uses RibbonFormattingTab.ReplaceSidebar to configure replace sidebar as part of the ribbon formatting tab workflow. The configured value is checked before the workflow continues.

ribbonFormattingTab.ReplaceSidebar = "Quarterly report";
if (!string.IsNullOrWhiteSpace(ribbonFormattingTab.ReplaceSidebar))
{
    Console.WriteLine($"Replace Sidebar: {ribbonFormattingTab.ReplaceSidebar}");
}

ribbonFormattingTab.ReplaceSidebar = "Quarterly report"
If Not String.IsNullOrWhiteSpace(ribbonFormattingTab.ReplaceSidebar) Then
    Console.WriteLine($"Replace Sidebar: {ribbonFormattingTab.ReplaceSidebar}")
End If

Remarks

Checking the TXITEM_Replace button, if the corresponding vertical sidebar drop down button is toggled, displays the connected sidebar as pinned. If the drop down button is not toggled, the sidebar is represented by a non-sizable dialog. In both cases, the sidebar's content layout is set to SidebarContentLayout.Replace and the connected horizontal replace sidebar is hidden.