ClassDockTabStrip
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, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlSplitPanelTabStripPanelDockTabStrip
Derived Classes:
Implements:
Inherited Members
Constructors
DockTabStrip(RadDock)
Initializes a new DockTabStrip instance and associates it with the specified RadDock instance.
Declaration
public DockTabStrip(RadDock dockManager)Parameters
dockManager
Properties
ActiveWindow
Gets or sets the currently active DockWindow instance.
Declaration
[Browsable(false)]
public DockWindow ActiveWindow { get; set; }Property Value
AllowTransparentBackColor
Determines whether the control accepts Color.Transparent as its BackColor.
Declaration
public bool AllowTransparentBackColor { get; set; }Property Value
BackColor
Gets or sets the BackColor of the strip. Transparent BackColor is a special case, further controlled by the AllowTransparentBackColor property.
Declaration
public override Color BackColor { get; set; }Property Value
Overrides
Collapsed
Declaration
[Browsable(false)]
public override bool Collapsed { get; set; }Property Value
Overrides
DefaultDockWindowBackColor
Declaration
protected virtual Color DefaultDockWindowBackColor { get; }Property Value
DockManager
Declaration
[Browsable(false)]
public RadDock DockManager { get; }Property Value
DockType
Gets the DockType member of this instance.
Declaration
[Browsable(false)]
public abstract DockType DockType { get; }Property Value
TabPanels
Declaration
[Browsable(false)]
public TabPanelCollection TabPanels { get; }Property Value
Methods
CheckCollapseOrDispose()
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.
Declaration
protected virtual void CheckCollapseOrDispose()CreateTabItem(TabPanel)
Declaration
protected override TabStripItem CreateTabItem(TabPanel tabPanel)Parameters
tabPanel
Returns
Overrides
GetCollapsed()
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.
IsDragAllowed(Point)
Determines whether a drag operation is currently allowed.
OnDockManagerChanged()
Allows inheritors to provide additional functionality upon owning RadDock instance change.
Declaration
protected virtual void OnDockManagerChanged()OnDragInitialized(Point)
Overrides the method to provide support for instanciating a DragDropService operation.
Declaration
protected override void OnDragInitialized(Point mouse)Parameters
mouse
Overrides
OnLoad(Size)
Notifies that the control is about to be visualized.
Declaration
protected override void OnLoad(Size desiredSize)Parameters
desiredSize
Overrides
OnLocalizationProviderChanged()
Declaration
protected virtual void OnLocalizationProviderChanged()OnMouseCaptureChanged(EventArgs)
Declaration
protected override void OnMouseCaptureChanged(EventArgs e)Parameters
e
Overrides
OnMouseDoubleClick(MouseEventArgs)
Declaration
protected override void OnMouseDoubleClick(MouseEventArgs e)Parameters
e
Overrides
OnMouseDown(MouseEventArgs)
Declaration
protected override void OnMouseDown(MouseEventArgs e)Parameters
e
Overrides
OnMouseMove(MouseEventArgs)
Declaration
protected override void OnMouseMove(MouseEventArgs e)Parameters
e
Overrides
OnTabCloseButtonClicked(TabStripItem)
Closes the corresponding DockWindow instance.
Declaration
protected override void OnTabCloseButtonClicked(TabStripItem item)Parameters
item
Overrides
ProcessFocusRequested(RadElement)
Processes a focus request from the specified element.
Declaration
protected override bool ProcessFocusRequested(RadElement element)Parameters
element
The element that requested the focus.
Returns
True if focus is approved, false otherwise.
Overrides
UpdateActivePanelBounds()
Declaration
protected override void UpdateActivePanelBounds()Overrides
UpdateActiveWindow(DockWindow, bool)
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.
Declaration
protected virtual void UpdateActiveWindow(DockWindow window, bool active)Parameters
window
active
True if the window is currently active, false otherwise.
UpdateAfterControlRemoved(Control)
Callback to notify the panel that a control has been successfully removed, tab strip has been updated and any additional update is allowed.
Declaration
protected override void UpdateAfterControlRemoved(Control value)Parameters
value
Overrides
UpdateAfterTransaction()
Allows an affected strip to perform additional update after a transaction completion.
Declaration
protected virtual void UpdateAfterTransaction()UpdateButtons()
Updates the additional buttons, associated with the strip. E.g. a ToolTabStrip will have caption buttons, while a DocumentTabStrip will have strip buttons.
Declaration
protected virtual void UpdateButtons()