TabClass Class

An instance of the TabClass class describes one tab of a SftTabs/NET control.

A tab's contents are described by its CellBaseClass.Parts collection, which the TabClass.Text and TabClass.Image properties access for the common case of a label and an image. A tab's properties can be set once the tab has been added to the control's SftTabs.Tabs collection; the TabClass.Text and TabClass.Image properties can also be set before.

Namespace: Softelvdm.SftTabsNET
Assembly: Softelvdm.SftTabsNET

Inheritance

• System.Object
• Softelvdm.SftTabsNET.Controls.CellBaseClass
• Softelvdm.SftTabsNET.TabClass

Syntax

public class TabClass : Softelvdm.SftTabsNET.Controls.CellBaseClass,
    System.ComponentModel.INotifyPropertyChanged;

Public Class TabClass
    Inherits Softelvdm.SftTabsNET.Controls.CellBaseClass
    Implements System.ComponentModel.INotifyPropertyChanged

Constructors

TabClass

Initializes a new instance of the TabClass class.

Properties

	AllowMergeFromPrevious	This property is not used for tabs. Tabs are not merged.
	AllowMergeFromUpper	This property is not used for tabs. Tabs are not merged.
	Appearance	This property is not used for tabs. The control's SftTabs.Look property defines how tabs are drawn.
	BackColor	Defines the background color of the cell.
	BackColorEnd	Defines the ending background color of the cell, when a gradient fill is used.
	BackColorHot	Defines the tab's background color while the mouse cursor is over it.
	BackColorSelected	Defines the background color of the cell, if the cell is selected.
	BackColorSelectedEnd	Defines the ending background color of the cell, if the cell is selected, when a gradient fill is used.
	Bounds	The tab's location and size in client coordinates of the control.
	CanMergeWithPrevious	Returns whether this cell is empty and can be merged with the previous adjacent cell.
	CanMergeWithUpper	Returns whether this cell is empty or has the same cell text and can be merged with the cell above.
	CloseButton	Defines when the tab shows its own close button.
	CloseButtonEnabled	Defines whether the tab's close button is enabled.
	Dimensions	Returns the dimensions of the cell.
	Displayed	Indicates whether the tab is currently displayed.
	Enabled	Returns whether this cell is enabled.
	EvaluatedAllowMergeFromPrevious	Returns whether this cell is eligible to be used for cell merging by the previous adjacent cell.
	EvaluatedAllowMergeFromUpper	Returns whether this cell is eligible to be used for cell merging by the cell above.
	EvaluatedAppearance	Returns the background appearance of the cell.
	EvaluatedMergeWithLower	Returns whether this cell is eligible to merge with the cell below.
	EvaluatedMergeWithNext	Returns whether this cell is eligible to merge with the next adjacent cell.
	EvaluatedOrientation	Returns the cell parts orientation.
	EvaluatedSortIndicatorPosition	Returns the sorting indicator position of the cell.
	FirstPart	Returns the first part object of the cell's parts collection.
	ForeColor	Defines the foreground color of the cell.
	ForeColorHot	Defines the tab's text color while the mouse cursor is over it.
	ForeColorSelected	Defines the foreground color of the cell, if the cell is selected.
	Image	Defines the tab's image.
	ImageIndex	Defines the index of the tab's image in the image list.
	ImageList	Defines the image list providing the tab's image.
	ImagePart	Returns the first ImagePartClass object of the cell's parts collection.
	Index	The position of the tab in the control's SftTabs.Tabs collection.
	IsEmpty	Returns whether this cell is empty.
	IsSubordinate	Returns whether this cell is part of another cell, due to cell merging.
	LowerMainCell	Returns the next main cell below the current cell.
	LowerSubordinateCell	Returns the cell below if the current cell merges into that cell.
	MainCell	Returns the main cell, if the current cell is part of the main cell due to cell merging.
	MergeWithLower	This property is not used for tabs. Tabs are not merged.
	MergeWithNext	This property is not used for tabs. Tabs are not merged.
	Name	Defines the tab's name.
	NextMainCell	Returns the next main cell following the current cell.
	NextSubordinateCell	Returns the following adjacent cell if the current cell merges into that cell.
	Orientation	Defines the cell parts orientation.
	OwningControl	The control owning this tab.
	OwningItem	Returns the owning item of the cell.
	Page	The page hosting the controls displayed while the tab is selected.
	PageBackColor	Defines the background color of the tab's page.
	Parts	Returns the cell's parts collection.
	PreviousMainCell	Returns the next main cell preceding the current cell.
	RealHeight	The height of the tab as displayed.
	RealWidth	The width of the tab as displayed.
	Row	The row in which the tab is displayed.
	Selected	Defines whether the tab is the selected tab.
	SortIndicatorPosition	This property is not used for tabs. Sorting indicators are not supported.
	SortStatus	This property is not used for tabs. Sorting indicators are not supported.
	Tag	Defines an application-specific object.
	TagObject	Defines application-specific data.
	TagObjects	Defines application-specific data.
	TagString	Defines an application-specific string.
	Text	Defines the tab's text.
	TextPart	Returns the first TextPartClass object of the cell's parts collection.
	ToolTip	Defines the tab's tooltip text.
	UpperMainCell	Returns the next main cell above the current cell.
	Visible	Defines whether the tab is visible.

Methods

	BestDimensions	Calculates the best dimensions for the current cell.
	Equals	Determines whether the specified object is equal to the current object.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
	GetHashCode	Serves as the default hash function.
	GetMainCell	Returns the main cell, if the current cell is part of the main cell due to cell merging.
	GetType	Gets the Type of the current instance.
	IsSameText	Determines whether the same cell text is used in the current cell and the specified cell.
	MemberwiseClone	Creates a shallow copy of the current Object.
	Paint	Paints the tab's contents into the given rectangle.
	ReferenceEquals	Determines whether the specified Object instances are the same instance.
	Remove	Removes the tab from the control.
	ScrollIntoView	Scrolls the tab into view.
	Select	Selects the tab.
	ToString	Returns a string that represents the current object.
	TurnRadioButtonOff	Turns all radiobuttons in this cell off.

Events

PropertyChanged

Occurs when a property of a TabClass instance is modified.

Examples

C# View entire sample code

using Softelvdm.SftTabsNET.Controls;

namespace DemoSample {
    public partial class Form1 : Form {

        private bool loading = false;
        private bool minimized = false;
        private int addedTabs = 0;
        private Dictionary<TabClass, Image> tabImages = new Dictionary<TabClass, Image>();

        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            // the options show the properties as they were defined in the designer

VB.NET View entire sample code

Imports Softelvdm.SftTabsNET
Imports Softelvdm.SftTabsNET.Controls

Public Class Form1

Private loading As Boolean = False
Private minimized As Boolean = False
Private addedTabs As Integer = 0
Private tabImages As New Dictionary(Of TabClass, Image)

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    ' the options show the properties as they were defined in the designer
    loading = True
    FillCombo(ComboLook, SftTabs1.Look)
    FillCombo(ComboPosition, SftTabs1.TabPosition)
    FillCombo(ComboOrientation, SftTabs1.TextOrientation)

See Also Classes | SftTabs/NET 3.0