Loading...
Searching...
No Matches
OFT.Attributes.TabAttribute Class Reference

Attribute that assigns a property or all properties of a class to a named tab in the settings UI. Use alongside System.ComponentModel.DataAnnotations.DisplayAttribute for property display metadata (Name, GroupName, Description, Order). More...

Inheritance diagram for OFT.Attributes.TabAttribute:
[legend]
Collaboration diagram for OFT.Attributes.TabAttribute:
[legend]

Public Member Functions

string? GetLocalizedTab ()
 Gets the localized tab name. Returns null if TabName is not set.
 
int? GetTabOrder ()
 Returns the explicitly assigned TabOrder, or null if not set.
 

Properties

string? TabName [get, set]
 Tab name. If ResourceType is set, this is treated as a resource key.
 
int TabOrder [get, set]
 Tab display order. Lower values appear first. Tabs with equal order are sorted by the order their first property appears in the class. When not set, the tab is sorted purely by its source declaration order.
 
Type? ResourceType [get, set]
 Resource type for localization of TabName.
 

Detailed Description

Attribute that assigns a property or all properties of a class to a named tab in the settings UI. Use alongside System.ComponentModel.DataAnnotations.DisplayAttribute for property display metadata (Name, GroupName, Description, Order).

Member Function Documentation

◆ GetLocalizedTab()

string? OFT.Attributes.TabAttribute.GetLocalizedTab ( )

Gets the localized tab name. Returns null if TabName is not set.

◆ GetTabOrder()

int? OFT.Attributes.TabAttribute.GetTabOrder ( )

Returns the explicitly assigned TabOrder, or null if not set.

Property Documentation

◆ ResourceType

Type? OFT.Attributes.TabAttribute.ResourceType
getset

Resource type for localization of TabName.

◆ TabName

string? OFT.Attributes.TabAttribute.TabName
getset

Tab name. If ResourceType is set, this is treated as a resource key.

◆ TabOrder

int OFT.Attributes.TabAttribute.TabOrder
getset

Tab display order. Lower values appear first. Tabs with equal order are sorted by the order their first property appears in the class. When not set, the tab is sorted purely by its source declaration order.


The documentation for this class was generated from the following file: