Class TabDefinition
Keeps information about a tab
Inheritance
Namespace: EPiServer.DataAbstraction
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public class TabDefinition : Object, IReadOnly<TabDefinition>, IReadOnlyConstructors
TabDefinition()
Initializes a new instance of the TabDefinition class.
Declaration
public TabDefinition()TabDefinition(Int32, String)
Initializes a new instance of the TabDefinition class.
Declaration
public TabDefinition(int id, string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | The identifier for the TabDefinition. |
| System.String | name | The name of the TabDefinition. |
TabDefinition(Int32, String, AccessLevel, Int32, Boolean)
Initializes a new instance of the TabDefinition class.
Declaration
public TabDefinition(int id, string name, AccessLevel access, int sortIndex, bool isSystemTabDefinition)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | The identifier for the TabDefinition. |
| System.String | name | The name of the TabDefinition. |
| AccessLevel | access | Specifies the associated access level for the tab. |
| System.Int32 | sortIndex | Sort index for the TabDefinition. |
| System.Boolean | isSystemTabDefinition | if set to |
TabDefinition(Int32, String, AccessLevel, Int32, Boolean, LocalizationService)
Initializes a new instance of the TabDefinition class.
Declaration
public TabDefinition(int id, string name, AccessLevel access, int sortIndex, bool isSystemTabDefinition, LocalizationService localizationService)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | The identifier for the TabDefinition. |
| System.String | name | The name of the TabDefinition. |
| AccessLevel | access | Specifies the associated access level for the tab. |
| System.Int32 | sortIndex | Sort index for the TabDefinition. |
| System.Boolean | isSystemTabDefinition | if set to |
| LocalizationService | localizationService | The resource locator that should be used by the instance to get localized strings. |
Properties
DisplayName
The display name of the data type
Declaration
public string DisplayName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ID
The unique identifier of type
Declaration
public int ID { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
IsReadOnly
Declaration
public bool IsReadOnly { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsSystemTab
If a system defined tab or not
Declaration
public bool IsSystemTab { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
LocalizedName
The localized name of the tab
Declaration
public string LocalizedName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
The name of the data type
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
RequiredAccess
The required access for this tab
Declaration
public AccessLevel RequiredAccess { get; set; }Property Value
| Type | Description |
|---|---|
| AccessLevel |
SortIndex
The relative sort index
Declaration
public int SortIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
CreateWritableClone()
Declaration
public TabDefinition CreateWritableClone()Returns
| Type | Description |
|---|---|
| TabDefinition |
MakeReadOnly()
Declaration
public void MakeReadOnly()ThrowIfReadOnly()
Declaration
protected virtual void ThrowIfReadOnly()Explicit Interface Implementations
IReadOnly.CreateWritableClone()
Declaration
object IReadOnly.CreateWritableClone()Returns
| Type | Description |
|---|---|
| System.Object |
