Class Footer

Namespace

ConsoleAppVisuals.PassiveElements

Assembly

ConsoleAppVisuals.dll

The Footer is a passive element that displays a footer on the console.

public class Footer : PassiveElement

Inheritance

object

Element

PassiveElement

Footer

Inherited Members

PassiveElement.Type

Element.ToggleVisibility()

Element.RenderElement()

Element.RenderOptionsBeforeHand()

Element.RenderOptionsAfterHand()

Element.RenderElementSpace(bool)

Element.GetRenderSpace()

Element.Clear()

Element.Id

Element.Visibility

Element.TextAlignment

Element.Line

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

For more information, consider visiting the documentation available here.

Constructors

Footer(string, string, string)

The Footer is a passive element that displays a footer on the console.

public Footer(string leftText = "Footer Left", string centerText = "Footer Center", string rightText = "Footer Right")

Parameters

leftText string

The text on the left of the footer.

centerText string

The text in the center of the footer.

rightText string

The text on the right of the footer.

Remarks

For more information, consider visiting the documentation available here.

Properties

Height

Gets the height of the footer.

public override int Height { get; }

Property Value

int

MaxNumberOfThisElement

Gets the maximum number of this element.

public override int MaxNumberOfThisElement { get; }

Property Value

int

Placement

Gets the placement of the footer.

public override Placement Placement { get; }

Property Value

Placement

Text

Gets the text of the footer.

public (string, string, string) Text { get; }

Property Value

(string, string, string)

Width

Gets the width of the footer.

public override int Width { get; }

Property Value

int

Methods

RenderElementActions()

Defines the actions to perform when the element is called to be rendered on the console.

[Visual]
protected override void RenderElementActions()

UpdateCenterText(string)

Updates the text in the center of the footer.

public void UpdateCenterText(string centerText)

Parameters

centerText string

The new text in the center of the footer.

Remarks

For more information, consider visiting the documentation available here.

UpdateLeftText(string)

Updates the text on the left of the footer.

public void UpdateLeftText(string leftText)

Parameters

leftText string

The new text on the left of the footer.

Remarks

For more information, consider visiting the documentation available here.

UpdateRightText(string)

Updates the text on the right of the footer.

public void UpdateRightText(string rightText)

Parameters

rightText string

The new text on the right of the footer.

Remarks

For more information, consider visiting the documentation available here.