DocumentTabStrip
A specialized DockTabStrip that resides within a DocumentContainer and hosts document windows, providing document-specific UI features like close buttons and overflow menus.
Definition
Namespace:Telerik.WinControls.UI.Docking
Assembly:Telerik.WinControls.RadDock.dll
Syntax:
public class DocumentTabStrip : DockTabStrip, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlSplitPanelTabStripPanelDockTabStripDocumentTabStrip...
Implements:
Inherited Members
Constructors
Initializes a new instance of the DocumentTabStrip class with default settings and no associated dock manager.
public DocumentTabStrip()
Initializes a new instance of the DocumentTabStrip class and associates it with the specified RadDock manager for document operations.
Properties
Gets the default tab strip alignment for document windows, which is positioned at the top of the container.
protected override TabStripAlignment DefaultTabStripAlignment { get; }
Overrides:
Gets the dock type identifier that specifies this strip is designed for document windows, returning Document.
public override DockType DockType { get; }
Overrides:
Gets the DockLayoutPanel that contains and arranges the document-specific buttons like close and overflow menu buttons.
public DockLayoutPanel DocumentButtonsLayout { get; }
Gets the OverflowDropDownButtonElement that provides access to the active window list when tabs are overflowing or hidden.
[Browsable(false)]
public OverflowDropDownButtonElement OverflowMenuButton { get; }
Methods
Determines whether the specified element's theme is defined by the control, particularly for document-specific buttons like close and overflow menu.
public override bool ControlDefinesThemeForElement(RadElement element)
The RadElement to check for theme definition.
Returns:True if the control defines the theme for the specified element; false otherwise.
Overrides:
Creates and initializes the child elements including document buttons layout, close button, and overflow menu for the DocumentTabStrip.
protected override void CreateChildItems(RadElement parent)
The parent RadElement that will contain the child elements.
Overrides:
Releases the unmanaged resources used by the DocumentTabStrip and optionally releases managed resources including event handlers and UI elements.
protected override void Dispose(bool disposing)
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides:
Determines whether dragging is allowed from any location on the document tab strip, always returning true for flexible document repositioning.
Handles control added events to update the view and layout when new document windows are added to the strip.
protected override void OnControlAdded(ControlEventArgs e)
A ControlEventArgs that contains the event data for the added control.
Overrides:
Handles control removed events to update the view and clear bold formatting when document windows are removed from the strip.
protected override void OnControlRemoved(ControlEventArgs e)
A ControlEventArgs that contains the event data for the removed control.
Overrides:
Handles layout events to update the overflow button state based on tab visibility and arrange document buttons properly.
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 document buttons with localized strings.
protected override void OnLocalizationProviderChanged()
Overrides:
Handles mouse click events, including middle-click support for closing documents by clicking on tab items.
protected override void OnMouseClick(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 for document-specific operations.
protected override void OnMouseDown(MouseEventArgs e)
A MouseEventArgs that contains the event data including button and location information.
Overrides:
Handles mouse up events to ensure proper event handling when the control is not disposed.
protected override void OnMouseUp(MouseEventArgs e)
A MouseEventArgs that contains the event data.
Overrides:
Handles the tab selection changing event to update the dock manager's active window and validate state transitions.
protected override void OnSelectedIndexChanging(TabStripPanelSelectedIndexChangingEventArgs e)
A TabStripPanelSelectedIndexChangingEventArgs that contains the event data.
Overrides:
Handles theme changes by reapplying bold formatting to the active document tab since locally set styles need to be refreshed.
protected override void OnThemeChanged()
Overrides:
Updates the active state of the specified dock window and applies bold formatting to the active document tab when appropriate.
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 document strip after transaction completion, ensuring the active document is properly highlighted with bold formatting.
protected override void UpdateAfterTransaction()
Overrides:
Updates the visibility and state of document buttons (close, overflow menu) based on the active window's button configuration and permissions.
protected override void UpdateButtons()
Overrides:
Updates the visibility of the tab strip and associated document buttons layout based on whether tabs should be shown.
protected override void UpdateTabStripVisibility(bool visible)
True to make the tab strip visible; false to hide it.
Overrides: