Interface ITabRenderer
The interface to implement when you create custom tab styles (tab renderers).
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public interface ITabRenderer : IDisposableRemarks
Use the default TabRendererBase implementation when you want to create custom tab renderers. See TabRendererFactory for information on how to register your custom renderer with the framework and other requirements.
Note that your implementation
Properties
Bounds
Gets / sets the current bounds of this tab.
Declaration
RectangleF Bounds { get; set; }Property Value
| Type | Description |
|---|---|
| System.Drawing.RectangleF |
DrawItemCallback
Represents the method you should call from your implementation to allow for custom drawing of the tabs.
Declaration
DrawItemCallback DrawItemCallback { get; set; }Property Value
| Type | Description |
|---|---|
| DrawItemCallback | A DrawItemCallback instance. |
ForceDrawImage
If to draw image anyway.
Declaration
bool ForceDrawImage { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
HotTrack
Indicates whether hot tracking is set on in this tab.
Declaration
bool HotTrack { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
TabAlignment
Gets / sets the System.Windows.Forms.TabAlignment.
Declaration
TabAlignment TabAlignment { get; set; }Property Value
| Type | Description |
|---|---|
| System.Windows.Forms.TabAlignment |
TabBorderColor
Indicates the border color of the tabs.
Declaration
Color TabBorderColor { get; }Property Value
| Type | Description |
|---|---|
| System.Drawing.Color |
TabData
Gets / sets the ITabData containing information regarding this tab.
Declaration
ITabData TabData { get; set; }Property Value
| Type | Description |
|---|---|
| ITabData |
Visible
Indicates whether this tab is visible.
Declaration
bool Visible { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
GetBoundsForScrolling()
Returns the current tab bounds. This includes any overlapped region.
Declaration
RectangleF GetBoundsForScrolling()Returns
| Type | Description |
|---|---|
| System.Drawing.RectangleF |
GetCurrentBounds()
Returns the current tab bounds. This includes any overlapped region.
Declaration
RectangleF GetCurrentBounds()Returns
| Type | Description |
|---|---|
| System.Drawing.RectangleF |
GetPreferredSize(Graphics)
Returns the preferred size for this tab.
Declaration
SizeF GetPreferredSize(Graphics g)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g |
Returns
| Type | Description |
|---|---|
| System.Drawing.SizeF |
GetRedrawBounds()
Returns the rectangle representing the dirty portion of the tab.
Declaration
RectangleF GetRedrawBounds()Returns
| Type | Description |
|---|---|
| System.Drawing.RectangleF |
HitTest(PointF)
Indicates whether the specified mouse position is within this tab.
Declaration
bool HitTest(PointF mousePosition)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.PointF | mousePosition | The point to verify. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the point is within the tab bounds; false otherwise. |
IsTextShrunk()
Indicates whether the text is shrunk.
Declaration
bool IsTextShrunk()Returns
| Type | Description |
|---|---|
| System.Boolean |
OnPaint(Graphics, Rectangle)
Paints the tab.
Declaration
void OnPaint(Graphics g, Rectangle clipRect)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Graphics | g | The System.Drawing.Graphics instance. |
| System.Drawing.Rectangle | clipRect | The clipping rectangle to use while drawing. |
TabPropertyChanged()
Notifies the tab that its properties have changed.
Declaration
void TabPropertyChanged()