Class ScreenComponentCollection

A list of screen components with events. The order components are added in determines the order they are updated and drawn.

Inheritance
Object
ScreenComponentCollection
Namespace: DaggerfallWorkshop.Game.UserInterface
Assembly: Assembly-CSharp.dll
Syntax
public class ScreenComponentCollection : IEnumerable<BaseScreenComponent>, IEnumerable

Constructors

| Improve this Doc View Source

ScreenComponentCollection()

Constructor.

Declaration
public ScreenComponentCollection()
| Improve this Doc View Source

ScreenComponentCollection(BaseScreenComponent)

Constructor.

Declaration
public ScreenComponentCollection(BaseScreenComponent parent)
Parameters
Type Name Description
BaseScreenComponent parent

Base component hosting this collection.

Properties

| Improve this Doc View Source

Count

Gets the number of components contained in collection.

Declaration
public int Count { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Item[Int32]

Gets component at index.

Declaration
public BaseScreenComponent this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of component.
Property Value
Type Description
BaseScreenComponent

Reference to component.

Methods

| Improve this Doc View Source

Add(BaseScreenComponent)

Adds a component to collection.

Declaration
public void Add(BaseScreenComponent component)
Parameters
Type Name Description
BaseScreenComponent component

Component to add.
| Improve this Doc View Source

Clear()

Clears the collection.

Declaration
public void Clear()
| Improve this Doc View Source

GetEnumerator()

Gets IEnumerator<T> for the component collection for use with foreach.

Declaration
public IEnumerator<BaseScreenComponent> GetEnumerator()
Returns
Type Description
IEnumerator<BaseScreenComponent>

IEnumerator of screen components.
| Improve this Doc View Source

RaiseComponentAddedEvent(BaseScreenComponent)

Raise component added event.

Declaration
protected virtual void RaiseComponentAddedEvent(BaseScreenComponent component)
Parameters
Type Name Description
BaseScreenComponent component
| Improve this Doc View Source

RaiseComponentRemovedEvent(BaseScreenComponent)

Raise component removed event.

Declaration
protected virtual void RaiseComponentRemovedEvent(BaseScreenComponent component)
Parameters
Type Name Description
BaseScreenComponent component
| Improve this Doc View Source

Remove(BaseScreenComponent)

Declaration
public void Remove(BaseScreenComponent component)
Parameters
Type Name Description
BaseScreenComponent component

Events

| Improve this Doc View Source

OnComponentAdded

This event is fired whenever a component is added.

Declaration
public event ScreenComponentCollection.ComponentAddedEventHandler OnComponentAdded
Event Type
Type Description
ScreenComponentCollection.ComponentAddedEventHandler
| Improve this Doc View Source

OnComponentRemoved

This event is fired whenever a component is removed.

Declaration
public event ScreenComponentCollection.ComponentAddedEventHandler OnComponentRemoved
Event Type
Type Description
ScreenComponentCollection.ComponentAddedEventHandler