ClassDocumentTabStrip
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, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlSplitPanelTabStripPanelDockTabStripDocumentTabStrip
Implements:
Inherited Members
Constructors
DocumentTabStrip()
Initializes a new instance of the DocumentTabStrip class with default settings and no associated dock manager.
Declaration
public DocumentTabStrip()DocumentTabStrip(RadDock)
Initializes a new instance of the DocumentTabStrip class and associates it with the specified RadDock manager for document operations.
Properties
DefaultTabStripAlignment
Gets the default tab strip alignment for document windows, which is positioned at the top of the container.
Declaration
protected override TabStripAlignment DefaultTabStripAlignment { get; }Property Value
Overrides
DockType
Gets the dock type identifier that specifies this strip is designed for document windows, returning Document.
Declaration
public override DockType DockType { get; }Property Value
Overrides
DocumentButtonsLayout
Gets the DockLayoutPanel that contains and arranges the document-specific buttons like close and overflow menu buttons.
Declaration
public DockLayoutPanel DocumentButtonsLayout { get; }Property Value
OverflowMenuButton
Gets the OverflowDropDownButtonElement that provides access to the active window list when tabs are overflowing or hidden.
Declaration
[Browsable(false)]
public OverflowDropDownButtonElement OverflowMenuButton { get; }Property Value
Methods
ControlDefinesThemeForElement(RadElement)
Determines whether the specified element's theme is defined by the control, particularly for document-specific buttons like close and overflow menu.
Declaration
public override bool ControlDefinesThemeForElement(RadElement element)Parameters
element
The RadElement to check for theme definition.
Returns
True if the control defines the theme for the specified element; false otherwise.
Overrides
CreateChildItems(RadElement)
Creates and initializes the child elements including document buttons layout, close button, and overflow menu for the DocumentTabStrip.
Declaration
protected override void CreateChildItems(RadElement parent)Parameters
parent
The parent RadElement that will contain the child elements.
Overrides
Dispose(bool)
Releases the unmanaged resources used by the DocumentTabStrip and optionally releases managed resources including event handlers and UI elements.
Declaration
protected override void Dispose(bool disposing)Parameters
disposing
True to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
IsDragAllowed(Point)
Determines whether dragging is allowed from any location on the document tab strip, always returning true for flexible document repositioning.
OnControlAdded(ControlEventArgs)
Handles control added events to update the view and layout when new document windows are added to the strip.
Declaration
protected override void OnControlAdded(ControlEventArgs e)Parameters
e
A ControlEventArgs that contains the event data for the added control.
Overrides
OnControlRemoved(ControlEventArgs)
Handles control removed events to update the view and clear bold formatting when document windows are removed from the strip.
Declaration
protected override void OnControlRemoved(ControlEventArgs e)Parameters
e
A ControlEventArgs that contains the event data for the removed control.
Overrides
OnLayout(LayoutEventArgs)
Handles layout events to update the overflow button state based on tab visibility and arrange document buttons properly.
Declaration
protected override void OnLayout(LayoutEventArgs e)Parameters
e
A LayoutEventArgs that contains the event data for the layout operation.
Overrides
OnLocalizationProviderChanged()
Handles localization provider changes by updating the tooltip text for document buttons with localized strings.
Declaration
protected override void OnLocalizationProviderChanged()Overrides
OnMouseClick(MouseEventArgs)
Handles mouse click events, including middle-click support for closing documents by clicking on tab items.
Declaration
protected override void OnMouseClick(MouseEventArgs e)Parameters
e
A 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 for document-specific operations.
Declaration
protected override void OnMouseDown(MouseEventArgs e)Parameters
e
A MouseEventArgs that contains the event data including button and location information.
Overrides
OnMouseUp(MouseEventArgs)
Handles mouse up events to ensure proper event handling when the control is not disposed.
Declaration
protected override void OnMouseUp(MouseEventArgs e)Parameters
e
A MouseEventArgs that contains the event data.
Overrides
OnRightToLeftChanged(EventArgs)
Handles right-to-left layout changes by adjusting the positioning and margins of document buttons to match the new layout direction.
OnSelectedIndexChanging(TabStripPanelSelectedIndexChangingEventArgs)
Handles the tab selection changing event to update the dock manager's active window and validate state transitions.
Declaration
protected override void OnSelectedIndexChanging(TabStripPanelSelectedIndexChangingEventArgs e)Parameters
e
TabStripPanelSelectedIndexChangingEventArgs
A TabStripPanelSelectedIndexChangingEventArgs that contains the event data.
Overrides
OnTabStripAlignmentChanged(EventArgs)
Handles tab strip alignment changes by updating the document buttons layout positioning and alignment based on the new tab position.
OnThemeChanged()
Handles theme changes by reapplying bold formatting to the active document tab since locally set styles need to be refreshed.
Declaration
protected override void OnThemeChanged()Overrides
UpdateActiveWindow(DockWindow, bool)
Updates the active state of the specified dock window and applies bold formatting to the active document tab when appropriate.
Declaration
protected override void UpdateActiveWindow(DockWindow window, bool active)Parameters
window
The DockWindow whose active state is being updated.
active
True if the window should be marked as active; false otherwise.
Overrides
UpdateAfterTransaction()
Updates the document strip after transaction completion, ensuring the active document is properly highlighted with bold formatting.
Declaration
protected override void UpdateAfterTransaction()Overrides
UpdateButtons()
Updates the visibility and state of document buttons (close, overflow menu) based on the active window's button configuration and permissions.
Declaration
protected override void UpdateButtons()Overrides
UpdateTabStripVisibility(bool)
Updates the visibility of the tab strip and associated document buttons layout based on whether tabs should be shown.
Declaration
protected override void UpdateTabStripVisibility(bool visible)Parameters
visible
True to make the tab strip visible; false to hide it.
Overrides