Class TabPanelData

The default implementation of the ITabPanelData interface.

Inheritance
System.Object
TabPanelData
AHTabPanelData
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 TabPanelData : ITabPanelData2, ITabPanelData

Constructors

TabPanelData(Control)

Create a new instance of the TabPanelData class.

Declaration
public TabPanelData(Control parent)
Parameters
Type Name Description
System.Windows.Forms.Control parent

The Control parent.

Properties

ActiveTabColor

Gets or sets the active tab color of the Tab panel data. Overridden. See ActiveTabColor.

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

ActiveTabFont

Gets or sets the active tab font of the Tab panel data. Overridden. See ActiveTabFont.

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

AdjustTopGap

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

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

Alignment

Overridden. See Alignment.

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

BackColor

Gets or sets the backcolor of the Tab panel data. Overridden. See BackColor.

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

BorderStyle

Overridden. See BorderStyle.

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

DisableInactivePageImage

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

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

FixedSingleBorderColor

Gets / sets the border color when in System.Windows.Forms.BorderStyle.FixedSingle mode.

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

Font

Gets or sets the font of the Tab panel data. Overridden. See Font.

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

HotTrack

Gets or sets the HotTrack of the Tab panel data. Overridden. See HotTrack.

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

ImageAlignmentR

Overridden. See ImageAlignmentR.

Declaration
public RelativeImageAlignment ImageAlignmentR { get; set; }
Property Value
Type
RelativeImageAlignment

ImageList

Overridden. See ImageList.

Declaration
public virtual ImageList ImageList { get; set; }
Property Value
Type
System.Windows.Forms.ImageList

ImageOffset

Adjusts y-position of the image.

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

InactiveTabColor

Gets or sets the inactive tab color of the Tab panel data. Overridden. See InactiveTabColor.

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

KeepSelectedTabInFrontRow

Overridden. See KeepSelectedTabInFrontRow.

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

LevelTextAndImage

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

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

Multiline

Overridden. See Multiline.

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

Padding

Gets or sets the padding of the Tab panel data. Overridden. See Padding.

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

RotateText180WhenLeftAligned

Overridden. See RotateText180WhenLeftAligned.

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

RotateTextWhenVertical

Indicates whether to rotate the tabs when aligned vertically. Overridden. See RotateTextWhenVertical.

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

SelectedIndex

Overridden. See SelectedIndex.

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

ShowSuperToolTips

Gets or sets the ShowSuperToolTips property. Overridden. See ShowSuperToolTips.

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

ShowToolTips

Gets or sets the ShowToolTips. Overridden. See ShowToolTips.

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

SizeMode

Gets or sets the size mode of the Tab panel data. Overridden. See SizeMode.

Declaration
public TabSizeMode SizeMode { get; set; }
Property Value
Type
TabSizeMode

TabGap

Overridden. See TabGap.

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

TabsData

Gets the TabsData. Overridden. See TabsData.

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

TabSize

Overridden. See TabSize.

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

TabStyle

Overridden. See TabStyle.

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

TextAlignment

Gets or sets the text alignment of the Tab panel data. Overridden. See TextAlignment.

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

TextLineAlignment

Gets or sets the text line alignment of the Tab panel data. Overridden. See TextLineAlignment.

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

UserMoveTabs

Gets or sets the UserMoveTabs. Overridden. See UserMoveTabs.

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

VerticalAlignment

Gets or sets Vertical alignment of the TabPanel data.

Declaration
public TabVerticalAlignment VerticalAlignment { get; set; }
Property Value
Type
TabVerticalAlignment

Methods

CreateNewTabData()

Overridden. See CreateNewTabData().

Declaration
public virtual ITabData CreateNewTabData()
Returns
Type
ITabData

IsTabSelectable(Int32, Boolean)

Indicates whether the tab is selectable, visually or programmatically.

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

The index of the tab page.
System.Boolean visually

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

True if the tab page can be selected; false otherwise.

OnPropertyChanged(String, Object, Object)

Fires the PropertyChanged event.

Declaration
protected void OnPropertyChanged(string property, object oldValue, object newValue)
Parameters
Type Name Description
System.String property

The property name that changed.
System.Object oldValue

The old value of the property.
System.Object newValue

The new value of the property.

OnSelectedIndexChanging(SelectedIndexChangingEventArgs)

Fires the SelectedIndexChanging event.

Declaration
protected void OnSelectedIndexChanging(SelectedIndexChangingEventArgs args)
Parameters
Type Name Description
SelectedIndexChangingEventArgs args

A SelectedIndexChangingEventArgs instance with information regarding this event.

Events

PropertyChanged

Fired when one of the TabPanelData's properties is changed.

Declaration
public event TabPanelPropertyChangedEventHandler PropertyChanged
Event Type
Type
TabPanelPropertyChangedEventHandler

SelectedIndexChanging

Fired before the SelectedIndex property is changed.

Declaration
public event SelectedIndexChangingEventHandler SelectedIndexChanging
Event Type
Type
SelectedIndexChangingEventHandler

Explicit Interface Implementations

ITabPanelData.OnSelectedIndexChanged(Int32, Int32)

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

Implements