Class TabRendererWorkbookMode

The tab renderer that implements workbook mode tabs look-and-feel.

Inheritance
System.Object
TabRendererBase
TabRendererWorkbookMode
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class TabRendererWorkbookMode : TabRendererBase, ITabRenderer, IDisposable

Constructors

TabRendererWorkbookMode(ITabControl, ITabPanelRenderer)

Creates a new instance of the TabRendererWorkbookMode class.

Declaration
public TabRendererWorkbookMode(ITabControl parent, ITabPanelRenderer panelRenderer)
Parameters
Type Name Description
ITabControl parent

The tab control parent.
ITabPanelRenderer panelRenderer

The ITabPanelRenderer parent.

Fields

OVERLAPX

The default horizontal overlap.

Declaration
public static readonly int OVERLAPX
Field Value
Type
System.Int32

OVERLAPY

The default vertical overlap.

Declaration
public static readonly int OVERLAPY
Field Value
Type
System.Int32

Properties

CloseButtonPadding

Gets space in pixels between tab's interior and close button.

Declaration
public override int CloseButtonPadding { get; }
Property Value
Type
System.Int32
Overrides

CorrectCloseButtonPosition

Declaration
protected override Point CorrectCloseButtonPosition { get; }
Property Value
Type
System.Drawing.Point
Overrides

LabelEditOffsetY

Returns y-coordinate offset for Label Edit control, in Tab's captions editable case.

Declaration
public override int LabelEditOffsetY { get; }
Property Value
Type
System.Int32
Overrides

TabBorderColor

Indicates the border color of the tabs.

Declaration
public override Color TabBorderColor { get; }
Property Value
Type
System.Drawing.Color
Overrides

TabPanelPropertyExtender

Returns the ITabDefaultProperties instance that provides default properties for this renderer.

Declaration
public static TabPanelPropertyWorkbookMode TabPanelPropertyExtender { get; }
Property Value
Type
TabPanelPropertyWorkbookMode

TabStyleName

Returns the unique name of this tab renderer.

Declaration
public static string TabStyleName { get; }
Property Value
Type
System.String

Methods

DrawBackground(DrawTabEventArgs)

Overridden. See DrawBackground(DrawTabEventArgs).

Declaration
protected override void DrawBackground(DrawTabEventArgs drawItemInfo)
Parameters
Type Name Description
DrawTabEventArgs drawItemInfo
Overrides

DrawBorders(DrawTabEventArgs)

Overridden. See DrawBorders(DrawTabEventArgs).

Declaration
protected override void DrawBorders(DrawTabEventArgs drawItemInfo)
Parameters
Type Name Description
DrawTabEventArgs drawItemInfo
Overrides

DrawInterior(DrawTabEventArgs)

Overridden. See DrawInterior(DrawTabEventArgs).

Declaration
protected override void DrawInterior(DrawTabEventArgs drawItemInfo)
Parameters
Type Name Description
DrawTabEventArgs drawItemInfo
Overrides

GetCurrentBounds()

Returns the current drawing bounds. Overridden. See GetCurrentBounds().

Declaration
public override RectangleF GetCurrentBounds()
Returns
Type Description
System.Drawing.RectangleF

The bounds as a rectangle.
Overrides
Remarks

If this is the selected tab, then this method adds the overlapped size to the bounds returned by Bounds.

GetOverlapSize(SizeF)

Returns the overlap size. Overridden. See GetOverlapSize(SizeF).

Declaration
public override SizeF GetOverlapSize(SizeF tabSize)
Parameters
Type Name Description
System.Drawing.SizeF tabSize
Returns
Type Description
System.Drawing.SizeF

The overlap size.
Overrides
Remarks

This implementation returns (0, 0).

GetPolygonFromBounds(RectangleF)

Returns the polygonal border of the tab from the bounds.

Declaration
public PointF[] GetPolygonFromBounds(RectangleF bounds)
Parameters
Type Name Description
System.Drawing.RectangleF bounds

The tab's bounds.
Returns
Type Description
System.Drawing.PointF[]

The polygonal border.

HitTest(PointF)

Indicates whether the specified position is within the current bounds. Overridden. See HitTest(PointF).

Declaration
public override bool HitTest(PointF mousePosition)
Parameters
Type Name Description
System.Drawing.PointF mousePosition

The mouse position to test.
Returns
Type Description
System.Boolean

True if hit; false otherwise.
Overrides

RegisterTabType()

Registers custom tab styles with the framework.

Declaration
public static void RegisterTabType()

Implements

System.IDisposable