DockTabStrip
Base class for a TabStripPanel instance that resides on a RadDock scene.
Definition
Namespace:Telerik.WinControls.UI.Docking
Assembly:Telerik.WinControls.RadDock.dll
Syntax:
public abstract class DockTabStrip : TabStripPanel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlSplitPanelTabStripPanelDockTabStrip...
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new DockTabStrip instance and associates it with the specified RadDock instance.
Properties
Gets or sets the currently active DockWindow instance.
[Browsable(false)]
public DockWindow ActiveWindow { get; set; }
Determines whether the control accepts Color.Transparent as its BackColor.
public bool AllowTransparentBackColor { get; set; }
Gets or sets the BackColor of the strip. Transparent BackColor is a special case, further controlled by the AllowTransparentBackColor property.
public override Color BackColor { get; set; }
Overrides:
Gets or sets whether this strip is collapsed in the docking layout.
[Browsable(false)]
public override bool Collapsed { get; set; }
Overrides:
Gets the content-area background color used by dock windows hosted in this strip, falling back to the strip color before its element is created.
protected virtual Color DefaultDockWindowBackColor { get; }
Gets the RadDock instance associated with this strip.
[Browsable(false)]
public RadDock DockManager { get; }
Gets the DockType member of this instance.
[Browsable(false)]
public abstract DockType DockType { get; }
Gets the collection of tab panels hosted by this docking strip.
[Browsable(false)]
public TabPanelCollection TabPanels { get; }
Methods
Provides routine which allows the strip to decide whether it should be collapsed or disposed. Internally used by the docking framework to defragment the dock tree.
protected virtual void CheckCollapseOrDispose()
Creates a tab item and raises the creation notification so handlers can customize or replace it.
protected override TabStripItem CreateTabItem(TabPanel tabPanel)
The panel represented by the new tab item.
Returns:The item produced by the creation handler, or the default item if none was supplied.
Overrides:
Determines whether the strip should be collapsed. E.g. it may not have child panels but should not be disposed as it may be a redock target.
Allows inheritors to provide additional functionality upon owning RadDock instance change.
protected virtual void OnDockManagerChanged()
Overrides the method to provide support for instanciating a DragDropService operation.
Updates tab command buttons after the strip completes its load layout.
Provides a hook for derived strips to refresh localized UI after the dock manager's localization provider changes.
protected virtual void OnLocalizationProviderChanged()
Routes a left-button double-click on a document tab to the dock manager when double-click handling is enabled.
protected override void OnMouseDoubleClick(MouseEventArgs e)
Overrides:
Focuses the strip and synchronizes the dock manager's active window with the selected tab.
protected override void OnMouseDown(MouseEventArgs e)
The mouse button and position that selected the tab.
Overrides:
Starts a docking drag when the left button moves a tab outside the tab-item area.
protected override void OnMouseMove(MouseEventArgs e)
The current mouse position and button state.
Overrides:
Closes the corresponding DockWindow instance.
protected override void OnTabCloseButtonClicked(TabStripItem item)
Overrides:
Saves the active window's focused control before forwarding a focus request from a strip element.
protected override bool ProcessFocusRequested(RadElement element)
Overrides:
Determines whether tab double-click handling is enabled outside the designer.
Sizes the selected panel to the strip's content area, temporarily adjusting anchored descendants while the designer loads them.
protected override void UpdateActivePanelBounds()
Overrides:
Allows a DockTabStrip to perform some additional operations upon activation of an owned DockWindow. For example a ToolTabStrip will update its Caption with Active or Inactive state correspondingly.
protected virtual void UpdateActiveWindow(DockWindow window, bool active)
True if the window is currently active, false otherwise.
Refreshes the active-window presentation after a control is removed from the strip.
protected override void UpdateAfterControlRemoved(Control value)
The control removed from the strip.
Overrides:
Allows an affected strip to perform additional update after a transaction completion.
protected virtual void UpdateAfterTransaction()
Updates the additional buttons, associated with the strip. E.g. a ToolTabStrip will have caption buttons, while a DocumentTabStrip will have strip buttons.
protected virtual void UpdateButtons()