Description

The Sidebar class represents a container that gives quick access to a control which is either user-defined or a predefined TextControl feature interface. It must be placed into another control, but can also be displayed as a dialog. A Sidebar is inherited from the System.Windows.Forms.TableLayoutPanel class and implements the System.ComponentModel.INotifyPropertyChanged interface. The following describes only the properties, methods and events defined through the Sidebar class. For a list of properties, methods and events inherited from the System.Windows.Forms.TableLayoutPanel class and the System.ComponentModel.INotifyPropertyChanged interface see the .NET Framework reference.

Syntax

public class Sidebar : TableLayoutPanel, INotifyPropertyChanged

Public Class Sidebar
    Inherits TableLayoutPanel
    Implements INotifyPropertyChanged

Examples

The following example creates a Sidebar instance and configures its text setting for a document workflow.

using TXTextControl.Windows.Forms.Sidebar sidebar = new();
sidebar.Text = "Quarterly results";

Dim sidebar As New TXTextControl.Windows.Forms.Sidebar()
sidebar.Text = "Quarterly results"

Members

Constructors

Constructor	Description
Sidebar	Initializes a new instance of the Sidebar class.

Properties

Property	Description
Content	Gets or sets an object of type System.Windows.Forms.Control that represents the content of the Sidebar.
ContentLayout	Determines the content layout that has to be intialized and rendered for the Sidebar. Beside the predefined TextControl feature layouts SidebarContentLayout.FieldNavigator, SidebarContentLayout.Find, SidebarContentLayout.Goto, SidebarContentLayout.Replace, SidebarContentLayout.Styles, SidebarContentLayout.TrackedChanges, SidebarContentLayout.ConditionalInstructions, SidebarContentLayout.DocumentSettings, SidebarContentLayout.Comments and SidebarContentLayout.About, the user can choose SidebarContentLayout.Custom to place a custom control as content. To disable setting any content for this Sidebar, set the property to SidebarContentLayout.None. The default value is SidebarContentLayout.None.
DialogLocation	Gets or sets the location of the dialog where the Sidebar is placed, if the Sidebar.IsPinned property is set to false. To place the dialog into the center of the top most control, the property value must be set to System.Drawing.Point.Empty. The default value is System.Drawing.Point.Empty.
DialogSize	Gets or sets the size of the dialog where the Sidebar is placed, if the Sidebar.IsPinned property is set to false. To resize the dialog according to its content, the property value must be set to System.Drawing.Size.Empty. The default value is System.Drawing.Size.Empty.
DialogStyle	Gets or sets the requested border and title bar layout of the sidebar dialog. The default value is SidebarDialogStyle.Standard.
IsPinned	Gets or sets a value indicating whether the Sidebar is rendered inside another control (property value is set to true) or displayed as dialog. The default value is true.
IsShown	Gets or sets a value indicating whether the Sidebar is shown. The default value is true.
IsSizable	Gets or sets a value indicating whether the Sidebar can be sized with the mouse. The default value is true.
ShowCloseButton	Gets or sets a value indicating whether the Sidebar's close button is shown. The default value is true.
ShowPinButton	Gets or sets a value indicating whether the Sidebar's pin button is shown. The default value is true.
ShowTitle	Gets or sets a value indicating whether the Sidebar's title is shown. The default value is true.
Text	Overridden. Gets or sets the text that is displayed in the title bar of the Sidebar.
TextControl	Gets or sets the TextControl that is used for the predefined TextControl feature layouts.
TitleFont	Gets or sets the font of the title bar's text. The default value is the font type 'Calibri Light' with a size of 18.
TitleForeColor	Gets or sets the color of the title bar's text. The default value is the ARGB value (255, 43, 87, 154).

Methods

Method	Description
FindItem	Finds a control inside a predefined content control that has the provided identifier name.

Events

Event	Description
PropertyChanged	Not described in the reference. `public event PropertyChangedEventHandler PropertyChanged;`

Enumerations

Enumeration	Description
AboutItem	Each AboutItem represents an item in a predefined About control. The corresponding string of a AboutItem is the same as the item's Name property. The AboutItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
CommentsItem	Each CommentsItem represents an item in a predefined Comments control. The corresponding string of a CommentsItem is the same as the item's Name property. The CommentsItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
ConditionalInstructionsItem	Each ConditionalInstructionsItem represents an item in a predefined ConditionalInstructions control. The corresponding string of a ConditionalInstructionsItem is the same as the item's Name property. The ConditionalInstructionsItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
DocumentSettingsItem	Each DocumentSettingsItem represents an item in a predefined DocumentSettings control. The corresponding string of a DocumentSettingsItem is the same as the item's Name property. The DocumentSettingsItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
FieldNavigatorItem	Each FieldNavigatorItem represents an item in a predefined FieldNavigator control. The corresponding string of a FieldNavigatorItem is the same as the item's Name property. The FieldNavigatorItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
FindAndReplaceItem	Each FieldNavigatorItem represents an item in a predefined Find or Replace control. The corresponding string of a FindAndReplaceItem is the same as the item's Name property. The FindAndReplaceItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
GotoItem	Each GotoItem represents an item in a predefined Goto control. The corresponding string of a GotoItem is the same as the item's Name property. The GotoItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
SidebarContentLayout	Specifies the requested layout that has to be intialized and rendered as sidebar content.
SidebarDialogStyle	Specifies the requested border and title bar layout of the sidebar dialog.
StylesItem	Each StylesItem represents an item in a predefined Styles control. The corresponding string of a StylesItem is the same as the item's Name property. The StylesItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.
TrackedChangesItem	Each TrackedChangesItem represents an item in a predefined TrackedChanges control. The corresponding string of a TrackedChangesItem is the same as the item's Name property. The TrackedChangesItem enumeration can be used with the Sidebar.FindItem method to get the item and manipulate it.

Sidebar Class