TXTextControl.Windows.Forms.Sidebar Class

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.

Introduced: 26.0.

Syntax

[C#]
public class Sidebar : System.Windows.Forms.TableLayoutPanel, System.ComponentModel.INotifyPropertyChanged
[Visual Basic]
Public Class Sidebar
  Inherits System.Windows.Forms.TableLayoutPanel
  Implements System.ComponentModel.INotifyPropertyChanged

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.
DialogLocation Gets or sets the location of the dialog where the Sidebar is placed, if the Sidebar.IsPinned property is set to false.
DialogSize Gets or sets the size of the dialog where the Sidebar is placed, if the Sidebar.IsPinned property is set to false.
DialogStyle Gets or sets the requested border and title bar layout of the sidebar dialog.
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.
IsShown Gets or sets a value indicating whether the Sidebar is shown.
IsSizable Gets or sets a value indicating whether the Sidebar can be sized with the mouse.
ShowCloseButton Gets or sets a value indicating whether the Sidebar's close button is shown.
ShowPinButton Gets or sets a value indicating whether the Sidebar's pin button is shown.
ShowTitle Gets or sets a value indicating whether the Sidebar's title is shown.
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.
TitleForeColor Gets or sets the color of the title bar's text.

Methods

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

Enumerations

Enumeration Description
FieldNavigatorItem Each FieldNavigatorItem represents an item in a predefined FieldNavigator control.
FindAndReplaceItem Each FieldNavigatorItem represents an item in a predefined Find or Replace control.
GotoItem Each GotoItem represents an item in a predefined Goto control.
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.
TrackedChangesItem Each TrackedChangesItem represents an item in a predefined TrackedChanges control.