TTMSFNCTabSetTab Class
A single tab in a
TTMSFNCTabSet, with display text, bitmaps, progress indicator, badge, close button, per-tab color overrides, and application-defined data.
API unit family: TMSFNCTabSet
Inherits from: TCollectionItem
Syntax
TTMSFNCTabSetTab = class(TCollectionItem)
Properties
| Name | Description |
|---|---|
| ActiveColor | Background color of the tab when it is the active (selected) tab. |
| ActiveTextColor | Tab text color when the tab is the active (selected) tab. |
| Badge | Text displayed in the tab's badge overlay (typically a notification count). |
| BadgeColor | Background color of the badge overlay circle. |
| BadgeTextColor | Text color of the badge overlay label. |
| BitmapContainer | Read-only reference to the bitmap container used to resolve named bitmaps. |
| BitmapSize | Pixel size (width and height) of the tab bitmap; pass 0 to use the natural bitmap size. |
| BitmapVisible | When True, the tab bitmap is drawn; when False, only the text label is shown. |
| Bitmaps | Scaled bitmaps collection used as the tab icon in its normal/active/hover/down states. |
| CloseButton | When True, a close button is drawn on the tab; clicking it fires OnCloseTab. |
| Color | Background color of the tab in its normal state; overrides the global appearance when UseDefaultAppearance is False. |
| DBKey | Unique string key identifying this tab in a database-adapter scenario. |
| DataBoolean | General-purpose Boolean for application use. |
| DataInteger | General-purpose integer for application use. |
| DataObject | General-purpose object reference for application use. |
| DataPointer | General-purpose pointer for application use. |
| DataString | General-purpose string for application use. |
| DisabledBitmaps | Scaled bitmaps collection used as the tab icon in its disabled state. |
| DisabledColor | Background color of the tab when it is disabled. |
| DisabledTextColor | Tab text color when the tab is disabled. |
| DownColor | Background color of the tab when it is pressed. |
| DownTextColor | Tab text color when the tab is pressed. |
| Enabled | When False, the tab is grayed out and cannot be selected or clicked. |
| Hint | Tooltip text shown when the mouse hovers over the tab. |
| HoverColor | Background color of the tab when the mouse hovers over it. |
| HoverTextColor | Tab text color when the mouse hovers over the tab. |
| Progress | Current progress value shown in the tab progress indicator; range is 0 to ProgressMax. |
| ProgressColor | Color of the progress bar or circular progress indicator drawn inside the tab. |
| ProgressKind | Shape of the progress indicator drawn inside the tab. |
| ProgressMax | Maximum value of the tab progress indicator. |
| ProgressMode | Animation style of the tab progress indicator. |
| Shape | Visual shape of the tab when UseDefaultAppearance is False. |
| StretchText | When True, the tab text stretches to fill the available text area. |
| TabVisible | When False, the tab is hidden from the strip but stays in the collection. |
| Tag | General-purpose integer tag for application use. |
| Text | Label text displayed on the tab; supports HTML formatting. |
| TextAlign | Horizontal alignment of the tab text within the tab. |
| TextColor | Tab text color in the normal (inactive, unselected) state; overrides the global appearance when UseDefaultAppearance is False. |
| TextVisible | When True, the tab label text is rendered; when False, only the bitmap is shown. |
| Trimming | Controls how overlong tab text is trimmed when word-wrapping is off. |
| UseDefaultAppearance | When False, per-tab color overrides (Color, TextColor, etc.) take effect; when True, the tab uses the global TabAppearance settings. |
| Visible | When False, the tab is hidden from the strip; use TabVisible in published context. |
| Width | Pixel width of the tab; pass 0 to use the auto-calculated width. |
| WordWrapping | When True, the tab label text wraps across multiple lines. |
Methods
| Name | Description |
|---|---|
| GetAutoSize | Returns the auto-calculated width of the tab based on its content. |
| GetBitmap | Returns the first available bitmap from the tab's Bitmaps collection, or nil if none. |
| GetShape | Returns the effective tab shape, falling back to the tab set's default shape when UseDefaultAppearance is True. |
| TabSet | Returns the tab set that owns this tab. |