ToolTabStrip
Represents a specialized DockTabStrip designed for tool windows that provides caption functionality, action buttons, and auto-hide capabilities for enhanced docking workspace management.
Definition
Namespace:Telerik.WinControls.UI.Docking
Assembly:Telerik.WinControls.RadDock.dll
Syntax:
public class ToolTabStrip : DockTabStrip, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlSplitPanelTabStripPanelDockTabStripToolTabStrip...
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new instance of the ToolTabStrip class with default settings and no associated dock manager.
public ToolTabStrip()Initializes a new instance of the ToolTabStrip class and associates it with the specified RadDock manager for docking operations.
Fields
The root layout panel element that defines the overall structure and arrangement of the ToolTabStrip including caption and tab areas.
protected DockLayoutPanel windowProperties
Gets the system menu RadDropDownButtonElement that provides access to window management actions and context menu options.
[Browsable(false)]
public RadDropDownButtonElement ActionMenuButton { get; }Gets the auto-hide RadToggleButtonElement that toggles the auto-hide state of the tool window in the title bar.
[Browsable(false)]
public RadToggleButtonElement AutoHideButton { get; }Gets or sets the preferred auto-hide position for the strip, determining where the tool window should be positioned when auto-hidden.
public AutoHidePosition AutoHidePosition { get; set; }Gets the ToolWindowCaptionElement that serves as the title bar of the ToolTabStrip containing caption text and action buttons.
[Browsable(false)]
public ToolWindowCaptionElement CaptionElement { get; }Gets the DockLayoutPanel instance that contains and arranges the caption element and tab strip components within the tool window.
[Browsable(false)]
public DockLayoutPanel CaptionLayoutPanel { get; }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.
public bool CaptionVisible { get; set; }Gets the close RadButtonElement that appears in the title bar for closing the active tool window.
[Browsable(false)]
public RadButtonElement CloseButton { get; }Gets the dock type identifier that specifies this strip is designed for tool windows, returning ToolWindow.
public override DockType DockType { get; }Overrides:
Gets the bounds rectangle for the tab panel area, adjusted for the caption height when the caption is visible.
public override Rectangle TabPanelBounds { get; }Overrides:
Gets or sets the fully qualified class name used for theme resolution and styling of the ToolTabStrip control.
public override string ThemeClassName { get; set; }Overrides:
Methods
Checks whether the element's theme is defined by the control.
public override bool ControlDefinesThemeForElement(RadElement element)The element to should be checked.
Returns:true if the control defines theme for this element, false otherwise.
Overrides:
If true is returned the ThemeResolutionService would not not set any theme to the element to avoid duplicating the style settings of the element.
Creates and initializes the child elements including the caption, layout panels, and tab strip components for the ToolTabStrip.
protected override void CreateChildItems(RadElement parent)The parent RadElement that will contain the child elements.
Overrides:
Releases the unmanaged resources used by the ToolTabStrip and optionally releases the managed resources including event handlers.
protected override void Dispose(bool disposing)True to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides:
Determines whether the auto-hide button should appear in the checked state, indicating the current auto-hide configuration.
protected virtual bool GetAutoHideButtonChecked()True if the auto-hide button should be checked; false otherwise.
Determines whether the tab strip element should be visible based on the base visibility logic and the requirement of having multiple tab panels.
protected override bool GetTabStripVisible()True if the tab strip should be visible; false otherwise.
Overrides:
Determines whether dragging is allowed from the specified location by checking if the location is within the caption text area.
Handles layout events to update the caption text and auto-hide button state based on the current configuration and active window.
protected override void OnLayout(LayoutEventArgs e)A LayoutEventArgs that contains the event data for the layout operation.
Overrides:
Handles localization provider changes by updating the tooltip text for caption buttons with localized strings.
protected override void OnLocalizationProviderChanged()Overrides:
Handles mouse double-click events to trigger docking operations when double-clicking on the caption area, excluding action buttons.
protected override void OnMouseDoubleClick(MouseEventArgs e)A MouseEventArgs that contains the event data including button and location information.
Overrides:
Handles mouse down events to display context menus when right-clicking on tab items, split panels, or the caption area.
protected override void OnMouseDown(MouseEventArgs e)A MouseEventArgs that contains the event data including button and location information.
Overrides:
Handles tab selection changing events to update the dock manager's active window when switching between tool tabs.
protected override void OnSelectedIndexChanging(TabStripPanelSelectedIndexChangingEventArgs e)A TabStripPanelSelectedIndexChangingEventArgs that contains the event data.
Overrides:
Determines whether a mouse double-click event should be processed based on the presence of dock manager, active window, and design-time context.
protected override bool ShouldHandleDoubleClick()True if the double-click should be handled; false otherwise.
Overrides:
Updates the active state appearance of the specified dock window and its associated caption element to reflect window activation changes.
protected override void UpdateActiveWindow(DockWindow window, bool active)The DockWindow whose active state is being updated.
activeboolTrue if the window should be marked as active; false otherwise.
Overrides:
Updates the visibility and state of caption buttons (close, auto-hide, system menu) based on the active window's button configuration and permissions.
protected override void UpdateButtons()Overrides:
Updates the caption text display to show the caption or text of the currently selected dock window, prioritizing custom captions over default text.
protected void UpdateCaptionText()