Class TerminalPageCategoryBase

Namespace

RichHudFramework.UI.Client

Assembly

RichHudClient.dll

Abstract base class for terminal page containers/groups.

public abstract class TerminalPageCategoryBase : IEnumerable<TerminalPageBase>, IEnumerable, IModRootMember

Inheritance

object

TerminalPageCategoryBase

Implements

IEnumerable<TerminalPageBase>

IEnumerable

IModRootMember

Derived

TerminalPageCategory

Properties

Enabled

Determines whether or not the category will appear in the list.

public bool Enabled { get; set; }

Property Value

bool

ID

Unique identifier used by the Framework API.

public object ID { get; }

Property Value

object

Name

The name of the category as it appears in the RichHudTerminal navigation list.

public string Name { get; set; }

Property Value

string

PageContainer

Interface accessor for collection initializers.

public ITerminalPageCategory PageContainer { get; }

Property Value

ITerminalPageCategory

Pages

Read-only collection of TerminalPageBases assigned to this category.

public IReadOnlyList<TerminalPageBase> Pages { get; }

Property Value

IReadOnlyList<TerminalPageBase>

SelectedPage

The currently selected TerminalPageBase within this category. Returns null if none selected.

public TerminalPageBase SelectedPage { get; }

Property Value

TerminalPageBase

Methods

Add(TerminalPageBase)

Adds the given TerminalPageBase to the category.

public void Add(TerminalPageBase page)

Parameters

page TerminalPageBase

AddRange(IReadOnlyList<TerminalPageBase>)

Adds a collection of pages to the category.

public void AddRange(IReadOnlyList<TerminalPageBase> pages)

Parameters

pages IReadOnlyList<TerminalPageBase>

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<TerminalPageBase> GetEnumerator()

Returns

IEnumerator<TerminalPageBase>

An enumerator that can be used to iterate through the collection.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerator IEnumerable.GetEnumerator()

Returns

IEnumerator

An IEnumerator object that can be used to iterate through the collection.