Description

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

Syntax

public string CommentsSidebar { get; set; }

Public Property CommentsSidebar As String

Examples

The following example uses RibbonProofingTab.CommentsSidebar to configure comments sidebar as part of the ribbon proofing tab workflow. The configured value is checked before the workflow continues.

ribbonProofingTab.CommentsSidebar = "Quarterly report";
if (!string.IsNullOrWhiteSpace(ribbonProofingTab.CommentsSidebar))
{
    Console.WriteLine($"Comments Sidebar: {ribbonProofingTab.CommentsSidebar}");
}

ribbonProofingTab.CommentsSidebar = "Quarterly report"
If Not String.IsNullOrWhiteSpace(ribbonProofingTab.CommentsSidebar) Then
    Console.WriteLine($"Comments Sidebar: {ribbonProofingTab.CommentsSidebar}")
End If

Remarks

Checking the TXITEM_Comments 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 sizable dialog. In both cases, the sidebar's content layout is set to SidebarContentLayout.Comments and the connected horizontal comments sidebar is hidden.