WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TabRendererWorkbookMode

    Show / Hide Table of Contents

    Class TabRendererWorkbookMode

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

    Inheritance
    System.Object
    TabRendererBase
    TabRendererWorkbookMode
    Implements
    ITabRenderer
    System.IDisposable
    Inherited Members
    TabRendererBase.panelRenderer
    TabRendererBase.ImageTextPadding
    TabRendererBase.SaveGraphicsState(Graphics, RectangleF)
    TabRendererBase.RestoreGraphicsState(Graphics)
    TabRendererBase.NeedMirroredBackground()
    TabRendererBase.TabPropertyChanged()
    TabRendererBase.IsTextShrunk()
    TabRendererBase.CloseButtonHitTest(Point)
    TabRendererBase.DrawCloseButton(Graphics, RectangleF)
    TabRendererBase.DrawCloseButton(Graphics, RectangleF, DrawTabEventArgs)
    TabRendererBase.GetCloseButtonBounds(DrawTabEventArgs)
    TabRendererBase.CorrectInteriorBounds(RectangleF)
    TabRendererBase.GetPreferredSize(Graphics)
    TabRendererBase.GetItemPreferredSize(Graphics)
    TabRendererBase.GetTabFont(Boolean)
    TabRendererBase.CorrectPreferredSize(SizeF)
    TabRendererBase.GetTextPosition(Graphics, String, Font, RectangleF, StringFormat)
    TabRendererBase.DrawFocusRect(Graphics, RectangleF, Color, Color)
    TabRendererBase.DrawTextAndImage(Graphics, RectangleF, DrawTabEventArgs)
    TabRendererBase.DrawText(Graphics, RectangleF, String, StringFormat, DrawTabEventArgs)
    TabRendererBase.CorrectBounds(RectangleF)
    TabRendererBase.OnPaint(Graphics, Rectangle)
    TabRendererBase.GetInteriorBounds(RectangleF, Boolean)
    TabRendererBase.IsSelectedState(DrawItemState)
    TabRendererBase.IsHotLightState(DrawItemState)
    TabRendererBase.ApplyTransform(Graphics)
    TabRendererBase.GetRedrawBounds()
    TabRendererBase.GetForeColor()
    TabRendererBase.GetActiveForeColor()
    TabRendererBase.GetBoundsForScrolling()
    TabRendererBase.Dispose()
    TabRendererBase.Dispose(Boolean)
    TabRendererBase.ForceDrawImage
    TabRendererBase.TextBounds
    TabRendererBase.ShouldDrawText
    TabRendererBase.TabData
    TabRendererBase.Visible
    TabRendererBase.HotTrack
    TabRendererBase.DrawItemCallback
    TabRendererBase.TabControl
    TabRendererBase.ShowCloseButton
    TabRendererBase.CloseButtonBackColor
    TabRendererBase.ShowCloseButtonBackColor
    TabRendererBase.CloseButtonBounds
    TabRendererBase.CloseButtonClicked
    TabRendererBase.CloseButtonSize
    TabRendererBase.HitCloseButton
    TabRendererBase.ShouldDrawRotatedWhenVertical
    TabRendererBase.NeedRotateTextWhenVertical
    TabRendererBase.Bounds
    TabRendererBase.ImageRect
    TabRendererBase.TabAlignment
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    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 Description
    System.Int32

    OVERLAPY

    The default vertical overlap.

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

    Properties

    CloseButtonPadding

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

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

    CorrectCloseButtonPosition

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

    LabelEditOffsetY

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

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

    TabBorderColor

    Indicates the border color of the tabs.

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

    TabPanelPropertyExtender

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

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

    TabStyleName

    Returns the unique name of this tab renderer.

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

    Methods

    DrawBackground(DrawTabEventArgs)

    Overridden. See DrawBackground(DrawTabEventArgs).

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

    DrawBorders(DrawTabEventArgs)

    Overridden. See DrawBorders(DrawTabEventArgs).

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

    DrawInterior(DrawTabEventArgs)

    Overridden. See DrawInterior(DrawTabEventArgs).

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

    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
    TabRendererBase.GetCurrentBounds()
    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
    TabRendererBase.GetOverlapSize(SizeF)
    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
    TabRendererBase.HitTest(PointF)

    RegisterTabType()

    Registers custom tab styles with the framework.

    Declaration
    public static void RegisterTabType()

    Implements

    ITabRenderer
    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved