Class DockTabStrip

Base class for a TabStripPanel instance that resides on a RadDock scene.

Inheritance
System.Object
RadControl
SplitPanel
TabStripPanel
DockTabStrip
DocumentTabStrip
ToolTabStrip
Inherited Members
Namespace: Telerik.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock.dll

Syntax

public abstract class DockTabStrip : TabStripPanel, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

DockTabStrip(RadDock)

Initializes a new DockTabStrip instance and associates it with the specified RadDock instance.

Declaration
public DockTabStrip(RadDock dockManager)
Parameters
RadDock dockManager

Properties

ActiveWindow

Gets or sets the currently active DockWindow instance.

Declaration
public DockWindow ActiveWindow { get; set; }
Property Value
DockWindow

AllowTransparentBackColor

Determines whether the control accepts Color.Transparent as its BackColor.

Declaration
public bool AllowTransparentBackColor { get; set; }
Property Value
System.Boolean

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
System.Drawing.Color

Overrides

Collapsed

Declaration
public override bool Collapsed { get; set; }
Property Value
System.Boolean

Overrides

DefaultDockWindowBackColor

Declaration
protected virtual Color DefaultDockWindowBackColor { get; }
Property Value
System.Drawing.Color

DockManager

Declaration
public RadDock DockManager { get; }
Property Value
RadDock

DockType

Gets the DockType member of this instance.

Declaration
public abstract DockType DockType { get; }
Property Value
DockType

TabPanels

Declaration
public TabPanelCollection TabPanels { get; }
Property Value
TabPanelCollection

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 tabPanel

Returns
TabStripItem

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.

Declaration
protected virtual bool GetCollapsed()
Returns
System.Boolean

IsDragAllowed(Point)

Determines whether a drag operation is currently allowed.

Declaration
protected virtual bool IsDragAllowed(Point location)
Parameters
System.Drawing.Point location

The location to examine, in client coordinates.
Returns
System.Boolean

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
System.Drawing.Point mouse

Overrides

OnLoad(Size)

Declaration
protected override void OnLoad(Size desiredSize)
Parameters
System.Drawing.Size desiredSize

Overrides

OnLocalizationProviderChanged()

Declaration
protected virtual void OnLocalizationProviderChanged()

OnMouseCaptureChanged(EventArgs)

Declaration
protected override void OnMouseCaptureChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnMouseDoubleClick(MouseEventArgs)

Declaration
protected override void OnMouseDoubleClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

Overrides

OnTabCloseButtonClicked(TabStripItem)

Closes the corresponding DockWindow instance.

Declaration
protected override void OnTabCloseButtonClicked(TabStripItem item)
Parameters
TabStripItem item

Overrides

ProcessFocusRequested(RadElement)

Declaration
protected override bool ProcessFocusRequested(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

ShouldHandleDoubleClick()

Declaration
protected virtual bool ShouldHandleDoubleClick()
Returns
System.Boolean

UpdateActivePanelBounds()

Declaration
protected override void UpdateActivePanelBounds()
Overrides

UpdateActiveWindow(DockWindow, Boolean)

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
DockWindow window

System.Boolean active

True if the window is currently active, false otherwise.

UpdateAfterControlRemoved(Control)

Declaration
protected override void UpdateAfterControlRemoved(Control value)
Parameters
System.Windows.Forms.Control 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()

UpdateTabSelection(Boolean)

this method is used internally.

Declaration
public override void UpdateTabSelection(bool updateFocus)
Parameters
System.Boolean updateFocus

Overrides

Extension Methods