Interface ITabPanelData

The interface that represents the tab panel's data.

Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public interface ITabPanelData

Properties

ActiveTabColor

Returns the active tab's color.

Declaration
Color ActiveTabColor { get; }
Property Value
Type Description
System.Drawing.Color

ActiveTabFont

Returns the active tab's font.

Declaration
Font ActiveTabFont { get; set; }
Property Value
Type Description
System.Drawing.Font

AdjustTopGap

Adjusts the gap between the tabControlAdv's top and the tabs.

Declaration
int AdjustTopGap { get; }
Property Value
Type Description
System.Int32

Alignment

Returns the tab alignment with which to align the tabs.

Declaration
TabAlignment Alignment { get; }
Property Value
Type Description
System.Windows.Forms.TabAlignment

BackColor

Returns the tab panel's back color.

Declaration
Color BackColor { get; set; }
Property Value
Type Description
System.Drawing.Color

BorderStyle

Returns the border style with which to draw.

Declaration
BorderStyle BorderStyle { get; }
Property Value
Type Description
System.Windows.Forms.BorderStyle

DisableInactivePageImage

Indicates whether image should be disabled when TabPage is not selected.

Declaration
bool DisableInactivePageImage { get; }
Property Value
Type Description
System.Boolean

FixedSingleBorderColor

Returns the border color when in System.Windows.Forms.BorderStyle.FixedSingle mode.

Declaration
Color FixedSingleBorderColor { get; }
Property Value
Type Description
System.Drawing.Color

Font

Returns the tab panel's font.

Declaration
Font Font { get; set; }
Property Value
Type Description
System.Drawing.Font

HotTrack

Indicates whether hot tracking is enabled.

Declaration
bool HotTrack { get; }
Property Value
Type Description
System.Boolean

ImageAlignmentR

Returns the relative image alignment of the images with respect to the text in the tab.

Declaration
RelativeImageAlignment ImageAlignmentR { get; }
Property Value
Type Description
RelativeImageAlignment

ImageList

Returns the imagelist.

Declaration
ImageList ImageList { get; }
Property Value
Type Description
System.Windows.Forms.ImageList

ImageOffset

Returns y-position of the image.

Declaration
int ImageOffset { get; }
Property Value
Type Description
System.Int32

InactiveTabColor

Returns the inactive tab's color.

Declaration
Color InactiveTabColor { get; }
Property Value
Type Description
System.Drawing.Color

KeepSelectedTabInFrontRow

Indicates whether the selected tab should be moved to the front row when in multiline mode.

Declaration
bool KeepSelectedTabInFrontRow { get; }
Property Value
Type Description
System.Boolean

LevelTextAndImage

Indicates whether the text and the image should be in the same level.

Declaration
bool LevelTextAndImage { get; }
Property Value
Type Description
System.Boolean

Multiline

Indicates whether to draw the tabs in multiline mode.

Declaration
bool Multiline { get; }
Property Value
Type Description
System.Boolean

Padding

Returns the left and top padding to use when calculating the tab positions.

Declaration
Point Padding { get; }
Property Value
Type Description
System.Drawing.Point

RotateText180WhenLeftAligned

Indicates whether to rotate the tabs when aligned left.

Declaration
bool RotateText180WhenLeftAligned { get; }
Property Value
Type Description
System.Boolean

RotateTextWhenVertical

Indicates whether to rotate the tabs when aligned vertically.

Declaration
bool RotateTextWhenVertical { get; }
Property Value
Type Description
System.Boolean

SelectedIndex

Returns the selected tab index.

Declaration
int SelectedIndex { get; set; }
Property Value
Type Description
System.Int32

ShowToolTips

Indicates whether tooltips are enabled.

Declaration
bool ShowToolTips { get; }
Property Value
Type Description
System.Boolean

SizeMode

Returns the tab sizing mode.

Declaration
TabSizeMode SizeMode { get; }
Property Value
Type Description
TabSizeMode

A TabSizeMode value.

TabGap

Returns the tab gap between tabs.

Declaration
int TabGap { get; }
Property Value
Type Description
System.Int32

TabsData

Returns a collection of ITabData.

Declaration
TabDataCollection TabsData { get; }
Property Value
Type Description
TabDataCollection

TabSize

Returns the tab size if in fixed width mode.

Declaration
SizeF TabSize { get; }
Property Value
Type Description
System.Drawing.SizeF

TabStyle

The tab style with which to draw.

Declaration
string TabStyle { get; }
Property Value
Type Description
System.String

TextAlignment

Returns the text alignment of the text in the tab.

Declaration
StringAlignment TextAlignment { get; }
Property Value
Type Description
System.Drawing.StringAlignment

TextLineAlignment

Returns the text line alignment of the text in the tab.

Declaration
StringAlignment TextLineAlignment { get; }
Property Value
Type Description
System.Drawing.StringAlignment

UserMoveTabs

Indicates whether users are allowed to move tabs.

Declaration
bool UserMoveTabs { get; }
Property Value
Type Description
System.Boolean

VerticalAlignment

Returns the vertical alignment of the tabs when they are aligned to the right or left.

Declaration
TabVerticalAlignment VerticalAlignment { get; }
Property Value
Type Description
TabVerticalAlignment

Methods

CreateNewTabData()

Creates a new ITabData.

Declaration
ITabData CreateNewTabData()
Returns
Type Description
ITabData

IsTabSelectable(Int32, Boolean)

Indicates whether a tab is selectable.

Declaration
bool IsTabSelectable(int tabIndex, bool visually)
Parameters
Type Name Description
System.Int32 tabIndex

The tab's index.
System.Boolean visually

Indicates whether check is for visual selection or programmatic selection.
Returns
Type Description
System.Boolean

True if selectable; false otherwise.

OnSelectedIndexChanged(Int32, Int32)

This will fire the property changed event indicating the change in SelectedIndex.

Declaration
void OnSelectedIndexChanged(int previousIndex, int curIndex)
Parameters
Type Name Description
System.Int32 previousIndex
System.Int32 curIndex

Events

PropertyChanged

This event is thrown when one of the tab's property is changed.

Declaration
event TabPanelPropertyChangedEventHandler PropertyChanged
Event Type
Type Description
TabPanelPropertyChangedEventHandler

SelectedIndexChanging

This event is fired before the SelectedIndex property is changed.

Declaration
event SelectedIndexChangingEventHandler SelectedIndexChanging
Event Type
Type Description
SelectedIndexChangingEventHandler