Class Bar

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

Provides a horizontally or vertically oriented container for Shortcuts to be used as a menu, toolbar, or status bar.

public class Bar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IOrientation, IDesignable

Inheritance: object

Responder

View

Bar

Implements: IDisposable

ISupportInitializeNotification

ISupportInitialize

IOrientation

IDesignable

Derived: MenuBarv2

Menuv2

StatusBar

Inherited Members: View.Margin

View.ShadowStyle

View.Border

View.BorderStyle

View.OnBorderStyleChanging(CancelEventArgs<LineStyle>)

View.BorderStyleChanging

View.Padding

View.GetAdornmentsThickness()

View.Arrangement

View.ColorScheme

View.GetFocusColor()

View.GetHotFocusColor()

View.GetHotNormalColor()

View.GetNormalColor()

View.SetAttribute(Attribute)

View.GetAttribute()

View.RaiseAccepting(CommandContext)

View.OnAccepting(CommandEventArgs)

View.Accepting

View.RaiseSelecting(CommandContext)

View.OnSelecting(CommandEventArgs)

View.Selecting

View.RaiseHandlingHotKey()

View.OnHandlingHotKey(CommandEventArgs)

View.HandlingHotKey

View.AddCommand(Command, View.CommandImplementation)

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.InvokeCommands(Command[], Key, KeyBinding?)

View.InvokeCommand(Command, Key, KeyBinding?)

View.InvokeCommand(Command, CommandContext)

View.SetContentSize(Size?)

View.GetContentSize()

View.ContentSizeTracksViewport

View.OnContentSizeChanged(SizeChangedEventArgs)

View.ContentSizeChanged

View.ContentToScreen(in Point)

View.ScreenToContent(in Point)

View.ViewportSettings

View.Viewport

View.ViewportChanged

View.OnViewportChanged(DrawEventArgs)

View.ViewportToScreen(in Rectangle)

View.ViewportToScreen(in Point)

View.ScreenToViewport(in Point)

View.GetViewportOffsetFromFrame()

View.ScrollVertical(int)

View.ScrollHorizontal(int)

View.Data

View.Id

View.Driver

View.Initialized

View.IsInitialized

View.BeginInit()

View.Enabled

View.EnabledChanged

View.OnEnabledChanged()

View.Visible

View.OnVisibleChanging()

View.VisibleChanging

View.OnVisibleChanged()

View.VisibleChanged

View.Title

View.OnTitleChanged()

View.OnTitleChanging(ref string)

View.TitleChanged

View.TitleChanging

View.ToString()

View.Dispose(bool)

View.CursorVisibility

View.PositionCursor()

View.Diagnostics

View.GetClip()

View.SetClip(Region)

View.SetClipToScreen()

View.ExcludeFromClip(Rectangle)

View.ClipViewport()

View.Draw()

View.DrawBorderAndPadding()

View.OnDrawingBorderAndPadding()

View.OnSettingAttribute()

View.SettingAttribute

View.SetNormalAttribute()

View.OnClearingViewport()

View.ClearingViewport

View.ClearViewport()

View.OnDrawingText()

View.DrawingText

View.DrawText()

View.OnDrawingContent()

View.DrawingContent

View.OnDrawingSubviews()

View.DrawingSubviews

View.DrawSubviews()

View.OnRenderingLineCanvas()

View.LineCanvas

View.SuperViewRendersLineCanvas

View.RenderLineCanvas()

View.OnDrawComplete()

View.DrawComplete

View.NeedsDraw

View.SubViewNeedsDraw

View.SetNeedsDraw()

View.SetNeedsDraw(Rectangle)

View.SetSubViewNeedsDraw()

View.ClearNeedsDraw()

View.Move(int, int)

View.AddRune(Rune)

View.AddRune(char)

View.AddRune(int, int, Rune)

View.AddStr(string)

View.DrawHotString(string, Attribute, Attribute)

View.DrawHotString(string, bool)

View.FillRect(Rectangle, Color?)

View.FillRect(Rectangle, Rune)

View.Subviews

View.SuperView

View.IsAdded

View.Add(View)

View.Add(params View[])

View.Added

View.OnAdded(SuperViewChangedEventArgs)

View.OnRemoved(SuperViewChangedEventArgs)

View.Remove(View)

View.RemoveAll()

View.Removed

View.GetTopSuperView(View, View)

View.MoveSubviewTowardsEnd(View)

View.MoveSubviewToEnd(View)

View.MoveSubviewTowardsStart(View)

View.MoveSubviewToStart(View)

View.HotKeyChanged

View.HotKey

View.AddKeyBindingsForHotKey(Key, Key, object)

View.HotKeySpecifier

View.NewKeyDownEvent(Key)

View.OnKeyDown(Key)

View.KeyDown

View.OnKeyDownNotHandled(Key)

View.KeyDownNotHandled

View.NewKeyUpEvent(Key)

View.OnKeyUp(Key)

View.KeyUp

View.KeyBindings

View.IsHotKeyBound(Key, out View)

View.InvokeCommands(Key, KeyBindingScope)

View.Contains(in Point)

View.Frame

View.FrameToScreen()

View.ScreenToFrame(in Point)

View.X

View.Y

View.Height

View.Width

View.Layout(Size)

View.Layout()

View.SetRelativeLayout(Size)

View.SubviewLayout

View.OnSubviewsLaidOut(LayoutEventArgs)

View.SubviewsLaidOut

View.NeedsLayout

View.SetNeedsLayout()

View.ValidatePosDim

View.OnMouseEnter(CancelEventArgs)

View.MouseEnter

View.OnMouseLeave()

View.MouseLeave

View.WantContinuousButtonPressed

View.WantMousePositionReports

View.NewMouseEvent(MouseEventArgs)

View.RaiseMouseEvent(MouseEventArgs)

View.OnMouseEvent(MouseEventArgs)

View.MouseEvent

View.RaiseMouseClickEvent(MouseEventArgs)

View.OnMouseClick(MouseEventArgs)

View.MouseClick

View.HighlightStyle

View.OnHighlight(CancelEventArgs<HighlightStyle>)

View.Highlight

View.AdvanceFocus(NavigationDirection, TabBehavior?)

View.OnAdvancingFocus(NavigationDirection, TabBehavior?)

View.AdvancingFocus

View.CanFocus

View.CanFocusChanged

View.FocusDeepest(NavigationDirection, TabBehavior?)

View.Focused

View.IsCurrentTop

View.MostFocused

View.OnCanFocusChanged()

View.HasFocus

View.SetFocus()

View.OnHasFocusChanging(bool, bool, View, View)

View.HasFocusChanging

View.OnHasFocusChanged(bool, View, View)

View.HasFocusChanged

View.TabStop

View.OnTextChanged()

View.PreserveTrailingSpaces

View.Text

View.TextAlignment

View.TextChanged

View.TextDirection

View.TextFormatter

View.VerticalTextAlignment

View.UpdateTextFormatterText()

Responder.Dispose()

Responder.Disposing

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

Any View can be added to a Bar. However, the Bar is designed to work with Shortcut objects. The Shortcut class provides a way to display a command, help, and key and align them in a specific order.

Constructors

Bar(): Initializes a new instance of View.

Bar(IEnumerable<Shortcut>)

Properties

AlignmentModes: Gets or sets the AlignmentModes for this Bar. The default is StartToEnd.

Orientation: Gets or sets the Orientation for this Bar. The default is Horizontal.

Methods

AddShortcutAt(int, Shortcut): Inserts a Shortcut in the specified index of Subviews.

EnableForDesign(): Causes the View to enable design-time mode. This typically means that the view will load demo data and be configured to allow for design-time manipulation.

EndInit(): Signals the View that initialization is ending. See ISupportInitialize.

OnOrientationChanged(Orientation): Called when Orientation has changed.

OnSubviewLayout(LayoutEventArgs): Called from LayoutSubviews() before any subviews have been laid out.

RemoveShortcut(int): Removes a Shortcut at specified index of Subviews.

SetBorderStyle(LineStyle): Sets the BorderStyle of the view to the specified value.

Events

OrientationChanged: Raised when Orientation has changed.