Class ToolTabStrip

Represents a specialized DockTabStrip designed for tool windows that provides caption functionality, action buttons, and auto-hide capabilities for enhanced docking workspace management.

Inheritance
System.Object
RadControl
SplitPanel
TabStripPanel
DockTabStrip
ToolTabStrip
AutoHideTabStrip
Inherited Members
Namespace: Telerik.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock.dll

Syntax

public class ToolTabStrip : DockTabStrip, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

ToolTabStrip()

Initializes a new instance of the ToolTabStrip class with default settings and no associated dock manager.

Declaration
public ToolTabStrip()

ToolTabStrip(RadDock)

Initializes a new instance of the ToolTabStrip class and associates it with the specified RadDock manager for docking operations.

Declaration
public ToolTabStrip(RadDock dockManager)
Parameters
RadDock dockManager

The RadDock instance that will manage this tool tab strip, or null for standalone usage.

Fields

window

The root layout panel element that defines the overall structure and arrangement of the ToolTabStrip including caption and tab areas.

Declaration
protected DockLayoutPanel window
Field Value
DockLayoutPanel

Properties

ActionMenuButton

Gets the system menu RadDropDownButtonElement that provides access to window management actions and context menu options.

Declaration
public RadDropDownButtonElement ActionMenuButton { get; }
Property Value
RadDropDownButtonElement

AutoHideButton

Gets the auto-hide RadToggleButtonElement that toggles the auto-hide state of the tool window in the title bar.

Declaration
public RadToggleButtonElement AutoHideButton { get; }
Property Value
RadToggleButtonElement

AutoHidePosition

Gets or sets the preferred auto-hide position for the strip, determining where the tool window should be positioned when auto-hidden.

Declaration
public AutoHidePosition AutoHidePosition { get; set; }
Property Value
AutoHidePosition

CaptionElement

Gets the ToolWindowCaptionElement that serves as the title bar of the ToolTabStrip containing caption text and action buttons.

Declaration
public ToolWindowCaptionElement CaptionElement { get; }
Property Value
ToolWindowCaptionElement

CaptionLayoutPanel

Gets the DockLayoutPanel instance that contains and arranges the caption element and tab strip components within the tool window.

Declaration
public DockLayoutPanel CaptionLayoutPanel { get; }
Property Value
DockLayoutPanel

CaptionVisible

Gets or sets a value indicating whether the caption element of the strip is visible, allowing users to show or hide the title bar area.

Declaration
public bool CaptionVisible { get; set; }
Property Value
System.Boolean

CloseButton

Gets the close RadButtonElement that appears in the title bar for closing the active tool window.

Declaration
public RadButtonElement CloseButton { get; }
Property Value
RadButtonElement

DockType

Gets the dock type identifier that specifies this strip is designed for tool windows, returning ToolWindow.

Declaration
public override DockType DockType { get; }
Property Value
DockType

Overrides

TabPanelBounds

Gets the bounds rectangle for the tab panel area, adjusted for the caption height when the caption is visible.

Declaration
public override Rectangle TabPanelBounds { get; }
Property Value
System.Drawing.Rectangle

Overrides

ThemeClassName

Gets or sets the fully qualified class name used for theme resolution and styling of the ToolTabStrip control.

Declaration
public override string ThemeClassName { get; set; }
Property Value
System.String

Overrides

Methods

ControlDefinesThemeForElement(RadElement)

Checks whether the element's theme is defined by the control.

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

The element to should be checked.
Returns
System.Boolean

true if the control defines theme for this element, false otherwise.
Overrides
Remarks

If true is returned the ThemeResolutionService would not not set any theme to the element to avoid duplicating the style settings of the element.

CreateChildItems(RadElement)

Creates and initializes the child elements including the caption, layout panels, and tab strip components for the ToolTabStrip.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

The parent RadElement that will contain the child elements.
Overrides

Dispose(Boolean)

Releases the unmanaged resources used by the ToolTabStrip and optionally releases the managed resources including event handlers.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

True to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

GetAutoHideButtonChecked()

Determines whether the auto-hide button should appear in the checked state, indicating the current auto-hide configuration.

Declaration
protected virtual bool GetAutoHideButtonChecked()
Returns
System.Boolean

True if the auto-hide button should be checked; false otherwise.

GetTabStripVisible()

Determines whether the tab strip element should be visible based on the base visibility logic and the requirement of having multiple tab panels.

Declaration
protected override bool GetTabStripVisible()
Returns
System.Boolean

True if the tab strip should be visible; false otherwise.
Overrides

IsDragAllowed(Point)

Determines whether dragging is allowed from the specified location by checking if the location is within the caption text area.

Declaration
protected override bool IsDragAllowed(Point location)
Parameters
System.Drawing.Point location

The System.Drawing.Point location to test for drag allowance.
Returns
System.Boolean

True if dragging is allowed from the specified location; false otherwise.
Overrides

OnLayout(LayoutEventArgs)

Handles layout events to update the caption text and auto-hide button state based on the current configuration and active window.

Declaration
protected override void OnLayout(LayoutEventArgs e)
Parameters
System.Windows.Forms.LayoutEventArgs e

A System.Windows.Forms.LayoutEventArgs that contains the event data for the layout operation.
Overrides

OnLocalizationProviderChanged()

Handles localization provider changes by updating the tooltip text for caption buttons with localized strings.

Declaration
protected override void OnLocalizationProviderChanged()
Overrides

OnMouseDoubleClick(MouseEventArgs)

Handles mouse double-click events to trigger docking operations when double-clicking on the caption area, excluding action buttons.

Declaration
protected override void OnMouseDoubleClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data including button and location information.
Overrides

OnMouseDown(MouseEventArgs)

Handles mouse down events to display context menus when right-clicking on tab items, split panels, or the caption area.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

A System.Windows.Forms.MouseEventArgs that contains the event data including button and location information.
Overrides

OnRightToLeftChanged(EventArgs)

Handles right-to-left layout changes by adjusting the positioning and alignment of caption elements and action buttons.

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

OnSelectedIndexChanging(TabStripPanelSelectedIndexChangingEventArgs)

Handles tab selection changing events to update the dock manager's active window when switching between tool tabs.

Declaration
protected override void OnSelectedIndexChanging(TabStripPanelSelectedIndexChangingEventArgs e)
Parameters
TabStripPanelSelectedIndexChangingEventArgs e

A TabStripPanelSelectedIndexChangingEventArgs that contains the event data.
Overrides

OnTabStripAlignmentChanged(EventArgs)

Handles tab strip alignment changes by updating the window margin to accommodate the new tab positioning.

Declaration
protected override void OnTabStripAlignmentChanged(EventArgs e)
Parameters
System.EventArgs e

An System.EventArgs that contains the event data.
Overrides

ShouldHandleDoubleClick()

Determines whether a mouse double-click event should be processed based on the presence of dock manager, active window, and design-time context.

Declaration
protected override bool ShouldHandleDoubleClick()
Returns
System.Boolean

True if the double-click should be handled; false otherwise.
Overrides

ShouldSerializeCaptionVisible()

This property is not relevant for this class.

Declaration
public bool ShouldSerializeCaptionVisible()
Returns
System.Boolean

UpdateActiveWindow(DockWindow, Boolean)

Updates the active state appearance of the specified dock window and its associated caption element to reflect window activation changes.

Declaration
protected override void UpdateActiveWindow(DockWindow window, bool active)
Parameters
DockWindow window

The DockWindow whose active state is being updated.
System.Boolean active

True if the window should be marked as active; false otherwise.
Overrides

UpdateButtons()

Updates the visibility and state of caption buttons (close, auto-hide, system menu) based on the active window's button configuration and permissions.

Declaration
protected override void UpdateButtons()
Overrides

UpdateCaptionText()

Updates the caption text display to show the caption or text of the currently selected dock window, prioritizing custom captions over default text.

Declaration
protected void UpdateCaptionText()

UpdateTabSelection(Boolean)

This method is not relevant for this class.

Declaration
public override void UpdateTabSelection(bool updateFocus)
Parameters
System.Boolean updateFocus

Overrides

Extension Methods