Class AHTabControl

Summary description for AHTabControl.

Inheritance
System.Object
BaseControl
TabControlAdv
AHTabControlBase
AHTabControl
Implements
System.IDisposable
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class AHTabControl : AHTabControlBase, IThemeProvider, IVisualStyle, IDisposable, ITabControl, ISupportInitialize, ISupportOffice2007Theme

Constructors

AHTabControl(DockingManager, DockingStyle)

Constructor of the AHTabControl.

Declaration
public AHTabControl(DockingManager dmgr, DockingStyle border)
Parameters
Type Name Description
DockingManager dmgr

The DockingManager instance.
DockingStyle border

The DockingStyle.

Fields

AnimationState

Declaration
protected AutoHideAnimationState AnimationState
Field Value
Type
AutoHideAnimationState

bLeadSpace

Declaration
protected bool bLeadSpace
Field Value
Type
System.Boolean

bNeedActivate

Declaration
protected bool bNeedActivate
Field Value
Type
System.Boolean

bTrailSpace

Declaration
protected bool bTrailSpace
Field Value
Type
System.Boolean

ddcAnimation

Declaration
protected DockStateControllerBase ddcAnimation
Field Value
Type
DockStateControllerBase

dockingMgr

Declaration
protected DockingManager dockingMgr
Field Value
Type
DockingManager

rcVisibleBounds

Declaration
protected Rectangle rcVisibleBounds
Field Value
Type
System.Drawing.Rectangle

tabBorder

Declaration
protected DockingStyle tabBorder
Field Value
Type
DockingStyle

tdTab

Declaration
protected ThemedControlDrawing tdTab
Field Value
Type
ThemedControlDrawing

tmrAnimation

Declaration
protected static Timer tmrAnimation
Field Value
Type
System.Windows.Forms.Timer

tmrHideController

Declaration
protected static Timer tmrHideController
Field Value
Type
System.Windows.Forms.Timer

tmrShowController

Declaration
protected static Timer tmrShowController
Field Value
Type
System.Windows.Forms.Timer

Properties

ActiveTabFont

Gets/Sets the ActiveTabFont

Declaration
public override Font ActiveTabFont { get; set; }
Property Value
Type
System.Drawing.Font
Overrides

Alignment

Gets / Sets the Tab alignment.

Declaration
public override TabAlignment Alignment { get; set; }
Property Value
Type
System.Windows.Forms.TabAlignment
Overrides

CreateParams

Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type
System.Windows.Forms.CreateParams

DockingManager

Gets the DockingManager.

Declaration
public DockingManager DockingManager { get; }
Property Value
Type
DockingManager

Edge

Gets the DockingStyle.

Declaration
public DockingStyle Edge { get; }
Property Value
Type
DockingStyle

EmptyLeft

Gets the EmptyLeft.

Declaration
public int EmptyLeft { get; }
Property Value
Type
System.Int32

Font

Gets / Sets the Font.

Declaration
public override Font Font { get; set; }
Property Value
Type
System.Drawing.Font
Overrides

IsOffice2003Style

Declaration
protected override bool IsOffice2003Style { get; }
Property Value
Type
System.Boolean
Overrides

LeadSpace

Sets the LeadSpace.

Declaration
public bool LeadSpace { set; }
Property Value
Type
System.Boolean

Padding

Gets /Sets the Padding.

Declaration
public override Point Padding { get; set; }
Property Value
Type
System.Drawing.Point
Overrides

ThemeDraw

Gets the ThemedControlDrawing.

Declaration
public ThemedControlDrawing ThemeDraw { get; }
Property Value
Type
ThemedControlDrawing

TrailSpace

Sets the TrailSpace

Declaration
public bool TrailSpace { set; }
Property Value
Type
System.Boolean

Methods

AddTab(DockStateControllerBase, Boolean)

Add the tab from the DockStateControllerBase.

Declaration
public void AddTab(DockStateControllerBase ddcbase, bool bshowcontrol)
Parameters
Type Name Description
DockStateControllerBase ddcbase

The DockStateControllerBase instance.
System.Boolean bshowcontrol

Indicates whether control is shown or not.

AddToEmptyLeft(Int32)

Add the padding on AHControl.

Declaration
public void AddToEmptyLeft(int nleft)
Parameters
Type Name Description
System.Int32 nleft

The value that needs to be assigned

CalcClientControlSize(DockStateControllerBase)

Declaration
protected Rectangle CalcClientControlSize(DockStateControllerBase ddcbase)
Parameters
Type Name Description
DockStateControllerBase ddcbase
Returns
Type
System.Drawing.Rectangle

CreateAccessibilityInstance()

Creates a new accessibility object in AHTabControl.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

A new System.Windows.Forms.AccessibleObject for the AHTabControl, when AccessibilityEnabled for DockingManager is set as true
Overrides

Dispose(Boolean)

Declaration
protected override void Dispose(bool bdisposing)
Parameters
Type Name Description
System.Boolean bdisposing
Overrides

dockingManager_ImageListChanged(Object, EventArgs)

Occurs on DockingManager ImageList changed.

Declaration
public void dockingManager_ImageListChanged(object obj, EventArgs e)
Parameters
Type Name Description
System.Object obj
System.EventArgs e

The EventArgs contains the event data.

ForceLayout()

Forces immediate layout of control.

Declaration
protected void ForceLayout()

GetActiveTabGroupOrSubGroupDockHostRect()

Returns the ActiveTabGroup Or SubGroupDockHostRect.

Declaration
public Rectangle GetActiveTabGroupOrSubGroupDockHostRect()
Returns
Type
System.Drawing.Rectangle

GetActiveTabGroupOrSubGroupRect()

Returns the Active TabGroup Or SubGroup Rectangle.

Declaration
public Rectangle GetActiveTabGroupOrSubGroupRect()
Returns
Type
System.Drawing.Rectangle

GetControlFromPoint(Point)

Declaration
protected DockStateControllerBase GetControlFromPoint(Point ptClient)
Parameters
Type Name Description
System.Drawing.Point ptClient
Returns
Type
DockStateControllerBase

GetDockBorder()

Declaration
protected DockStyle GetDockBorder()
Returns
Type
System.Windows.Forms.DockStyle

GetTabGroupIndex(Point)

Declaration
protected int GetTabGroupIndex(Point pt)
Parameters
Type Name Description
System.Drawing.Point pt
Returns
Type
System.Int32

GetTabSubGroupIndex(Int32, Point)

Declaration
protected int GetTabSubGroupIndex(int ngroup, Point pt)
Parameters
Type Name Description
System.Int32 ngroup
System.Drawing.Point pt
Returns
Type
System.Int32

HideAnimation_TickEventHandler(Object, EventArgs)

Declaration
protected void HideAnimation_TickEventHandler(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

HideController(DockStateControllerBase, Boolean)

Hide the Controller in AHTabControl.

Declaration
public void HideController(DockStateControllerBase ddcbase, bool banimate)
Parameters
Type Name Description
DockStateControllerBase ddcbase

The DockStateControllerBase instance.
System.Boolean banimate

Indicates whether the Animation needs to specified or not.

HideController(DockStateControllerBase, Boolean, Boolean)

Hide the Controller in AHTabControl.

Declaration
public void HideController(DockStateControllerBase ddcbase, bool banimate, bool bhidenow)
Parameters
Type Name Description
DockStateControllerBase ddcbase

The DockStateControllerBase instance.
System.Boolean banimate

Indicates whether the Animation needs to specified or not.
System.Boolean bhidenow

Indicates whether the controls needs to hide immediately.

HideController_TickEventHandler(Object, EventArgs)

Declaration
protected void HideController_TickEventHandler(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

InitiateAnimationStopEvent(DockStateControllerBase, Control)

Declaration
protected void InitiateAnimationStopEvent(DockStateControllerBase ddcbase, Control dockctrl)
Parameters
Type Name Description
DockStateControllerBase ddcbase
System.Windows.Forms.Control dockctrl

InitiateHideAnimationStartEvent(DockStateControllerBase, Control)

Declaration
protected void InitiateHideAnimationStartEvent(DockStateControllerBase ddcbase, Control dockctrl)
Parameters
Type Name Description
DockStateControllerBase ddcbase
System.Windows.Forms.Control dockctrl

InitiateShowAnimationStartEvent(DockStateControllerBase, Control)

Declaration
protected void InitiateShowAnimationStartEvent(DockStateControllerBase ddcbase, Control dockctrl)
Parameters
Type Name Description
DockStateControllerBase ddcbase
System.Windows.Forms.Control dockctrl

InitScrollButtons()

Declaration
protected override void InitScrollButtons()
Overrides

OnMouseDown(MouseEventArgs)

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnMouseHover(EventArgs)

Declaration
protected override void OnMouseHover(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnMouseLeave(EventArgs)

Declaration
protected override void OnMouseLeave(EventArgs e)
Parameters
Type Name Description
System.EventArgs e
Overrides

OnMouseMove(MouseEventArgs)

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnMouseUp(MouseEventArgs)

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e
Overrides

OnPaint(PaintEventArgs)

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e
Overrides

OnStyleChanged()

Declaration
protected override void OnStyleChanged()
Overrides

Redraw()

Declaration
protected void Redraw()

RemoveTab(DockStateControllerBase)

Remove the tab in AHTabControl.

Declaration
public void RemoveTab(DockStateControllerBase dscbase)
Parameters
Type Name Description
DockStateControllerBase dscbase

The DockStateControllerBase instance.

SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified)

Declaration
protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Int32 width
System.Int32 height
System.Windows.Forms.BoundsSpecified specified

SetClientControlSize(DockStateControllerBase, Rectangle)

Declaration
protected void SetClientControlSize(DockStateControllerBase ddcbase, Rectangle rcbounds)
Parameters
Type Name Description
DockStateControllerBase ddcbase
System.Drawing.Rectangle rcbounds

ShowAnimation_TickEventHandler(Object, EventArgs)

Declaration
protected void ShowAnimation_TickEventHandler(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

ShowController(DockStateControllerBase, Boolean)

Show the AHTab control.

Declaration
public void ShowController(DockStateControllerBase ddcbase, bool bAnimate)
Parameters
Type Name Description
DockStateControllerBase ddcbase

The DockStateControllerBase instance.
System.Boolean bAnimate

Indicates whether the Animation needs to specified or not.

ShowController(DockStateControllerBase, Boolean, Boolean)

Show the AHTab control.

Declaration
public void ShowController(DockStateControllerBase ddcbase, bool banimate, bool bActivateAfterShow)
Parameters
Type Name Description
DockStateControllerBase ddcbase

The DockStateControllerBase instance.
System.Boolean banimate

Indicates whether the Animation needs to specified or not.
System.Boolean bActivateAfterShow

Specifies whether control needs to be activated after shown.

ShowController_TickEventHandler(Object, EventArgs)

Declaration
protected void ShowController_TickEventHandler(object sender, EventArgs e)
Parameters
Type Name Description
System.Object sender
System.EventArgs e

StopAllAnimations()

Declaration
protected void StopAllAnimations()

StopHideAnimation()

Declaration
protected void StopHideAnimation()

StopShowAnimation()

Declaration
protected void StopShowAnimation()

UpdateAHTabImage(DockStateControllerBase)

Declaration
public void UpdateAHTabImage(DockStateControllerBase ddcbase)
Parameters
Type Name Description
DockStateControllerBase ddcbase

UpdateAHTabText(DockStateControllerBase)

Update the AH TabItem text.

Declaration
public void UpdateAHTabText(DockStateControllerBase ddcbase)
Parameters
Type Name Description
DockStateControllerBase ddcbase

The DockStateControllerBase instance.

UpdateOffice2007Theme()

Declaration
protected void UpdateOffice2007Theme()

UpdateRenderer()

Update the Renderer.

Declaration
public void UpdateRenderer()

Implements

System.IDisposable
System.ComponentModel.ISupportInitialize