Terminal.Gui/docs/index.json

{
  "README.html": {
    "href": "README.html",
    "title": "",
    "keywords": "This folder generates the API docs for Terminal.Gui. The API documentation is generated via a GitHub Action (.github/workflows/api-docs.yml) using DocFX. The Action publishes the docs to the gh-pages branch, which gets published to https://gui-cs.github.io/Terminal.Gui/. NOTE: the v2 are generated from another repository (https://github.com/gui-cs/Terminal.GuiV2Docs) and are published here: https://gui-cs.github.io/Terminal.GuiV2Docs/. To Generate the Docs Locally Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html Change to the ./docfx folder and run ./build.ps1 Browse to http://localhost:8080 and verify everything looks good. Hit ctrl-c to stop the script."
  },
  "api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html",
    "title": "Class Application.ResizedEventArgs",
    "keywords": "Class Application.ResizedEventArgs Event arguments for the Resized event. Inheritance object EventArgs Application.ResizedEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Application.ResizedEventArgs : EventArgs Properties | Edit this page View Source Cols The number of columns in the resized terminal. Declaration public int Cols { get; set; } Property Value Type Description int | Edit this page View Source Rows The number of rows in the resized terminal. Declaration public int Rows { get; set; } Property Value Type Description int"
  },
  "api/Terminal.Gui/Terminal.Gui.Application.RunState.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Application.RunState.html",
    "title": "Class Application.RunState",
    "keywords": "Class Application.RunState Captures the execution state for the provided Toplevel view. Inheritance object Application.RunState Implements IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Application.RunState : IDisposable Constructors | Edit this page View Source RunState(Toplevel) Initializes a new Application.RunState class. Declaration public RunState(Toplevel view) Parameters Type Name Description Toplevel view Properties | Edit this page View Source Toplevel The Toplevel belong to this Application.RunState. Declaration public Toplevel Toplevel { get; } Property Value Type Description Toplevel Methods | Edit this page View Source Dispose() Releases all resource used by the Application.RunState object. Declaration public void Dispose() Remarks Call Dispose() when you are finished using the Application.RunState. | Edit this page View Source Dispose(bool) Releases all resource used by the Application.RunState object. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description bool disposing If set to true we are disposing and should dispose held objects. Implements IDisposable"
  },
  "api/Terminal.Gui/Terminal.Gui.Application.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Application.html",
    "title": "Class Application",
    "keywords": "Class Application A static, singleton class providing the main application driver for Terminal.Gui apps. Inheritance object Application Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class Application Remarks Creates a instance of MainLoop to process input events, handle timers and other sources of data. It is accessible via the MainLoop property. You can hook up to the Iteration event to have your method invoked on each iteration of the MainLoop. When invoked sets the SynchronizationContext to one that is tied to the mainloop, allowing user code to use async/await. Examples // A simple Terminal.Gui app that creates a window with a frame and title with // 5 rows/columns of padding. Application.Init(); var win = new Window (\"Hello World - CTRL-Q to quit\") { X = 5, Y = 5, Width = Dim.Fill (5), Height = Dim.Fill (5) }; Application.Top.Add(win); Application.Run(); Application.Shutdown(); Fields | Edit this page View Source Driver The current ConsoleDriver in use. Declaration public static ConsoleDriver Driver Field Value Type Description ConsoleDriver | Edit this page View Source Iteration This event is raised on each iteration of the MainLoop. Declaration public static Action Iteration Field Value Type Description Action Remarks See also Timeout | Edit this page View Source Resized Invoked when the terminal was resized. The new size of the terminal is provided. Declaration public static Action<Application.ResizedEventArgs> Resized Field Value Type Description Action<Application.ResizedEventArgs> | Edit this page View Source RootKeyEvent Called for new KeyPress events before any processing is performed or views evaluate. Use for global key handling and/or debugging. Return true to suppress the KeyPress event Declaration public static Func<KeyEvent, bool> RootKeyEvent Field Value Type Description Func<KeyEvent, bool> | Edit this page View Source RootMouseEvent Merely a debugging aid to see the raw mouse events Declaration public static Action<MouseEvent> RootMouseEvent Field Value Type Description Action<MouseEvent> Properties | Edit this page View Source AlternateBackwardKey Alternative key to navigate backwards through views. Shift+Ctrl+Tab is the primary key. Declaration public static Key AlternateBackwardKey { get; set; } Property Value Type Description Key | Edit this page View Source AlternateForwardKey Alternative key to navigate forwards through views. Ctrl+Tab is the primary key. Declaration public static Key AlternateForwardKey { get; set; } Property Value Type Description Key | Edit this page View Source Current The current Toplevel object. This is updated when Run(Func<Exception, bool>) enters and leaves to point to the current Toplevel . Declaration public static Toplevel Current { get; } Property Value Type Description Toplevel The current. | Edit this page View Source EnableConsoleScrolling The current EnableConsoleScrolling used in the terminal. Declaration [Obsolete(\"This API is deprecated and has no impact when enabled.\", false)] public static bool EnableConsoleScrolling { get; set; } Property Value Type Description bool Remarks If false (the default) the height of the Terminal.Gui application (Rows) tracks to the height of the visible console view when the console is resized. In this case scrolling in the console will be disabled and all Rows will remain visible. If true then height of the Terminal.Gui application Rows only tracks the height of the visible console view when the console is made larger (the application will only grow in height, never shrink). In this case console scrolling is enabled and the contents (Rows high) will scroll as the console scrolls. This API is deprecated and has no impact when enabled. This API was previously named 'HeightAsBuffer` but was renamed to make its purpose more clear. | Edit this page View Source ExitRunLoopAfterFirstIteration Set to true to cause the RunLoop method to exit after the first iterations. Set to false (the default) to cause the RunLoop to continue running until Application.RequestStop() is called. Declaration public static bool ExitRunLoopAfterFirstIteration { get; set; } Property Value Type Description bool | Edit this page View Source HeightAsBuffer This API is deprecated; use EnableConsoleScrolling instead. Declaration [Obsolete(\"This API is deprecated and has no impact when enabled.\", false)] public static bool HeightAsBuffer { get; set; } Property Value Type Description bool | Edit this page View Source IsMouseDisabled Disable or enable the mouse. The mouse is enabled by default. Declaration public static bool IsMouseDisabled { get; set; } Property Value Type Description bool | Edit this page View Source MainLoop The MainLoop driver for the application Declaration public static MainLoop MainLoop { get; } Property Value Type Description MainLoop The main loop. | Edit this page View Source MdiChildes Gets all the Mdi childes which represent all the not modal Toplevel from the MdiTop. Declaration public static List<Toplevel> MdiChildes { get; } Property Value Type Description List<Toplevel> | Edit this page View Source MdiTop The Toplevel object used for the application on startup which IsMdiContainer is true. Declaration public static Toplevel MdiTop { get; } Property Value Type Description Toplevel | Edit this page View Source MouseGrabView The view that grabbed the mouse, to where will be routed all the mouse events. Declaration public static View MouseGrabView { get; } Property Value Type Description View | Edit this page View Source QuitKey Gets or sets the key to quit the application. Declaration public static Key QuitKey { get; set; } Property Value Type Description Key | Edit this page View Source SupportedCultures Gets all supported cultures by the application without the invariant language. Declaration public static List<CultureInfo> SupportedCultures { get; } Property Value Type Description List<CultureInfo> | Edit this page View Source Top The Toplevel object used for the application on startup (Top) Declaration public static Toplevel Top { get; } Property Value Type Description Toplevel The top. | Edit this page View Source UseSystemConsole If true, forces the use of the System.Console-based (see NetDriver) driver. The default is false. Declaration public static bool UseSystemConsole { get; set; } Property Value Type Description bool | Edit this page View Source WantContinuousButtonPressedView The current View object that wants continuous mouse button pressed events. Declaration public static View WantContinuousButtonPressedView { get; } Property Value Type Description View Methods | Edit this page View Source Begin(Toplevel) Building block API: Prepares the provided Toplevel for execution. Declaration public static Application.RunState Begin(Toplevel toplevel) Parameters Type Name Description Toplevel toplevel The Toplevel to prepare execution for. Returns Type Description Application.RunState The Application.RunState handle that needs to be passed to the End(RunState) method upon completion. Remarks This method prepares the provided toplevel for running with the focus, it adds this to the list of toplevels, sets up the mainloop to process the event, lays out the subviews, focuses the first element, and draws the toplevel in the screen. This is usually followed by executing the RunLoop(RunState, bool) method, and then the End(RunState) method upon termination which will undo these changes. | Edit this page View Source DoEvents() Wakes up the mainloop that might be waiting on input, must be thread safe. Declaration public static void DoEvents() | Edit this page View Source End(RunState) Building block API: completes the execution of a Toplevel that was started with Begin(Toplevel) . Declaration public static void End(Application.RunState runState) Parameters Type Name Description Application.RunState runState The Application.RunState returned by the Begin(Toplevel) method. | Edit this page View Source EnsuresTopOnFront() Ensures that the superview of the most focused view is on front. Declaration public static void EnsuresTopOnFront() | Edit this page View Source GrabMouse(View) Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called. Declaration public static void GrabMouse(View view) Parameters Type Name Description View view View that will receive all mouse events until UngrabMouse is invoked. | Edit this page View Source Init(ConsoleDriver, IMainLoopDriver) Initializes a new instance of Terminal.Gui Application. Declaration public static void Init(ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) Parameters Type Name Description ConsoleDriver driver The ConsoleDriver to use. If not specified the default driver for the platform will be used (see WindowsDriver, CursesDriver, and NetDriver). IMainLoopDriver mainLoopDriver Specifies the MainLoop to use. Must not be null if driver is not null. | Edit this page View Source MakeCenteredRect(Size) Returns a rectangle that is centered in the screen for the provided size. Declaration public static Rect MakeCenteredRect(Size size) Parameters Type Name Description Size size Size for the rectangle. Returns Type Description Rect The centered rect. | Edit this page View Source MoveNext() Move to the next Mdi child from the MdiTop. Declaration public static void MoveNext() | Edit this page View Source MovePrevious() Move to the previous Mdi child from the MdiTop. Declaration public static void MovePrevious() | Edit this page View Source Refresh() Triggers a refresh of the entire display. Declaration public static void Refresh() | Edit this page View Source RequestStop(Toplevel) Stops running the most recent Toplevel or the top if provided. Declaration public static void RequestStop(Toplevel top = null) Parameters Type Name Description Toplevel top The toplevel to request stop. Remarks This will cause Run(Func<Exception, bool>) to return. Calling RequestStop(Toplevel) is equivalent to setting the Running property on the currently running Toplevel to false. | Edit this page View Source Run(Func<Exception, bool>) Runs the application by calling Run(Toplevel, Func<Exception, bool>) with the value of Top. Declaration public static void Run(Func<Exception, bool> errorHandler = null) Parameters Type Name Description Func<Exception, bool> errorHandler Remarks See Run(Toplevel, Func<Exception, bool>) for more details. | Edit this page View Source Run(Toplevel, Func<Exception, bool>) Runs the main loop on the given Toplevel container. Declaration public static void Run(Toplevel view, Func<Exception, bool> errorHandler = null) Parameters Type Name Description Toplevel view The Toplevel to run modally. Func<Exception, bool> errorHandler RELEASE builds only: Handler for any unhandled exceptions (resumes when returns true, rethrows when null). Remarks This method is used to start processing events for the main application, but it is also used to run other modal Views such as Dialog boxes. To make a Run(Toplevel, Func<Exception, bool>) stop execution, call RequestStop(Toplevel). Calling Run(Toplevel, Func<Exception, bool>) is equivalent to calling Begin(Toplevel), followed by RunLoop(RunState, bool), and then calling End(RunState). Alternatively, to have a program control the main loop and process events manually, call Begin(Toplevel) to set things up manually and then repeatedly call RunLoop(RunState, bool) with the wait parameter set to false. By doing this the RunLoop(RunState, bool) method will only process any pending events, timers, idle handlers and then return control immediately. RELEASE builds only: When errorHandler is null any exeptions will be rethrown. Otheriwse, if errorHandler will be called. If errorHandler returns true the RunLoop(RunState, bool) will resume; otherwise this method will exit. | Edit this page View Source RunLoop(RunState, bool) Building block API: Runs the MainLoop for the created Toplevel. Declaration public static void RunLoop(Application.RunState state, bool wait = true) Parameters Type Name Description Application.RunState state The state returned by the Begin(Toplevel) method. bool wait By default this is true which will execute the runloop waiting for events, if set to false, a single iteration will execute. Remarks Use the wait parameter to control whether this is a blocking or non-blocking call. | Edit this page View Source RunMainLoopIteration(ref RunState, bool, ref bool) Run one iteration of the MainLoop. Declaration public static void RunMainLoopIteration(ref Application.RunState state, bool wait, ref bool firstIteration) Parameters Type Name Description Application.RunState state The state returned by Begin(Toplevel). bool wait If true will execute the runloop waiting for events. If true will return after a single iteration. bool firstIteration Set to true if this is the first run loop iteration. Upon return, it will be set to false if at least one iteration happened. | Edit this page View Source Run<T>(Func<Exception, bool>, ConsoleDriver, IMainLoopDriver) Runs the application by calling Run(Toplevel, Func<Exception, bool>) with a new instance of the specified Toplevel-derived class. Calling Init(ConsoleDriver, IMainLoopDriver) first is not needed as this function will initialze the application. Shutdown() must be called when the application is closing (typically after Run> has returned) to ensure resources are cleaned up and terminal settings restored. Declaration public static void Run<T>(Func<Exception, bool> errorHandler = null, ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) where T : Toplevel, new() Parameters Type Name Description Func<Exception, bool> errorHandler ConsoleDriver driver The ConsoleDriver to use. If not specified the default driver for the platform will be used (WindowsDriver, CursesDriver, or NetDriver). This parameteter must be null if Init(ConsoleDriver, IMainLoopDriver) has already been called. IMainLoopDriver mainLoopDriver Specifies the MainLoop to use. Type Parameters Name Description T Remarks See Run(Toplevel, Func<Exception, bool>) for more details. | Edit this page View Source Shutdown() Shutdown an application initialized with Init(ConsoleDriver, IMainLoopDriver). Declaration public static void Shutdown() Remarks Shutdown must be called for every call to Init(ConsoleDriver, IMainLoopDriver) or Run(Toplevel, Func<Exception, bool>) to ensure all resources are cleaned up (Disposed) and terminal settings are restored. | Edit this page View Source UngrabMouse() Releases the mouse grab, so mouse events will be routed to the view on which the mouse is. Declaration public static void UngrabMouse() Events | Edit this page View Source GrabbedMouse Event to be invoked when a view grab the mouse. Declaration public static event Action<View> GrabbedMouse Event Type Type Description Action<View> | Edit this page View Source GrabbingMouse Invoked when a view wants to grab the mouse; can be canceled. Declaration public static event Func<View, bool> GrabbingMouse Event Type Type Description Func<View, bool> | Edit this page View Source NotifyNewRunState Notify that a new Application.RunState was created (Begin(Toplevel) was called). The token is created in Begin(Toplevel) and this event will be fired before that function exits. Declaration public static event Action<Application.RunState> NotifyNewRunState Event Type Type Description Action<Application.RunState> Remarks If ExitRunLoopAfterFirstIteration is true callers to Begin(Toplevel) must also subscribe to NotifyStopRunState and manually dispose of the Application.RunState token when the application is done. | Edit this page View Source NotifyStopRunState Notify that a existent Application.RunState is stopping (End(RunState) was called). Declaration public static event Action<Toplevel> NotifyStopRunState Event Type Type Description Action<Toplevel> Remarks If ExitRunLoopAfterFirstIteration is true callers to Begin(Toplevel) must also subscribe to NotifyStopRunState and manually dispose of the Application.RunState token when the application is done. | Edit this page View Source UnGrabbedMouse Event to be invoked when a view ungrab the mouse. Declaration public static event Action<View> UnGrabbedMouse Event Type Type Description Action<View> | Edit this page View Source UnGrabbingMouse Invoked when a view wants ungrab the mouse; can be canceled. Declaration public static event Func<View, bool> UnGrabbingMouse Event Type Type Description Func<View, bool>"
  },
  "api/Terminal.Gui/Terminal.Gui.Attribute.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Attribute.html",
    "title": "Struct Attribute",
    "keywords": "Struct Attribute Attributes are used as elements that contain both a foreground and a background or platform specific features. Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct Attribute Remarks Attributes are needed to map colors to terminal capabilities that might lack colors. They encode both the foreground and the background color and are used in the ColorScheme class to define color schemes that can be used in an application. Constructors | Edit this page View Source Attribute(int) Initializes a new instance of the Attribute struct with only the value passed to and trying to get the colors if defined. Declaration public Attribute(int value) Parameters Type Name Description int value Value. | Edit this page View Source Attribute(int, Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(int value, Color foreground, Color background) Parameters Type Name Description int value Value. Color foreground Foreground Color background Background | Edit this page View Source Attribute(Color) Initializes a new instance of the Attribute struct with the same colors for the foreground and background. Declaration public Attribute(Color color) Parameters Type Name Description Color color The color. | Edit this page View Source Attribute(Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(Color foreground = Color.Black, Color background = Color.Black) Parameters Type Name Description Color foreground Foreground Color background Background Properties | Edit this page View Source Background The background color. Declaration public readonly Color Background { get; } Property Value Type Description Color | Edit this page View Source Foreground The foreground color. Declaration public readonly Color Foreground { get; } Property Value Type Description Color | Edit this page View Source HasValidColors Returns true if the Attribute is valid (both foreground and background have valid color values). Declaration public bool HasValidColors { get; } Property Value Type Description bool | Edit this page View Source Initialized If true the attribute has been initialized by a ConsoleDriver and thus has Value that is valid for that driver. If false the Foreground and Background colors may have been set '-1' but the attribute has not been mapped to a ConsoleDriver specific color value. Declaration public readonly bool Initialized { get; } Property Value Type Description bool Remarks Attributes that have not been initialized must eventually be initialized before being passed to a driver. | Edit this page View Source Value The ConsoleDriver-specific color attribute value. If Initialized is false the value of this property is invalid (typically because the Attribute was created before a driver was loaded) and the attribute should be re-made (see Make(Color, Color)) before it is used. Declaration public readonly int Value { get; } Property Value Type Description int Methods | Edit this page View Source Get() Gets the current Attribute from the driver. Declaration public static Attribute Get() Returns Type Description Attribute The current attribute. | Edit this page View Source Make(Color, Color) Creates an Attribute from the specified foreground and background colors. Declaration public static Attribute Make(Color foreground, Color background) Parameters Type Name Description Color foreground Foreground color to use. Color background Background color to use. Returns Type Description Attribute The new attribute. Remarks If a ConsoleDriver has not been loaded (Application.Driver == null) this method will return an attribute with Initialized set to false. Operators | Edit this page View Source implicit operator Attribute(int) Implicitly convert an driver-specific color value into an Attribute Declaration public static implicit operator Attribute(int v) Parameters Type Name Description int v value Returns Type Description Attribute An attribute with the specified driver-specific color value. | Edit this page View Source implicit operator int(Attribute) Implicit conversion from an Attribute to the underlying, driver-specific, Int32 representation of the color. Declaration public static implicit operator int(Attribute c) Parameters Type Name Description Attribute c The attribute to convert Returns Type Description int The driver-specific color value stored in the attribute."
  },
  "api/Terminal.Gui/Terminal.Gui.Autocomplete.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Autocomplete.html",
    "title": "Class Autocomplete",
    "keywords": "Class Autocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. Inheritance object Autocomplete TextFieldAutocomplete TextViewAutocomplete Implements IAutocomplete Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public abstract class Autocomplete : IAutocomplete Properties | Edit this page View Source AllSuggestions The full set of all strings that can be suggested. Declaration public virtual List<string> AllSuggestions { get; set; } Property Value Type Description List<string> | Edit this page View Source CloseKey The key that the user can press to close the currently popped autocomplete menu Declaration public virtual Key CloseKey { get; set; } Property Value Type Description Key | Edit this page View Source ColorScheme The colors to use to render the overlay. Accessing this property before the Application has been initialized will cause an error Declaration public virtual ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme | Edit this page View Source HostControl The host control to handle. Declaration public virtual View HostControl { get; set; } Property Value Type Description View | Edit this page View Source MaxHeight The maximum number of visible rows in the autocomplete dropdown to render Declaration public virtual int MaxHeight { get; set; } Property Value Type Description int | Edit this page View Source MaxWidth The maximum width of the autocomplete dropdown Declaration public virtual int MaxWidth { get; set; } Property Value Type Description int | Edit this page View Source PopupInsideContainer Gets or sets If the popup is displayed inside or outside the host limits. Declaration public bool PopupInsideContainer { get; set; } Property Value Type Description bool | Edit this page View Source Reopen The key that the user can press to reopen the currently popped autocomplete menu Declaration public virtual Key Reopen { get; set; } Property Value Type Description Key | Edit this page View Source ScrollOffset When more suggestions are available than can be rendered the user can scroll down the dropdown list. This indicates how far down they have gone Declaration public virtual int ScrollOffset { get; set; } Property Value Type Description int | Edit this page View Source SelectedIdx The currently selected index into Suggestions that the user has highlighted Declaration public virtual int SelectedIdx { get; set; } Property Value Type Description int | Edit this page View Source SelectionKey The key that the user must press to accept the currently selected autocomplete suggestion Declaration public virtual Key SelectionKey { get; set; } Property Value Type Description Key | Edit this page View Source Suggestions The strings that form the current list of suggestions to render based on what the user has typed so far. Declaration public virtual ReadOnlyCollection<string> Suggestions { get; set; } Property Value Type Description ReadOnlyCollection<string> | Edit this page View Source Visible True if the autocomplete should be considered open and visible Declaration public virtual bool Visible { get; set; } Property Value Type Description bool Methods | Edit this page View Source ClearSuggestions() Clears Suggestions Declaration public virtual void ClearSuggestions() | Edit this page View Source Close() Closes the Autocomplete context menu if it is showing and ClearSuggestions() Declaration protected void Close() | Edit this page View Source DeleteTextBackwards() Deletes the text backwards before insert the selected text in the HostControl. Declaration protected abstract void DeleteTextBackwards() | Edit this page View Source EnsureSelectedIdxIsValid() Updates SelectedIdx to be a valid index within Suggestions Declaration public virtual void EnsureSelectedIdxIsValid() | Edit this page View Source GenerateSuggestions(int) Populates Suggestions with all strings in AllSuggestions that match with the current cursor position/text in the HostControl Declaration public virtual void GenerateSuggestions(int columnOffset = 0) Parameters Type Name Description int columnOffset The column offset. | Edit this page View Source GetCurrentWord(int) Returns the currently selected word from the HostControl. When overriding this method views can make use of IdxToWord(List<Rune>, int, int) Declaration protected abstract string GetCurrentWord(int columnOffset = 0) Parameters Type Name Description int columnOffset The column offset. Returns Type Description string | Edit this page View Source IdxToWord(List<Rune>, int, int) Given a line of characters, returns the word which ends at idx or null. Also returns null if the idx is positioned in the middle of a word. Use this method to determine whether autocomplete should be shown when the cursor is at a given point in a line and to get the word from which suggestions should be generated. Use the columnOffset to indicate if search the word at left (negative), at right (positive) or at the current column (zero) which is the default. Declaration protected virtual string IdxToWord(List<Rune> line, int idx, int columnOffset = 0) Parameters Type Name Description List<Rune> line int idx int columnOffset Returns Type Description string | Edit this page View Source InsertSelection(string) Called when the user confirms a selection at the current cursor location in the HostControl. The accepted string is the full autocomplete word to be inserted. Typically a host will have to remove some characters such that the accepted string completes the word instead of simply being appended. Declaration protected virtual bool InsertSelection(string accepted) Parameters Type Name Description string accepted Returns Type Description bool True if the insertion was possible otherwise false | Edit this page View Source InsertText(string) Inser the selected text in the HostControl. Declaration protected abstract void InsertText(string accepted) Parameters Type Name Description string accepted | Edit this page View Source IsWordChar(Rune) Return true if the given symbol should be considered part of a word and can be contained in matches. Base behavior is to use IsLetterOrDigit(char) Declaration public virtual bool IsWordChar(Rune rune) Parameters Type Name Description Rune rune Returns Type Description bool | Edit this page View Source MouseEvent(MouseEvent, bool) Handle mouse events before HostControl e.g. to make mouse events like report/click apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration public virtual bool MouseEvent(MouseEvent me, bool fromHost = false) Parameters Type Name Description MouseEvent me The mouse event. bool fromHost If was called from the popup or from the host. Returns Type Description bool trueif the mouse can be handled falseotherwise. | Edit this page View Source MoveDown() Moves the selection in the Autocomplete context menu down one Declaration protected void MoveDown() | Edit this page View Source MoveUp() Moves the selection in the Autocomplete context menu up one Declaration protected void MoveUp() | Edit this page View Source ProcessKey(KeyEvent) Handle key events before HostControl e.g. to make key events like up/down apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration public virtual bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb The key event. Returns Type Description bool trueif the key can be handled falseotherwise. | Edit this page View Source RenderOverlay(Point) Renders the autocomplete dialog inside or outside the given HostControl at the given point. Declaration public virtual void RenderOverlay(Point renderAt) Parameters Type Name Description Point renderAt | Edit this page View Source RenderSelectedIdxByMouse(MouseEvent) Render the current selection in the Autocomplete context menu by the mouse reporting. Declaration protected void RenderSelectedIdxByMouse(MouseEvent me) Parameters Type Name Description MouseEvent me | Edit this page View Source ReopenSuggestions() Reopen the popup after it has been closed. Declaration protected bool ReopenSuggestions() Returns Type Description bool | Edit this page View Source Select() Completes the autocomplete selection process. Called when user hits the SelectionKey. Declaration protected bool Select() Returns Type Description bool Implements IAutocomplete"
  },
  "api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html",
    "title": "Class Border.ToplevelContainer",
    "keywords": "Class Border.ToplevelContainer A sealed Toplevel derived class to implement Border feature. This is only a wrapper to get borders on a toplevel and is recommended using another derived, like Window where is possible to have borders with or without border line or spacing around. Inheritance object Responder View Toplevel Border.ToplevelContainer Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.AddKeyBinding(Key, params Command[]) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public sealed class Border.ToplevelContainer : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ToplevelContainer() Initializes with default null values. Declaration public ToplevelContainer() | Edit this page View Source ToplevelContainer(Border, string) Initializes a Border.ToplevelContainer with a Computed Declaration public ToplevelContainer(Border border, string title = null) Parameters Type Name Description Border border The border. string title The title. | Edit this page View Source ToplevelContainer(Rect, Border, string) Initializes a Border.ToplevelContainer with a Absolute Declaration public ToplevelContainer(Rect frame, Border border, string title = null) Parameters Type Name Description Rect frame The frame. Border border The border. string title The title. Properties | Edit this page View Source Border Declaration public override Border Border { get; set; } Property Value Type Description Border Overrides View.Border Methods | Edit this page View Source Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides Toplevel.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View)RemoveAll() | Edit this page View Source OnCanFocusChanged() Method invoked when the CanFocus property from a view is changed. Declaration public override void OnCanFocusChanged() Overrides View.OnCanFocusChanged() | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides Toplevel.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Remove(View) Removes a subview added via Add(View) or Add(params View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides Toplevel.Remove(View) | Edit this page View Source RemoveAll() Removes all subviews (children) added via Add(View) or Add(params View[]) from this View. Declaration public override void RemoveAll() Overrides Toplevel.RemoveAll() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Border.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Border.html",
    "title": "Class Border",
    "keywords": "Class Border Draws a border, background, or both around another element. Inheritance object Border Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Border Properties | Edit this page View Source ActualHeight Gets the rendered height of this element. Declaration public int ActualHeight { get; } Property Value Type Description int | Edit this page View Source ActualWidth Gets the rendered width of this element. Declaration public int ActualWidth { get; } Property Value Type Description int | Edit this page View Source Background Gets or sets the Color that fills the area between the bounds of a Border. Declaration public Color Background { get; set; } Property Value Type Description Color | Edit this page View Source BorderBrush Gets or sets the Color that draws the outer border color. Declaration public Color BorderBrush { get; set; } Property Value Type Description Color | Edit this page View Source BorderStyle Specifies the BorderStyle for a view. Declaration public BorderStyle BorderStyle { get; set; } Property Value Type Description BorderStyle | Edit this page View Source BorderThickness Gets or sets the relative Thickness of a Border. Declaration public Thickness BorderThickness { get; set; } Property Value Type Description Thickness | Edit this page View Source Child Gets or sets the single child element of a View. Declaration public View Child { get; set; } Property Value Type Description View | Edit this page View Source ChildContainer Gets or private sets by the Border.ToplevelContainer Declaration public Border.ToplevelContainer ChildContainer { get; } Property Value Type Description Border.ToplevelContainer | Edit this page View Source DrawMarginFrame Gets or sets if a margin frame is drawn around the Child regardless the BorderStyle Declaration public bool DrawMarginFrame { get; set; } Property Value Type Description bool | Edit this page View Source Effect3D Gets or sets the 3D effect around the Border. Declaration public bool Effect3D { get; set; } Property Value Type Description bool | Edit this page View Source Effect3DBrush Gets or sets the color for the Border Declaration public Attribute? Effect3DBrush { get; set; } Property Value Type Description Attribute? | Edit this page View Source Effect3DOffset Get or sets the offset start position for the Effect3D Declaration public Point Effect3DOffset { get; set; } Property Value Type Description Point | Edit this page View Source Padding Gets or sets a Thickness value that describes the amount of space between a Border and its child element. Declaration public Thickness Padding { get; set; } Property Value Type Description Thickness | Edit this page View Source Parent Gets the parent Child parent if any. Declaration public View Parent { get; } Property Value Type Description View | Edit this page View Source Title The title to be displayed for this view. Declaration public ustring Title { get; set; } Property Value Type Description ustring Methods | Edit this page View Source DrawContent(View, bool) Drawn the BorderThickness more the Padding more the BorderStyle and the Effect3D. Declaration public void DrawContent(View view = null, bool fill = true) Parameters Type Name Description View view The view to draw. bool fill If it will clear or not the content area. | Edit this page View Source DrawFullContent() Same as DrawContent(View, bool) but drawing full frames for all borders. Declaration public void DrawFullContent() | Edit this page View Source DrawTitle(View) Draws the view Title to the screen. Declaration public void DrawTitle(View view) Parameters Type Name Description View view The view. | Edit this page View Source DrawTitle(View, Rect) Draws the Text to the screen. Declaration public void DrawTitle(View view, Rect rect) Parameters Type Name Description View view The view. Rect rect The frame. | Edit this page View Source GetSumThickness() Calculate the sum of the Padding and the BorderThickness Declaration public Thickness GetSumThickness() Returns Type Description Thickness The total of the Border Thickness | Edit this page View Source OnBorderChanged() Invoke the BorderChanged event. Declaration public virtual void OnBorderChanged() Events | Edit this page View Source BorderChanged Invoked when any property of Border changes (except Child). Declaration public event Action<Border> BorderChanged Event Type Type Description Action<Border>"
  },
  "api/Terminal.Gui/Terminal.Gui.BorderStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.BorderStyle.html",
    "title": "Enum BorderStyle",
    "keywords": "Enum BorderStyle Specifies the border style for a View and to be used by the Border class. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum BorderStyle Fields Name Description Double The border is drawn with a double line limits. None No border is drawn. Rounded The border is drawn with a single line and rounded corners limits. Single The border is drawn with a single line limits."
  },
  "api/Terminal.Gui/Terminal.Gui.Button.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Button.html",
    "title": "Class Button",
    "keywords": "Class Button Button is a View that provides an item that invokes an Action when activated by the user. Inheritance object Responder View Button Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks Provides a button showing text invokes an Action when clicked on with a mouse or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_') in the button text. Use HotKeySpecifier to change the hotkey specifier from the default of ('_'). If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey. When the button is configured as the default (IsDefault) and the user presses the ENTER key, if no other View processes the KeyEvent, the Button's Action will be invoked. Constructors | Edit this page View Source Button() Initializes a new instance of Button using Computed layout. Declaration public Button() Remarks The width of the Button is computed based on the text length. The height will always be 1. | Edit this page View Source Button(ustring, bool) Initializes a new instance of Button using Computed layout. Declaration public Button(ustring text, bool is_default = false) Parameters Type Name Description ustring text The button's text bool is_default If true, a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. | Edit this page View Source Button(int, int, ustring) Initializes a new instance of Button using Absolute layout, based on the given text Declaration public Button(int x, int y, ustring text) Parameters Type Name Description int x X position where the button will be shown. int y Y position where the button will be shown. ustring text The button's text Remarks The width of the Button is computed based on the text length. The height will always be 1. | Edit this page View Source Button(int, int, ustring, bool) Initializes a new instance of Button using Absolute layout, based on the given text. Declaration public Button(int x, int y, ustring text, bool is_default) Parameters Type Name Description int x X position where the button will be shown. int y Y position where the button will be shown. ustring text The button's text bool is_default If true, a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Properties | Edit this page View Source HotKey Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire. Declaration public override Key HotKey { get; set; } Property Value Type Description Key Overrides View.HotKey | Edit this page View Source IsDefault Gets or sets whether the Button is the default action to activate in a dialog. Declaration public bool IsDefault { get; set; } Property Value Type Description bool true if is default; otherwise, false. Methods | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnClicked() Virtual method to invoke the Clicked event. Declaration public virtual void OnClicked() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source UpdateTextFormatterText() Can be overridden if the Text has different format than the default. Declaration protected override void UpdateTextFormatterText() Overrides View.UpdateTextFormatterText() Events | Edit this page View Source Clicked Clicked Action, raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.CheckBox.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.CheckBox.html",
    "title": "Class CheckBox",
    "keywords": "Class CheckBox The CheckBox View shows an on/off toggle that the user can set Inheritance object Responder View CheckBox Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source CheckBox() Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox() | Edit this page View Source CheckBox(ustring, bool) Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox(ustring s, bool is_checked = false) Parameters Type Name Description ustring s S. bool is_checked If set to true is checked. | Edit this page View Source CheckBox(int, int, ustring) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s) Parameters Type Name Description int x int y ustring s Remarks The size of CheckBox is computed based on the text length. This CheckBox is not toggled. | Edit this page View Source CheckBox(int, int, ustring, bool) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s, bool is_checked) Parameters Type Name Description int x int y ustring s bool is_checked Remarks The size of CheckBox is computed based on the text length. Properties | Edit this page View Source Checked The state of the CheckBox Declaration public bool Checked { get; set; } Property Value Type Description bool Methods | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnToggled(bool) Called when the Checked property changes. Invokes the Toggled event. Declaration public virtual void OnToggled(bool previousChecked) Parameters Type Name Description bool previousChecked | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source UpdateTextFormatterText() Can be overridden if the Text has different format than the default. Declaration protected override void UpdateTextFormatterText() Overrides View.UpdateTextFormatterText() Events | Edit this page View Source Toggled Toggled event, raised when the CheckBox is toggled. Declaration public event Action<bool> Toggled Event Type Type Description Action<bool> Remarks Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard. The passed bool contains the previous state. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Clipboard.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Clipboard.html",
    "title": "Class Clipboard",
    "keywords": "Class Clipboard Provides cut, copy, and paste support for the OS clipboard. Inheritance object Clipboard Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class Clipboard Remarks On Windows, the Clipboard class uses the Windows Clipboard APIs via P/Invoke. On Linux, when not running under Windows Subsystem for Linux (WSL), the Clipboard class uses the xclip command line tool. If xclip is not installed, the clipboard will not work. On Linux, when running under Windows Subsystem for Linux (WSL), the Clipboard class launches Windows' powershell.exe via WSL interop and uses the \"Set-Clipboard\" and \"Get-Clipboard\" Powershell CmdLets. On the Mac, the Clipboard class uses the MacO OS X pbcopy and pbpaste command line tools and the Mac clipboard APIs vai P/Invoke. Properties | Edit this page View Source Contents Gets (copies from) or sets (pastes to) the contents of the OS clipboard. Declaration public static ustring Contents { get; set; } Property Value Type Description ustring | Edit this page View Source IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard. Declaration public static bool IsSupported { get; } Property Value Type Description bool Methods | Edit this page View Source TryGetClipboardData(out string) Copies the contents of the OS clipboard to result if possible. Declaration public static bool TryGetClipboardData(out string result) Parameters Type Name Description string result The contents of the OS clipboard if successful, Empty if not. Returns Type Description bool true the OS clipboard was retrieved, false otherwise. | Edit this page View Source TrySetClipboardData(string) Pastes the text to the OS clipboard if possible. Declaration public static bool TrySetClipboardData(string text) Parameters Type Name Description string text The text to paste to the OS clipboard. Returns Type Description bool true the OS clipboard was set, false otherwise."
  },
  "api/Terminal.Gui/Terminal.Gui.ClipboardBase.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ClipboardBase.html",
    "title": "Class ClipboardBase",
    "keywords": "Class ClipboardBase Shared abstract class to enforce rules from the implementation of the IClipboard interface. Inheritance object ClipboardBase FakeDriver.FakeClipboard Implements IClipboard Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public abstract class ClipboardBase : IClipboard Properties | Edit this page View Source IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard Declaration public abstract bool IsSupported { get; } Property Value Type Description bool Methods | Edit this page View Source GetClipboardData() Returns the contents of the OS clipboard if possible. Declaration public string GetClipboardData() Returns Type Description string The contents of the OS clipboard if successful. Exceptions Type Condition NotSupportedException Thrown if it was not possible to copy from the OS clipboard. | Edit this page View Source GetClipboardDataImpl() Returns the contents of the OS clipboard if possible. Implemented by ConsoleDriver-specific subclasses. Declaration protected abstract string GetClipboardDataImpl() Returns Type Description string The contents of the OS clipboard if successful. Exceptions Type Condition NotSupportedException Thrown if it was not possible to copy from the OS clipboard. | Edit this page View Source SetClipboardData(string) Pastes the text to the OS clipboard if possible. Declaration public void SetClipboardData(string text) Parameters Type Name Description string text The text to paste to the OS clipboard. Exceptions Type Condition NotSupportedException Thrown if it was not possible to paste to the OS clipboard. | Edit this page View Source SetClipboardDataImpl(string) Pastes the text to the OS clipboard if possible. Implemented by ConsoleDriver-specific subclasses. Declaration protected abstract void SetClipboardDataImpl(string text) Parameters Type Name Description string text The text to paste to the OS clipboard. Exceptions Type Condition NotSupportedException Thrown if it was not possible to paste to the OS clipboard. | Edit this page View Source TryGetClipboardData(out string) Copies the contents of the OS clipboard to result if possible. Declaration public bool TryGetClipboardData(out string result) Parameters Type Name Description string result The contents of the OS clipboard if successful, Empty if not. Returns Type Description bool true the OS clipboard was retrieved, false otherwise. | Edit this page View Source TrySetClipboardData(string) Pastes the text to the OS clipboard if possible. Declaration public bool TrySetClipboardData(string text) Parameters Type Name Description string text The text to paste to the OS clipboard. Returns Type Description bool true the OS clipboard was set, false otherwise. Implements IClipboard"
  },
  "api/Terminal.Gui/Terminal.Gui.CollectionNavigator.KeystrokeNavigatorEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.CollectionNavigator.KeystrokeNavigatorEventArgs.html",
    "title": "Class CollectionNavigator.KeystrokeNavigatorEventArgs",
    "keywords": "Class CollectionNavigator.KeystrokeNavigatorEventArgs Event arguments for the SearchStringChanged event. Inheritance object CollectionNavigator.KeystrokeNavigatorEventArgs Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class CollectionNavigator.KeystrokeNavigatorEventArgs Constructors | Edit this page View Source KeystrokeNavigatorEventArgs(string) Initializes a new instance of CollectionNavigator.KeystrokeNavigatorEventArgs Declaration public KeystrokeNavigatorEventArgs(string searchString) Parameters Type Name Description string searchString The current SearchString. Properties | Edit this page View Source SearchString he current SearchString. Declaration public string SearchString { get; } Property Value Type Description string"
  },
  "api/Terminal.Gui/Terminal.Gui.CollectionNavigator.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.CollectionNavigator.html",
    "title": "Class CollectionNavigator",
    "keywords": "Class CollectionNavigator Navigates a collection of items using keystrokes. The keystrokes are used to build a search string. The SearchString is used to find the next item in the collection that matches the search string when GetNextMatchingItem(int, char) is called. If the user types keystrokes that can't be found in the collection, the search string is cleared and the next item is found that starts with the last keystroke. If the user pauses keystrokes for a short time (see TypingDelay), the search string is cleared. Inheritance object CollectionNavigator Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class CollectionNavigator Constructors | Edit this page View Source CollectionNavigator() Constructs a new CollectionNavigator. Declaration public CollectionNavigator() | Edit this page View Source CollectionNavigator(IEnumerable<object>) Constructs a new CollectionNavigator for the given collection. Declaration public CollectionNavigator(IEnumerable<object> collection) Parameters Type Name Description IEnumerable<object> collection Properties | Edit this page View Source Collection The collection of objects to search. ToString() is used to search the collection. Declaration public IEnumerable<object> Collection { get; set; } Property Value Type Description IEnumerable<object> | Edit this page View Source Comparer The compararer function to use when searching the collection. Declaration public StringComparer Comparer { get; set; } Property Value Type Description StringComparer | Edit this page View Source SearchString Gets the current search string. This includes the set of keystrokes that have been pressed since the last unsuccessful match or after TypingDelay) milliseconds. Useful for debugging. Declaration public string SearchString { get; } Property Value Type Description string | Edit this page View Source TypingDelay Gets or sets the number of milliseconds to delay before clearing the search string. The delay is reset on each call to GetNextMatchingItem(int, char). The default is 500ms. Declaration public int TypingDelay { get; set; } Property Value Type Description int Methods | Edit this page View Source GetNextMatchingItem(int, char) Gets the index of the next item in the collection that matches the current SearchString plus the provided character (typically from a key press). Declaration public int GetNextMatchingItem(int currentIndex, char keyStruck) Parameters Type Name Description int currentIndex The index in the collection to start the search from. char keyStruck The character of the key the user pressed. Returns Type Description int The index of the item that matches what the user has typed. Returns -1 if no item in the collection matched. | Edit this page View Source IsCompatibleKey(KeyEvent) Returns true if kb is a searchable key (e.g. letters, numbers etc) that is valid to pass to to this class for search filtering. Declaration public static bool IsCompatibleKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool | Edit this page View Source OnSearchStringChanged(KeystrokeNavigatorEventArgs) Invoked when the SearchString changes. Useful for debugging. Invokes the SearchStringChanged event. Declaration public virtual void OnSearchStringChanged(CollectionNavigator.KeystrokeNavigatorEventArgs e) Parameters Type Name Description CollectionNavigator.KeystrokeNavigatorEventArgs e Events | Edit this page View Source SearchStringChanged This event is invoked when SearchString changes. Useful for debugging. Declaration public event Action<CollectionNavigator.KeystrokeNavigatorEventArgs> SearchStringChanged Event Type Type Description Action<CollectionNavigator.KeystrokeNavigatorEventArgs>"
  },
  "api/Terminal.Gui/Terminal.Gui.Color.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Color.html",
    "title": "Enum Color",
    "keywords": "Enum Color Colors that can be used to set the foreground and background colors in console applications. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum Color Remarks The HasValidColors value indicates either no-color has been set or the color is invalid. Fields Name Description Black The black color. Blue The blue color. BrightBlue The bright bBlue color. BrightCyan The bright cyan color. BrightGreen The bright green color. BrightMagenta The bright magenta color. BrightRed The bright red color. BrightYellow The bright yellow color. Brown The brown color. Cyan The cyan color. DarkGray The dark gray color. Gray The gray color. Green The green color. Magenta The magenta color. Red The red color. White The White color."
  },
  "api/Terminal.Gui/Terminal.Gui.ColorPicker.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ColorPicker.html",
    "title": "Class ColorPicker",
    "keywords": "Class ColorPicker The ColorPicker View Color picker. Inheritance object Responder View ColorPicker Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ColorPicker : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ColorPicker() Initializes a new instance of ColorPicker. Declaration public ColorPicker() | Edit this page View Source ColorPicker(ustring) Initializes a new instance of ColorPicker. Declaration public ColorPicker(ustring title) Parameters Type Name Description ustring title Title. | Edit this page View Source ColorPicker(int, int, ustring) Initializes a new instance of ColorPicker. Declaration public ColorPicker(int x, int y, ustring title) Parameters Type Name Description int x X location. int y Y location. ustring title Title | Edit this page View Source ColorPicker(Point, ustring) Initializes a new instance of ColorPicker. Declaration public ColorPicker(Point point, ustring title) Parameters Type Name Description Point point Location point. ustring title Title. Properties | Edit this page View Source Cursor Cursor for the selected color. Declaration public Point Cursor { get; set; } Property Value Type Description Point | Edit this page View Source SelectedColor Selected color. Declaration public Color SelectedColor { get; set; } Property Value Type Description Color Methods | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source MoveDown() Moves the selected item index to the next row. Declaration public virtual bool MoveDown() Returns Type Description bool | Edit this page View Source MoveLeft() Moves the selected item index to the previous column. Declaration public virtual bool MoveLeft() Returns Type Description bool | Edit this page View Source MoveRight() Moves the selected item index to the next column. Declaration public virtual bool MoveRight() Returns Type Description bool | Edit this page View Source MoveUp() Moves the selected item index to the previous row. Declaration public virtual bool MoveUp() Returns Type Description bool | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. Events | Edit this page View Source ColorChanged Fired when a color is picked. Declaration public event Action ColorChanged Event Type Type Description Action Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.ColorScheme.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ColorScheme.html",
    "title": "Class ColorScheme",
    "keywords": "Class ColorScheme Defines the color Attributes for common visible elements in a View. Containers such as Window and FrameView use ColorScheme to determine the colors used by sub-views. Inheritance object ColorScheme Implements IEquatable<ColorScheme> Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ColorScheme : IEquatable<ColorScheme> Remarks See also: ColorSchemes. Properties | Edit this page View Source Disabled The default foreground and background color for text, when the view is disabled. Declaration public Attribute Disabled { get; set; } Property Value Type Description Attribute | Edit this page View Source Focus The foreground and background color for text when the view has the focus. Declaration public Attribute Focus { get; set; } Property Value Type Description Attribute | Edit this page View Source HotFocus The foreground and background color for text when the view is highlighted (hot) and has focus. Declaration public Attribute HotFocus { get; set; } Property Value Type Description Attribute | Edit this page View Source HotNormal The foreground and background color for text when the view is highlighted (hot). Declaration public Attribute HotNormal { get; set; } Property Value Type Description Attribute | Edit this page View Source Normal The foreground and background color for text when the view is not focused, hot, or disabled. Declaration public Attribute Normal { get; set; } Property Value Type Description Attribute Methods | Edit this page View Source Equals(object) Compares two ColorScheme objects for equality. Declaration public override bool Equals(object obj) Parameters Type Name Description object obj Returns Type Description bool true if the two objects are equal Overrides object.Equals(object) | Edit this page View Source Equals(ColorScheme) Compares two ColorScheme objects for equality. Declaration public bool Equals(ColorScheme other) Parameters Type Name Description ColorScheme other Returns Type Description bool true if the two objects are equal | Edit this page View Source GetHashCode() Returns a hashcode for this instance. Declaration public override int GetHashCode() Returns Type Description int hashcode for this instance Overrides object.GetHashCode() Operators | Edit this page View Source operator ==(ColorScheme, ColorScheme) Compares two ColorScheme objects for equality. Declaration public static bool operator ==(ColorScheme left, ColorScheme right) Parameters Type Name Description ColorScheme left ColorScheme right Returns Type Description bool true if the two objects are equivalent | Edit this page View Source operator !=(ColorScheme, ColorScheme) Compares two ColorScheme objects for inequality. Declaration public static bool operator !=(ColorScheme left, ColorScheme right) Parameters Type Name Description ColorScheme left ColorScheme right Returns Type Description bool true if the two objects are not equivalent Implements IEquatable<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Colors.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Colors.html",
    "title": "Class Colors",
    "keywords": "Class Colors The default ColorSchemes for the application. Inheritance object Colors Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class Colors Remarks This property can be set in a Theme to change the default Colors for the application. Properties | Edit this page View Source Base The base color scheme, for the default toplevel views. Declaration public static ColorScheme Base { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Base\"]; | Edit this page View Source ColorSchemes Provides the defined ColorSchemes. Declaration public static Dictionary<string, ColorScheme> ColorSchemes { get; } Property Value Type Description Dictionary<string, ColorScheme> | Edit this page View Source Dialog The dialog color scheme, for standard popup dialog boxes Declaration public static ColorScheme Dialog { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Dialog\"]; | Edit this page View Source Error The color scheme for showing errors. Declaration public static ColorScheme Error { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Error\"]; | Edit this page View Source Menu The menu bar color Declaration public static ColorScheme Menu { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Menu\"]; | Edit this page View Source TopLevel The application toplevel color scheme, for the default toplevel views. Declaration public static ColorScheme TopLevel { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"TopLevel\"]; Methods | Edit this page View Source Create() Creates a new dictionary of new ColorScheme objects. Declaration public static Dictionary<string, ColorScheme> Create() Returns Type Description Dictionary<string, ColorScheme>"
  },
  "api/Terminal.Gui/Terminal.Gui.ComboBox.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ComboBox.html",
    "title": "Class ComboBox",
    "keywords": "Class ComboBox Provides a drop-down list of items the user can select from. Inheritance object Responder View ComboBox Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ComboBox() Public constructor Declaration public ComboBox() | Edit this page View Source ComboBox(ustring) Public constructor Declaration public ComboBox(ustring text) Parameters Type Name Description ustring text | Edit this page View Source ComboBox(IList) Initialize with the source. Declaration public ComboBox(IList source) Parameters Type Name Description IList source The source. | Edit this page View Source ComboBox(Rect, IList) Public constructor Declaration public ComboBox(Rect rect, IList source) Parameters Type Name Description Rect rect IList source Properties | Edit this page View Source ColorScheme Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme | Edit this page View Source HideDropdownListOnClick Gets or sets if the drop-down list can be hide with a button click event. Declaration public bool HideDropdownListOnClick { get; set; } Property Value Type Description bool | Edit this page View Source IsShow Gets the drop down list state, expanded or collapsed. Declaration public bool IsShow { get; } Property Value Type Description bool | Edit this page View Source ReadOnly If set to true its not allow any changes in the text. Declaration public bool ReadOnly { get; set; } Property Value Type Description bool | Edit this page View Source SearchText Current search text Declaration public ustring SearchText { get; set; } Property Value Type Description ustring | Edit this page View Source SelectedItem Gets the index of the currently selected item in the Source Declaration public int SelectedItem { get; set; } Property Value Type Description int The selected item or -1 none selected. | Edit this page View Source Source Gets or sets the IListDataSource backing this ComboBox, enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new IList source. | Edit this page View Source Text The currently selected list item Declaration public ustring Text { get; set; } Property Value Type Description ustring Methods | Edit this page View Source Collapse() Collapses the drop down list. Returns true if the state chagned or false if it was already collapsed and no action was taken Declaration public virtual bool Collapse() Returns Type Description bool | Edit this page View Source Expand() Expands the drop down list. Returns true if the state chagned or false if it was already expanded and no action was taken Declaration public virtual bool Expand() Returns Type Description bool | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnCollapsed() Virtual method which invokes the Collapsed event. Declaration public virtual void OnCollapsed() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnExpanded() Virtual method which invokes the Expanded event. Declaration public virtual void OnExpanded() | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnLeave(View) | Edit this page View Source OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description bool | Edit this page View Source OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description bool | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent e) Parameters Type Name Description KeyEvent e Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source SetSource(IList) Sets the source of the ComboBox to an IList. Declaration public void SetSource(IList source) Parameters Type Name Description IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Events | Edit this page View Source Collapsed This event is raised when the drop-down list is collapsed. Declaration public event Action Collapsed Event Type Type Description Action | Edit this page View Source Expanded This event is raised when the drop-down list is expanded. Declaration public event Action Expanded Event Type Type Description Action | Edit this page View Source OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action<ListViewItemEventArgs> OpenSelectedItem Event Type Type Description Action<ListViewItemEventArgs> | Edit this page View Source SelectedItemChanged This event is raised when the selected item in the ComboBox has changed. Declaration public event Action<ListViewItemEventArgs> SelectedItemChanged Event Type Type Description Action<ListViewItemEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Command.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Command.html",
    "title": "Enum Command",
    "keywords": "Enum Command Actions which can be performed by the application or bound to keys in a View control. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum Command Fields Name Description Accept Accepts the current state (e.g. selection, button press etc). BackTab Tabs back to the previous item. BottomEnd Moves to the bottom/end. BottomEndExtend Extends the selection to the bottom/end. Cancel Cancels an action or any temporary states on the control e.g. expanding a combo list. Collapse Collapses a list or item (with subitems). CollapseAll Recursively collapses a list items of their children (if any). Copy Copies the current selection. Cut Cuts the current selection. CutToEndLine Cuts to the clipboard the characters from the current position to the end of the line. CutToStartLine Cuts to the clipboard the characters from the current position to the start of the line. DeleteAll Deletes all objects. DeleteCharLeft Deletes the character on the left. DeleteCharRight Deletes the character on the right. DisableOverwrite Disables overwrite mode (EnableOverwrite) EnableOverwrite Enables overwrite mode such that newly typed text overwrites the text that is already there (typically associated with the Insert key). EndOfLine Moves the cursor to the end of line. EndOfLineExtend Extends the selection to the end of line. EndOfPage Moves the cursor to the bottom of page. Expand Expands a list or item (with subitems). ExpandAll Recursively Expands all child items and their child items (if any). KillWordBackwards Deletes the characters backwards. KillWordForwards Deletes the characters forwards. Left Moves the selection left one by the minimum increment supported by the View e.g. single character, cell, item etc. LeftExtend Extends the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc. LeftHome Moves to the left begin. LeftHomeExtend Extends the selection to the left begin. LineDown Moves down one item (cell, line, etc...). LineDownExtend Extends the selection down one (cell, line, etc...). LineDownToLastBranch Moves down to the last child node of the branch that holds the current selection. LineUp Moves up one (cell, line, etc...). LineUpExtend Extends the selection up one item (cell, line, etc...). LineUpToFirstBranch Moves up to the first child node of the branch that holds the current selection. NewLine Inserts a new item. NextView Moves focus to the next view. NextViewOrTop Moves focus to the next view or toplevel (case of MDI). OpenSelectedItem Open the selected item. PageDown Move one page down. PageDownExtend Move one page page extending the selection to cover revealed objects/characters. PageLeft Moves to the left page. PageRight Moves to the right page. PageUp Move one page up. PageUpExtend Move one page up extending the selection to cover revealed objects/characters. Paste Pastes the current selection. PreviousView Moves focuss to the previous view. PreviousViewOrTop Moves focus to the next previous or toplevel (case of MDI). QuitToplevel Quit a Toplevel. Redo Redo changes. Refresh Refresh. Right Moves the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc. RightEnd Moves to the right end. RightEndExtend Extends the selection to the right end. RightExtend Extends the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc. ScrollDown Scrolls down one (cell, line, etc...) (without changing the selection). ScrollLeft Scrolls one item (cell, character, etc...) to the left ScrollRight Scrolls one item (cell, character, etc...) to the right. ScrollUp Scrolls up one item (cell, line, etc...) (without changing the selection). SelectAll Selects all objects. StartOfLine Moves the cursor to the start of line. StartOfLineExtend Extends the selection to the start of line. StartOfPage Moves the cursor to the top of page. Suspend Suspend a application (used on Linux). Tab Tabs to the next item. ToggleChecked Toggle the checked state. ToggleExpandCollapse Toggles the Expanded or collapsed state of a a list or item (with subitems). ToggleExtend Toggles the selection. ToggleOverwrite Toggles overwrite mode such that newly typed text overwrites the text that is already there (typically associated with the Insert key). TopHome Moves to the top/home. TopHomeExtend Extends the selection to the top/home. Undo Undo changes. UnixEmulation Unix emulation. WordLeft Moves the caret to the start of the previous word. WordLeftExtend Extends the selection to the start of the previous word. WordRight Moves the caret to the start of the next word. WordRightExtend Extends the selection to the start of the next word."
  },
  "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html",
    "title": "Enum ConsoleDriver.DiagnosticFlags",
    "keywords": "Enum ConsoleDriver.DiagnosticFlags Enables diagnostic functions Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax [Flags] public enum ConsoleDriver.DiagnosticFlags : uint Fields Name Description FramePadding When Enabled, DrawWindowFrame(Rect, int, int, int, int, bool, bool, Border) will use 'L', 'R', 'T', and 'B' for padding instead of ' '. FrameRuler When enabled, DrawWindowFrame(Rect, int, int, int, int, bool, bool, Border) will draw a ruler in the frame for any side with a padding value greater than 0. Off All diagnostics off"
  },
  "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html",
    "title": "Class ConsoleDriver",
    "keywords": "Class ConsoleDriver ConsoleDriver is an abstract class that defines the requirements for a console driver. There are currently three implementations: CursesDriver (for Unix and Mac), WindowsDriver, and NetDriver that uses the .NET Console API. Inheritance object ConsoleDriver FakeDriver Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public abstract class ConsoleDriver Fields | Edit this page View Source BlocksMeterSegment Blocks Segment indicator for meter views (e.g. ProgressBar. Declaration public Rune BlocksMeterSegment Field Value Type Description Rune | Edit this page View Source BottomTee The bottom tee. Declaration public Rune BottomTee Field Value Type Description Rune | Edit this page View Source Checked Checkmark. Declaration public Rune Checked Field Value Type Description Rune | Edit this page View Source ContinuousMeterSegment Continuous Segment indicator for meter views (e.g. ProgressBar. Declaration public Rune ContinuousMeterSegment Field Value Type Description Rune | Edit this page View Source Diamond Diamond character Declaration public Rune Diamond Field Value Type Description Rune | Edit this page View Source DownArrow Down Arrow. Declaration public Rune DownArrow Field Value Type Description Rune | Edit this page View Source HDLine Horizontal double line character. Declaration public Rune HDLine Field Value Type Description Rune | Edit this page View Source HLine Horizontal line character. Declaration public Rune HLine Field Value Type Description Rune | Edit this page View Source HRLine Horizontal line character for rounded corners. Declaration public Rune HRLine Field Value Type Description Rune | Edit this page View Source LLCorner Lower left corner Declaration public Rune LLCorner Field Value Type Description Rune | Edit this page View Source LLDCorner Lower left double corner Declaration public Rune LLDCorner Field Value Type Description Rune | Edit this page View Source LLRCorner Lower left rounded corner Declaration public Rune LLRCorner Field Value Type Description Rune | Edit this page View Source LRCorner Lower right corner Declaration public Rune LRCorner Field Value Type Description Rune | Edit this page View Source LRDCorner Lower right double corner Declaration public Rune LRDCorner Field Value Type Description Rune | Edit this page View Source LRRCorner Lower right rounded corner Declaration public Rune LRRCorner Field Value Type Description Rune | Edit this page View Source LeftArrow Left Arrow. Declaration public Rune LeftArrow Field Value Type Description Rune | Edit this page View Source LeftBracket Left frame/bracket (e.g. '[' for Button). Declaration public Rune LeftBracket Field Value Type Description Rune | Edit this page View Source LeftDefaultIndicator Left indicator for default action (e.g. for Button). Declaration public Rune LeftDefaultIndicator Field Value Type Description Rune | Edit this page View Source LeftTee Left tee Declaration public Rune LeftTee Field Value Type Description Rune | Edit this page View Source RightArrow Right Arrow. Declaration public Rune RightArrow Field Value Type Description Rune | Edit this page View Source RightBracket Right frame/bracket (e.g. ']' for Button). Declaration public Rune RightBracket Field Value Type Description Rune | Edit this page View Source RightDefaultIndicator Right indicator for default action (e.g. for Button). Declaration public Rune RightDefaultIndicator Field Value Type Description Rune | Edit this page View Source RightTee Right tee Declaration public Rune RightTee Field Value Type Description Rune | Edit this page View Source Selected Selected mark. Declaration public Rune Selected Field Value Type Description Rune | Edit this page View Source Stipple Stipple pattern Declaration public Rune Stipple Field Value Type Description Rune | Edit this page View Source TerminalResized The handler fired when the terminal is resized. Declaration protected Action TerminalResized Field Value Type Description Action | Edit this page View Source TopTee Top tee Declaration public Rune TopTee Field Value Type Description Rune | Edit this page View Source ULCorner Upper left corner Declaration public Rune ULCorner Field Value Type Description Rune | Edit this page View Source ULDCorner Upper left double corner Declaration public Rune ULDCorner Field Value Type Description Rune | Edit this page View Source ULRCorner Upper left rounded corner Declaration public Rune ULRCorner Field Value Type Description Rune | Edit this page View Source URCorner Upper right corner Declaration public Rune URCorner Field Value Type Description Rune | Edit this page View Source URDCorner Upper right double corner Declaration public Rune URDCorner Field Value Type Description Rune | Edit this page View Source URRCorner Upper right rounded corner Declaration public Rune URRCorner Field Value Type Description Rune | Edit this page View Source UnChecked Un-checked checkmark. Declaration public Rune UnChecked Field Value Type Description Rune | Edit this page View Source UnSelected Un-selected selected mark. Declaration public Rune UnSelected Field Value Type Description Rune | Edit this page View Source UpArrow Up Arrow. Declaration public Rune UpArrow Field Value Type Description Rune | Edit this page View Source VDLine Vertical double line character. Declaration public Rune VDLine Field Value Type Description Rune | Edit this page View Source VLine Vertical line character. Declaration public Rune VLine Field Value Type Description Rune | Edit this page View Source VRLine Vertical line character for rounded corners. Declaration public Rune VRLine Field Value Type Description Rune Properties | Edit this page View Source Clip Controls the current clipping region that AddRune/AddStr is subject to. Declaration public Rect Clip { get; set; } Property Value Type Description Rect The clip. | Edit this page View Source Clipboard Get the operation system clipboard. Declaration public abstract IClipboard Clipboard { get; } Property Value Type Description IClipboard | Edit this page View Source Cols The current number of columns in the terminal. Declaration public abstract int Cols { get; } Property Value Type Description int | Edit this page View Source Contents The format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag Declaration public virtual int[,,] Contents { get; } Property Value Type Description int[,,] | Edit this page View Source CurrentAttribute The current attribute the driver is using. Declaration public virtual Attribute CurrentAttribute { get; set; } Property Value Type Description Attribute | Edit this page View Source Diagnostics Set flags to enable/disable ConsoleDriver diagnostics. Declaration public static ConsoleDriver.DiagnosticFlags Diagnostics { get; set; } Property Value Type Description ConsoleDriver.DiagnosticFlags | Edit this page View Source EnableConsoleScrolling If false (the default) the height of the Terminal.Gui application (Rows) tracks to the height of the visible console view when the console is resized. In this case scrolling in the console will be disabled and all Rows will remain visible. If true then height of the Terminal.Gui application Rows only tracks the height of the visible console view when the console is made larger (the application will only grow in height, never shrink). In this case console scrolling is enabled and the contents (Rows high) will scroll as the console scrolls. Declaration [Obsolete(\"This API is deprecated and has no impact when enabled.\", false)] public abstract bool EnableConsoleScrolling { get; set; } Property Value Type Description bool Remarks NOTE: Changes to Windows Terminal prevents this functionality from working. It only really worked on Windows 'conhost' previously. | Edit this page View Source HeightAsBuffer This API is deprecated and has no impact when enabled. Declaration [Obsolete(\"This API is deprecated and has no impact when enabled.\", false)] public abstract bool HeightAsBuffer { get; set; } Property Value Type Description bool | Edit this page View Source Left The current left in the terminal. Declaration public abstract int Left { get; } Property Value Type Description int | Edit this page View Source Rows The current number of rows in the terminal. Declaration public abstract int Rows { get; } Property Value Type Description int | Edit this page View Source Top The current top in the terminal. Declaration public abstract int Top { get; } Property Value Type Description int Methods | Edit this page View Source AddRune(Rune) Adds the specified rune to the display at the current cursor position. Declaration public abstract void AddRune(Rune rune) Parameters Type Name Description Rune rune Rune to add. | Edit this page View Source AddStr(ustring) Adds the str to the display at the cursor position. Declaration public abstract void AddStr(ustring str) Parameters Type Name Description ustring str String. | Edit this page View Source CookMouse() Enables the cooked event processing from the mouse driver. Not implemented by any driver: See Issue #2300. Declaration public abstract void CookMouse() | Edit this page View Source DrawFrame(Rect, int, bool) Draws a frame on the specified region with the specified padding around the frame. Declaration public virtual void DrawFrame(Rect region, int padding, bool fill) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. int padding Padding to add on the sides. bool fill If set to true it will clear the contents with the current color, otherwise the contents will be left untouched. Remarks This API has been superseded by DrawWindowFrame(Rect, int, int, int, int, bool, bool, Border). | Edit this page View Source DrawWindowFrame(Rect, int, int, int, int, bool, bool, Border) Draws a frame for a window with padding and an optional visible border inside the padding. Declaration public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false, Border borderContent = null) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. int paddingLeft Number of columns to pad on the left (if 0 the border will not appear on the left). int paddingTop Number of rows to pad on the top (if 0 the border and title will not appear on the top). int paddingRight Number of columns to pad on the right (if 0 the border will not appear on the right). int paddingBottom Number of rows to pad on the bottom (if 0 the border will not appear on the bottom). bool border If set to true and any padding dimension is > 0 the border will be drawn. bool fill If set to true it will clear the content area (the area inside the padding) with the current color, otherwise the content area will be left untouched. Border borderContent The Border to be used if defined. | Edit this page View Source DrawWindowTitle(Rect, ustring, int, int, int, int, TextAlignment) Draws the title for a Window-style view incorporating padding. Declaration public virtual void DrawWindowTitle(Rect region, ustring title, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom, TextAlignment textAlignment = TextAlignment.Left) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. ustring title The title for the window. The title will only be drawn if title is not null or empty and paddingTop is greater than 0. int paddingLeft Number of columns to pad on the left (if 0 the border will not appear on the left). int paddingTop Number of rows to pad on the top (if 0 the border and title will not appear on the top). int paddingRight Number of columns to pad on the right (if 0 the border will not appear on the right). int paddingBottom Number of rows to pad on the bottom (if 0 the border will not appear on the bottom). TextAlignment textAlignment Not yet implemented. | Edit this page View Source End() Ends the execution of the console driver. Declaration public abstract void End() | Edit this page View Source EnsureCursorVisibility() Ensure the cursor visibility Declaration public abstract bool EnsureCursorVisibility() Returns Type Description bool true upon success | Edit this page View Source GetAttribute() Gets the current Attribute. Declaration public Attribute GetAttribute() Returns Type Description Attribute The current attribute. | Edit this page View Source GetColors(int, out Color, out Color) Gets the foreground and background colors based on the value. Declaration public abstract bool GetColors(int value, out Color foreground, out Color background) Parameters Type Name Description int value The value. Color foreground The foreground. Color background The background. Returns Type Description bool | Edit this page View Source GetCursorVisibility(out CursorVisibility) Retreive the cursor caret visibility Declaration public abstract bool GetCursorVisibility(out CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The current CursorVisibility Returns Type Description bool true upon success | Edit this page View Source Init(Action) Initializes the driver Declaration public abstract void Init(Action terminalResized) Parameters Type Name Description Action terminalResized Method to invoke when the terminal is resized. | Edit this page View Source InitalizeColorSchemes(bool) Ensures all Attributes in ColorSchemes are correctly initialized by the driver. Declaration public void InitalizeColorSchemes(bool supportsColors = true) Parameters Type Name Description bool supportsColors Flag indicating if colors are supported (not used). | Edit this page View Source IsValidContent(int, int, Rect) Ensures that the column and line are in a valid range from the size of the driver. Declaration public bool IsValidContent(int col, int row, Rect clip) Parameters Type Name Description int col The column. int row The row. Rect clip The clip. Returns Type Description bool trueif it's a valid range,falseotherwise. | Edit this page View Source MakeAttribute(Color, Color) Make the attribute for the foreground and background colors. Declaration public abstract Attribute MakeAttribute(Color fore, Color back) Parameters Type Name Description Color fore Foreground. Color back Background. Returns Type Description Attribute | Edit this page View Source MakeColor(Color, Color) Make the Colors for the ColorScheme. Declaration public abstract Attribute MakeColor(Color foreground, Color background) Parameters Type Name Description Color foreground The foreground color. Color background The background color. Returns Type Description Attribute The attribute for the foreground and background colors. | Edit this page View Source MakePrintable(Rune) Ensures a Rune is not a control character and can be displayed by translating characters below 0x20 to equivalent, printable, Unicode chars. Declaration public static Rune MakePrintable(Rune c) Parameters Type Name Description Rune c Rune to translate Returns Type Description Rune | Edit this page View Source Move(int, int) Moves the cursor to the specified column and row. Declaration public abstract void Move(int col, int row) Parameters Type Name Description int col Column to move the cursor to. int row Row to move the cursor to. | Edit this page View Source PrepareToRun(MainLoop, Action<KeyEvent>, Action<KeyEvent>, Action<KeyEvent>, Action<MouseEvent>) Prepare the driver and set the key and mouse events handlers. Declaration public abstract void PrepareToRun(MainLoop mainLoop, Action<KeyEvent> keyHandler, Action<KeyEvent> keyDownHandler, Action<KeyEvent> keyUpHandler, Action<MouseEvent> mouseHandler) Parameters Type Name Description MainLoop mainLoop The main loop. Action<KeyEvent> keyHandler The handler for ProcessKey Action<KeyEvent> keyDownHandler The handler for key down events Action<KeyEvent> keyUpHandler The handler for key up events Action<MouseEvent> mouseHandler The handler for mouse events | Edit this page View Source Refresh() Updates the screen to reflect all the changes that have been done to the display buffer Declaration public abstract void Refresh() | Edit this page View Source ResizeScreen() Resizes the clip area when the screen is resized. Declaration public abstract void ResizeScreen() | Edit this page View Source SendKeys(char, ConsoleKey, bool, bool, bool) Allows sending keys without typing on a keyboard. Declaration public abstract void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control) Parameters Type Name Description char keyChar The character key. ConsoleKey key The key. bool shift If shift key is sending. bool alt If alt key is sending. bool control If control key is sending. | Edit this page View Source SetAttribute(Attribute) Selects the specified attribute as the attribute to use for future calls to AddRune and AddString. Declaration public virtual void SetAttribute(Attribute c) Parameters Type Name Description Attribute c C. Remarks Implementations should call base.SetAttribute(c). | Edit this page View Source SetColors(ConsoleColor, ConsoleColor) Set Colors from limit sets of colors. Not implemented by any driver: See Issue #2300. Declaration public abstract void SetColors(ConsoleColor foreground, ConsoleColor background) Parameters Type Name Description ConsoleColor foreground Foreground. ConsoleColor background Background. | Edit this page View Source SetColors(short, short) Advanced uses - set colors to any pre-set pairs, you would need to init_color that independently with the R, G, B values. Not implemented by any driver: See Issue #2300. Declaration public abstract void SetColors(short foregroundColorId, short backgroundColorId) Parameters Type Name Description short foregroundColorId Foreground color identifier. short backgroundColorId Background color identifier. | Edit this page View Source SetCursorVisibility(CursorVisibility) Change the cursor caret visibility Declaration public abstract bool SetCursorVisibility(CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The wished CursorVisibility Returns Type Description bool true upon success | Edit this page View Source SetTerminalResized(Action) Set the handler when the terminal is resized. Declaration public void SetTerminalResized(Action terminalResized) Parameters Type Name Description Action terminalResized | Edit this page View Source StartReportingMouseMoves() Start of mouse moves. Declaration public abstract void StartReportingMouseMoves() | Edit this page View Source StopReportingMouseMoves() Stop reporting mouses moves. Declaration public abstract void StopReportingMouseMoves() | Edit this page View Source Suspend() Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver. Declaration public abstract void Suspend() | Edit this page View Source UncookMouse() Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked. Not implemented by any driver: See Issue #2300. Declaration public abstract void UncookMouse() | Edit this page View Source UpdateCursor() Updates the location of the cursor position Declaration public abstract void UpdateCursor() | Edit this page View Source UpdateOffScreen() Reset and recreate the contents and the driver buffer. Declaration public abstract void UpdateOffScreen() | Edit this page View Source UpdateScreen() Redraws the physical screen with the contents that have been queued up via any of the printing commands. Declaration public abstract void UpdateScreen()"
  },
  "api/Terminal.Gui/Terminal.Gui.ConsoleKeyMapping.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ConsoleKeyMapping.html",
    "title": "Class ConsoleKeyMapping",
    "keywords": "Class ConsoleKeyMapping Helper class to handle the scan code and virtual key from a ConsoleKey. Inheritance object ConsoleKeyMapping Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class ConsoleKeyMapping Methods | Edit this page View Source GetConsoleKeyFromKey(uint, ConsoleModifiers, out uint, out uint) Get the ConsoleKey from a Key. Declaration public static uint GetConsoleKeyFromKey(uint keyValue, ConsoleModifiers modifiers, out uint scanCode, out uint outputChar) Parameters Type Name Description uint keyValue The key value. ConsoleModifiers modifiers The modifiers keys. uint scanCode The resulting scan code. uint outputChar The resulting output character. Returns Type Description uint The ConsoleKey or the outputChar. | Edit this page View Source GetKeyCharFromConsoleKey(uint, ConsoleModifiers, out uint, out uint) Get the output character from the ConsoleKey. Declaration public static uint GetKeyCharFromConsoleKey(uint unicodeChar, ConsoleModifiers modifiers, out uint consoleKey, out uint scanCode) Parameters Type Name Description uint unicodeChar The unicode character. ConsoleModifiers modifiers The modifiers keys. uint consoleKey The resulting console key. uint scanCode The resulting scan code. Returns Type Description uint The output character or the consoleKey. | Edit this page View Source MapConsoleKeyToKey(ConsoleKey, out bool) Maps a ConsoleKey to a Key. Declaration public static Key MapConsoleKeyToKey(ConsoleKey consoleKey, out bool isMappable) Parameters Type Name Description ConsoleKey consoleKey The console key. bool isMappable If true is mapped to a valid character, otherwise false. Returns Type Description Key The Key or the consoleKey. | Edit this page View Source MapKeyModifiers(ConsoleKeyInfo, Key) Maps a ConsoleKeyInfo to a Key. Declaration public static Key MapKeyModifiers(ConsoleKeyInfo keyInfo, Key key) Parameters Type Name Description ConsoleKeyInfo keyInfo The console key info. Key key The key. Returns Type Description Key The Key with ConsoleModifiers or the key | Edit this page View Source MapKeyToConsoleKey(uint, out bool) Maps a Key to a ConsoleKey. Declaration public static uint MapKeyToConsoleKey(uint keyValue, out bool isMappable) Parameters Type Name Description uint keyValue The key value. bool isMappable If true is mapped to a valid character, otherwise false. Returns Type Description uint The ConsoleKey or the keyValue."
  },
  "api/Terminal.Gui/Terminal.Gui.ContextMenu.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ContextMenu.html",
    "title": "Class ContextMenu",
    "keywords": "Class ContextMenu ContextMenu provides a pop-up menu that can be positioned anywhere within a View. ContextMenu is analogous to MenuBar and, once activated, works like a sub-menu of a MenuBarItem (but can be positioned anywhere). By default, a ContextMenu with sub-menus is displayed in a cascading manner, where each sub-menu pops out of the ContextMenu frame (either to the right or left, depending on where the ContextMenu is relative to the edge of the screen). By setting UseSubMenusSingleFrame to true, this behavior can be changed such that all sub-menus are drawn within the ContextMenu frame. ContextMenus can be activated using the Shift-F10 key (by default; use the Key to change to another key). Callers can cause the ContextMenu to be activated on a right-mouse click (or other interaction) by calling Show(). ContextMenus are located using screen using screen coordinates and appear above all other Views. Inheritance object ContextMenu Implements IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public sealed class ContextMenu : IDisposable Constructors | Edit this page View Source ContextMenu() Initializes a context menu with no menu items. Declaration public ContextMenu() | Edit this page View Source ContextMenu(int, int, MenuBarItem) Initializes a context menu with menu items at a specific screen location. Declaration public ContextMenu(int x, int y, MenuBarItem menuItems) Parameters Type Name Description int x The left position (screen relative). int y The top position (screen relative). MenuBarItem menuItems The menu items. | Edit this page View Source ContextMenu(View, MenuBarItem) Initializes a context menu, with a View specifiying the parent/hose of the menu. Declaration public ContextMenu(View host, MenuBarItem menuItems) Parameters Type Name Description View host The host view. MenuBarItem menuItems The menu items for the context menu. Properties | Edit this page View Source ForceMinimumPosToZero Sets or gets whether the context menu be forced to the right, ensuring it is not clipped, if the x position is less than zero. The default is true which means the context menu will be forced to the right. If set to false, the context menu will be clipped on the left if x is less than zero. Declaration public bool ForceMinimumPosToZero { get; set; } Property Value Type Description bool | Edit this page View Source Host The host View which position will be used, otherwise if it's null the container will be used. Declaration public View Host { get; set; } Property Value Type Description View | Edit this page View Source IsShow Gets whether the ContextMenu is showing or not. Declaration public static bool IsShow { get; } Property Value Type Description bool | Edit this page View Source Key Key specifies they keyboard key that will activate the context menu with the keyboard. Declaration public Key Key { get; set; } Property Value Type Description Key | Edit this page View Source MenuBar Gets the MenuBar that is hosting this context menu. Declaration public MenuBar MenuBar { get; } Property Value Type Description MenuBar | Edit this page View Source MenuItems Gets or sets the menu items for this context menu. Declaration public MenuBarItem MenuItems { get; set; } Property Value Type Description MenuBarItem | Edit this page View Source MouseFlags MouseFlags specifies the mouse action used to activate the context menu by mouse. Declaration public MouseFlags MouseFlags { get; set; } Property Value Type Description MouseFlags | Edit this page View Source Position Gets or sets the menu position. Declaration public Point Position { get; set; } Property Value Type Description Point | Edit this page View Source UseSubMenusSingleFrame Gets or sets if sub-menus will be displayed using a \"single frame\" menu style. If true, the ContextMenu and any sub-menus that would normally cascade will be displayed within a single frame. If false (the default), sub-menus will cascade using separate frames for each level of the menu hierarchy. Declaration public bool UseSubMenusSingleFrame { get; set; } Property Value Type Description bool Methods | Edit this page View Source Dispose() Disposes the context menu object. Declaration public void Dispose() | Edit this page View Source Hide() Hides (closes) the ContextMenu. Declaration public void Hide() | Edit this page View Source Show() Shows (opens) the ContextMenu, displaying the MenuItems it contains. Declaration public void Show() Events | Edit this page View Source KeyChanged Event invoked when the Key is changed. Declaration public event Action<Key> KeyChanged Event Type Type Description Action<Key> | Edit this page View Source MouseFlagsChanged Event invoked when the MouseFlags is changed. Declaration public event Action<MouseFlags> MouseFlagsChanged Event Type Type Description Action<MouseFlags> Implements IDisposable"
  },
  "api/Terminal.Gui/Terminal.Gui.CursorVisibility.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.CursorVisibility.html",
    "title": "Enum CursorVisibility",
    "keywords": "Enum CursorVisibility Cursors Visibility that are displayed Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum CursorVisibility Fields Name Description Box Cursor caret is displayed as a blinking block ▉ BoxFix Cursor caret is displayed a block ▉ Default Cursor caret has default Invisible Cursor caret is hidden Underline Cursor caret is normally shown as a blinking underline bar _ UnderlineFix Cursor caret is normally shown as a underline bar _ Vertical Cursor caret is displayed a blinking vertical bar | VerticalFix Cursor caret is displayed a blinking vertical bar |"
  },
  "api/Terminal.Gui/Terminal.Gui.DateField.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.DateField.html",
    "title": "Class DateField",
    "keywords": "Class DateField Simple Date editing View Inheritance object Responder View TextField DateField Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanging TextField.TextChanged TextField.OnLeave(View) TextField.Autocomplete TextField.Frame TextField.Text TextField.Secret TextField.ScrollOffset TextField.IsDirty TextField.HasHistoryChanges TextField.ContextMenu TextField.PositionCursor() TextField.Redraw(Rect) TextField.GetNormalColor() TextField.CanFocus TextField.KillWordBackwards() TextField.KillWordForwards() TextField.SelectAll() TextField.DeleteAll() TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() TextField.OnTextChanging(ustring) TextField.DesiredCursorVisibility TextField.OnEnter(View) TextField.InsertText(string, bool) TextField.ClearHistoryChanges() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class DateField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The DateField View provides date editing functionality with mouse support. Constructors | Edit this page View Source DateField() Initializes a new instance of DateField using Computed layout. Declaration public DateField() | Edit this page View Source DateField(DateTime) Initializes a new instance of DateField using Computed layout. Declaration public DateField(DateTime date) Parameters Type Name Description DateTime date | Edit this page View Source DateField(int, int, DateTime, bool) Initializes a new instance of DateField using Absolute layout. Declaration public DateField(int x, int y, DateTime date, bool isShort = false) Parameters Type Name Description int x The x coordinate. int y The y coordinate. DateTime date Initial date contents. bool isShort If true, shows only two digits for the year. Properties | Edit this page View Source CursorPosition Sets or gets the current cursor position. Declaration public override int CursorPosition { get; set; } Property Value Type Description int Overrides TextField.CursorPosition | Edit this page View Source Date Gets or sets the date of the DateField. Declaration public DateTime Date { get; set; } Property Value Type Description DateTime | Edit this page View Source IsShortFormat Get or set the date format for the widget. Declaration public bool IsShortFormat { get; set; } Property Value Type Description bool Methods | Edit this page View Source DeleteCharLeft(bool) Deletes the left character. Declaration public override void DeleteCharLeft(bool useOldCursorPos = true) Parameters Type Name Description bool useOldCursorPos Overrides TextField.DeleteCharLeft(bool) | Edit this page View Source DeleteCharRight() Deletes the right character. Declaration public override void DeleteCharRight() Overrides TextField.DeleteCharRight() | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description bool true, if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) | Edit this page View Source OnDateChanged(DateTimeEventArgs<DateTime>) Event firing method for the DateChanged event. Declaration public virtual void OnDateChanged(DateTimeEventArgs<DateTime> args) Parameters Type Name Description DateTimeEventArgs<DateTime> args Event arguments | Edit this page View Source ProcessKey(KeyEvent) Processes key presses for the TextField. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete, Backspace Deletes the character before cursor. Events | Edit this page View Source DateChanged DateChanged event, raised when the Date property has changed. Declaration public event Action<DateTimeEventArgs<DateTime>> DateChanged Event Type Type Description Action<DateTimeEventArgs<DateTime>> Remarks This event is raised when the Date property changes. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html",
    "title": "Class DateTimeEventArgs<T>",
    "keywords": "Class DateTimeEventArgs<T> Defines the event arguments for DateChanged and TimeChanged events. Inheritance object EventArgs DateTimeEventArgs<T> Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class DateTimeEventArgs<T> : EventArgs Type Parameters Name Description T Constructors | Edit this page View Source DateTimeEventArgs(T, T, string) Initializes a new instance of DateTimeEventArgs<T> Declaration public DateTimeEventArgs(T oldValue, T newValue, string format) Parameters Type Name Description T oldValue The old DateField or TimeField value. T newValue The new DateField or TimeField value. string format The DateField or TimeField format string. Properties | Edit this page View Source Format The DateField or TimeField format. Declaration public string Format { get; } Property Value Type Description string | Edit this page View Source NewValue The new DateField or TimeField value. Declaration public T NewValue { get; } Property Value Type Description T | Edit this page View Source OldValue The old DateField or TimeField value. Declaration public T OldValue { get; } Property Value Type Description T"
  },
  "api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html",
    "title": "Enum Dialog.ButtonAlignments",
    "keywords": "Enum Dialog.ButtonAlignments Determines the horizontal alignment of the Dialog buttons. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum Dialog.ButtonAlignments Fields Name Description Center Center-aligns the buttons (the default). Justify Justifies the buttons Left Left-aligns the buttons Right Right-aligns the buttons"
  },
  "api/Terminal.Gui/Terminal.Gui.Dialog.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Dialog.html",
    "title": "Class Dialog",
    "keywords": "Class Dialog The Dialog View is a Window that by default is centered and contains one or more Buttons. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Inheritance object Responder View Toplevel Window Dialog FileDialog Wizard Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To run the Dialog modally, create the Dialog, and pass it to Run(Func<Exception, bool>). This will execute the dialog until it terminates via the [ESC] or [CTRL-Q] key, or when one of the views or buttons added to the dialog calls RequestStop(Toplevel). Constructors | Edit this page View Source Dialog() Initializes a new instance of the Dialog class using Computed. Declaration public Dialog() Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialization use X, Y, Width, and Height to override this with a location or size. Use AddButton(Button) to add buttons to the dialog. | Edit this page View Source Dialog(ustring, int, int, params Button[]) Initializes a new instance of the Dialog class using Computed positioning and an optional set of Buttons to display Declaration public Dialog(ustring title, int width, int height, params Button[] buttons) Parameters Type Name Description ustring title Title for the dialog. int width Width for the dialog. int height Height for the dialog. Button[] buttons Optional buttons to lay out at the bottom of the dialog. Remarks if width and height are both 0, the Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialization use X, Y, Width, and Height to override this with a location or size. | Edit this page View Source Dialog(ustring, params Button[]) Initializes a new instance of the Dialog class using Computed positioning and with an optional set of Buttons to display Declaration public Dialog(ustring title, params Button[] buttons) Parameters Type Name Description ustring title Title for the dialog. Button[] buttons Optional buttons to lay out at the bottom of the dialog. Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialization use X, Y, Width, and Height to override this with a location or size. Properties | Edit this page View Source ButtonAlignment Determines how the Dialog Buttons are aligned along the bottom of the dialog. Declaration public Dialog.ButtonAlignments ButtonAlignment { get; set; } Property Value Type Description Dialog.ButtonAlignments Methods | Edit this page View Source AddButton(Button) Adds a Button to the Dialog, its layout will be controlled by the Dialog Declaration public void AddButton(Button button) Parameters Type Name Description Button button Button to add. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides Toplevel.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Dim.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Dim.html",
    "title": "Class Dim",
    "keywords": "Class Dim Dim properties of a View to control the position. Inheritance object Dim Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Dim Remarks Use the Dim objects on the Width or Height properties of a View to control the position. These can be used to set the absolute position, when merely assigning an integer value (via the implicit integer to Pos conversion), and they can be combined to produce more useful layouts, like: Pos.Center - 3, which would shift the position of the View 3 characters to the left after centering for example. Methods | Edit this page View Source Equals(object) Determines whether the specified object is equal to the current object. Declaration public override bool Equals(object other) Parameters Type Name Description object other The object to compare with the current object. Returns Type Description bool true if the specified object is equal to the current object; otherwise, false. Overrides object.Equals(object) | Edit this page View Source Fill(int) Initializes a new instance of the Dim class that fills the dimension, but leaves the specified number of colums for a margin. Declaration public static Dim Fill(int margin = 0) Parameters Type Name Description int margin Margin to use. Returns Type Description Dim The Fill dimension. | Edit this page View Source Function(Func<int>) Creates a \"DimFunc\" from the specified function. Declaration public static Dim Function(Func<int> function) Parameters Type Name Description Func<int> function The function to be executed. Returns Type Description Dim The Dim returned from the function. | Edit this page View Source GetHashCode() Serves as the default hash function. Declaration public override int GetHashCode() Returns Type Description int A hash code for the current object. Overrides object.GetHashCode() | Edit this page View Source Height(View) Returns a Dim object tracks the Height of the specified View. Declaration public static Dim Height(View view) Parameters Type Name Description View view The view that will be tracked. Returns Type Description Dim The Dim of the other View. | Edit this page View Source Percent(float, bool) Creates a percentage Dim object Declaration public static Dim Percent(float n, bool r = false) Parameters Type Name Description float n A value between 0 and 100 representing the percentage. bool r If true the Percent is computed based on the remaining space after the X/Y anchor positions. If false is computed based on the whole original space. Returns Type Description Dim The percent Dim object. Examples This initializes a TextFieldthat is centered horizontally, is 50% of the way down, is 30% the height, and is 80% the width of the View it added to. var textView = new TextView () { X = Pos.Center (), Y = Pos.Percent (50), Width = Dim.Percent (80), Height = Dim.Percent (30), }; | Edit this page View Source Sized(int) Creates an Absolute Dim from the specified integer value. Declaration public static Dim Sized(int n) Parameters Type Name Description int n The value to convert to the Dim. Returns Type Description Dim The Absolute Dim. | Edit this page View Source Width(View) Returns a Dim object tracks the Width of the specified View. Declaration public static Dim Width(View view) Parameters Type Name Description View view The view that will be tracked. Returns Type Description Dim The Dim of the other View. Operators | Edit this page View Source operator +(Dim, Dim) Adds a Dim to a Dim, yielding a new Dim. Declaration public static Dim operator +(Dim left, Dim right) Parameters Type Name Description Dim left The first Dim to add. Dim right The second Dim to add. Returns Type Description Dim The Dim that is the sum of the values of left and right. | Edit this page View Source implicit operator Dim(int) Creates an Absolute Dim from the specified integer value. Declaration public static implicit operator Dim(int n) Parameters Type Name Description int n The value to convert to the pos. Returns Type Description Dim The Absolute Dim. | Edit this page View Source operator -(Dim, Dim) Subtracts a Dim from a Dim, yielding a new Dim. Declaration public static Dim operator -(Dim left, Dim right) Parameters Type Name Description Dim left The Dim to subtract from (the minuend). Dim right The Dim to subtract (the subtrahend). Returns Type Description Dim The Dim that is the left minus right."
  },
  "api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html",
    "title": "Enum DisplayModeLayout",
    "keywords": "Enum DisplayModeLayout Used for choose the display mode of this RadioGroup Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum DisplayModeLayout Fields Name Description Horizontal Horizontal mode display. Vertical Vertical mode display. It's the default."
  },
  "api/Terminal.Gui/Terminal.Gui.EscSeqReqProc.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.EscSeqReqProc.html",
    "title": "Class EscSeqReqProc",
    "keywords": "Class EscSeqReqProc Manages a list of EscSeqReqStatus. Inheritance object EscSeqReqProc Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class EscSeqReqProc Properties | Edit this page View Source EscSeqReqStats Gets the EscSeqReqStatus list. Declaration public List<EscSeqReqStatus> EscSeqReqStats { get; } Property Value Type Description List<EscSeqReqStatus> Methods | Edit this page View Source Add(string, int) Adds a new EscSeqReqStatus instance to the EscSeqReqStats list. Declaration public void Add(string terminating, int numOfReq = 1) Parameters Type Name Description string terminating The terminating. int numOfReq The number of requests. | Edit this page View Source Remove(string) Removes a EscSeqReqStatus instance from the EscSeqReqStats list. Declaration public void Remove(string terminating) Parameters Type Name Description string terminating The terminating string. | Edit this page View Source Requested(string) Indicates if a EscSeqReqStatus with the terminating exist in the EscSeqReqStats list. Declaration public bool Requested(string terminating) Parameters Type Name Description string terminating Returns Type Description bool true if exist, false otherwise."
  },
  "api/Terminal.Gui/Terminal.Gui.EscSeqReqStatus.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.EscSeqReqStatus.html",
    "title": "Class EscSeqReqStatus",
    "keywords": "Class EscSeqReqStatus Represents the state of an ANSI escape sequence request. Inheritance object EscSeqReqStatus Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class EscSeqReqStatus Remarks This is needed because there are some escape sequence requests responses that are equal with some normal escape sequences and thus, will be only considered the responses to the requests that were registered with this object. Constructors | Edit this page View Source EscSeqReqStatus(string, int) Creates a new state of escape sequence request. Declaration public EscSeqReqStatus(string terminating, int numOfReq) Parameters Type Name Description string terminating The terminating. int numOfReq The number of requests. Properties | Edit this page View Source NumOutstanding Gets information about unfinished requests. Declaration public int NumOutstanding { get; set; } Property Value Type Description int | Edit this page View Source NumRequests Gets the number of requests. Declaration public int NumRequests { get; } Property Value Type Description int | Edit this page View Source Terminating Gets the terminating. Declaration public string Terminating { get; } Property Value Type Description string"
  },
  "api/Terminal.Gui/Terminal.Gui.EscSeqUtils.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.EscSeqUtils.html",
    "title": "Class EscSeqUtils",
    "keywords": "Class EscSeqUtils Provides a platform-independent API for managing ANSI escape sequence codes. Inheritance object EscSeqUtils Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class EscSeqUtils Fields | Edit this page View Source CSI_DisableAnyEventMouse Represents the CSI for disable any mouse event tracking. Declaration public static readonly string CSI_DisableAnyEventMouse Field Value Type Description string | Edit this page View Source CSI_DisableSgrExtModeMouse Represents the CSI for disable SGR (Select Graphic Rendition). Declaration public static readonly string CSI_DisableSgrExtModeMouse Field Value Type Description string | Edit this page View Source CSI_DisableUrxvtExtModeMouse Represents the CSI for disable URXVT (Unicode Extended Virtual Terminal). Declaration public static readonly string CSI_DisableUrxvtExtModeMouse Field Value Type Description string | Edit this page View Source CSI_EnableAnyEventMouse Represents the CSI for enable any mouse event tracking. Declaration public static readonly string CSI_EnableAnyEventMouse Field Value Type Description string | Edit this page View Source CSI_EnableSgrExtModeMouse Represents the CSI for enable SGR (Select Graphic Rendition). Declaration public static readonly string CSI_EnableSgrExtModeMouse Field Value Type Description string | Edit this page View Source CSI_EnableUrxvtExtModeMouse Represents the CSI for enable URXVT (Unicode Extended Virtual Terminal). Declaration public static readonly string CSI_EnableUrxvtExtModeMouse Field Value Type Description string | Edit this page View Source KeyCSI Represents the CSI (Control Sequence Introducer). Declaration public static readonly string KeyCSI Field Value Type Description string | Edit this page View Source KeyEsc Represents the escape key. Declaration public static readonly char KeyEsc Field Value Type Description char Properties | Edit this page View Source DisableMouseEvents Control sequence for disable mouse events. Declaration public static string DisableMouseEvents { get; set; } Property Value Type Description string | Edit this page View Source EnableMouseEvents Control sequence for enable mouse events. Declaration public static string EnableMouseEvents { get; set; } Property Value Type Description string Methods | Edit this page View Source DecodeEscSeq(EscSeqReqProc, ref ConsoleKeyInfo, ref ConsoleKey, ConsoleKeyInfo[], ref ConsoleModifiers, out string, out string, out string[], out string, out bool, out List<MouseFlags>, out Point, out bool, Action<MouseFlags, Point>) Decodes a escape sequence to been processed in the appropriate manner. Declaration public static void DecodeEscSeq(EscSeqReqProc escSeqReqProc, ref ConsoleKeyInfo newConsoleKeyInfo, ref ConsoleKey key, ConsoleKeyInfo[] cki, ref ConsoleModifiers mod, out string c1Control, out string code, out string[] values, out string terminating, out bool isKeyMouse, out List<MouseFlags> buttonState, out Point pos, out bool isReq, Action<MouseFlags, Point> continuousButtonPressedHandler) Parameters Type Name Description EscSeqReqProc escSeqReqProc The EscSeqReqProc which may contain a request. ConsoleKeyInfo newConsoleKeyInfo The ConsoleKeyInfo which may changes. ConsoleKey key The ConsoleKey which may changes. ConsoleKeyInfo[] cki The ConsoleKeyInfo array. ConsoleModifiers mod The ConsoleModifiers which may changes. string c1Control The control returned by the GetC1ControlChar(char) method. string code The code returned by the GetEscapeResult(char[]) method. string[] values The values returned by the GetEscapeResult(char[]) method. string terminating The terminating returned by the GetEscapeResult(char[]) method. bool isKeyMouse Indicates if the escape sequence is a mouse key. List<MouseFlags> buttonState The MouseFlags button state. Point pos The MouseFlags position. bool isReq Indicates if the escape sequence is a response to a request. Action<MouseFlags, Point> continuousButtonPressedHandler The handler that will process the event. | Edit this page View Source GetC1ControlChar(char) Gets the c1Control used in the called escape sequence. Declaration public static string GetC1ControlChar(char c) Parameters Type Name Description char c The char used. Returns Type Description string The c1Control. | Edit this page View Source GetConsoleInputKey(ConsoleKeyInfo) Ensures a console key is mapped to one that works correctly with ANSI escape sequences. Declaration public static ConsoleKeyInfo GetConsoleInputKey(ConsoleKeyInfo consoleKeyInfo) Parameters Type Name Description ConsoleKeyInfo consoleKeyInfo The ConsoleKeyInfo. Returns Type Description ConsoleKeyInfo The ConsoleKeyInfo modified. | Edit this page View Source GetConsoleKey(char, string, ref ConsoleModifiers) Gets the ConsoleKey depending on terminating and value. Declaration public static ConsoleKey GetConsoleKey(char terminating, string value, ref ConsoleModifiers mod) Parameters Type Name Description char terminating The terminating. string value The value. ConsoleModifiers mod The ConsoleModifiers which may changes. Returns Type Description ConsoleKey The ConsoleKey and probably the ConsoleModifiers. | Edit this page View Source GetConsoleModifiers(string) Gets the ConsoleModifiers from the value. Declaration public static ConsoleModifiers GetConsoleModifiers(string value) Parameters Type Name Description string value The value. Returns Type Description ConsoleModifiers The ConsoleModifiers or zero. | Edit this page View Source GetEscapeResult(char[]) Gets all the needed information about a escape sequence. Declaration public static (string c1Control, string code, string[] values, string terminating) GetEscapeResult(char[] kChar) Parameters Type Name Description char[] kChar The array with all chars. Returns Type Description (string c1Control, string code, string[] values, string terminating) The c1Control returned by GetC1ControlChar(char), code, values and terminating. | Edit this page View Source GetKeyCharArray(ConsoleKeyInfo[]) A helper to get only the KeyChar from the ConsoleKeyInfo array. Declaration public static char[] GetKeyCharArray(ConsoleKeyInfo[] cki) Parameters Type Name Description ConsoleKeyInfo[] cki Returns Type Description char[] The char array of the escape sequence. | Edit this page View Source GetMouse(ConsoleKeyInfo[], out List<MouseFlags>, out Point, Action<MouseFlags, Point>) Gets the MouseFlags mouse button flags and the position. Declaration public static void GetMouse(ConsoleKeyInfo[] cki, out List<MouseFlags> mouseFlags, out Point pos, Action<MouseFlags, Point> continuousButtonPressedHandler) Parameters Type Name Description ConsoleKeyInfo[] cki The ConsoleKeyInfo array. List<MouseFlags> mouseFlags The mouse button flags. Point pos The mouse position. Action<MouseFlags, Point> continuousButtonPressedHandler The handler that will process the event. | Edit this page View Source GetParentProcess(Process) Get the terminal that holds the console driver. Declaration public static Process GetParentProcess(Process process) Parameters Type Name Description Process process The process. Returns Type Description Process If supported the executable console process, null otherwise. | Edit this page View Source ResizeArray(ConsoleKeyInfo, ConsoleKeyInfo[]) A helper to resize the ConsoleKeyInfo as needed. Declaration public static ConsoleKeyInfo[] ResizeArray(ConsoleKeyInfo consoleKeyInfo, ConsoleKeyInfo[] cki) Parameters Type Name Description ConsoleKeyInfo consoleKeyInfo The ConsoleKeyInfo. ConsoleKeyInfo[] cki The ConsoleKeyInfo array to resize. Returns Type Description ConsoleKeyInfo[] The ConsoleKeyInfo resized."
  },
  "api/Terminal.Gui/Terminal.Gui.FakeConsole.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.FakeConsole.html",
    "title": "Class FakeConsole",
    "keywords": "Class FakeConsole Inheritance object FakeConsole Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class FakeConsole Fields | Edit this page View Source HEIGHT Specifies the initial console height. Declaration public const int HEIGHT = 25 Field Value Type Description int | Edit this page View Source MockKeyPresses Declaration public static Stack<ConsoleKeyInfo> MockKeyPresses Field Value Type Description Stack<ConsoleKeyInfo> | Edit this page View Source WIDTH Specifies the initial console width. Declaration public const int WIDTH = 80 Field Value Type Description int Properties | Edit this page View Source BackgroundColor Declaration public static ConsoleColor BackgroundColor { get; set; } Property Value Type Description ConsoleColor | Edit this page View Source BufferHeight Declaration public static int BufferHeight { get; set; } Property Value Type Description int | Edit this page View Source BufferWidth Declaration public static int BufferWidth { get; set; } Property Value Type Description int | Edit this page View Source CapsLock Declaration public static bool CapsLock { get; } Property Value Type Description bool | Edit this page View Source CursorLeft Declaration public static int CursorLeft { get; set; } Property Value Type Description int | Edit this page View Source CursorSize Declaration public static int CursorSize { get; set; } Property Value Type Description int | Edit this page View Source CursorTop Declaration public static int CursorTop { get; set; } Property Value Type Description int | Edit this page View Source CursorVisible Declaration public static bool CursorVisible { get; set; } Property Value Type Description bool | Edit this page View Source Error Declaration public static TextWriter Error { get; } Property Value Type Description TextWriter | Edit this page View Source ForegroundColor Declaration public static ConsoleColor ForegroundColor { get; set; } Property Value Type Description ConsoleColor | Edit this page View Source In Declaration public static TextReader In { get; } Property Value Type Description TextReader | Edit this page View Source InputEncoding Declaration public static Encoding InputEncoding { get; set; } Property Value Type Description Encoding | Edit this page View Source IsErrorRedirected Declaration public static bool IsErrorRedirected { get; } Property Value Type Description bool | Edit this page View Source IsInputRedirected Declaration public static bool IsInputRedirected { get; } Property Value Type Description bool | Edit this page View Source IsOutputRedirected Declaration public static bool IsOutputRedirected { get; } Property Value Type Description bool | Edit this page View Source KeyAvailable Declaration public static bool KeyAvailable { get; } Property Value Type Description bool | Edit this page View Source LargestWindowHeight Declaration public static int LargestWindowHeight { get; } Property Value Type Description int | Edit this page View Source LargestWindowWidth Declaration public static int LargestWindowWidth { get; } Property Value Type Description int | Edit this page View Source NumberLock Declaration public static bool NumberLock { get; } Property Value Type Description bool | Edit this page View Source Out Declaration public static TextWriter Out { get; } Property Value Type Description TextWriter | Edit this page View Source OutputEncoding Declaration public static Encoding OutputEncoding { get; set; } Property Value Type Description Encoding | Edit this page View Source Title Declaration public static string Title { get; set; } Property Value Type Description string | Edit this page View Source TreatControlCAsInput Declaration public static bool TreatControlCAsInput { get; set; } Property Value Type Description bool | Edit this page View Source WindowHeight Declaration public static int WindowHeight { get; set; } Property Value Type Description int | Edit this page View Source WindowLeft Declaration public static int WindowLeft { get; set; } Property Value Type Description int | Edit this page View Source WindowTop Declaration public static int WindowTop { get; set; } Property Value Type Description int | Edit this page View Source WindowWidth Declaration public static int WindowWidth { get; set; } Property Value Type Description int Methods | Edit this page View Source Beep() Declaration public static void Beep() | Edit this page View Source Beep(int, int) Declaration public static void Beep(int frequency, int duration) Parameters Type Name Description int frequency int duration | Edit this page View Source Clear() Declaration public static void Clear() | Edit this page View Source MoveBufferArea(int, int, int, int, int, int) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop) Parameters Type Name Description int sourceLeft int sourceTop int sourceWidth int sourceHeight int targetLeft int targetTop | Edit this page View Source MoveBufferArea(int, int, int, int, int, int, char, ConsoleColor, ConsoleColor) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop, char sourceChar, ConsoleColor sourceForeColor, ConsoleColor sourceBackColor) Parameters Type Name Description int sourceLeft int sourceTop int sourceWidth int sourceHeight int targetLeft int targetTop char sourceChar ConsoleColor sourceForeColor ConsoleColor sourceBackColor | Edit this page View Source OpenStandardError() Declaration public static Stream OpenStandardError() Returns Type Description Stream | Edit this page View Source OpenStandardError(int) Declaration public static Stream OpenStandardError(int bufferSize) Parameters Type Name Description int bufferSize Returns Type Description Stream | Edit this page View Source OpenStandardInput() Declaration public static Stream OpenStandardInput() Returns Type Description Stream | Edit this page View Source OpenStandardInput(int) Declaration public static Stream OpenStandardInput(int bufferSize) Parameters Type Name Description int bufferSize Returns Type Description Stream | Edit this page View Source OpenStandardOutput() Declaration public static Stream OpenStandardOutput() Returns Type Description Stream | Edit this page View Source OpenStandardOutput(int) Declaration public static Stream OpenStandardOutput(int bufferSize) Parameters Type Name Description int bufferSize Returns Type Description Stream | Edit this page View Source Read() Declaration public static int Read() Returns Type Description int | Edit this page View Source ReadKey() Declaration public static ConsoleKeyInfo ReadKey() Returns Type Description ConsoleKeyInfo | Edit this page View Source ReadKey(bool) Declaration public static ConsoleKeyInfo ReadKey(bool intercept) Parameters Type Name Description bool intercept Returns Type Description ConsoleKeyInfo | Edit this page View Source ReadLine() Declaration public static string ReadLine() Returns Type Description string | Edit this page View Source ResetColor() Declaration public static void ResetColor() | Edit this page View Source SetBufferSize(int, int) Declaration public static void SetBufferSize(int width, int height) Parameters Type Name Description int width int height | Edit this page View Source SetCursorPosition(int, int) Declaration public static void SetCursorPosition(int left, int top) Parameters Type Name Description int left int top | Edit this page View Source SetError(TextWriter) Declaration public static void SetError(TextWriter newError) Parameters Type Name Description TextWriter newError | Edit this page View Source SetIn(TextReader) Declaration public static void SetIn(TextReader newIn) Parameters Type Name Description TextReader newIn | Edit this page View Source SetOut(TextWriter) Declaration public static void SetOut(TextWriter newOut) Parameters Type Name Description TextWriter newOut | Edit this page View Source SetWindowPosition(int, int) Declaration public static void SetWindowPosition(int left, int top) Parameters Type Name Description int left int top | Edit this page View Source SetWindowSize(int, int) Declaration public static void SetWindowSize(int width, int height) Parameters Type Name Description int width int height | Edit this page View Source Write(bool) Declaration public static void Write(bool value) Parameters Type Name Description bool value | Edit this page View Source Write(char) Declaration public static void Write(char value) Parameters Type Name Description char value | Edit this page View Source Write(char[]) Declaration public static void Write(char[] buffer) Parameters Type Name Description char[] buffer | Edit this page View Source Write(char[], int, int) Declaration public static void Write(char[] buffer, int index, int count) Parameters Type Name Description char[] buffer int index int count | Edit this page View Source Write(decimal) Declaration public static void Write(decimal value) Parameters Type Name Description decimal value | Edit this page View Source Write(double) Declaration public static void Write(double value) Parameters Type Name Description double value | Edit this page View Source Write(int) Declaration public static void Write(int value) Parameters Type Name Description int value | Edit this page View Source Write(long) Declaration public static void Write(long value) Parameters Type Name Description long value | Edit this page View Source Write(object) Declaration public static void Write(object value) Parameters Type Name Description object value | Edit this page View Source Write(float) Declaration public static void Write(float value) Parameters Type Name Description float value | Edit this page View Source Write(string) Declaration public static void Write(string value) Parameters Type Name Description string value | Edit this page View Source Write(string, object) Declaration public static void Write(string format, object arg0) Parameters Type Name Description string format object arg0 | Edit this page View Source Write(string, object, object) Declaration public static void Write(string format, object arg0, object arg1) Parameters Type Name Description string format object arg0 object arg1 | Edit this page View Source Write(string, object, object, object) Declaration public static void Write(string format, object arg0, object arg1, object arg2) Parameters Type Name Description string format object arg0 object arg1 object arg2 | Edit this page View Source Write(string, object, object, object, object) Declaration public static void Write(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description string format object arg0 object arg1 object arg2 object arg3 | Edit this page View Source Write(string, params object[]) Declaration public static void Write(string format, params object[] arg) Parameters Type Name Description string format object[] arg | Edit this page View Source Write(uint) Declaration public static void Write(uint value) Parameters Type Name Description uint value | Edit this page View Source Write(ulong) Declaration public static void Write(ulong value) Parameters Type Name Description ulong value | Edit this page View Source WriteLine() Declaration public static void WriteLine() | Edit this page View Source WriteLine(bool) Declaration public static void WriteLine(bool value) Parameters Type Name Description bool value | Edit this page View Source WriteLine(char) Declaration public static void WriteLine(char value) Parameters Type Name Description char value | Edit this page View Source WriteLine(char[]) Declaration public static void WriteLine(char[] buffer) Parameters Type Name Description char[] buffer | Edit this page View Source WriteLine(char[], int, int) Declaration public static void WriteLine(char[] buffer, int index, int count) Parameters Type Name Description char[] buffer int index int count | Edit this page View Source WriteLine(decimal) Declaration public static void WriteLine(decimal value) Parameters Type Name Description decimal value | Edit this page View Source WriteLine(double) Declaration public static void WriteLine(double value) Parameters Type Name Description double value | Edit this page View Source WriteLine(int) Declaration public static void WriteLine(int value) Parameters Type Name Description int value | Edit this page View Source WriteLine(long) Declaration public static void WriteLine(long value) Parameters Type Name Description long value | Edit this page View Source WriteLine(object) Declaration public static void WriteLine(object value) Parameters Type Name Description object value | Edit this page View Source WriteLine(float) Declaration public static void WriteLine(float value) Parameters Type Name Description float value | Edit this page View Source WriteLine(string) Declaration public static void WriteLine(string value) Parameters Type Name Description string value | Edit this page View Source WriteLine(string, object) Declaration public static void WriteLine(string format, object arg0) Parameters Type Name Description string format object arg0 | Edit this page View Source WriteLine(string, object, object) Declaration public static void WriteLine(string format, object arg0, object arg1) Parameters Type Name Description string format object arg0 object arg1 | Edit this page View Source WriteLine(string, object, object, object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2) Parameters Type Name Description string format object arg0 object arg1 object arg2 | Edit this page View Source WriteLine(string, object, object, object, object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description string format object arg0 object arg1 object arg2 object arg3 | Edit this page View Source WriteLine(string, params object[]) Declaration public static void WriteLine(string format, params object[] arg) Parameters Type Name Description string format object[] arg | Edit this page View Source WriteLine(uint) Declaration public static void WriteLine(uint value) Parameters Type Name Description uint value | Edit this page View Source WriteLine(ulong) Declaration public static void WriteLine(ulong value) Parameters Type Name Description ulong value"
  },
  "api/Terminal.Gui/Terminal.Gui.FakeDriver.Behaviors.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.FakeDriver.Behaviors.html",
    "title": "Class FakeDriver.Behaviors",
    "keywords": "Class FakeDriver.Behaviors Inheritance object FakeDriver.Behaviors Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class FakeDriver.Behaviors Constructors | Edit this page View Source Behaviors(bool, bool, bool) Declaration public Behaviors(bool useFakeClipboard = false, bool fakeClipboardAlwaysThrowsNotSupportedException = false, bool fakeClipboardIsSupportedAlwaysTrue = false) Parameters Type Name Description bool useFakeClipboard bool fakeClipboardAlwaysThrowsNotSupportedException bool fakeClipboardIsSupportedAlwaysTrue Properties | Edit this page View Source FakeClipboardAlwaysThrowsNotSupportedException Declaration public bool FakeClipboardAlwaysThrowsNotSupportedException { get; } Property Value Type Description bool | Edit this page View Source FakeClipboardIsSupportedAlwaysFalse Declaration public bool FakeClipboardIsSupportedAlwaysFalse { get; } Property Value Type Description bool | Edit this page View Source UseFakeClipboard Declaration public bool UseFakeClipboard { get; } Property Value Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.FakeDriver.FakeClipboard.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.FakeDriver.FakeClipboard.html",
    "title": "Class FakeDriver.FakeClipboard",
    "keywords": "Class FakeDriver.FakeClipboard Inheritance object ClipboardBase FakeDriver.FakeClipboard Implements IClipboard Inherited Members ClipboardBase.GetClipboardData() ClipboardBase.SetClipboardData(string) ClipboardBase.TryGetClipboardData(out string) ClipboardBase.TrySetClipboardData(string) object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class FakeDriver.FakeClipboard : ClipboardBase, IClipboard Constructors | Edit this page View Source FakeClipboard(bool, bool) Declaration public FakeClipboard(bool fakeClipboardThrowsNotSupportedException = false, bool isSupportedAlwaysFalse = false) Parameters Type Name Description bool fakeClipboardThrowsNotSupportedException bool isSupportedAlwaysFalse Fields | Edit this page View Source FakeException Declaration public Exception FakeException Field Value Type Description Exception Properties | Edit this page View Source IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard Declaration public override bool IsSupported { get; } Property Value Type Description bool Overrides ClipboardBase.IsSupported Methods | Edit this page View Source GetClipboardDataImpl() Returns the contents of the OS clipboard if possible. Implemented by ConsoleDriver-specific subclasses. Declaration protected override string GetClipboardDataImpl() Returns Type Description string The contents of the OS clipboard if successful. Overrides ClipboardBase.GetClipboardDataImpl() Exceptions Type Condition NotSupportedException Thrown if it was not possible to copy from the OS clipboard. | Edit this page View Source SetClipboardDataImpl(string) Pastes the text to the OS clipboard if possible. Implemented by ConsoleDriver-specific subclasses. Declaration protected override void SetClipboardDataImpl(string text) Parameters Type Name Description string text The text to paste to the OS clipboard. Overrides ClipboardBase.SetClipboardDataImpl(string) Exceptions Type Condition NotSupportedException Thrown if it was not possible to paste to the OS clipboard. Implements IClipboard"
  },
  "api/Terminal.Gui/Terminal.Gui.FakeDriver.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.FakeDriver.html",
    "title": "Class FakeDriver",
    "keywords": "Class FakeDriver Implements a mock ConsoleDriver for unit testing Inheritance object ConsoleDriver FakeDriver Inherited Members ConsoleDriver.TerminalResized ConsoleDriver.MakePrintable(Rune) ConsoleDriver.IsValidContent(int, int, Rect) ConsoleDriver.CurrentAttribute ConsoleDriver.SetTerminalResized(Action) ConsoleDriver.DrawWindowTitle(Rect, ustring, int, int, int, int, TextAlignment) ConsoleDriver.Diagnostics ConsoleDriver.DrawWindowFrame(Rect, int, int, int, int, bool, bool, Border) ConsoleDriver.DrawFrame(Rect, int, bool) ConsoleDriver.Clip ConsoleDriver.HLine ConsoleDriver.VLine ConsoleDriver.Stipple ConsoleDriver.Diamond ConsoleDriver.ULCorner ConsoleDriver.LLCorner ConsoleDriver.URCorner ConsoleDriver.LRCorner ConsoleDriver.LeftTee ConsoleDriver.RightTee ConsoleDriver.TopTee ConsoleDriver.BottomTee ConsoleDriver.Checked ConsoleDriver.UnChecked ConsoleDriver.Selected ConsoleDriver.UnSelected ConsoleDriver.RightArrow ConsoleDriver.LeftArrow ConsoleDriver.DownArrow ConsoleDriver.UpArrow ConsoleDriver.LeftDefaultIndicator ConsoleDriver.RightDefaultIndicator ConsoleDriver.LeftBracket ConsoleDriver.RightBracket ConsoleDriver.BlocksMeterSegment ConsoleDriver.ContinuousMeterSegment ConsoleDriver.HDLine ConsoleDriver.VDLine ConsoleDriver.ULDCorner ConsoleDriver.LLDCorner ConsoleDriver.URDCorner ConsoleDriver.LRDCorner ConsoleDriver.HRLine ConsoleDriver.VRLine ConsoleDriver.ULRCorner ConsoleDriver.LLRCorner ConsoleDriver.URRCorner ConsoleDriver.LRRCorner ConsoleDriver.GetAttribute() ConsoleDriver.InitalizeColorSchemes(bool) object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class FakeDriver : ConsoleDriver Constructors | Edit this page View Source FakeDriver() Declaration public FakeDriver() Fields | Edit this page View Source FakeBehaviors Declaration public static FakeDriver.Behaviors FakeBehaviors Field Value Type Description FakeDriver.Behaviors Properties | Edit this page View Source Clipboard Get the operation system clipboard. Declaration public override IClipboard Clipboard { get; } Property Value Type Description IClipboard Overrides ConsoleDriver.Clipboard | Edit this page View Source Cols The current number of columns in the terminal. Declaration public override int Cols { get; } Property Value Type Description int Overrides ConsoleDriver.Cols | Edit this page View Source Contents Assists with testing, the format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag Declaration public override int[,,] Contents { get; } Property Value Type Description int[,,] Overrides ConsoleDriver.Contents | Edit this page View Source EnableConsoleScrolling If false (the default) the height of the Terminal.Gui application (Rows) tracks to the height of the visible console view when the console is resized. In this case scrolling in the console will be disabled and all Rows will remain visible. If true then height of the Terminal.Gui application Rows only tracks the height of the visible console view when the console is made larger (the application will only grow in height, never shrink). In this case console scrolling is enabled and the contents (Rows high) will scroll as the console scrolls. Declaration [Obsolete(\"This API is deprecated\", false)] public override bool EnableConsoleScrolling { get; set; } Property Value Type Description bool Overrides ConsoleDriver.EnableConsoleScrolling Remarks NOTE: Changes to Windows Terminal prevents this functionality from working. It only really worked on Windows 'conhost' previously. | Edit this page View Source HeightAsBuffer This API is deprecated and has no impact when enabled. Declaration [Obsolete(\"This API is deprecated\", false)] public override bool HeightAsBuffer { get; set; } Property Value Type Description bool Overrides ConsoleDriver.HeightAsBuffer | Edit this page View Source Left The current left in the terminal. Declaration public override int Left { get; } Property Value Type Description int Overrides ConsoleDriver.Left | Edit this page View Source Rows The current number of rows in the terminal. Declaration public override int Rows { get; } Property Value Type Description int Overrides ConsoleDriver.Rows | Edit this page View Source Top The current top in the terminal. Declaration public override int Top { get; } Property Value Type Description int Overrides ConsoleDriver.Top Methods | Edit this page View Source AddRune(Rune) Adds the specified rune to the display at the current cursor position. Declaration public override void AddRune(Rune rune) Parameters Type Name Description Rune rune Rune to add. Overrides ConsoleDriver.AddRune(Rune) | Edit this page View Source AddStr(ustring) Adds the str to the display at the cursor position. Declaration public override void AddStr(ustring str) Parameters Type Name Description ustring str String. Overrides ConsoleDriver.AddStr(ustring) | Edit this page View Source CookMouse() Enables the cooked event processing from the mouse driver. Not implemented by any driver: See Issue #2300. Declaration public override void CookMouse() Overrides ConsoleDriver.CookMouse() | Edit this page View Source End() Ends the execution of the console driver. Declaration public override void End() Overrides ConsoleDriver.End() | Edit this page View Source EnsureCursorVisibility() Ensure the cursor visibility Declaration public override bool EnsureCursorVisibility() Returns Type Description bool true upon success Overrides ConsoleDriver.EnsureCursorVisibility() | Edit this page View Source FromVKPacketToKConsoleKeyInfo(ConsoleKeyInfo) Declaration public ConsoleKeyInfo FromVKPacketToKConsoleKeyInfo(ConsoleKeyInfo consoleKeyInfo) Parameters Type Name Description ConsoleKeyInfo consoleKeyInfo Returns Type Description ConsoleKeyInfo | Edit this page View Source GetColors(int, out Color, out Color) Gets the foreground and background colors based on the value. Declaration public override bool GetColors(int value, out Color foreground, out Color background) Parameters Type Name Description int value The value. Color foreground The foreground. Color background The background. Returns Type Description bool Overrides ConsoleDriver.GetColors(int, out Color, out Color) | Edit this page View Source GetCursorVisibility(out CursorVisibility) Retreive the cursor caret visibility Declaration public override bool GetCursorVisibility(out CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The current CursorVisibility Returns Type Description bool true upon success Overrides ConsoleDriver.GetCursorVisibility(out CursorVisibility) | Edit this page View Source Init(Action) Initializes the driver Declaration public override void Init(Action terminalResized) Parameters Type Name Description Action terminalResized Method to invoke when the terminal is resized. Overrides ConsoleDriver.Init(Action) | Edit this page View Source MakeAttribute(Color, Color) Make the attribute for the foreground and background colors. Declaration public override Attribute MakeAttribute(Color fore, Color back) Parameters Type Name Description Color fore Foreground. Color back Background. Returns Type Description Attribute Overrides ConsoleDriver.MakeAttribute(Color, Color) | Edit this page View Source MakeColor(Color, Color) Make the Colors for the ColorScheme. Declaration public override Attribute MakeColor(Color foreground, Color background) Parameters Type Name Description Color foreground The foreground color. Color background The background color. Returns Type Description Attribute The attribute for the foreground and background colors. Overrides ConsoleDriver.MakeColor(Color, Color) | Edit this page View Source Move(int, int) Moves the cursor to the specified column and row. Declaration public override void Move(int col, int row) Parameters Type Name Description int col Column to move the cursor to. int row Row to move the cursor to. Overrides ConsoleDriver.Move(int, int) | Edit this page View Source PrepareToRun(MainLoop, Action<KeyEvent>, Action<KeyEvent>, Action<KeyEvent>, Action<MouseEvent>) Prepare the driver and set the key and mouse events handlers. Declaration public override void PrepareToRun(MainLoop mainLoop, Action<KeyEvent> keyHandler, Action<KeyEvent> keyDownHandler, Action<KeyEvent> keyUpHandler, Action<MouseEvent> mouseHandler) Parameters Type Name Description MainLoop mainLoop The main loop. Action<KeyEvent> keyHandler The handler for ProcessKey Action<KeyEvent> keyDownHandler The handler for key down events Action<KeyEvent> keyUpHandler The handler for key up events Action<MouseEvent> mouseHandler The handler for mouse events Overrides ConsoleDriver.PrepareToRun(MainLoop, Action<KeyEvent>, Action<KeyEvent>, Action<KeyEvent>, Action<MouseEvent>) | Edit this page View Source Refresh() Updates the screen to reflect all the changes that have been done to the display buffer Declaration public override void Refresh() Overrides ConsoleDriver.Refresh() | Edit this page View Source ResizeScreen() Resizes the clip area when the screen is resized. Declaration public override void ResizeScreen() Overrides ConsoleDriver.ResizeScreen() | Edit this page View Source SendKeys(char, ConsoleKey, bool, bool, bool) Allows sending keys without typing on a keyboard. Declaration public override void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control) Parameters Type Name Description char keyChar The character key. ConsoleKey key The key. bool shift If shift key is sending. bool alt If alt key is sending. bool control If control key is sending. Overrides ConsoleDriver.SendKeys(char, ConsoleKey, bool, bool, bool) | Edit this page View Source SetAttribute(Attribute) Selects the specified attribute as the attribute to use for future calls to AddRune and AddString. Declaration public override void SetAttribute(Attribute c) Parameters Type Name Description Attribute c C. Overrides ConsoleDriver.SetAttribute(Attribute) Remarks Implementations should call base.SetAttribute(c). | Edit this page View Source SetBufferSize(int, int) Declaration public void SetBufferSize(int width, int height) Parameters Type Name Description int width int height | Edit this page View Source SetColors(ConsoleColor, ConsoleColor) Set Colors from limit sets of colors. Not implemented by any driver: See Issue #2300. Declaration public override void SetColors(ConsoleColor foreground, ConsoleColor background) Parameters Type Name Description ConsoleColor foreground Foreground. ConsoleColor background Background. Overrides ConsoleDriver.SetColors(ConsoleColor, ConsoleColor) | Edit this page View Source SetColors(short, short) Advanced uses - set colors to any pre-set pairs, you would need to init_color that independently with the R, G, B values. Not implemented by any driver: See Issue #2300. Declaration public override void SetColors(short foregroundColorId, short backgroundColorId) Parameters Type Name Description short foregroundColorId Foreground color identifier. short backgroundColorId Background color identifier. Overrides ConsoleDriver.SetColors(short, short) | Edit this page View Source SetCursorVisibility(CursorVisibility) Change the cursor caret visibility Declaration public override bool SetCursorVisibility(CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The wished CursorVisibility Returns Type Description bool true upon success Overrides ConsoleDriver.SetCursorVisibility(CursorVisibility) | Edit this page View Source SetWindowPosition(int, int) Declaration public void SetWindowPosition(int left, int top) Parameters Type Name Description int left int top | Edit this page View Source SetWindowSize(int, int) Declaration public void SetWindowSize(int width, int height) Parameters Type Name Description int width int height | Edit this page View Source StartReportingMouseMoves() Start of mouse moves. Declaration public override void StartReportingMouseMoves() Overrides ConsoleDriver.StartReportingMouseMoves() | Edit this page View Source StopReportingMouseMoves() Stop reporting mouses moves. Declaration public override void StopReportingMouseMoves() Overrides ConsoleDriver.StopReportingMouseMoves() | Edit this page View Source Suspend() Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver. Declaration public override void Suspend() Overrides ConsoleDriver.Suspend() | Edit this page View Source UncookMouse() Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked. Not implemented by any driver: See Issue #2300. Declaration public override void UncookMouse() Overrides ConsoleDriver.UncookMouse() | Edit this page View Source UpdateCursor() Updates the location of the cursor position Declaration public override void UpdateCursor() Overrides ConsoleDriver.UpdateCursor() | Edit this page View Source UpdateOffScreen() Reset and recreate the contents and the driver buffer. Declaration public override void UpdateOffScreen() Overrides ConsoleDriver.UpdateOffScreen() | Edit this page View Source UpdateScreen() Redraws the physical screen with the contents that have been queued up via any of the printing commands. Declaration public override void UpdateScreen() Overrides ConsoleDriver.UpdateScreen()"
  },
  "api/Terminal.Gui/Terminal.Gui.FileDialog.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.FileDialog.html",
    "title": "Class FileDialog",
    "keywords": "Class FileDialog Base class for the OpenDialog and the SaveDialog Inheritance object Responder View Toplevel Window Dialog FileDialog OpenDialog SaveDialog Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Dialog.AddButton(Button) Dialog.ButtonAlignment Dialog.ProcessKey(KeyEvent) Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source FileDialog() Initializes a new FileDialog. Declaration public FileDialog() | Edit this page View Source FileDialog(ustring, ustring, ustring, ustring, ustring, List<string>) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameDirLabel, ustring nameFieldLabel, ustring message, List<string> allowedTypes = null) Parameters Type Name Description ustring title The title. ustring prompt The prompt. ustring nameDirLabel The name of the directory field label. ustring nameFieldLabel The name of the file field label.. ustring message The message. List<string> allowedTypes The allowed types. | Edit this page View Source FileDialog(ustring, ustring, ustring, ustring, List<string>) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message, List<string> allowedTypes = null) Parameters Type Name Description ustring title The title. ustring prompt The prompt. ustring nameFieldLabel The name of the file field label.. ustring message The message. List<string> allowedTypes The allowed types. | Edit this page View Source FileDialog(ustring, ustring, ustring, List<string>) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring message, List<string> allowedTypes) Parameters Type Name Description ustring title The title. ustring prompt The prompt. ustring message The message. List<string> allowedTypes The allowed types. Properties | Edit this page View Source AllowedFileTypes The array of filename extensions allowed, or null if all file extensions are allowed. Declaration public string[] AllowedFileTypes { get; set; } Property Value Type Description string[] The allowed file types. | Edit this page View Source AllowsOtherFileTypes Gets or sets a value indicating whether this FileDialog allows the file to be saved with a different extension Declaration public bool AllowsOtherFileTypes { get; set; } Property Value Type Description bool true if allows other file types; otherwise, false. | Edit this page View Source CanCreateDirectories Gets or sets a value indicating whether this FileDialog can create directories. Declaration public bool CanCreateDirectories { get; set; } Property Value Type Description bool true if can create directories; otherwise, false. | Edit this page View Source Canceled Check if the dialog was or not canceled. Declaration public bool Canceled { get; } Property Value Type Description bool | Edit this page View Source DirectoryPath Gets or sets the directory path for this panel Declaration public ustring DirectoryPath { get; set; } Property Value Type Description ustring The directory path. | Edit this page View Source FilePath The File path that is currently shown on the panel Declaration public ustring FilePath { get; set; } Property Value Type Description ustring The absolute file path for the file path entered. | Edit this page View Source IsExtensionHidden Gets or sets a value indicating whether this FileDialog is extension hidden. Declaration public bool IsExtensionHidden { get; set; } Property Value Type Description bool true if is extension hidden; otherwise, false. | Edit this page View Source Message Gets or sets the message displayed to the user, defaults to nothing Declaration public ustring Message { get; set; } Property Value Type Description ustring The message. | Edit this page View Source NameDirLabel Gets or sets the name of the directory field label. Declaration public ustring NameDirLabel { get; set; } Property Value Type Description ustring The name of the directory field label. | Edit this page View Source NameFieldLabel Gets or sets the name field label. Declaration public ustring NameFieldLabel { get; set; } Property Value Type Description ustring The name field label. | Edit this page View Source Prompt Gets or sets the prompt label for the Button displayed to the user Declaration public ustring Prompt { get; set; } Property Value Type Description ustring The prompt. Methods | Edit this page View Source WillPresent() Invoked by Begin(Toplevel) as part of Run(Toplevel, Func<Exception, bool>) after the views have been laid out, and before the views are drawn for the first time. Declaration public override void WillPresent() Overrides Toplevel.WillPresent() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.FrameView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.FrameView.html",
    "title": "Class FrameView",
    "keywords": "Class FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. Inheritance object Responder View FrameView Wizard.WizardStep Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class FrameView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source FrameView() Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView() | Edit this page View Source FrameView(ustring, Border) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(ustring title, Border border = null) Parameters Type Name Description ustring title Title. Border border The Border. | Edit this page View Source FrameView(Rect, ustring, View[], Border) Initializes a new instance of the FrameView class using Absolute layout. Declaration public FrameView(Rect frame, ustring title = null, View[] views = null, Border border = null) Parameters Type Name Description Rect frame Frame. ustring title Title. View[] views Views. Border border The Border. Properties | Edit this page View Source Border Declaration public override Border Border { get; set; } Property Value Type Description Border Overrides View.Border | Edit this page View Source Text The text displayed by the Label. Declaration public override ustring Text { get; set; } Property Value Type Description ustring Overrides View.Text | Edit this page View Source TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label. Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment | Edit this page View Source Title The title to be displayed for this FrameView. Declaration public ustring Title { get; set; } Property Value Type Description ustring The title. Methods | Edit this page View Source Add(View) Add the specified View to this container. Declaration public override void Add(View view) Parameters Type Name Description View view View to add to this container Overrides View.Add(View) | Edit this page View Source OnCanFocusChanged() Method invoked when the CanFocus property from a view is changed. Declaration public override void OnCanFocusChanged() Overrides View.OnCanFocusChanged() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Remove(View) Removes a View from this container. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) | Edit this page View Source RemoveAll() Removes all Views from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.GraphView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.GraphView.html",
    "title": "Class GraphView",
    "keywords": "Class GraphView Control for rendering graphs (bar, scatter etc) Inheritance object Responder View GraphView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class GraphView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source GraphView() Creates a new graph with a 1 to 1 graph space with absolute layout Declaration public GraphView() Properties | Edit this page View Source Annotations Elements drawn into graph after series have been drawn e.g. Legends etc Declaration public List<IAnnotation> Annotations { get; } Property Value Type Description List<IAnnotation> | Edit this page View Source AxisX Horizontal axis Declaration public HorizontalAxis AxisX { get; set; } Property Value Type Description HorizontalAxis | Edit this page View Source AxisY Vertical axis Declaration public VerticalAxis AxisY { get; set; } Property Value Type Description VerticalAxis | Edit this page View Source CellSize Translates console width/height into graph space. Defaults to 1 row/col of console space being 1 unit of graph space. Declaration public PointF CellSize { get; set; } Property Value Type Description PointF | Edit this page View Source GraphColor The color of the background of the graph and axis/labels Declaration public Attribute? GraphColor { get; set; } Property Value Type Description Attribute? | Edit this page View Source MarginBottom Amount of space to leave on bottom of control. Graph content (Series) will not be rendered in margins but axis labels may be Declaration public uint MarginBottom { get; set; } Property Value Type Description uint | Edit this page View Source MarginLeft Amount of space to leave on left of control. Graph content (Series) will not be rendered in margins but axis labels may be Declaration public uint MarginLeft { get; set; } Property Value Type Description uint | Edit this page View Source ScrollOffset The graph space position of the bottom left of the control. Changing this scrolls the viewport around in the graph Declaration public PointF ScrollOffset { get; set; } Property Value Type Description PointF | Edit this page View Source Series Collection of data series that are rendered in the graph Declaration public List<ISeries> Series { get; } Property Value Type Description List<ISeries> Methods | Edit this page View Source DrawLine(Point, Point, Rune) Draws a line between two points in screen space. Can be diagonals. Declaration public void DrawLine(Point start, Point end, Rune symbol) Parameters Type Name Description Point start Point end Rune symbol The symbol to use for the line | Edit this page View Source GraphSpaceToScreen(PointF) Calculates the screen location for a given point in graph space. Bear in mind these be off screen Declaration public Point GraphSpaceToScreen(PointF location) Parameters Type Name Description PointF location Point in graph space that may or may not be represented in the visible area of graph currently presented. E.g. 0,0 for origin Returns Type Description Point Screen position (Column/Row) which would be used to render the graph location. Note that this can be outside the current client area of the control | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) Remarks Also ensures that cursor is invisible after entering the GraphView. | Edit this page View Source PageDown() Scrolls the graph down 1 page Declaration public void PageDown() | Edit this page View Source PageUp() Scrolls the graph up 1 page Declaration public void PageUp() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Reset() Clears all settings configured on the graph and resets all properties to default values (CellSize, ScrollOffset etc) Declaration public void Reset() | Edit this page View Source ScreenToGraphSpace(int, int) Returns the section of the graph that is represented by the given screen position Declaration public RectangleF ScreenToGraphSpace(int col, int row) Parameters Type Name Description int col int row Returns Type Description RectangleF | Edit this page View Source ScreenToGraphSpace(Rect) Returns the section of the graph that is represented by the screen area Declaration public RectangleF ScreenToGraphSpace(Rect screenArea) Parameters Type Name Description Rect screenArea Returns Type Description RectangleF | Edit this page View Source Scroll(float, float) Scrolls the view by a given number of units in graph space. See CellSize to translate this into rows/cols Declaration public void Scroll(float offsetX, float offsetY) Parameters Type Name Description float offsetX float offsetY | Edit this page View Source SetDriverColorToGraphColor() Sets the color attribute of Driver to the GraphColor (if defined) or ColorScheme otherwise. Declaration public void SetDriverColorToGraphColor() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.Axis.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.Axis.html",
    "title": "Class Axis",
    "keywords": "Class Axis Renders a continuous line with grid line ticks and labels Inheritance object Axis HorizontalAxis VerticalAxis Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public abstract class Axis Constructors | Edit this page View Source Axis(Orientation) Populates base properties and sets the read only Orientation Declaration protected Axis(Orientation orientation) Parameters Type Name Description Orientation orientation Fields | Edit this page View Source LabelGetter Allows you to control what label text is rendered for a given Increment when ShowLabelsEvery is above 0 Declaration public LabelGetterDelegate LabelGetter Field Value Type Description LabelGetterDelegate Properties | Edit this page View Source Increment Number of units of graph space between ticks on axis. 0 for no ticks Declaration public float Increment { get; set; } Property Value Type Description float | Edit this page View Source Minimum The minimum axis point to show. Defaults to null (no minimum) Declaration public float? Minimum { get; set; } Property Value Type Description float? | Edit this page View Source Orientation Direction of the axis Declaration public Orientation Orientation { get; } Property Value Type Description Orientation | Edit this page View Source ShowLabelsEvery The number of Increment before an label is added. 0 = never show labels Declaration public uint ShowLabelsEvery { get; set; } Property Value Type Description uint | Edit this page View Source Text Displayed below/to left of labels (see Orientation). If text is not visible, check MarginBottom / MarginLeft Declaration public string Text { get; set; } Property Value Type Description string | Edit this page View Source Visible True to render axis. Defaults to true Declaration public bool Visible { get; set; } Property Value Type Description bool Methods | Edit this page View Source DrawAxisLabel(GraphView, int, string) Draws a custom label text at screenPosition units along the axis (X or Y depending on Orientation) Declaration public abstract void DrawAxisLabel(GraphView graph, int screenPosition, string text) Parameters Type Name Description GraphView graph int screenPosition string text | Edit this page View Source DrawAxisLabels(GraphView) Draws labels and axis Increment ticks Declaration public abstract void DrawAxisLabels(GraphView graph) Parameters Type Name Description GraphView graph | Edit this page View Source DrawAxisLine(GraphView) Draws the solid line of the axis Declaration public abstract void DrawAxisLine(GraphView graph) Parameters Type Name Description GraphView graph | Edit this page View Source DrawAxisLine(GraphView, int, int) Draws a single cell of the solid line of the axis Declaration protected abstract void DrawAxisLine(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph int x int y | Edit this page View Source Reset() Resets all configurable properties of the axis to default values Declaration public virtual void Reset()"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html",
    "title": "Class AxisIncrementToRender",
    "keywords": "Class AxisIncrementToRender A location on an axis of a GraphView that may or may not have a label associated with it Inheritance object AxisIncrementToRender Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class AxisIncrementToRender Constructors | Edit this page View Source AxisIncrementToRender(Orientation, int, float) Describe a new section of an axis that requires an axis increment symbol and/or label Declaration public AxisIncrementToRender(Orientation orientation, int screen, float value) Parameters Type Name Description Orientation orientation int screen float value Properties | Edit this page View Source Orientation Direction of the parent axis Declaration public Orientation Orientation { get; } Property Value Type Description Orientation | Edit this page View Source ScreenLocation The screen location (X or Y depending on Orientation) that the increment will be rendered at Declaration public int ScreenLocation { get; } Property Value Type Description int | Edit this page View Source Value The value at this position on the axis in graph space Declaration public float Value { get; } Property Value Type Description float"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html",
    "title": "Class BarSeries.Bar",
    "keywords": "Class BarSeries.Bar A single bar in a BarSeries Inheritance object BarSeries.Bar Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class BarSeries.Bar Constructors | Edit this page View Source Bar(string, GraphCellToRender, float) Creates a new instance of a single bar rendered in the given fill that extends out value graph space units in the default Orientation Declaration public Bar(string text, GraphCellToRender fill, float value) Parameters Type Name Description string text GraphCellToRender fill float value Properties | Edit this page View Source Fill The color and character that will be rendered in the console when the bar extends over it Declaration public GraphCellToRender Fill { get; set; } Property Value Type Description GraphCellToRender | Edit this page View Source Text Optional text that describes the bar. This will be rendered on the corresponding Axis unless DrawLabels is false Declaration public string Text { get; set; } Property Value Type Description string | Edit this page View Source Value The value in graph space X/Y (depending on Orientation) to which the bar extends. Declaration public float Value { get; } Property Value Type Description float"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html",
    "title": "Class BarSeries",
    "keywords": "Class BarSeries Series of bars positioned at regular intervals Inheritance object BarSeries Implements ISeries Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class BarSeries : ISeries Properties | Edit this page View Source BarEvery Determines the spacing of bars along the axis. Defaults to 1 i.e. every 1 unit of graph space a bar is rendered. Note that you should also consider CellSize when changing this. Declaration public float BarEvery { get; set; } Property Value Type Description float | Edit this page View Source Bars Ordered collection of graph bars to position along axis Declaration public List<BarSeries.Bar> Bars { get; set; } Property Value Type Description List<BarSeries.Bar> | Edit this page View Source DrawLabels True to draw Text along the axis under the bar. Defaults to true. Declaration public bool DrawLabels { get; set; } Property Value Type Description bool | Edit this page View Source Offset The number of units of graph space along the axis before rendering the first bar (and subsequent bars - see BarEvery). Defaults to 0 Declaration public float Offset { get; set; } Property Value Type Description float | Edit this page View Source Orientation Direction bars protrude from the corresponding axis. Defaults to vertical Declaration public Orientation Orientation { get; set; } Property Value Type Description Orientation | Edit this page View Source OverrideBarColor Overrides the Fill with a fixed color Declaration public Attribute? OverrideBarColor { get; set; } Property Value Type Description Attribute? Methods | Edit this page View Source AdjustColor(GraphCellToRender) Applies any color overriding Declaration protected virtual GraphCellToRender AdjustColor(GraphCellToRender graphCellToRender) Parameters Type Name Description GraphCellToRender graphCellToRender Returns Type Description GraphCellToRender | Edit this page View Source DrawBarLine(GraphView, Point, Point, Bar) Override to do custom drawing of the bar e.g. to apply varying color or changing the fill symbol mid bar. Declaration protected virtual void DrawBarLine(GraphView graph, Point start, Point end, BarSeries.Bar beingDrawn) Parameters Type Name Description GraphView graph Point start Screen position of the start of the bar Point end Screen position of the end of the bar BarSeries.Bar beingDrawn The Bar that occupies this space and is being drawn | Edit this page View Source DrawSeries(GraphView, Rect, RectangleF) Draws bars that are currently in the drawBounds Declaration public virtual void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Rect drawBounds Screen area of the graph excluding margins RectangleF graphBounds Graph space area that should be drawn into drawBounds Implements ISeries"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html",
    "title": "Class GraphCellToRender",
    "keywords": "Class GraphCellToRender Describes how to render a single row/column of a GraphView based on the value(s) in ISeries at that location Inheritance object GraphCellToRender Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class GraphCellToRender Constructors | Edit this page View Source GraphCellToRender(Rune) Creates instance and sets Rune with default graph coloring Declaration public GraphCellToRender(Rune rune) Parameters Type Name Description Rune rune | Edit this page View Source GraphCellToRender(Rune, Attribute?) Creates instance and sets Rune and Color (or default if null) Declaration public GraphCellToRender(Rune rune, Attribute? color) Parameters Type Name Description Rune rune Attribute? color | Edit this page View Source GraphCellToRender(Rune, Attribute) Creates instance and sets Rune with custom graph coloring Declaration public GraphCellToRender(Rune rune, Attribute color) Parameters Type Name Description Rune rune Attribute color Properties | Edit this page View Source Color Optional color to render the Rune with Declaration public Attribute? Color { get; set; } Property Value Type Description Attribute? | Edit this page View Source Rune The character to render in the console Declaration public Rune Rune { get; set; } Property Value Type Description Rune"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html",
    "title": "Class HorizontalAxis",
    "keywords": "Class HorizontalAxis The horizontal (x axis) of a GraphView Inheritance object Axis HorizontalAxis Inherited Members Axis.Orientation Axis.Increment Axis.ShowLabelsEvery Axis.Visible Axis.LabelGetter Axis.Text Axis.Minimum Axis.Reset() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class HorizontalAxis : Axis Constructors | Edit this page View Source HorizontalAxis() Creates a new instance of axis with an Orientation of Horizontal Declaration public HorizontalAxis() Methods | Edit this page View Source DrawAxisLabel(GraphView, int, string) Draws the given text on the axis at x screenPosition. For the screen y position use GetAxisYPosition(GraphView) Declaration public override void DrawAxisLabel(GraphView graph, int screenPosition, string text) Parameters Type Name Description GraphView graph Graph being drawn onto int screenPosition Number of screen columns along the axis to take before rendering string text Text to render under the axis tick Overrides Axis.DrawAxisLabel(GraphView, int, string) | Edit this page View Source DrawAxisLabels(GraphView) Draws the horizontal x axis labels and Increment ticks Declaration public override void DrawAxisLabels(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLabels(GraphView) | Edit this page View Source DrawAxisLine(GraphView) Draws the horizontal axis line Declaration public override void DrawAxisLine(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLine(GraphView) | Edit this page View Source DrawAxisLine(GraphView, int, int) Draws a horizontal axis line at the given x, y screen coordinates Declaration protected override void DrawAxisLine(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph int x int y Overrides Axis.DrawAxisLine(GraphView, int, int) | Edit this page View Source GetAxisYPosition(GraphView) Returns the Y screen position of the origin (typically 0,0) of graph space. Return value is bounded by the screen i.e. the axis is always rendered even if the origin is offscreen. Declaration public int GetAxisYPosition(GraphView graph) Parameters Type Name Description GraphView graph Returns Type Description int"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html",
    "title": "Interface IAnnotation",
    "keywords": "Interface IAnnotation Describes an overlay element that is rendered either before or after a series. Annotations can be positioned either in screen space (e.g. a legend) or in graph space (e.g. a line showing high point) Unlike ISeries, annotations are allowed to draw into graph margins Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public interface IAnnotation Properties | Edit this page View Source BeforeSeries True if annotation should be drawn before ISeries. This allowes Series and later annotations to potentially draw over the top of this annotation. Declaration bool BeforeSeries { get; } Property Value Type Description bool Methods | Edit this page View Source Render(GraphView) Called once after series have been rendered (or before if BeforeSeries is true). Use Driver to draw and Bounds to avoid drawing outside of graph Declaration void Render(GraphView graph) Parameters Type Name Description GraphView graph"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html",
    "title": "Interface ISeries",
    "keywords": "Interface ISeries Describes a series of data that can be rendered into a GraphView> Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public interface ISeries Methods | Edit this page View Source DrawSeries(GraphView, Rect, RectangleF) Draws the graphBounds section of a series into the graph view drawBounds Declaration void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Graph series is to be drawn onto Rect drawBounds Visible area of the graph in Console Screen units (excluding margins) RectangleF graphBounds Visible area of the graph in Graph space units"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html",
    "title": "Delegate LabelGetterDelegate",
    "keywords": "Delegate LabelGetterDelegate Delegate for custom formatting of axis labels. Determines what should be displayed at a given label Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public delegate string LabelGetterDelegate(AxisIncrementToRender toRender) Parameters Type Name Description AxisIncrementToRender toRender The axis increment to which the label is attached Returns Type Description string"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html",
    "title": "Class LegendAnnotation",
    "keywords": "Class LegendAnnotation A box containing symbol definitions e.g. meanings for colors in a graph. The 'Key' to the graph Inheritance object LegendAnnotation Implements IAnnotation Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class LegendAnnotation : IAnnotation Constructors | Edit this page View Source LegendAnnotation(Rect) Creates a new empty legend at the given screen coordinates Declaration public LegendAnnotation(Rect legendBounds) Parameters Type Name Description Rect legendBounds Defines the area available for the legend to render in (within the graph). This is in screen units (i.e. not graph space) Properties | Edit this page View Source BeforeSeries Returns false i.e. Lengends render after series Declaration public bool BeforeSeries { get; } Property Value Type Description bool | Edit this page View Source Border True to draw a solid border around the legend. Defaults to true. This border will be within the Bounds and so reduces the width/height available for text by 2 Declaration public bool Border { get; set; } Property Value Type Description bool | Edit this page View Source Bounds Defines the screen area available for the legend to render in Declaration public Rect Bounds { get; set; } Property Value Type Description Rect Methods | Edit this page View Source AddEntry(GraphCellToRender, string) Adds an entry into the legend. Duplicate entries are permissable Declaration public void AddEntry(GraphCellToRender graphCellToRender, string text) Parameters Type Name Description GraphCellToRender graphCellToRender The symbol appearing on the graph that should appear in the legend string text Text to render on this line of the legend. Will be truncated if outside of Legend Bounds | Edit this page View Source Render(GraphView) Draws the Legend and all entries into the area within Bounds Declaration public void Render(GraphView graph) Parameters Type Name Description GraphView graph Implements IAnnotation"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.LineCanvas.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.LineCanvas.html",
    "title": "Class LineCanvas",
    "keywords": "Class LineCanvas Facilitates box drawing and line intersection detection and rendering. Does not support diagonal lines. Inheritance object LineCanvas Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class LineCanvas Methods | Edit this page View Source AddLine(Point, int, Orientation, BorderStyle) Add a new line to the canvas starting at from. Use positive length for Right and negative for Left when Orientation is Horizontal. Use positive length for Down and negative for Up when Orientation is Vertical. Declaration public void AddLine(Point from, int length, Orientation orientation, BorderStyle style) Parameters Type Name Description Point from Starting point. int length Length of line. 0 for a dot. Positive for Down/Right. Negative for Up/Left. Orientation orientation Direction of the line. BorderStyle style The style of line to use | Edit this page View Source GenerateImage(Rect) Evaluate all currently defined lines that lie within inArea and map that shows what characters (if any) should be rendered at each point so that all lines connect up correctly with appropriate intersection symbols. Declaration public Dictionary<Point, Rune> GenerateImage(Rect inArea) Parameters Type Name Description Rect inArea Returns Type Description Dictionary<Point, Rune> Mapping of all the points within inArea to line or intersection runes which should be drawn there."
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html",
    "title": "Class MultiBarSeries",
    "keywords": "Class MultiBarSeries Collection of BarSeries in which bars are clustered by category Inheritance object MultiBarSeries Implements ISeries Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class MultiBarSeries : ISeries Constructors | Edit this page View Source MultiBarSeries(int, float, float, Attribute[]) Creates a new series of clustered bars. Declaration public MultiBarSeries(int numberOfBarsPerCategory, float barsEvery, float spacing, Attribute[] colors = null) Parameters Type Name Description int numberOfBarsPerCategory Each category has this many bars float barsEvery How far appart to put each category (in graph space) float spacing How much spacing between bars in a category (should be less than barsEvery/numberOfBarsPerCategory) Attribute[] colors Array of colors that define bar color in each category. Length must match numberOfBarsPerCategory Properties | Edit this page View Source Spacing The number of units of graph space between bars. Should be less than BarEvery Declaration public float Spacing { get; } Property Value Type Description float | Edit this page View Source SubSeries Sub collections. Each series contains the bars for a different category. Thus SubSeries[0].Bars[0] is the first bar on the axis and SubSeries[1].Bars[0] is the second etc Declaration public IReadOnlyCollection<BarSeries> SubSeries { get; } Property Value Type Description IReadOnlyCollection<BarSeries> Methods | Edit this page View Source AddBars(string, Rune, params float[]) Adds a new cluster of bars Declaration public void AddBars(string label, Rune fill, params float[] values) Parameters Type Name Description string label Rune fill float[] values Values for each bar in category, must match the number of bars per category | Edit this page View Source DrawSeries(GraphView, Rect, RectangleF) Draws all SubSeries Declaration public void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Rect drawBounds RectangleF graphBounds Implements ISeries"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html",
    "title": "Enum Orientation",
    "keywords": "Enum Orientation Direction of an element (horizontal or vertical) Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public enum Orientation Fields Name Description Horizontal Left to right Vertical Bottom to top"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html",
    "title": "Class PathAnnotation.LineF",
    "keywords": "Class PathAnnotation.LineF Describes two points in graph space and a line between them Inheritance object PathAnnotation.LineF Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class PathAnnotation.LineF Constructors | Edit this page View Source LineF(PointF, PointF) Creates a new line between the points Declaration public LineF(PointF start, PointF end) Parameters Type Name Description PointF start PointF end Properties | Edit this page View Source End The end point of the line Declaration public PointF End { get; } Property Value Type Description PointF | Edit this page View Source Start The start of the line Declaration public PointF Start { get; } Property Value Type Description PointF"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html",
    "title": "Class PathAnnotation",
    "keywords": "Class PathAnnotation Sequence of lines to connect points e.g. of a ScatterSeries Inheritance object PathAnnotation Implements IAnnotation Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class PathAnnotation : IAnnotation Properties | Edit this page View Source BeforeSeries True to add line before plotting series. Defaults to false Declaration public bool BeforeSeries { get; set; } Property Value Type Description bool | Edit this page View Source LineColor Color for the line that connects points Declaration public Attribute? LineColor { get; set; } Property Value Type Description Attribute? | Edit this page View Source LineRune The symbol that gets drawn along the line, defaults to '.' Declaration public Rune LineRune { get; set; } Property Value Type Description Rune | Edit this page View Source Points Points that should be connected. Lines will be drawn between points in the order they appear in the list Declaration public List<PointF> Points { get; set; } Property Value Type Description List<PointF> Methods | Edit this page View Source Render(GraphView) Draws lines connecting each of the Points Declaration public void Render(GraphView graph) Parameters Type Name Description GraphView graph Implements IAnnotation"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html",
    "title": "Class ScatterSeries",
    "keywords": "Class ScatterSeries Series composed of any number of discrete data points Inheritance object ScatterSeries Implements ISeries Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class ScatterSeries : ISeries Properties | Edit this page View Source Fill The color and character that will be rendered in the console when there are point(s) in the corresponding graph space. Defaults to uncolored 'x' Declaration public GraphCellToRender Fill { get; set; } Property Value Type Description GraphCellToRender | Edit this page View Source Points Collection of each discrete point in the series Declaration public List<PointF> Points { get; set; } Property Value Type Description List<PointF> Methods | Edit this page View Source DrawSeries(GraphView, Rect, RectangleF) Draws all points directly onto the graph Declaration public void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Rect drawBounds RectangleF graphBounds Implements ISeries"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html",
    "title": "Class TextAnnotation",
    "keywords": "Class TextAnnotation Displays text at a given position (in screen space or graph space) Inheritance object TextAnnotation Implements IAnnotation Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class TextAnnotation : IAnnotation Properties | Edit this page View Source BeforeSeries True to add text before plotting series. Defaults to false Declaration public bool BeforeSeries { get; set; } Property Value Type Description bool | Edit this page View Source GraphPosition The location in graph space to draw the Text. This annotation will only show if the point is in the current viewable area of the graph presented in the GraphView Declaration public PointF GraphPosition { get; set; } Property Value Type Description PointF | Edit this page View Source ScreenPosition The location on screen to draw the Text regardless of scroll/zoom settings. This overrides GraphPosition if specified. Declaration public Point? ScreenPosition { get; set; } Property Value Type Description Point? | Edit this page View Source Text Text to display on the graph Declaration public string Text { get; set; } Property Value Type Description string Methods | Edit this page View Source DrawText(GraphView, int, int) Draws the Text at the given coordinates with truncation to avoid spilling over of the graph Declaration protected void DrawText(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph int x Screen x position to start drawing string int y Screen y position to start drawing string | Edit this page View Source Render(GraphView) Draws the annotation Declaration public void Render(GraphView graph) Parameters Type Name Description GraphView graph Implements IAnnotation"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html",
    "title": "Class VerticalAxis",
    "keywords": "Class VerticalAxis The vertical (i.e. Y axis) of a GraphView Inheritance object Axis VerticalAxis Inherited Members Axis.Orientation Axis.Increment Axis.ShowLabelsEvery Axis.Visible Axis.LabelGetter Axis.Text Axis.Minimum Axis.Reset() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Graphs Assembly: Terminal.Gui.dll Syntax public class VerticalAxis : Axis Constructors | Edit this page View Source VerticalAxis() Creates a new Vertical axis Declaration public VerticalAxis() Methods | Edit this page View Source DrawAxisLabel(GraphView, int, string) Draws the given text on the axis at y screenPosition. For the screen x position use GetAxisXPosition(GraphView) Declaration public override void DrawAxisLabel(GraphView graph, int screenPosition, string text) Parameters Type Name Description GraphView graph Graph being drawn onto int screenPosition Number of rows from the top of the screen (i.e. down the axis) before rendering string text Text to render to the left of the axis tick. Ensure to set MarginLeft or ScrollOffset sufficient that it is visible Overrides Axis.DrawAxisLabel(GraphView, int, string) | Edit this page View Source DrawAxisLabels(GraphView) Draws axis Increment markers and labels Declaration public override void DrawAxisLabels(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLabels(GraphView) | Edit this page View Source DrawAxisLine(GraphView) Draws the vertical axis line Declaration public override void DrawAxisLine(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLine(GraphView) | Edit this page View Source DrawAxisLine(GraphView, int, int) Draws a vertical axis line at the given x, y screen coordinates Declaration protected override void DrawAxisLine(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph int x int y Overrides Axis.DrawAxisLine(GraphView, int, int) | Edit this page View Source GetAxisXPosition(GraphView) Returns the X screen position of the origin (typically 0,0) of graph space. Return value is bounded by the screen i.e. the axis is always rendered even if the origin is offscreen. Declaration public int GetAxisXPosition(GraphView graph) Parameters Type Name Description GraphView graph Returns Type Description int"
  },
  "api/Terminal.Gui/Terminal.Gui.Graphs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Graphs.html",
    "title": "Namespace Terminal.Gui.Graphs",
    "keywords": "Namespace Terminal.Gui.Graphs Classes Axis Renders a continuous line with grid line ticks and labels AxisIncrementToRender A location on an axis of a GraphView that may or may not have a label associated with it BarSeries Series of bars positioned at regular intervals BarSeries.Bar A single bar in a BarSeries GraphCellToRender Describes how to render a single row/column of a GraphView based on the value(s) in ISeries at that location HorizontalAxis The horizontal (x axis) of a GraphView LegendAnnotation A box containing symbol definitions e.g. meanings for colors in a graph. The 'Key' to the graph LineCanvas Facilitates box drawing and line intersection detection and rendering. Does not support diagonal lines. MultiBarSeries Collection of BarSeries in which bars are clustered by category PathAnnotation Sequence of lines to connect points e.g. of a ScatterSeries PathAnnotation.LineF Describes two points in graph space and a line between them ScatterSeries Series composed of any number of discrete data points TextAnnotation Displays text at a given position (in screen space or graph space) VerticalAxis The vertical (i.e. Y axis) of a GraphView Interfaces IAnnotation Describes an overlay element that is rendered either before or after a series. Annotations can be positioned either in screen space (e.g. a legend) or in graph space (e.g. a line showing high point) Unlike ISeries, annotations are allowed to draw into graph margins ISeries Describes a series of data that can be rendered into a GraphView> Enums Orientation Direction of an element (horizontal or vertical) Delegates LabelGetterDelegate Delegate for custom formatting of axis labels. Determines what should be displayed at a given label"
  },
  "api/Terminal.Gui/Terminal.Gui.HexView.HexViewEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.HexView.HexViewEventArgs.html",
    "title": "Class HexView.HexViewEventArgs",
    "keywords": "Class HexView.HexViewEventArgs Defines the event arguments for PositionChanged event. Inheritance object EventArgs HexView.HexViewEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class HexView.HexViewEventArgs : EventArgs Constructors | Edit this page View Source HexViewEventArgs(long, Point, int) Initializes a new instance of HexView.HexViewEventArgs Declaration public HexViewEventArgs(long pos, Point cursor, int lineLength) Parameters Type Name Description long pos The character position. Point cursor The cursor position. int lineLength Line bytes length. Properties | Edit this page View Source BytesPerLine The bytes length per line. Declaration public int BytesPerLine { get; } Property Value Type Description int | Edit this page View Source CursorPosition Gets the current cursor position starting at one for both, line and column. Declaration public Point CursorPosition { get; } Property Value Type Description Point | Edit this page View Source Position Gets the current character position starting at one, related to the Stream. Declaration public long Position { get; } Property Value Type Description long"
  },
  "api/Terminal.Gui/Terminal.Gui.HexView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.HexView.html",
    "title": "Class HexView",
    "keywords": "Class HexView An hex viewer and editor View over a Stream Inheritance object Responder View HexView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class HexView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks HexView provides a hex editor on top of a seekable Stream with the left side showing an hex dump of the values in the Stream and the right side showing the contents (filtered to non-control sequence ASCII characters). Users can switch from one side to the other by using the tab key. To enable editing, set AllowEdits to true. When AllowEdits is true the user can make changes to the hexadecimal values of the Stream. Any changes are tracked in the Edits property (a SortedDictionary<TKey, TValue>) indicating the position where the changes were made and the new values. A convenience method, ApplyEdits(Stream) will apply the edits to the Stream. Control the first byte shown by setting the DisplayStart property to an offset in the stream. Constructors | Edit this page View Source HexView() Initializes a HexView class using Computed layout. Declaration public HexView() | Edit this page View Source HexView(Stream) Initializes a HexView class using Computed layout. Declaration public HexView(Stream source) Parameters Type Name Description Stream source The Stream to view and edit as hex, this Stream must support seeking, or an exception will be thrown. Properties | Edit this page View Source AllowEdits Gets or sets whether this HexView allow editing of the Stream of the underlying Stream. Declaration public bool AllowEdits { get; set; } Property Value Type Description bool true if allow edits; otherwise, false. | Edit this page View Source BytesPerLine The bytes length per line. Declaration public int BytesPerLine { get; } Property Value Type Description int | Edit this page View Source CursorPosition Gets the current cursor position starting at one for both, line and column. Declaration public Point CursorPosition { get; } Property Value Type Description Point | Edit this page View Source DesiredCursorVisibility Get / Set the wished cursor when the field is focused Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility | Edit this page View Source DisplayStart Sets or gets the offset into the Stream that will displayed at the top of the HexView Declaration public long DisplayStart { get; set; } Property Value Type Description long The display start. | Edit this page View Source Edits Gets a SortedDictionary<TKey, TValue> describing the edits done to the HexView. Each Key indicates an offset where an edit was made and the Value is the changed byte. Declaration public IReadOnlyDictionary<long, byte> Edits { get; } Property Value Type Description IReadOnlyDictionary<long, byte> The edits. | Edit this page View Source Frame Gets or sets the frame for the view. The frame is relative to the view's container (SuperView). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView. | Edit this page View Source Position Gets the current character position starting at one, related to the Stream. Declaration public long Position { get; } Property Value Type Description long | Edit this page View Source Source Sets or gets the Stream the HexView is operating on; the stream must support seeking (CanSeek == true). Declaration public Stream Source { get; set; } Property Value Type Description Stream The source. Methods | Edit this page View Source ApplyEdits(Stream) This method applies and edits made to the Stream and resets the contents of the Edits property. Declaration public void ApplyEdits(Stream stream = null) Parameters Type Name Description Stream stream If provided also applies the changes to the passed Stream | Edit this page View Source DiscardEdits() This method discards the edits made to the Stream by resetting the contents of the Edits property. Declaration public void DiscardEdits() | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnEdited(KeyValuePair<long, byte>) Method used to invoke the Edited event passing the KeyValuePair<TKey, TValue>. Declaration public virtual void OnEdited(KeyValuePair<long, byte> keyValuePair) Parameters Type Name Description KeyValuePair<long, byte> keyValuePair The key value pair. | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnPositionChanged() Method used to invoke the PositionChanged event passing the HexView.HexViewEventArgs arguments. Declaration public virtual void OnPositionChanged() | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. Events | Edit this page View Source Edited Event to be invoked when an edit is made on the Stream. Declaration public event Action<KeyValuePair<long, byte>> Edited Event Type Type Description Action<KeyValuePair<long, byte>> | Edit this page View Source PositionChanged Event to be invoked when the position and cursor position changes. Declaration public event Action<HexView.HexViewEventArgs> PositionChanged Event Type Type Description Action<HexView.HexViewEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.IAutocomplete.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.IAutocomplete.html",
    "title": "Interface IAutocomplete",
    "keywords": "Interface IAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public interface IAutocomplete Properties | Edit this page View Source AllSuggestions The full set of all strings that can be suggested. Declaration List<string> AllSuggestions { get; set; } Property Value Type Description List<string> | Edit this page View Source CloseKey The key that the user can press to close the currently popped autocomplete menu Declaration Key CloseKey { get; set; } Property Value Type Description Key | Edit this page View Source ColorScheme The colors to use to render the overlay. Accessing this property before the Application has been initialized will cause an error Declaration ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme | Edit this page View Source HostControl The host control that will use autocomplete. Declaration View HostControl { get; set; } Property Value Type Description View | Edit this page View Source MaxHeight The maximum number of visible rows in the autocomplete dropdown to render Declaration int MaxHeight { get; set; } Property Value Type Description int | Edit this page View Source MaxWidth The maximum width of the autocomplete dropdown Declaration int MaxWidth { get; set; } Property Value Type Description int | Edit this page View Source PopupInsideContainer Gets or sets where the popup will be displayed. Declaration bool PopupInsideContainer { get; set; } Property Value Type Description bool | Edit this page View Source Reopen The key that the user can press to reopen the currently popped autocomplete menu Declaration Key Reopen { get; set; } Property Value Type Description Key | Edit this page View Source SelectedIdx The currently selected index into Suggestions that the user has highlighted Declaration int SelectedIdx { get; set; } Property Value Type Description int | Edit this page View Source SelectionKey The key that the user must press to accept the currently selected autocomplete suggestion Declaration Key SelectionKey { get; set; } Property Value Type Description Key | Edit this page View Source Suggestions The strings that form the current list of suggestions to render based on what the user has typed so far. Declaration ReadOnlyCollection<string> Suggestions { get; set; } Property Value Type Description ReadOnlyCollection<string> | Edit this page View Source Visible True if the autocomplete should be considered open and visible Declaration bool Visible { get; set; } Property Value Type Description bool Methods | Edit this page View Source ClearSuggestions() Clears Suggestions Declaration void ClearSuggestions() | Edit this page View Source GenerateSuggestions(int) Populates Suggestions with all strings in AllSuggestions that match with the current cursor position/text in the HostControl. Declaration void GenerateSuggestions(int columnOffset = 0) Parameters Type Name Description int columnOffset The column offset. Current (zero - default), left (negative), right (positive). | Edit this page View Source MouseEvent(MouseEvent, bool) Handle mouse events before HostControl e.g. to make mouse events like report/click apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration bool MouseEvent(MouseEvent me, bool fromHost = false) Parameters Type Name Description MouseEvent me The mouse event. bool fromHost If was called from the popup or from the host. Returns Type Description bool trueif the mouse can be handled falseotherwise. | Edit this page View Source ProcessKey(KeyEvent) Handle key events before HostControl e.g. to make key events like up/down apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb The key event. Returns Type Description bool trueif the key can be handled falseotherwise. | Edit this page View Source RenderOverlay(Point) Renders the autocomplete dialog inside the given HostControl at the given point. Declaration void RenderOverlay(Point renderAt) Parameters Type Name Description Point renderAt"
  },
  "api/Terminal.Gui/Terminal.Gui.IClipboard.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.IClipboard.html",
    "title": "Interface IClipboard",
    "keywords": "Interface IClipboard Definition to interact with the OS clipboard. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public interface IClipboard Properties | Edit this page View Source IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard. Declaration bool IsSupported { get; } Property Value Type Description bool Methods | Edit this page View Source GetClipboardData() Get the operation system clipboard. Declaration string GetClipboardData() Returns Type Description string Exceptions Type Condition NotSupportedException Thrown if it was not possible to read the clipboard contents. | Edit this page View Source SetClipboardData(string) Sets the operation system clipboard. Declaration void SetClipboardData(string text) Parameters Type Name Description string text Exceptions Type Condition NotSupportedException Thrown if it was not possible to set the clipboard contents. | Edit this page View Source TryGetClipboardData(out string) Gets the operation system clipboard if possible. Declaration bool TryGetClipboardData(out string result) Parameters Type Name Description string result Clipboard contents read Returns Type Description bool true if it was possible to read the OS clipboard. | Edit this page View Source TrySetClipboardData(string) Sets the operation system clipboard if possible. Declaration bool TrySetClipboardData(string text) Parameters Type Name Description string text Returns Type Description bool True if the clipboard content was set successfully."
  },
  "api/Terminal.Gui/Terminal.Gui.IListDataSource.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.IListDataSource.html",
    "title": "Interface IListDataSource",
    "keywords": "Interface IListDataSource Implement IListDataSource to provide custom rendering for a ListView. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public interface IListDataSource Properties | Edit this page View Source Count Returns the number of elements to display Declaration int Count { get; } Property Value Type Description int | Edit this page View Source Length Returns the maximum length of elements to display Declaration int Length { get; } Property Value Type Description int Methods | Edit this page View Source IsMarked(int) Should return whether the specified item is currently marked. Declaration bool IsMarked(int item) Parameters Type Name Description int item Item index. Returns Type Description bool true, if marked, false otherwise. | Edit this page View Source Render(ListView, ConsoleDriver, bool, int, int, int, int, int) This method is invoked to render a specified item, the method should cover the entire provided width. Declaration void Render(ListView container, ConsoleDriver driver, bool selected, int item, int col, int line, int width, int start = 0) Parameters Type Name Description ListView container The list view to render. ConsoleDriver driver The console driver to render. bool selected Describes whether the item being rendered is currently selected by the user. int item The index of the item to render, zero for the first item and so on. int col The column where the rendering will start int line The line where the rendering will be done. int width The width that must be filled out. int start The index of the string to be displayed. Remarks The default color will be set before this method is invoked, and will be based on whether the item is selected or not. | Edit this page View Source SetMark(int, bool) Flags the item as marked. Declaration void SetMark(int item, bool value) Parameters Type Name Description int item Item index. bool value If set to true value. | Edit this page View Source ToList() Return the source as IList. Declaration IList ToList() Returns Type Description IList"
  },
  "api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html",
    "title": "Interface IMainLoopDriver",
    "keywords": "Interface IMainLoopDriver Public interface to create your own platform specific main loop driver. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public interface IMainLoopDriver Methods | Edit this page View Source EventsPending(bool) Must report whether there are any events pending, or even block waiting for events. Declaration bool EventsPending(bool wait) Parameters Type Name Description bool wait If set to true wait until an event is available, otherwise return immediately. Returns Type Description bool true, if there were pending events, false otherwise. | Edit this page View Source MainIteration() The iteration function. Declaration void MainIteration() | Edit this page View Source Setup(MainLoop) Initializes the main loop driver, gets the calling main loop for the initialization. Declaration void Setup(MainLoop mainLoop) Parameters Type Name Description MainLoop mainLoop Main loop. | Edit this page View Source Wakeup() Wakes up the mainloop that might be waiting on input, must be thread safe. Declaration void Wakeup()"
  },
  "api/Terminal.Gui/Terminal.Gui.ITreeView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ITreeView.html",
    "title": "Interface ITreeView",
    "keywords": "Interface ITreeView Interface for all non generic members of TreeView<T>. See TreeView Deep Dive for more information. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public interface ITreeView Properties | Edit this page View Source Style Contains options for changing how the tree is rendered. Declaration TreeStyle Style { get; set; } Property Value Type Description TreeStyle Methods | Edit this page View Source ClearObjects() Removes all objects from the tree and clears selection. Declaration void ClearObjects() | Edit this page View Source SetNeedsDisplay() Sets a flag indicating this view needs to be redisplayed because its state has changed. Declaration void SetNeedsDisplay()"
  },
  "api/Terminal.Gui/Terminal.Gui.ITreeViewFilter-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ITreeViewFilter-1.html",
    "title": "Interface ITreeViewFilter<T>",
    "keywords": "Interface ITreeViewFilter<T> Provides filtering for a TreeView. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public interface ITreeViewFilter<T> where T : class Type Parameters Name Description T Methods | Edit this page View Source IsMatch(T) Return true if the model should be included in the tree. Declaration bool IsMatch(T model) Parameters Type Name Description T model Returns Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.Key.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Key.html",
    "title": "Enum Key",
    "keywords": "Enum Key The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax [Flags] public enum Key : uint Remarks If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask) Numerics keys are the values between 48 and 57 corresponding to 0 to 9 Upper alpha keys are the values between 65 and 90 corresponding to A to Z Unicode runes are also stored here, the letter 'A\" for example is encoded as a value 65 (not surfaced in the enum). Fields Name Description A The key code for the user pressing Shift-A AltMask When this value is set, the Key encodes the sequence Alt-KeyValue. And the actual value must be extracted by removing the AltMask. B The key code for the user pressing Shift-B BackTab Shift-tab key (backwards tab key). Backspace Backspace key. C The key code for the user pressing Shift-C CharMask Mask that indicates that this is a character value, values outside this range indicate special characters like Alt-key combinations or special keys on the keyboard like function keys, arrows keys and so on. Clear The key code for the user pressing the clear key. CtrlMask When this value is set, the Key encodes the sequence Ctrl-KeyValue. And the actual value must be extracted by removing the CtrlMask. CursorDown Cursor down key. CursorLeft Cursor left key. CursorRight Cursor right key. CursorUp Cursor up key D The key code for the user pressing Shift-D D0 Digit 0. D1 Digit 1. D2 Digit 2. D3 Digit 3. D4 Digit 4. D5 Digit 5. D6 Digit 6. D7 Digit 7. D8 Digit 8. D9 Digit 9. Delete The key code for the user pressing the delete key. DeleteChar Delete character key. E The key code for the user pressing Shift-E End End key. Enter The key code for the user pressing the return key. Esc The key code for the user pressing the escape key F The key code for the user pressing Shift-F F1 F1 key. F10 F10 key. F11 F11 key. F12 F12 key. F13 F13 key. F14 F14 key. F15 F15 key. F16 F16 key. F17 F17 key. F18 F18 key. F19 F19 key. F2 F2 key. F20 F20 key. F21 F21 key. F22 F22 key. F23 F23 key. F24 F24 key. F3 F3 key. F4 F4 key. F5 F5 key. F6 F6 key. F7 F7 key. F8 F8 key. F9 F9 key. G The key code for the user pressing Shift-G H The key code for the user pressing Shift-H Home Home key. I The key code for the user pressing Shift-I InsertChar Insert character key. J The key code for the user pressing Shift-J K The key code for the user pressing Shift-K L The key code for the user pressing Shift-L M The key code for the user pressing Shift-M N The key code for the user pressing Shift-N Null The key code representing null or empty O The key code for the user pressing Shift-O P The key code for the user pressing Shift-P PageDown Page Down key. PageUp Page Up key. PrintScreen Print screen character key. Q The key code for the user pressing Shift-Q R The key code for the user pressing Shift-R S The key code for the user pressing Shift-S ShiftMask When this value is set, the Key encodes the sequence Shift-KeyValue. Space The key code for the user pressing the space bar SpecialMask If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask). T The key code for the user pressing Shift-T Tab The key code for the user pressing the tab key (forwards tab key). U The key code for the user pressing Shift-U Unknown A key with an unknown mapping was raised. V The key code for the user pressing Shift-V W The key code for the user pressing Shift-W X The key code for the user pressing Shift-X Y The key code for the user pressing Shift-Y Z The key code for the user pressing Shift-Z a The key code for the user pressing A b The key code for the user pressing B c The key code for the user pressing C d The key code for the user pressing D e The key code for the user pressing E f The key code for the user pressing F g The key code for the user pressing G h The key code for the user pressing H i The key code for the user pressing I j The key code for the user pressing J k The key code for the user pressing K l The key code for the user pressing L m The key code for the user pressing M n The key code for the user pressing N o The key code for the user pressing O p The key code for the user pressing P q The key code for the user pressing Q r The key code for the user pressing R s The key code for the user pressing S t The key code for the user pressing T u The key code for the user pressing U v The key code for the user pressing V w The key code for the user pressing W x The key code for the user pressing X y The key code for the user pressing Y z The key code for the user pressing Z"
  },
  "api/Terminal.Gui/Terminal.Gui.KeyEvent.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.KeyEvent.html",
    "title": "Class KeyEvent",
    "keywords": "Class KeyEvent Describes a keyboard event. Inheritance object KeyEvent Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class KeyEvent Constructors | Edit this page View Source KeyEvent() Constructs a new KeyEvent Declaration public KeyEvent() | Edit this page View Source KeyEvent(Key, KeyModifiers) Constructs a new KeyEvent from the provided Key value - can be a rune cast into a Key value Declaration public KeyEvent(Key k, KeyModifiers km) Parameters Type Name Description Key k KeyModifiers km Fields | Edit this page View Source Key Symbolic definition for the key. Declaration public Key Key Field Value Type Description Key Properties | Edit this page View Source IsAlt Gets a value indicating whether the Alt key was pressed (real or synthesized) Declaration public bool IsAlt { get; } Property Value Type Description bool true if is alternate; otherwise, false. | Edit this page View Source IsCapslock Gets a value indicating whether the Caps lock key was pressed (real or synthesized) Declaration public bool IsCapslock { get; } Property Value Type Description bool true if is alternate; otherwise, false. | Edit this page View Source IsCtrl Determines whether the value is a control key (and NOT just the ctrl key) Declaration public bool IsCtrl { get; } Property Value Type Description bool true if is ctrl; otherwise, false. | Edit this page View Source IsNumlock Gets a value indicating whether the Num lock key was pressed (real or synthesized) Declaration public bool IsNumlock { get; } Property Value Type Description bool true if is alternate; otherwise, false. | Edit this page View Source IsScrolllock Gets a value indicating whether the Scroll lock key was pressed (real or synthesized) Declaration public bool IsScrolllock { get; } Property Value Type Description bool true if is alternate; otherwise, false. | Edit this page View Source IsShift Gets a value indicating whether the Shift key was pressed. Declaration public bool IsShift { get; } Property Value Type Description bool true if is shift; otherwise, false. | Edit this page View Source KeyValue The key value cast to an integer, you will typical use this for extracting the Unicode rune value out of a key, when none of the symbolic options are in use. Declaration public int KeyValue { get; } Property Value Type Description int Methods | Edit this page View Source ToString() Pretty prints the KeyEvent Declaration public override string ToString() Returns Type Description string Overrides object.ToString()"
  },
  "api/Terminal.Gui/Terminal.Gui.KeyModifiers.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.KeyModifiers.html",
    "title": "Class KeyModifiers",
    "keywords": "Class KeyModifiers Identifies the state of the \"shift\"-keys within a event. Inheritance object KeyModifiers Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class KeyModifiers Fields | Edit this page View Source Alt Check if the Alt key was pressed or not. Declaration public bool Alt Field Value Type Description bool | Edit this page View Source Capslock Check if the Caps lock key was pressed or not. Declaration public bool Capslock Field Value Type Description bool | Edit this page View Source Ctrl Check if the Ctrl key was pressed or not. Declaration public bool Ctrl Field Value Type Description bool | Edit this page View Source Numlock Check if the Num lock key was pressed or not. Declaration public bool Numlock Field Value Type Description bool | Edit this page View Source Scrolllock Check if the Scroll lock key was pressed or not. Declaration public bool Scrolllock Field Value Type Description bool | Edit this page View Source Shift Check if the Shift key was pressed or not. Declaration public bool Shift Field Value Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.Label.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Label.html",
    "title": "Class Label",
    "keywords": "Class Label The Label View displays a string at a given position and supports multiple lines separated by newline characters. Multi-line Labels support word wrap. Inheritance object Responder View Label Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The Label view is functionality identical to View and is included for API backwards compatibility. Constructors | Edit this page View Source Label() Initializes a new instance of View using Computed layout. Declaration public Label() Remarks Use X, Y, Width, and Height properties to dynamically control the size and location of the view. The View will be created using Computed coordinates. The initial size (Frame) will be adjusted to fit the contents of Text, including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. This constructor initialize a View with a LayoutStyle of Computed. Use X, Y, Width, and Height properties to dynamically control the size and location of the view. | Edit this page View Source Label(ustring, bool) Declaration public Label(ustring text, bool autosize = true) Parameters Type Name Description ustring text bool autosize | Edit this page View Source Label(ustring, TextDirection, bool) Declaration public Label(ustring text, TextDirection direction, bool autosize = true) Parameters Type Name Description ustring text TextDirection direction bool autosize | Edit this page View Source Label(int, int, ustring, bool) Declaration public Label(int x, int y, ustring text, bool autosize = true) Parameters Type Name Description int x int y ustring text bool autosize | Edit this page View Source Label(Rect, ustring, bool) Declaration public Label(Rect rect, ustring text, bool autosize = false) Parameters Type Name Description Rect rect ustring text bool autosize | Edit this page View Source Label(Rect, bool) Declaration public Label(Rect frame, bool autosize = false) Parameters Type Name Description Rect frame bool autosize Methods | Edit this page View Source OnClicked() Virtual method to invoke the Clicked event. Declaration public virtual void OnClicked() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnMouseEvent(MouseEvent) | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent ke) Parameters Type Name Description KeyEvent ke Returns Type Description bool Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. Events | Edit this page View Source Clicked Clicked Action, raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.LayoutStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.LayoutStyle.html",
    "title": "Enum LayoutStyle",
    "keywords": "Enum LayoutStyle Determines the LayoutStyle for a View, if Absolute, during LayoutSubviews(), the value from the Frame will be used, if the value is Computed, then Frame will be updated from the X, Y Pos objects and the Width and Height Dim objects. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum LayoutStyle Fields Name Description Absolute The position and size of the view are based on the Frame value. Computed The position and size of the view will be computed based on the X, Y, Width and Height properties and set on the Frame."
  },
  "api/Terminal.Gui/Terminal.Gui.LineView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.LineView.html",
    "title": "Class LineView",
    "keywords": "Class LineView A straight line control either horizontal or vertical Inheritance object Responder View LineView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class LineView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source LineView() Creates a horizontal line Declaration public LineView() | Edit this page View Source LineView(Orientation) Creates a horizontal or vertical line based on orientation Declaration public LineView(Orientation orientation) Parameters Type Name Description Orientation orientation Properties | Edit this page View Source EndingAnchor The rune to display at the end of the line (right end of horizontal line or bottom end of vertical). If not specified then LineRune is used Declaration public Rune? EndingAnchor { get; set; } Property Value Type Description Rune? | Edit this page View Source LineRune The symbol to use for drawing the line Declaration public Rune LineRune { get; set; } Property Value Type Description Rune | Edit this page View Source Orientation The direction of the line. If you change this you will need to manually update the Width/Height of the control to cover a relevant area based on the new direction. Declaration public Orientation Orientation { get; set; } Property Value Type Description Orientation | Edit this page View Source StartingAnchor The rune to display at the start of the line (left end of horizontal line or top end of vertical) If not specified then LineRune is used Declaration public Rune? StartingAnchor { get; set; } Property Value Type Description Rune? Methods | Edit this page View Source Redraw(Rect) Draws the line including any starting/ending anchors Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.ListView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ListView.html",
    "title": "Class ListView",
    "keywords": "Class ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. Inheritance object Responder View ListView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ListView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The ListView displays lists of data and allows the user to scroll through the data. Items in the can be activated firing an event (with the ENTER key or a mouse double-click). If the AllowsMarking property is true, elements of the list can be marked by the user. By default ListView uses ToString() to render the items of any IList object (e.g. arrays, List<T>, and other collections). Alternatively, an object that implements IListDataSource can be provided giving full control of what is rendered. ListView can display any object that implements the IList interface. string values are converted into NStack.ustring values before rendering, and other values are converted into string by calling ToString() and then converting to NStack.ustring . To change the contents of the ListView, set the Source property (when providing custom rendering via IListDataSource) or call SetSource(IList) an IList is being used. When AllowsMarking is set to true the rendering will prefix the rendered items with [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different marking style set AllowsMarking to false and implement custom rendering. Searching the ListView with the keyboard is supported. Users type the first characters of an item, and the first item that starts with what the user types will be selected. Constructors | Edit this page View Source ListView() Initializes a new instance of ListView. Set the Source property to display something. Declaration public ListView() | Edit this page View Source ListView(IList) Initializes a new instance of ListView that will display the contents of the object implementing the IList interface, with relative positioning. Declaration public ListView(IList source) Parameters Type Name Description IList source An IList data source, if the elements are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. | Edit this page View Source ListView(IListDataSource) Initializes a new instance of ListView that will display the provided data source, using relative positioning. Declaration public ListView(IListDataSource source) Parameters Type Name Description IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. | Edit this page View Source ListView(Rect, IList) Initializes a new instance of ListView that will display the contents of the object implementing the IList interface with an absolute position. Declaration public ListView(Rect rect, IList source) Parameters Type Name Description Rect rect Frame for the listview. IList source An IList data source, if the elements of the IList are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. | Edit this page View Source ListView(Rect, IListDataSource) Initializes a new instance of ListView with the provided data source and an absolute position Declaration public ListView(Rect rect, IListDataSource source) Parameters Type Name Description Rect rect Frame for the listview. IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. Properties | Edit this page View Source AllowsMarking Gets or sets whether this ListView allows items to be marked. Declaration public bool AllowsMarking { get; set; } Property Value Type Description bool Set to true to allow marking elements of the list. Remarks If set to true, ListView will render items marked items with \"[x]\", and unmarked items with \"[ ]\" spaces. SPACE key will toggle marking. The default is false. | Edit this page View Source AllowsMultipleSelection If set to true more than one item can be selected. If false selecting an item will cause all others to be un-selected. The default is false. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description bool | Edit this page View Source KeystrokeNavigator Gets the CollectionNavigator that searches the Source collection as the user types. Declaration public CollectionNavigator KeystrokeNavigator { get; } Property Value Type Description CollectionNavigator | Edit this page View Source LeftItem Gets or sets the leftmost column that is currently visible (when scrolling horizontally). Declaration public int LeftItem { get; set; } Property Value Type Description int The left position. | Edit this page View Source Maxlength Gets the widest item in the list. Declaration public int Maxlength { get; } Property Value Type Description int | Edit this page View Source SelectedItem Gets or sets the index of the currently selected item. Declaration public int SelectedItem { get; set; } Property Value Type Description int The selected item. | Edit this page View Source Source Gets or sets the IListDataSource backing this ListView, enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new IList source. | Edit this page View Source TopItem Gets or sets the item that is displayed at the top of the ListView. Declaration public int TopItem { get; set; } Property Value Type Description int The top item. Methods | Edit this page View Source AllowsAll() If AllowsMarking and AllowsMultipleSelection are both true, unmarks all marked items other than the currently selected. Declaration public virtual bool AllowsAll() Returns Type Description bool true if unmarking was successful. | Edit this page View Source EnsureSelectedItemVisible() Ensures the selected item is always visible on the screen. Declaration public void EnsureSelectedItemVisible() | Edit this page View Source MarkUnmarkRow() Marks the SelectedItem if it is not already marked. Declaration public virtual bool MarkUnmarkRow() Returns Type Description bool true if the SelectedItem was marked. | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source MoveDown() Changes the SelectedItem to the next item in the list, scrolling the list if needed. Declaration public virtual bool MoveDown() Returns Type Description bool | Edit this page View Source MoveEnd() Changes the SelectedItem to last item in the list, scrolling the list if needed. Declaration public virtual bool MoveEnd() Returns Type Description bool | Edit this page View Source MoveHome() Changes the SelectedItem to the first item in the list, scrolling the list if needed. Declaration public virtual bool MoveHome() Returns Type Description bool | Edit this page View Source MovePageDown() Changes the SelectedItem to the item just below the bottom of the visible list, scrolling if needed. Declaration public virtual bool MovePageDown() Returns Type Description bool | Edit this page View Source MovePageUp() Changes the SelectedItem to the item at the top of the visible list. Declaration public virtual bool MovePageUp() Returns Type Description bool | Edit this page View Source MoveUp() Changes the SelectedItem to the previous item in the list, scrolling the list if needed. Declaration public virtual bool MoveUp() Returns Type Description bool | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnLeave(View) | Edit this page View Source OnOpenSelectedItem() Invokes the OpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description bool | Edit this page View Source OnRowRender(ListViewRowEventArgs) Virtual method that will invoke the RowRender. Declaration public virtual void OnRowRender(ListViewRowEventArgs rowEventArgs) Parameters Type Name Description ListViewRowEventArgs rowEventArgs | Edit this page View Source OnSelectedChanged() Invokes the SelectedItemChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description bool | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source ScrollDown(int) Scrolls the view down by items items. Declaration public virtual bool ScrollDown(int items) Parameters Type Name Description int items Number of items to scroll down. Returns Type Description bool | Edit this page View Source ScrollLeft(int) Scrolls the view left. Declaration public virtual bool ScrollLeft(int cols) Parameters Type Name Description int cols Number of columns to scroll left. Returns Type Description bool | Edit this page View Source ScrollRight(int) Scrolls the view right. Declaration public virtual bool ScrollRight(int cols) Parameters Type Name Description int cols Number of columns to scroll right. Returns Type Description bool | Edit this page View Source ScrollUp(int) Scrolls the view up by items items. Declaration public virtual bool ScrollUp(int items) Parameters Type Name Description int items Number of items to scroll up. Returns Type Description bool | Edit this page View Source SetSource(IList) Sets the source of the ListView to an IList. Declaration public void SetSource(IList source) Parameters Type Name Description IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. | Edit this page View Source SetSourceAsync(IList) Sets the source to an IList value asynchronously. Declaration public Task SetSourceAsync(IList source) Parameters Type Name Description IList source Returns Type Description Task An item implementing the IList interface. Remarks Use the Source property to set a new IListDataSource source and use custom rendering. Events | Edit this page View Source OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action<ListViewItemEventArgs> OpenSelectedItem Event Type Type Description Action<ListViewItemEventArgs> | Edit this page View Source RowRender This event is invoked when this ListView is being drawn before rendering. Declaration public event Action<ListViewRowEventArgs> RowRender Event Type Type Description Action<ListViewRowEventArgs> | Edit this page View Source SelectedItemChanged This event is raised when the selected item in the ListView has changed. Declaration public event Action<ListViewItemEventArgs> SelectedItemChanged Event Type Type Description Action<ListViewItemEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html",
    "title": "Class ListViewItemEventArgs",
    "keywords": "Class ListViewItemEventArgs EventArgs for ListView events. Inheritance object EventArgs ListViewItemEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ListViewItemEventArgs : EventArgs Constructors | Edit this page View Source ListViewItemEventArgs(int, object) Initializes a new instance of ListViewItemEventArgs Declaration public ListViewItemEventArgs(int item, object value) Parameters Type Name Description int item The index of the ListView item. object value The ListView item Properties | Edit this page View Source Item The index of the ListView item. Declaration public int Item { get; } Property Value Type Description int | Edit this page View Source Value The ListView item. Declaration public object Value { get; } Property Value Type Description object"
  },
  "api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html",
    "title": "Class ListViewRowEventArgs",
    "keywords": "Class ListViewRowEventArgs EventArgs used by the RowRender event. Inheritance object EventArgs ListViewRowEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ListViewRowEventArgs : EventArgs Constructors | Edit this page View Source ListViewRowEventArgs(int) Initializes with the current row. Declaration public ListViewRowEventArgs(int row) Parameters Type Name Description int row Properties | Edit this page View Source Row The current row being rendered. Declaration public int Row { get; } Property Value Type Description int | Edit this page View Source RowAttribute The Attribute used by current row or null to maintain the current attribute. Declaration public Attribute? RowAttribute { get; set; } Property Value Type Description Attribute?"
  },
  "api/Terminal.Gui/Terminal.Gui.ListWrapper.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ListWrapper.html",
    "title": "Class ListWrapper",
    "keywords": "Class ListWrapper Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy. Inheritance object ListWrapper Implements IListDataSource Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ListWrapper : IListDataSource Constructors | Edit this page View Source ListWrapper(IList) Declaration public ListWrapper(IList source) Parameters Type Name Description IList source Properties | Edit this page View Source Count Returns the number of elements to display Declaration public int Count { get; } Property Value Type Description int | Edit this page View Source Length Returns the maximum length of elements to display Declaration public int Length { get; } Property Value Type Description int Methods | Edit this page View Source IsMarked(int) Should return whether the specified item is currently marked. Declaration public bool IsMarked(int item) Parameters Type Name Description int item Item index. Returns Type Description bool true, if marked, false otherwise. | Edit this page View Source Render(ListView, ConsoleDriver, bool, int, int, int, int, int) This method is invoked to render a specified item, the method should cover the entire provided width. Declaration public void Render(ListView container, ConsoleDriver driver, bool marked, int item, int col, int line, int width, int start = 0) Parameters Type Name Description ListView container The list view to render. ConsoleDriver driver The console driver to render. bool marked int item The index of the item to render, zero for the first item and so on. int col The column where the rendering will start int line The line where the rendering will be done. int width The width that must be filled out. int start The index of the string to be displayed. Remarks The default color will be set before this method is invoked, and will be based on whether the item is selected or not. | Edit this page View Source SetMark(int, bool) Flags the item as marked. Declaration public void SetMark(int item, bool value) Parameters Type Name Description int item Item index. bool value If set to true value. | Edit this page View Source StartsWith(string) Declaration public int StartsWith(string search) Parameters Type Name Description string search Returns Type Description int | Edit this page View Source ToList() Return the source as IList. Declaration public IList ToList() Returns Type Description IList Implements IListDataSource"
  },
  "api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html",
    "title": "Class MainLoop.Timeout",
    "keywords": "Class MainLoop.Timeout Provides data for timers running manipulation. Inheritance object MainLoop.Timeout Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public sealed class MainLoop.Timeout Fields | Edit this page View Source Callback The function that will be invoked. Declaration public Func<MainLoop, bool> Callback Field Value Type Description Func<MainLoop, bool> | Edit this page View Source Span Time to wait before invoke the callback. Declaration public TimeSpan Span Field Value Type Description TimeSpan"
  },
  "api/Terminal.Gui/Terminal.Gui.MainLoop.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MainLoop.html",
    "title": "Class MainLoop",
    "keywords": "Class MainLoop Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers. Inheritance object MainLoop Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class MainLoop Remarks Monitoring of file descriptors is only available on Unix, there does not seem to be a way of supporting this on Windows. Constructors | Edit this page View Source MainLoop(IMainLoopDriver) Creates a new Mainloop. Declaration public MainLoop(IMainLoopDriver driver) Parameters Type Name Description IMainLoopDriver driver Should match the ConsoleDriver (one of the implementations FakeMainLoop, UnixMainLoop, NetMainLoop or WindowsMainLoop). Properties | Edit this page View Source Driver The current IMainLoopDriver in use. Declaration public IMainLoopDriver Driver { get; } Property Value Type Description IMainLoopDriver The driver. | Edit this page View Source IdleHandlers Gets a copy of the list of all idle handlers. Declaration public ReadOnlyCollection<Func<bool>> IdleHandlers { get; } Property Value Type Description ReadOnlyCollection<Func<bool>> | Edit this page View Source Timeouts Gets the list of all timeouts sorted by the TimeSpan time ticks./>. A shorter limit time can be added at the end, but it will be called before an earlier addition that has a longer limit time. Declaration public SortedList<long, MainLoop.Timeout> Timeouts { get; } Property Value Type Description SortedList<long, MainLoop.Timeout> Methods | Edit this page View Source AddIdle(Func<bool>) Adds specified idle handler function to mainloop processing. The handler function will be called once per iteration of the main loop after other events have been handled. Declaration public Func<bool> AddIdle(Func<bool> idleHandler) Parameters Type Name Description Func<bool> idleHandler Token that can be used to remove the idle handler with RemoveIdle(Func<bool>) . Returns Type Description Func<bool> Remarks Remove an idle hander by calling RemoveIdle(Func<bool>) with the token this method returns. If the idleHandler returns false it will be removed and not called subsequently. | Edit this page View Source AddTimeout(TimeSpan, Func<MainLoop, bool>) Adds a timeout to the mainloop. Declaration public object AddTimeout(TimeSpan time, Func<MainLoop, bool> callback) Parameters Type Name Description TimeSpan time Func<MainLoop, bool> callback Returns Type Description object Remarks When time specified passes, the callback will be invoked. If the callback returns true, the timeout will be reset, repeating the invocation. If it returns false, the timeout will stop and be removed. The returned value is a token that can be used to stop the timeout by calling RemoveTimeout(object). | Edit this page View Source EventsPending(bool) Determines whether there are pending events to be processed. Declaration public bool EventsPending(bool wait = false) Parameters Type Name Description bool wait Returns Type Description bool Remarks You can use this method if you want to probe if events are pending. Typically used if you need to flush the input queue while still running some of your own code in your main thread. | Edit this page View Source Invoke(Action) Runs action on the thread that is processing events Declaration public void Invoke(Action action) Parameters Type Name Description Action action the action to be invoked on the main processing thread. | Edit this page View Source MainIteration() Runs one iteration of timers and file watches Declaration public void MainIteration() Remarks You use this to process all pending events (timers, idle handlers and file watches). You can use it like this: while (main.EvensPending ()) MainIteration (); | Edit this page View Source RemoveIdle(Func<bool>) Removes an idle handler added with AddIdle(Func<bool>) from processing. Declaration public bool RemoveIdle(Func<bool> token) Parameters Type Name Description Func<bool> token A token returned by AddIdle(Func<bool>) Returns Type Description bool | Edit this page View Source RemoveTimeout(object) Removes a previously scheduled timeout Declaration public bool RemoveTimeout(object token) Parameters Type Name Description object token Returns Type Description bool Remarks The token parameter is the value returned by AddTimeout. | Edit this page View Source Run() Runs the mainloop. Declaration public void Run() | Edit this page View Source Stop() Stops the mainloop. Declaration public void Stop() Events | Edit this page View Source TimeoutAdded Invoked when a new timeout is added. To be used in the case when ExitRunLoopAfterFirstIteration is true. Declaration public event Action<long> TimeoutAdded Event Type Type Description Action<long>"
  },
  "api/Terminal.Gui/Terminal.Gui.MenuBar.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MenuBar.html",
    "title": "Class MenuBar",
    "keywords": "Class MenuBar Provides a menu bar that spans the top of a Toplevel View with drop-down and cascading menus. By default, any sub-sub-menus (sub-menus of the MenuItems added to MenuBarItems) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting UseSubMenusSingleFrame to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar. Inheritance object Responder View MenuBar Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class MenuBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The MenuBar appears on the first row of the parent Toplevel View and uses the full width. The MenuBar provides global hotkeys for the application. See HotKey. See also: ContextMenu Constructors | Edit this page View Source MenuBar() Initializes a new instance of the MenuBar. Declaration public MenuBar() | Edit this page View Source MenuBar(MenuBarItem[]) Initializes a new instance of the MenuBar class with the specified set of toplevel menu items. Declaration public MenuBar(MenuBarItem[] menus) Parameters Type Name Description MenuBarItem[] menus Individual menu items; a null item will result in a separator being drawn. Properties | Edit this page View Source HotKeySpecifier The specifier character for the hotkey to all menus. Declaration public static Rune HotKeySpecifier { get; } Property Value Type Description Rune | Edit this page View Source IsMenuOpen true if the menu is open; otherwise true. Declaration public bool IsMenuOpen { get; protected set; } Property Value Type Description bool | Edit this page View Source Key The Key used to activate the menu bar by keyboard. Declaration public Key Key { get; set; } Property Value Type Description Key | Edit this page View Source LastFocused Gets the view that was last focused before opening the menu. Declaration public View LastFocused { get; } Property Value Type Description View | Edit this page View Source Menus Gets or sets the array of MenuBarItems for the menu. Only set this after the MenuBar is visible. Declaration public MenuBarItem[] Menus { get; set; } Property Value Type Description MenuBarItem[] The menu array. | Edit this page View Source ShortcutDelimiter Sets or gets the shortcut delimiter separator. The default is \"+\". Declaration public static ustring ShortcutDelimiter { get; set; } Property Value Type Description ustring | Edit this page View Source UseKeysUpDownAsKeysLeftRight Used for change the navigation key style. Declaration public bool UseKeysUpDownAsKeysLeftRight { get; set; } Property Value Type Description bool | Edit this page View Source UseSubMenusSingleFrame Gets or sets if the sub-menus must be displayed in a single or multiple frames. By default any sub-sub-menus (sub-menus of the main MenuItems) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting UseSubMenusSingleFrame to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar. Declaration public bool UseSubMenusSingleFrame { get; set; } Property Value Type Description bool | Edit this page View Source Visible Gets or sets a value indicating whether this Responder and all its child controls are displayed. Declaration public override bool Visible { get; set; } Property Value Type Description bool Overrides View.Visible Methods | Edit this page View Source CloseMenu(bool) Closes the Menu programmatically if open and not canceled (as though F9 were pressed). Declaration public bool CloseMenu(bool ignoreUseSubMenusSingleFrame = false) Parameters Type Name Description bool ignoreUseSubMenusSingleFrame Returns Type Description bool | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnKeyDown(KeyEvent) Method invoked when a key is pressed. Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled Overrides View.OnKeyDown(KeyEvent) | Edit this page View Source OnKeyUp(KeyEvent) Method invoked when a key is released. Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled Overrides View.OnKeyUp(KeyEvent) | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnLeave(View) | Edit this page View Source OnMenuAllClosed() Virtual method that will invoke the MenuAllClosed. Declaration public virtual void OnMenuAllClosed() | Edit this page View Source OnMenuClosing(MenuBarItem, bool, bool) Virtual method that will invoke the MenuClosing. Declaration public virtual MenuClosingEventArgs OnMenuClosing(MenuBarItem currentMenu, bool reopen, bool isSubMenu) Parameters Type Name Description MenuBarItem currentMenu The current menu to be closed. bool reopen Whether the current menu will be reopen. bool isSubMenu Whether is a sub-menu or not. Returns Type Description MenuClosingEventArgs | Edit this page View Source OnMenuOpened() Virtual method that will invoke the MenuOpened event if it's defined. Declaration public virtual void OnMenuOpened() | Edit this page View Source OnMenuOpening(MenuBarItem) Virtual method that will invoke the MenuOpening event if it's defined. Declaration public virtual MenuOpeningEventArgs OnMenuOpening(MenuBarItem currentMenu) Parameters Type Name Description MenuBarItem currentMenu The current menu to be replaced. Returns Type Description MenuOpeningEventArgs Returns the MenuOpeningEventArgs | Edit this page View Source OpenMenu() Opens the Menu programatically, as though the F9 key were pressed. Declaration public void OpenMenu() | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. Events | Edit this page View Source MenuAllClosed Raised when all the menu is closed. Declaration public event Action MenuAllClosed Event Type Type Description Action | Edit this page View Source MenuClosing Raised when a menu is closing passing MenuClosingEventArgs. Declaration public event Action<MenuClosingEventArgs> MenuClosing Event Type Type Description Action<MenuClosingEventArgs> | Edit this page View Source MenuOpened Raised when a menu is opened. Declaration public event Action<MenuItem> MenuOpened Event Type Type Description Action<MenuItem> | Edit this page View Source MenuOpening Raised as a menu is opening. Declaration public event Action<MenuOpeningEventArgs> MenuOpening Event Type Type Description Action<MenuOpeningEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html",
    "title": "Class MenuBarItem",
    "keywords": "Class MenuBarItem MenuBarItem is a menu item on an app's MenuBar. MenuBarItems do not support Shortcut. Inheritance object MenuItem MenuBarItem Inherited Members MenuItem.Data MenuItem.HotKey MenuItem.Shortcut MenuItem.ShortcutTag MenuItem.Title MenuItem.Help MenuItem.Action MenuItem.CanExecute MenuItem.IsEnabled() MenuItem.Checked MenuItem.CheckType MenuItem.Parent MenuItem.GetMenuItem() MenuItem.GetMenuBarItem() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class MenuBarItem : MenuItem Constructors | Edit this page View Source MenuBarItem() Initializes a new MenuBarItem. Declaration public MenuBarItem() | Edit this page View Source MenuBarItem(ustring, ustring, Action, Func<bool>, MenuItem) Initializes a new MenuBarItem as a MenuItem. Declaration public MenuBarItem(ustring title, ustring help, Action action, Func<bool> canExecute = null, MenuItem parent = null) Parameters Type Name Description ustring title Title for the menu item. ustring help Help text to display. Will be displayed next to the Title surrounded by parentheses. Action action Action to invoke when the menu item is activated. Func<bool> canExecute Function to determine if the action can currently be executed. MenuItem parent The parent MenuItem of this if exist, otherwise is null. | Edit this page View Source MenuBarItem(ustring, List<MenuItem[]>, MenuItem) Initializes a new MenuBarItem with separate list of items. Declaration public MenuBarItem(ustring title, List<MenuItem[]> children, MenuItem parent = null) Parameters Type Name Description ustring title Title for the menu item. List<MenuItem[]> children The list of items in the current menu. MenuItem parent The parent MenuItem of this if exist, otherwise is null. | Edit this page View Source MenuBarItem(ustring, MenuItem[], MenuItem) Initializes a new MenuBarItem. Declaration public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null) Parameters Type Name Description ustring title Title for the menu item. MenuItem[] children The items in the current menu. MenuItem parent The parent MenuItem of this if exist, otherwise is null. | Edit this page View Source MenuBarItem(MenuItem[]) Initializes a new MenuBarItem. Declaration public MenuBarItem(MenuItem[] children) Parameters Type Name Description MenuItem[] children The items in the current menu. Properties | Edit this page View Source Children Gets or sets an array of MenuItem objects that are the children of this MenuBarItem Declaration public MenuItem[] Children { get; set; } Property Value Type Description MenuItem[] The children. Methods | Edit this page View Source GetChildrenIndex(MenuItem) Get the index of the MenuItem parameter. Declaration public int GetChildrenIndex(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description int Returns a value bigger than -1 if the MenuItem is a child of this. | Edit this page View Source IsSubMenuOf(MenuItem) Check if the MenuItem parameter is a child of this. Declaration public bool IsSubMenuOf(MenuItem menuItem) Parameters Type Name Description MenuItem menuItem Returns Type Description bool Returns true if it is a child of this. false otherwise. | Edit this page View Source SubMenu(MenuItem) Check if the children parameter is a MenuBarItem. Declaration public MenuBarItem SubMenu(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description MenuBarItem Returns a MenuBarItem or null otherwise."
  },
  "api/Terminal.Gui/Terminal.Gui.MenuClosingEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MenuClosingEventArgs.html",
    "title": "Class MenuClosingEventArgs",
    "keywords": "Class MenuClosingEventArgs An EventArgs which allows passing a cancelable menu closing event. Inheritance object EventArgs MenuClosingEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class MenuClosingEventArgs : EventArgs Constructors | Edit this page View Source MenuClosingEventArgs(MenuBarItem, bool, bool) Initializes a new instance of MenuClosingEventArgs. Declaration public MenuClosingEventArgs(MenuBarItem currentMenu, bool reopen, bool isSubMenu) Parameters Type Name Description MenuBarItem currentMenu The current MenuBarItem parent. bool reopen Whether the current menu will reopen. bool isSubMenu Indicates whether it is a sub-menu. Properties | Edit this page View Source Cancel Flag that allows the cancellation of the event. If set to true in the event handler, the event will be canceled. Declaration public bool Cancel { get; set; } Property Value Type Description bool | Edit this page View Source CurrentMenu The current MenuBarItem parent. Declaration public MenuBarItem CurrentMenu { get; } Property Value Type Description MenuBarItem | Edit this page View Source IsSubMenu Indicates whether the current menu is a sub-menu. Declaration public bool IsSubMenu { get; } Property Value Type Description bool | Edit this page View Source Reopen Indicates whether the current menu will reopen. Declaration public bool Reopen { get; } Property Value Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.MenuItem.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MenuItem.html",
    "title": "Class MenuItem",
    "keywords": "Class MenuItem A MenuItem has title, an associated help text, and an action to execute on activation. MenuItems can also have a checked indicator (see Checked). Inheritance object MenuItem MenuBarItem Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class MenuItem Constructors | Edit this page View Source MenuItem(ustring, ustring, Action, Func<bool>, MenuItem, Key) Initializes a new instance of MenuItem. Declaration public MenuItem(ustring title, ustring help, Action action, Func<bool> canExecute = null, MenuItem parent = null, Key shortcut = Key.Null) Parameters Type Name Description ustring title Title for the menu item. ustring help Help text to display. Action action Action to invoke when the menu item is activated. Func<bool> canExecute Function to determine if the action can currently be executed. MenuItem parent The Parent of this menu item. Key shortcut The Shortcut keystroke combination. | Edit this page View Source MenuItem(Key) Initializes a new instance of MenuItem Declaration public MenuItem(Key shortcut = Key.Null) Parameters Type Name Description Key shortcut Fields | Edit this page View Source HotKey The HotKey is used to activate a MenuItem with the keyboard. HotKeys are defined by prefixing the Title of a MenuItem with an underscore ('_'). Pressing Alt-Hotkey for a MenuBarItem (menu items on the menu bar) works even if the menu is not active). Once a menu has focus and is active, pressing just the HotKey will activate the MenuItem. For example for a MenuBar with a \"_File\" MenuBarItem that contains a \"_New\" MenuItem, Alt-F will open the File menu. Pressing the N key will then activate the New MenuItem. See also Shortcut which enable global key-bindings to menu items. Declaration public Rune HotKey Field Value Type Description Rune Properties | Edit this page View Source Action Gets or sets the action to be invoked when the menu item is triggered. Declaration public Action Action { get; set; } Property Value Type Description Action Method to invoke. | Edit this page View Source CanExecute Gets or sets the action to be invoked to determine if the menu can be triggered. If CanExecute returns true the menu item will be enabled. Otherwise, it will be disabled. Declaration public Func<bool> CanExecute { get; set; } Property Value Type Description Func<bool> Function to determine if the action is can be executed or not. | Edit this page View Source CheckType Sets or gets the MenuItemCheckStyle of a menu item where Checked is set to true. Declaration public MenuItemCheckStyle CheckType { get; set; } Property Value Type Description MenuItemCheckStyle | Edit this page View Source Checked Sets or gets whether the MenuItem shows a check indicator or not. See MenuItemCheckStyle. Declaration public bool Checked { get; set; } Property Value Type Description bool | Edit this page View Source Data Gets or sets arbitrary data for the menu item. Declaration public object Data { get; set; } Property Value Type Description object Remarks This property is not used internally. | Edit this page View Source Help Gets or sets the help text for the menu item. The help text is drawn to the right of the Title. Declaration public ustring Help { get; set; } Property Value Type Description ustring The help text. | Edit this page View Source Parent Gets the parent for this MenuItem. Declaration public MenuItem Parent { get; } Property Value Type Description MenuItem The parent. | Edit this page View Source Shortcut Shortcut defines a key binding to the MenuItem that will invoke the MenuItem's action globally for the View that is the parent of the MenuBar or ContextMenu this MenuItem. The Key will be drawn on the MenuItem to the right of the Title and Help text. See ShortcutTag. Declaration public Key Shortcut { get; set; } Property Value Type Description Key | Edit this page View Source ShortcutTag Gets the text describing the keystroke combination defined by Shortcut. Declaration public ustring ShortcutTag { get; } Property Value Type Description ustring | Edit this page View Source Title Gets or sets the title of the menu item . Declaration public ustring Title { get; set; } Property Value Type Description ustring The title. Methods | Edit this page View Source GetMenuBarItem() Merely a debugging aid to see the interaction with main. Declaration public bool GetMenuBarItem() Returns Type Description bool | Edit this page View Source GetMenuItem() Merely a debugging aid to see the interaction with main. Declaration public MenuItem GetMenuItem() Returns Type Description MenuItem | Edit this page View Source IsEnabled() Returns true if the menu item is enabled. This method is a wrapper around CanExecute. Declaration public bool IsEnabled() Returns Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html",
    "title": "Enum MenuItemCheckStyle",
    "keywords": "Enum MenuItemCheckStyle Specifies how a MenuItem shows selection state. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax [Flags] public enum MenuItemCheckStyle Fields Name Description Checked The menu item will indicate checked/un-checked state (see Checked). NoCheck The menu item will be shown normally, with no check indicator. The default. Radio The menu item is part of a menu radio group (see Checked) and will indicate selected state."
  },
  "api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html",
    "title": "Class MenuOpeningEventArgs",
    "keywords": "Class MenuOpeningEventArgs An EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem. Inheritance object EventArgs MenuOpeningEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class MenuOpeningEventArgs : EventArgs Constructors | Edit this page View Source MenuOpeningEventArgs(MenuBarItem) Initializes a new instance of MenuOpeningEventArgs. Declaration public MenuOpeningEventArgs(MenuBarItem currentMenu) Parameters Type Name Description MenuBarItem currentMenu The current MenuBarItem parent. Properties | Edit this page View Source Cancel Flag that allows the cancellation of the event. If set to true in the event handler, the event will be canceled. Declaration public bool Cancel { get; set; } Property Value Type Description bool | Edit this page View Source CurrentMenu The current MenuBarItem parent. Declaration public MenuBarItem CurrentMenu { get; } Property Value Type Description MenuBarItem | Edit this page View Source NewMenuBarItem The new MenuBarItem to be replaced. Declaration public MenuBarItem NewMenuBarItem { get; set; } Property Value Type Description MenuBarItem"
  },
  "api/Terminal.Gui/Terminal.Gui.MessageBox.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MessageBox.html",
    "title": "Class MessageBox",
    "keywords": "Class MessageBox MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from. Inheritance object MessageBox Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class MessageBox Examples var n = MessageBox.Query (\"Quit Demo\", \"Are you sure you want to quit this demo?\", \"Yes\", \"No\"); if (n == 0) quit = true; else quit = false; Properties | Edit this page View Source Clicked The index of the selected button, or -1 if the user pressed ESC to close the dialog. This is useful for web based console where by default there is no SynchronizationContext or TaskScheduler. Declaration public static int Clicked { get; } Property Value Type Description int Methods | Edit this page View Source ErrorQuery(ustring, ustring, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int ErrorQuery(ustring title, ustring message, params ustring[] buttons) Parameters Type Name Description ustring title Title for the query. ustring message Message to display, might contain multiple lines. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks The message box will be vertically and horizontally centered in the container and the size will be automatically determined from the size of the title, message. and buttons. | Edit this page View Source ErrorQuery(ustring, ustring, int, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int ErrorQuery(ustring title, ustring message, int defaultButton = 0, params ustring[] buttons) Parameters Type Name Description ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks The message box will be vertically and horizontally centered in the container and the size will be automatically determined from the size of the title, message. and buttons. | Edit this page View Source ErrorQuery(ustring, ustring, int, Border, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int ErrorQuery(ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons) Parameters Type Name Description ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. Border border The border settings. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks The message box will be vertically and horizontally centered in the container and the size will be automatically determined from the size of the title, message. and buttons. | Edit this page View Source ErrorQuery(int, int, ustring, ustring, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int ErrorQuery(int width, int height, ustring title, ustring message, params ustring[] buttons) Parameters Type Name Description int width Width for the window. int height Height for the window. ustring title Title for the query. ustring message Message to display, might contain multiple lines. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks Use ErrorQuery(ustring, ustring, params ustring[]) instead; it automatically sizes the MessageBox based on the contents. | Edit this page View Source ErrorQuery(int, int, ustring, ustring, int, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int ErrorQuery(int width, int height, ustring title, ustring message, int defaultButton = 0, params ustring[] buttons) Parameters Type Name Description int width Width for the window. int height Height for the window. ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks Use ErrorQuery(ustring, ustring, params ustring[]) instead; it automatically sizes the MessageBox based on the contents. | Edit this page View Source ErrorQuery(int, int, ustring, ustring, int, Border, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int ErrorQuery(int width, int height, ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons) Parameters Type Name Description int width Width for the window. int height Height for the window. ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. Border border The border settings. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks Use ErrorQuery(ustring, ustring, params ustring[]) instead; it automatically sizes the MessageBox based on the contents. | Edit this page View Source Query(ustring, ustring, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int Query(ustring title, ustring message, params ustring[] buttons) Parameters Type Name Description ustring title Title for the query. ustring message Message to display, might contain multiple lines. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks The message box will be vertically and horizontally centered in the container and the size will be automatically determined from the size of the message and buttons. | Edit this page View Source Query(ustring, ustring, int, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int Query(ustring title, ustring message, int defaultButton = 0, params ustring[] buttons) Parameters Type Name Description ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks The message box will be vertically and horizontally centered in the container and the size will be automatically determined from the size of the message and buttons. | Edit this page View Source Query(ustring, ustring, int, Border, params ustring[]) Presents an error MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int Query(ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons) Parameters Type Name Description ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. Border border The border settings. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks The message box will be vertically and horizontally centered in the container and the size will be automatically determined from the size of the message and buttons. | Edit this page View Source Query(int, int, ustring, ustring, params ustring[]) Presents a normal MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int Query(int width, int height, ustring title, ustring message, params ustring[] buttons) Parameters Type Name Description int width Width for the window. int height Height for the window. ustring title Title for the query. ustring message Message to display, might contain multiple lines. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks Use Query(ustring, ustring, params ustring[]) instead; it automatically sizes the MessageBox based on the contents. | Edit this page View Source Query(int, int, ustring, ustring, int, params ustring[]) Presents a normal MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int Query(int width, int height, ustring title, ustring message, int defaultButton = 0, params ustring[] buttons) Parameters Type Name Description int width Width for the window. int height Height for the window. ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks Use Query(ustring, ustring, params ustring[]) instead; it automatically sizes the MessageBox based on the contents. | Edit this page View Source Query(int, int, ustring, ustring, int, Border, params ustring[]) Presents a normal MessageBox with the specified title and message and a list of buttons to show to the user. Declaration public static int Query(int width, int height, ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons) Parameters Type Name Description int width Width for the window. int height Height for the window. ustring title Title for the query. ustring message Message to display, might contain multiple lines. int defaultButton Index of the default button. Border border The border settings. ustring[] buttons Array of buttons to add. Returns Type Description int The index of the selected button, or -1 if the user pressed ESC to close the dialog. Remarks Use Query(ustring, ustring, params ustring[]) instead; it automatically sizes the MessageBox based on the contents."
  },
  "api/Terminal.Gui/Terminal.Gui.MouseEvent.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MouseEvent.html",
    "title": "Class MouseEvent",
    "keywords": "Class MouseEvent Low-level construct that conveys the details of mouse events, such as coordinates and button state, from ConsoleDrivers up to Application and Views. Inheritance object MouseEvent Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class MouseEvent Remarks The Application class includes the RootMouseEvent Action which takes a MouseEvent argument. Properties | Edit this page View Source Flags Flags indicating the kind of mouse event that is being posted. Declaration public MouseFlags Flags { get; set; } Property Value Type Description MouseFlags | Edit this page View Source Handled Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber. Its important to set this value to true specially when updating any View's layout from inside the subscriber method. Declaration public bool Handled { get; set; } Property Value Type Description bool | Edit this page View Source OfX The offset X (column) location for the mouse event. Declaration public int OfX { get; set; } Property Value Type Description int | Edit this page View Source OfY The offset Y (column) location for the mouse event. Declaration public int OfY { get; set; } Property Value Type Description int | Edit this page View Source View The current view at the location for the mouse event. Declaration public View View { get; set; } Property Value Type Description View | Edit this page View Source X The X (column) location for the mouse event. Declaration public int X { get; set; } Property Value Type Description int | Edit this page View Source Y The Y (column) location for the mouse event. Declaration public int Y { get; set; } Property Value Type Description int Methods | Edit this page View Source ToString() Returns a string that represents the current MouseEvent. Declaration public override string ToString() Returns Type Description string A string that represents the current MouseEvent. Overrides object.ToString()"
  },
  "api/Terminal.Gui/Terminal.Gui.MouseFlags.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.MouseFlags.html",
    "title": "Enum MouseFlags",
    "keywords": "Enum MouseFlags Mouse flags reported in MouseEvent. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax [Flags] public enum MouseFlags Remarks They just happen to map to the ncurses ones. Fields Name Description AllEvents Mask that captures all the events. Button1Clicked The first mouse button was clicked (press+release). Button1DoubleClicked The first mouse button was double-clicked. Button1Pressed The first mouse button was pressed. Button1Released The first mouse button was released. Button1TripleClicked The first mouse button was triple-clicked. Button2Clicked The second mouse button was clicked (press+release). Button2DoubleClicked The second mouse button was double-clicked. Button2Pressed The second mouse button was pressed. Button2Released The second mouse button was released. Button2TripleClicked The second mouse button was triple-clicked. Button3Clicked The third mouse button was clicked (press+release). Button3DoubleClicked The third mouse button was double-clicked. Button3Pressed The third mouse button was pressed. Button3Released The third mouse button was released. Button3TripleClicked The third mouse button was triple-clicked. Button4Clicked The fourth button was clicked (press+release). Button4DoubleClicked The fourth button was double-clicked. Button4Pressed The fourth mouse button was pressed. Button4Released The fourth mouse button was released. Button4TripleClicked The fourth button was triple-clicked. ButtonAlt Flag: the alt key was pressed when the mouse button took place. ButtonCtrl Flag: the ctrl key was pressed when the mouse button took place. ButtonShift Flag: the shift key was pressed when the mouse button took place. ReportMousePosition The mouse position is being reported in this event. WheeledDown Vertical button wheeled down. WheeledLeft Vertical button wheeled up while pressing ButtonShift. WheeledRight Vertical button wheeled down while pressing ButtonShift. WheeledUp Vertical button wheeled up."
  },
  "api/Terminal.Gui/Terminal.Gui.OpenDialog.OpenMode.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.OpenDialog.OpenMode.html",
    "title": "Enum OpenDialog.OpenMode",
    "keywords": "Enum OpenDialog.OpenMode Determine which System.IO type to open. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum OpenDialog.OpenMode Fields Name Description Directory Opens only directory or directories. File Opens only file or files. Mixed Opens files and directories."
  },
  "api/Terminal.Gui/Terminal.Gui.OpenDialog.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.OpenDialog.html",
    "title": "Class OpenDialog",
    "keywords": "Class OpenDialog The OpenDialogprovides an interactive dialog box for users to select files or directories. Inheritance object Responder View Toplevel Window Dialog FileDialog OpenDialog Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameDirLabel FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ButtonAlignment Dialog.ProcessKey(KeyEvent) Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The open dialog can be used to select files for opening, it can be configured to allow multiple items to be selected (based on the AllowsMultipleSelection) variable and you can control whether this should allow files or directories to be selected. To use, create an instance of OpenDialog, and pass it to Run(Func<Exception, bool>). This will run the dialog modally, and when this returns, the list of files will be available on the FilePaths property. To select more than one file, users can use the spacebar, or control-t. Constructors | Edit this page View Source OpenDialog() Initializes a new OpenDialog. Declaration public OpenDialog() | Edit this page View Source OpenDialog(ustring, ustring, List<string>, OpenMode) Initializes a new OpenDialog. Declaration public OpenDialog(ustring title, ustring message, List<string> allowedTypes = null, OpenDialog.OpenMode openMode = OpenMode.File) Parameters Type Name Description ustring title The title. ustring message The message. List<string> allowedTypes The allowed types. OpenDialog.OpenMode openMode The open mode. Properties | Edit this page View Source AllowsMultipleSelection Gets or sets a value indicating whether this OpenDialog allows multiple selection. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description bool true if allows multiple selection; otherwise, false, defaults to false. | Edit this page View Source CanChooseDirectories Gets or sets a value indicating whether this OpenDialog can choose directories. Declaration public bool CanChooseDirectories { get; set; } Property Value Type Description bool true if can choose directories; otherwise, false defaults to false. | Edit this page View Source CanChooseFiles Gets or sets a value indicating whether this OpenDialog can choose files. Declaration public bool CanChooseFiles { get; set; } Property Value Type Description bool true if can choose files; otherwise, false. Defaults to true | Edit this page View Source FilePaths Returns the selected files, or an empty list if nothing has been selected Declaration public IReadOnlyList<string> FilePaths { get; } Property Value Type Description IReadOnlyList<string> The file paths. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.PanelView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.PanelView.html",
    "title": "Class PanelView",
    "keywords": "Class PanelView A container for single Child that will allow to drawn Border in two ways. If UsePanelFrame the borders and the child will be accommodated in the available panel size, otherwise the panel will be resized based on the child and borders thickness sizes. Inheritance object Responder View PanelView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class PanelView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source PanelView() Initializes a panel with a null child. Declaration public PanelView() | Edit this page View Source PanelView(View) Initializes a panel with a valid child. Declaration public PanelView(View child) Parameters Type Name Description View child Properties | Edit this page View Source Border Declaration public override Border Border { get; set; } Property Value Type Description Border Overrides View.Border | Edit this page View Source Child The child that will use this panel. Declaration public View Child { get; set; } Property Value Type Description View | Edit this page View Source UsePanelFrame Gets or sets if the panel size will used, otherwise the child size. Declaration public bool UsePanelFrame { get; set; } Property Value Type Description bool Methods | Edit this page View Source Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides View.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View)RemoveAll() | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Remove(View) Removes a subview added via Add(View) or Add(params View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) | Edit this page View Source RemoveAll() Removes all subviews (children) added via Add(View) or Add(params View[]) from this View. Declaration public override void RemoveAll() Overrides View.RemoveAll() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Point.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Point.html",
    "title": "Struct Point",
    "keywords": "Struct Point Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. Inherited Members object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct Point Constructors | Edit this page View Source Point(int, int) Point Constructor Declaration public Point(int x, int y) Parameters Type Name Description int x int y Remarks Creates a Point from a specified x,y coordinate pair. | Edit this page View Source Point(Size) Point Constructor Declaration public Point(Size sz) Parameters Type Name Description Size sz Remarks Creates a Point from a Size value. Fields | Edit this page View Source Empty Empty Shared Field Declaration public static readonly Point Empty Field Value Type Description Point Remarks An uninitialized Point Structure. | Edit this page View Source X Gets or sets the x-coordinate of this Point. Declaration public int X Field Value Type Description int | Edit this page View Source Y Gets or sets the y-coordinate of this Point. Declaration public int Y Field Value Type Description int Properties | Edit this page View Source IsEmpty IsEmpty Property Declaration public bool IsEmpty { get; } Property Value Type Description bool Remarks Indicates if both X and Y are zero. Methods | Edit this page View Source Add(Point, Size) Adds the specified Size to the specified Point. Declaration public static Point Add(Point pt, Size sz) Parameters Type Name Description Point pt The Point to add. Size sz The Size to add. Returns Type Description Point The Point that is the result of the addition operation. | Edit this page View Source Equals(object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description object obj Returns Type Description bool Overrides ValueType.Equals(object) Remarks Checks equivalence of this Point and another object. | Edit this page View Source GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description int Overrides ValueType.GetHashCode() Remarks Calculates a hashing value. | Edit this page View Source Offset(int, int) Offset Method Declaration public void Offset(int dx, int dy) Parameters Type Name Description int dx int dy Remarks Moves the Point a specified distance. | Edit this page View Source Offset(Point) Translates this Point by the specified Point. Declaration public void Offset(Point p) Parameters Type Name Description Point p The Point used offset this Point. | Edit this page View Source Subtract(Point, Size) Returns the result of subtracting specified Size from the specified Point. Declaration public static Point Subtract(Point pt, Size sz) Parameters Type Name Description Point pt The Point to be subtracted from. Size sz The Size to subtract from the Point. Returns Type Description Point The Point that is the result of the subtraction operation. | Edit this page View Source ToString() ToString Method Declaration public override string ToString() Returns Type Description string Overrides ValueType.ToString() Remarks Formats the Point as a string in coordinate notation. Operators | Edit this page View Source operator +(Point, Size) Addition Operator Declaration public static Point operator +(Point pt, Size sz) Parameters Type Name Description Point pt Size sz Returns Type Description Point Remarks Translates a Point using the Width and Height properties of the given Size . | Edit this page View Source operator ==(Point, Point) Equality Operator Declaration public static bool operator ==(Point left, Point right) Parameters Type Name Description Point left Point right Returns Type Description bool Remarks Compares two Point objects. The return value is based on the equivalence of the X and Y properties of the two points. | Edit this page View Source explicit operator Size(Point) Point to Size Conversion Declaration public static explicit operator Size(Point p) Parameters Type Name Description Point p Returns Type Description Size Remarks Returns a Size based on the Coordinates of a given Point. Requires explicit cast. | Edit this page View Source operator !=(Point, Point) Inequality Operator Declaration public static bool operator !=(Point left, Point right) Parameters Type Name Description Point left Point right Returns Type Description bool Remarks Compares two Point objects. The return value is based on the equivalence of the X and Y properties of the two points. | Edit this page View Source operator -(Point, Size) Subtraction Operator Declaration public static Point operator -(Point pt, Size sz) Parameters Type Name Description Point pt Size sz Returns Type Description Point Remarks Translates a Point using the negation of the Width and Height properties of the given Size."
  },
  "api/Terminal.Gui/Terminal.Gui.PointF.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.PointF.html",
    "title": "Struct PointF",
    "keywords": "Struct PointF Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. Implements IEquatable<PointF> Inherited Members object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct PointF : IEquatable<PointF> Constructors | Edit this page View Source PointF(float, float) Initializes a new instance of the PointF class with the specified coordinates. Declaration public PointF(float x, float y) Parameters Type Name Description float x float y Fields | Edit this page View Source Empty Creates a new instance of the PointF class with member data left uninitialized. Declaration public static readonly PointF Empty Field Value Type Description PointF Properties | Edit this page View Source IsEmpty Gets a value indicating whether this PointF is empty. Declaration [Browsable(false)] public bool IsEmpty { get; } Property Value Type Description bool | Edit this page View Source X Gets the x-coordinate of this PointF. Declaration public float X { get; set; } Property Value Type Description float | Edit this page View Source Y Gets the y-coordinate of this PointF. Declaration public float Y { get; set; } Property Value Type Description float Methods | Edit this page View Source Add(PointF, Size) Translates a PointF by a given Size . Declaration public static PointF Add(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF | Edit this page View Source Add(PointF, SizeF) Translates a PointF by a given SizeF . Declaration public static PointF Add(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF | Edit this page View Source Equals(object) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public override bool Equals(object obj) Parameters Type Name Description object obj Returns Type Description bool Overrides ValueType.Equals(object) | Edit this page View Source Equals(PointF) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public bool Equals(PointF other) Parameters Type Name Description PointF other Returns Type Description bool | Edit this page View Source GetHashCode() Generates a hashcode from the X and Y components Declaration public override int GetHashCode() Returns Type Description int Overrides ValueType.GetHashCode() | Edit this page View Source Subtract(PointF, Size) Translates a PointF by the negative of a given Size . Declaration public static PointF Subtract(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF | Edit this page View Source Subtract(PointF, SizeF) Translates a PointF by the negative of a given SizeF . Declaration public static PointF Subtract(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF | Edit this page View Source ToString() Returns a string including the X and Y values Declaration public override string ToString() Returns Type Description string Overrides ValueType.ToString() Operators | Edit this page View Source operator +(PointF, Size) Translates a PointF by a given Size . Declaration public static PointF operator +(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF | Edit this page View Source operator +(PointF, SizeF) Translates a PointF by a given SizeF . Declaration public static PointF operator +(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF | Edit this page View Source operator ==(PointF, PointF) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public static bool operator ==(PointF left, PointF right) Parameters Type Name Description PointF left PointF right Returns Type Description bool | Edit this page View Source operator !=(PointF, PointF) Compares two PointF objects. The result specifies whether the values of the X or Y properties of the two PointF objects are unequal. Declaration public static bool operator !=(PointF left, PointF right) Parameters Type Name Description PointF left PointF right Returns Type Description bool | Edit this page View Source operator -(PointF, Size) Translates a PointF by the negative of a given Size . Declaration public static PointF operator -(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF | Edit this page View Source operator -(PointF, SizeF) Translates a PointF by the negative of a given SizeF . Declaration public static PointF operator -(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF Implements IEquatable<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Pos.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Pos.html",
    "title": "Class Pos",
    "keywords": "Class Pos Describes the position of a View which can be an absolute value, a percentage, centered, or relative to the ending dimension. Integer values are implicitly convertible to an absolute Pos. These objects are created using the static methods Percent, AnchorEnd, and Center. The Pos objects can be combined with the addition and subtraction operators. Inheritance object Pos Inherited Members object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Pos Remarks Use the Pos objects on the X or Y properties of a view to control the position. These can be used to set the absolute position, when merely assigning an integer value (via the implicit integer to Pos conversion), and they can be combined to produce more useful layouts, like: Pos.Center - 3, which would shift the position of the View 3 characters to the left after centering for example. It is possible to reference coordinates of another view by using the methods Left(View), Right(View), Bottom(View), Top(View). The X(View) and Y(View) are aliases to Left(View) and Top(View) respectively. Methods | Edit this page View Source AnchorEnd(int) Creates a Pos object that is anchored to the end (right side or bottom) of the dimension, useful to flush the layout from the right or bottom. Declaration public static Pos AnchorEnd(int margin = 0) Parameters Type Name Description int margin Optional margin to place to the right or below. Returns Type Description Pos The Pos object anchored to the end (the bottom or the right side). Examples This sample shows how align a Button to the bottom-right of a View. // See Issue #502 anchorButton.X = Pos.AnchorEnd () - (Pos.Right (anchorButton) - Pos.Left (anchorButton)); anchorButton.Y = Pos.AnchorEnd (1); | Edit this page View Source At(int) Creates an Absolute Pos from the specified integer value. Declaration public static Pos At(int n) Parameters Type Name Description int n The value to convert to the Pos. Returns Type Description Pos The Absolute Pos. | Edit this page View Source Bottom(View) Returns a Pos object tracks the Bottom (Y+Height) coordinate of the specified View Declaration public static Pos Bottom(View view) Parameters Type Name Description View view The View that will be tracked. Returns Type Description Pos The Pos that depends on the other view. | Edit this page View Source Center() Returns a Pos object that can be used to center the View Declaration public static Pos Center() Returns Type Description Pos The center Pos. Examples This creates a TextFieldthat is centered horizontally, is 50% of the way down, is 30% the height, and is 80% the width of the View it added to. var textView = new TextView () { X = Pos.Center (), Y = Pos.Percent (50), Width = Dim.Percent (80), Height = Dim.Percent (30), }; | Edit this page View Source Equals(object) Determines whether the specified object is equal to the current object. Declaration public override bool Equals(object other) Parameters Type Name Description object other The object to compare with the current object. Returns Type Description bool true if the specified object is equal to the current object; otherwise, false. Overrides object.Equals(object) | Edit this page View Source Function(Func<int>) Creates a \"PosFunc\" from the specified function. Declaration public static Pos Function(Func<int> function) Parameters Type Name Description Func<int> function The function to be executed. Returns Type Description Pos The Pos returned from the function. | Edit this page View Source GetHashCode() Serves as the default hash function. Declaration public override int GetHashCode() Returns Type Description int A hash code for the current object. Overrides object.GetHashCode() | Edit this page View Source Left(View) Returns a Pos object tracks the Left (X) position of the specified View. Declaration public static Pos Left(View view) Parameters Type Name Description View view The View that will be tracked. Returns Type Description Pos The Pos that depends on the other view. | Edit this page View Source Percent(float) Creates a percentage Pos object Declaration public static Pos Percent(float n) Parameters Type Name Description float n A value between 0 and 100 representing the percentage. Returns Type Description Pos The percent Pos object. Examples This creates a TextFieldthat is centered horizontally, is 50% of the way down, is 30% the height, and is 80% the width of the View it added to. var textView = new TextView () { X = Pos.Center (), Y = Pos.Percent (50), Width = Dim.Percent (80), Height = Dim.Percent (30), }; | Edit this page View Source Right(View) Returns a Pos object tracks the Right (X+Width) coordinate of the specified View. Declaration public static Pos Right(View view) Parameters Type Name Description View view The View that will be tracked. Returns Type Description Pos The Pos that depends on the other view. | Edit this page View Source Top(View) Returns a Pos object tracks the Top (Y) position of the specified View. Declaration public static Pos Top(View view) Parameters Type Name Description View view The View that will be tracked. Returns Type Description Pos The Pos that depends on the other view. | Edit this page View Source X(View) Returns a Pos object tracks the Left (X) position of the specified View. Declaration public static Pos X(View view) Parameters Type Name Description View view The View that will be tracked. Returns Type Description Pos The Pos that depends on the other view. | Edit this page View Source Y(View) Returns a Pos object tracks the Top (Y) position of the specified View. Declaration public static Pos Y(View view) Parameters Type Name Description View view The View that will be tracked. Returns Type Description Pos The Pos that depends on the other view. Operators | Edit this page View Source operator +(Pos, Pos) Adds a Pos to a Pos, yielding a new Pos. Declaration public static Pos operator +(Pos left, Pos right) Parameters Type Name Description Pos left The first Pos to add. Pos right The second Pos to add. Returns Type Description Pos The Pos that is the sum of the values of left and right. | Edit this page View Source implicit operator Pos(int) Creates an Absolute Pos from the specified integer value. Declaration public static implicit operator Pos(int n) Parameters Type Name Description int n The value to convert to the Pos . Returns Type Description Pos The Absolute Pos. | Edit this page View Source operator -(Pos, Pos) Subtracts a Pos from a Pos, yielding a new Pos. Declaration public static Pos operator -(Pos left, Pos right) Parameters Type Name Description Pos left The Pos to subtract from (the minuend). Pos right The Pos to subtract (the subtrahend). Returns Type Description Pos The Pos that is the left minus right."
  },
  "api/Terminal.Gui/Terminal.Gui.ProgressBar.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ProgressBar.html",
    "title": "Class ProgressBar",
    "keywords": "Class ProgressBar A Progress Bar view that can indicate progress of an activity visually. Inheritance object Responder View ProgressBar Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks ProgressBar can operate in two modes, percentage mode, or activity mode. The progress bar starts in percentage mode and setting the Fraction property will reflect on the UI the progress made so far. Activity mode is used when the application has no way of knowing how much time is left, and is started when the Pulse() method is called. Call Pulse() repeatedly as progress is made. Constructors | Edit this page View Source ProgressBar() Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout. Declaration public ProgressBar() | Edit this page View Source ProgressBar(Rect) Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size. Declaration public ProgressBar(Rect rect) Parameters Type Name Description Rect rect Rect. Properties | Edit this page View Source BidirectionalMarquee Specifies if the MarqueeBlocks or the MarqueeContinuous styles is unidirectional or bidirectional. Declaration public bool BidirectionalMarquee { get; set; } Property Value Type Description bool | Edit this page View Source Fraction Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1. Declaration public float Fraction { get; set; } Property Value Type Description float The fraction representing the progress. | Edit this page View Source ProgressBarFormat Specifies the format that a ProgressBar uses to indicate the visual presentation. Declaration public ProgressBarFormat ProgressBarFormat { get; set; } Property Value Type Description ProgressBarFormat | Edit this page View Source ProgressBarStyle Gets/Sets the progress bar style based on the ProgressBarStyle Declaration public ProgressBarStyle ProgressBarStyle { get; set; } Property Value Type Description ProgressBarStyle | Edit this page View Source SegmentCharacter Segment indicator for meter views. Declaration public Rune SegmentCharacter { get; set; } Property Value Type Description Rune | Edit this page View Source Text The text displayed by the View. Declaration public override ustring Text { get; set; } Property Value Type Description ustring Overrides View.Text Remarks If provided, the text will be drawn before any subviews are drawn. The text will be drawn starting at the view origin (0, 0) and will be formatted according to the TextAlignment property. If the view's height is greater than 1, the text will word-wrap to additional lines if it does not fit horizontally. If the view's height is 1, the text will be clipped. Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to (Rune)0xffff. Methods | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source Pulse() Notifies the ProgressBar that some progress has taken place. Declaration public void Pulse() Remarks If the ProgressBar is percentage mode, it switches to activity mode. If is in activity mode, the marker is moved. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html",
    "title": "Enum ProgressBarFormat",
    "keywords": "Enum ProgressBarFormat Specifies the format that a ProgressBar uses to indicate the visual presentation. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum ProgressBarFormat Fields Name Description Framed A framed visual presentation showing only the progress bar. FramedPlusPercentage A framed visual presentation showing the progress bar and the percentage. FramedProgressPadded A framed visual presentation showing all with the progress bar padded. Simple A simple visual presentation showing only the progress bar. SimplePlusPercentage A simple visual presentation showing the progress bar and the percentage."
  },
  "api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html",
    "title": "Enum ProgressBarStyle",
    "keywords": "Enum ProgressBarStyle Specifies the style that a ProgressBar uses to indicate the progress of an operation. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum ProgressBarStyle Fields Name Description Blocks Indicates progress by increasing the number of segmented blocks in a ProgressBar. Continuous Indicates progress by increasing the size of a smooth, continuous bar in a ProgressBar. MarqueeBlocks Indicates progress by continuously scrolling a block across a ProgressBar in a marquee fashion. MarqueeContinuous Indicates progress by continuously scrolling a block across a ProgressBar in a marquee fashion."
  },
  "api/Terminal.Gui/Terminal.Gui.RadioGroup.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.RadioGroup.html",
    "title": "Class RadioGroup",
    "keywords": "Class RadioGroup Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time. Inheritance object Responder View RadioGroup Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class RadioGroup : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source RadioGroup() Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup() | Edit this page View Source RadioGroup(ustring[], int) Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup(ustring[] radioLabels, int selected = 0) Parameters Type Name Description ustring[] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. int selected The index of the item to be selected, the value is clamped to the number of items. | Edit this page View Source RadioGroup(int, int, ustring[], int) Initializes a new instance of the RadioGroup class using Absolute layout. The View frame is computed from the provided radio labels. Declaration public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0) Parameters Type Name Description int x The x coordinate. int y The y coordinate. ustring[] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. int selected The item to be selected, the value is clamped to the number of items. | Edit this page View Source RadioGroup(Rect, ustring[], int) Initializes a new instance of the RadioGroup class using Absolute layout. Declaration public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0) Parameters Type Name Description Rect rect Boundaries for the radio group. ustring[] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. int selected The index of item to be selected, the value is clamped to the number of items. Properties | Edit this page View Source DisplayMode Gets or sets the DisplayModeLayout for this RadioGroup. Declaration public DisplayModeLayout DisplayMode { get; set; } Property Value Type Description DisplayModeLayout | Edit this page View Source HorizontalSpace Gets or sets the horizontal space for this RadioGroup if the DisplayMode is Horizontal Declaration public int HorizontalSpace { get; set; } Property Value Type Description int | Edit this page View Source RadioLabels The radio labels to display Declaration public ustring[] RadioLabels { get; set; } Property Value Type Description ustring[] The radio labels. | Edit this page View Source SelectedItem The currently selected item from the list of radio labels Declaration public int SelectedItem { get; set; } Property Value Type Description int The selected. Methods | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnSelectedItemChanged(int, int) Called whenever the current selected item changes. Invokes the SelectedItemChanged event. Declaration public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem) Parameters Type Name Description int selectedItem int previousSelectedItem | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Refresh() Allow to invoke the SelectedItemChanged after their creation. Declaration public void Refresh() Events | Edit this page View Source SelectedItemChanged Invoked when the selected radio label has changed. Declaration public event Action<SelectedItemChangedArgs> SelectedItemChanged Event Type Type Description Action<SelectedItemChangedArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Rect.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Rect.html",
    "title": "Struct Rect",
    "keywords": "Struct Rect Stores a set of four integers that represent the location and size of a rectangle Inherited Members object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct Rect Constructors | Edit this page View Source Rect(int, int, int, int) Rectangle Constructor Declaration public Rect(int x, int y, int width, int height) Parameters Type Name Description int x int y int width int height Remarks Creates a Rectangle from a specified x,y location and width and height values. | Edit this page View Source Rect(Point, Size) Rectangle Constructor Declaration public Rect(Point location, Size size) Parameters Type Name Description Point location Size size Remarks Creates a Rectangle from Point and Size values. Fields | Edit this page View Source Empty Empty Shared Field Declaration public static readonly Rect Empty Field Value Type Description Rect Remarks An uninitialized Rectangle Structure. | Edit this page View Source X Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure. Declaration public int X Field Value Type Description int | Edit this page View Source Y Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure. Declaration public int Y Field Value Type Description int Properties | Edit this page View Source Bottom Bottom Property Declaration public int Bottom { get; } Property Value Type Description int Remarks The Y coordinate of the bottom edge of the Rectangle. Read only. | Edit this page View Source Height Gets or sets the height of this Rectangle structure. Declaration public int Height { get; set; } Property Value Type Description int | Edit this page View Source IsEmpty IsEmpty Property Declaration public bool IsEmpty { get; } Property Value Type Description bool Remarks Indicates if the width or height are zero. Read only. | Edit this page View Source Left Left Property Declaration public int Left { get; } Property Value Type Description int Remarks The X coordinate of the left edge of the Rectangle. Read only. | Edit this page View Source Location Location Property Declaration public Point Location { get; set; } Property Value Type Description Point Remarks The Location of the top-left corner of the Rectangle. | Edit this page View Source Right Right Property Declaration public int Right { get; } Property Value Type Description int Remarks The X coordinate of the right edge of the Rectangle. Read only. | Edit this page View Source Size Size Property Declaration public Size Size { get; set; } Property Value Type Description Size Remarks The Size of the Rectangle. | Edit this page View Source Top Top Property Declaration public int Top { get; } Property Value Type Description int Remarks The Y coordinate of the top edge of the Rectangle. Read only. | Edit this page View Source Width Gets or sets the width of this Rect structure. Declaration public int Width { get; set; } Property Value Type Description int Methods | Edit this page View Source Contains(int, int) Contains Method Declaration public bool Contains(int x, int y) Parameters Type Name Description int x int y Returns Type Description bool Remarks Checks if an x,y coordinate lies within this Rectangle. | Edit this page View Source Contains(Point) Contains Method Declaration public bool Contains(Point pt) Parameters Type Name Description Point pt Returns Type Description bool Remarks Checks if a Point lies within this Rectangle. | Edit this page View Source Contains(Rect) Contains Method Declaration public bool Contains(Rect rect) Parameters Type Name Description Rect rect Returns Type Description bool Remarks Checks if a Rectangle lies entirely within this Rectangle. | Edit this page View Source Equals(object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description object obj Returns Type Description bool Overrides ValueType.Equals(object) Remarks Checks equivalence of this Rectangle and another object. | Edit this page View Source FromLTRB(int, int, int, int) FromLTRB Shared Method Declaration public static Rect FromLTRB(int left, int top, int right, int bottom) Parameters Type Name Description int left int top int right int bottom Returns Type Description Rect Remarks Produces a Rectangle structure from left, top, right and bottom coordinates. | Edit this page View Source GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description int Overrides ValueType.GetHashCode() Remarks Calculates a hashing value. | Edit this page View Source Inflate(int, int) Inflate Method Declaration public void Inflate(int width, int height) Parameters Type Name Description int width int height Remarks Inflates the Rectangle by a specified width and height. | Edit this page View Source Inflate(Rect, int, int) Inflate Shared Method Declaration public static Rect Inflate(Rect rect, int x, int y) Parameters Type Name Description Rect rect int x int y Returns Type Description Rect Remarks Produces a new Rectangle by inflating an existing Rectangle by the specified coordinate values. | Edit this page View Source Inflate(Size) Inflate Method Declaration public void Inflate(Size size) Parameters Type Name Description Size size Remarks Inflates the Rectangle by a specified Size. | Edit this page View Source Intersect(Rect) Intersect Method Declaration public void Intersect(Rect rect) Parameters Type Name Description Rect rect Remarks Replaces the Rectangle with the intersection of itself and another Rectangle. | Edit this page View Source Intersect(Rect, Rect) Intersect Shared Method Declaration public static Rect Intersect(Rect a, Rect b) Parameters Type Name Description Rect a Rect b Returns Type Description Rect Remarks Produces a new Rectangle by intersecting 2 existing Rectangles. Returns null if there is no intersection. | Edit this page View Source IntersectsWith(Rect) IntersectsWith Method Declaration public bool IntersectsWith(Rect rect) Parameters Type Name Description Rect rect Returns Type Description bool Remarks Checks if a Rectangle intersects with this one. | Edit this page View Source Offset(int, int) Offset Method Declaration public void Offset(int x, int y) Parameters Type Name Description int x int y Remarks Moves the Rectangle a specified distance. | Edit this page View Source Offset(Point) Offset Method Declaration public void Offset(Point pos) Parameters Type Name Description Point pos Remarks Moves the Rectangle a specified distance. | Edit this page View Source ToString() ToString Method Declaration public override string ToString() Returns Type Description string Overrides ValueType.ToString() Remarks Formats the Rectangle as a string in (x,y,w,h) notation. | Edit this page View Source Union(Rect, Rect) Union Shared Method Declaration public static Rect Union(Rect a, Rect b) Parameters Type Name Description Rect a Rect b Returns Type Description Rect Remarks Produces a new Rectangle from the union of 2 existing Rectangles. Operators | Edit this page View Source operator ==(Rect, Rect) Equality Operator Declaration public static bool operator ==(Rect left, Rect right) Parameters Type Name Description Rect left Rect right Returns Type Description bool Remarks Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size properties of the two Rectangles. | Edit this page View Source operator !=(Rect, Rect) Inequality Operator Declaration public static bool operator !=(Rect left, Rect right) Parameters Type Name Description Rect left Rect right Returns Type Description bool Remarks Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size properties of the two Rectangles."
  },
  "api/Terminal.Gui/Terminal.Gui.RectangleF.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.RectangleF.html",
    "title": "Struct RectangleF",
    "keywords": "Struct RectangleF Stores the location and size of a rectangular region. Implements IEquatable<RectangleF> Inherited Members object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct RectangleF : IEquatable<RectangleF> Constructors | Edit this page View Source RectangleF(float, float, float, float) Initializes a new instance of the RectangleF class with the specified location and size. Declaration public RectangleF(float x, float y, float width, float height) Parameters Type Name Description float x float y float width float height | Edit this page View Source RectangleF(PointF, SizeF) Initializes a new instance of the RectangleF class with the specified location and size. Declaration public RectangleF(PointF location, SizeF size) Parameters Type Name Description PointF location SizeF size Fields | Edit this page View Source Empty Initializes a new instance of the RectangleF class. Declaration public static readonly RectangleF Empty Field Value Type Description RectangleF Properties | Edit this page View Source Bottom Gets the y-coordinate of the lower-right corner of the rectangular region defined by this RectangleF. Declaration [Browsable(false)] public float Bottom { get; } Property Value Type Description float | Edit this page View Source Height Gets or sets the height of the rectangular region defined by this RectangleF. Declaration public float Height { get; set; } Property Value Type Description float | Edit this page View Source IsEmpty Tests whether this RectangleF has a Width or a Height of 0. Declaration [Browsable(false)] public bool IsEmpty { get; } Property Value Type Description bool | Edit this page View Source Left Gets the x-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public float Left { get; } Property Value Type Description float | Edit this page View Source Location Gets or sets the coordinates of the upper-left corner of the rectangular region represented by this RectangleF. Declaration [Browsable(false)] public PointF Location { get; set; } Property Value Type Description PointF | Edit this page View Source Right Gets the x-coordinate of the lower-right corner of the rectangular region defined by this RectangleF. Declaration [Browsable(false)] public float Right { get; } Property Value Type Description float | Edit this page View Source Size Gets or sets the size of this RectangleF. Declaration [Browsable(false)] public SizeF Size { get; set; } Property Value Type Description SizeF | Edit this page View Source Top Gets the y-coordinate of the upper-left corner of the rectangular region defined by this RectangleF. Declaration [Browsable(false)] public float Top { get; } Property Value Type Description float | Edit this page View Source Width Gets or sets the width of the rectangular region defined by this RectangleF. Declaration public float Width { get; set; } Property Value Type Description float | Edit this page View Source X Gets or sets the x-coordinate of the upper-left corner of the rectangular region defined by this RectangleF. Declaration public float X { get; set; } Property Value Type Description float | Edit this page View Source Y Gets or sets the y-coordinate of the upper-left corner of the rectangular region defined by this RectangleF. Declaration public float Y { get; set; } Property Value Type Description float Methods | Edit this page View Source Contains(float, float) Determines if the specified point is contained within the rectangular region defined by this Rect . Declaration public bool Contains(float x, float y) Parameters Type Name Description float x float y Returns Type Description bool | Edit this page View Source Contains(PointF) Determines if the specified point is contained within the rectangular region defined by this Rect . Declaration public bool Contains(PointF pt) Parameters Type Name Description PointF pt Returns Type Description bool | Edit this page View Source Contains(RectangleF) Determines if the rectangular region represented by rect is entirely contained within the rectangular region represented by this Rect . Declaration public bool Contains(RectangleF rect) Parameters Type Name Description RectangleF rect Returns Type Description bool | Edit this page View Source Equals(object) Tests whether obj is a RectangleF with the same location and size of this RectangleF. Declaration public override bool Equals(object obj) Parameters Type Name Description object obj Returns Type Description bool Overrides ValueType.Equals(object) | Edit this page View Source Equals(RectangleF) Returns true if two RectangleF objects have equal location and size. Declaration public bool Equals(RectangleF other) Parameters Type Name Description RectangleF other Returns Type Description bool | Edit this page View Source FromLTRB(float, float, float, float) Creates a new RectangleF with the specified location and size. Declaration public static RectangleF FromLTRB(float left, float top, float right, float bottom) Parameters Type Name Description float left float top float right float bottom Returns Type Description RectangleF | Edit this page View Source GetHashCode() Gets the hash code for this RectangleF. Declaration public override int GetHashCode() Returns Type Description int Overrides ValueType.GetHashCode() | Edit this page View Source Inflate(float, float) Inflates this Rect by the specified amount. Declaration public void Inflate(float x, float y) Parameters Type Name Description float x float y | Edit this page View Source Inflate(RectangleF, float, float) Creates a Rect that is inflated by the specified amount. Declaration public static RectangleF Inflate(RectangleF rect, float x, float y) Parameters Type Name Description RectangleF rect float x float y Returns Type Description RectangleF | Edit this page View Source Inflate(SizeF) Inflates this Rect by the specified amount. Declaration public void Inflate(SizeF size) Parameters Type Name Description SizeF size | Edit this page View Source Intersect(RectangleF) Creates a Rectangle that represents the intersection between this Rectangle and rect. Declaration public void Intersect(RectangleF rect) Parameters Type Name Description RectangleF rect | Edit this page View Source Intersect(RectangleF, RectangleF) Creates a rectangle that represents the intersection between a and b. If there is no intersection, an empty rectangle is returned. Declaration public static RectangleF Intersect(RectangleF a, RectangleF b) Parameters Type Name Description RectangleF a RectangleF b Returns Type Description RectangleF | Edit this page View Source IntersectsWith(RectangleF) Determines if this rectangle intersects with rect. Declaration public bool IntersectsWith(RectangleF rect) Parameters Type Name Description RectangleF rect Returns Type Description bool | Edit this page View Source Offset(float, float) Adjusts the location of this rectangle by the specified amount. Declaration public void Offset(float x, float y) Parameters Type Name Description float x float y | Edit this page View Source Offset(PointF) Adjusts the location of this rectangle by the specified amount. Declaration public void Offset(PointF pos) Parameters Type Name Description PointF pos | Edit this page View Source ToString() Converts the Location and Size of this RectangleF to a human-readable string. Declaration public override string ToString() Returns Type Description string Overrides ValueType.ToString() | Edit this page View Source Union(RectangleF, RectangleF) Creates a rectangle that represents the union between a and b. Declaration public static RectangleF Union(RectangleF a, RectangleF b) Parameters Type Name Description RectangleF a RectangleF b Returns Type Description RectangleF Operators | Edit this page View Source operator ==(RectangleF, RectangleF) Tests whether two RectangleF objects have equal location and size. Declaration public static bool operator ==(RectangleF left, RectangleF right) Parameters Type Name Description RectangleF left RectangleF right Returns Type Description bool | Edit this page View Source implicit operator RectangleF(Rect) Converts the specified Rect to a RectangleF. Declaration public static implicit operator RectangleF(Rect r) Parameters Type Name Description Rect r Returns Type Description RectangleF | Edit this page View Source operator !=(RectangleF, RectangleF) Tests whether two RectangleF objects differ in location or size. Declaration public static bool operator !=(RectangleF left, RectangleF right) Parameters Type Name Description RectangleF left RectangleF right Returns Type Description bool Implements IEquatable<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Responder.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Responder.html",
    "title": "Class Responder",
    "keywords": "Class Responder Responder base class implemented by objects that want to participate on keyboard and mouse input. Inheritance object Responder View Implements IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Responder : IDisposable Properties | Edit this page View Source CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public virtual bool CanFocus { get; set; } Property Value Type Description bool true if can focus; otherwise, false. | Edit this page View Source Enabled Gets or sets a value indicating whether this Responder can respond to user interaction. Declaration public virtual bool Enabled { get; set; } Property Value Type Description bool | Edit this page View Source HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public virtual bool HasFocus { get; } Property Value Type Description bool true if has focus; otherwise, false. | Edit this page View Source Visible Gets or sets a value indicating whether this Responder and all its child controls are displayed. Declaration public virtual bool Visible { get; set; } Property Value Type Description bool Methods | Edit this page View Source Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resource. Declaration public void Dispose() | Edit this page View Source Dispose(bool) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description bool disposing Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public virtual bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description bool true, if the event was handled, false otherwise. | Edit this page View Source OnCanFocusChanged() Method invoked when the CanFocus property from a view is changed. Declaration public virtual void OnCanFocusChanged() | Edit this page View Source OnEnabledChanged() Method invoked when the Enabled property from a view is changed. Declaration public virtual void OnEnabledChanged() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public virtual bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. | Edit this page View Source OnKeyDown(KeyEvent) Method invoked when a key is pressed. Declaration public virtual bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled | Edit this page View Source OnKeyUp(KeyEvent) Method invoked when a key is released. Declaration public virtual bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public virtual bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. | Edit this page View Source OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public virtual bool OnMouseEnter(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description bool true, if the event was handled, false otherwise. | Edit this page View Source OnMouseLeave(MouseEvent) Method invoked when a mouse event is generated for the last time. Declaration public virtual bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description bool true, if the event was handled, false otherwise. | Edit this page View Source OnVisibleChanged() Method invoked when the Visible property from a view is changed. Declaration public virtual void OnVisibleChanged() | Edit this page View Source ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public virtual bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public virtual bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public virtual bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Implements IDisposable"
  },
  "api/Terminal.Gui/Terminal.Gui.SaveDialog.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.SaveDialog.html",
    "title": "Class SaveDialog",
    "keywords": "Class SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. Inheritance object Responder View Toplevel Window Dialog FileDialog SaveDialog Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameDirLabel FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ButtonAlignment Dialog.ProcessKey(KeyEvent) Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To use, create an instance of SaveDialog, and pass it to Run(Func<Exception, bool>). This will run the dialog modally, and when this returns, the FileNameproperty will contain the selected file name or null if the user canceled. Constructors | Edit this page View Source SaveDialog() Initializes a new SaveDialog. Declaration public SaveDialog() | Edit this page View Source SaveDialog(ustring, ustring, List<string>) Initializes a new SaveDialog. Declaration public SaveDialog(ustring title, ustring message, List<string> allowedTypes = null) Parameters Type Name Description ustring title The title. ustring message The message. List<string> allowedTypes The allowed types. Properties | Edit this page View Source FileName Gets the name of the file the user selected for saving, or null if the user canceled the SaveDialog. Declaration public ustring FileName { get; } Property Value Type Description ustring The name of the file. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.ScrollBarView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ScrollBarView.html",
    "title": "Class ScrollBarView",
    "keywords": "Class ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical Inheritance object Responder View ScrollBarView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The scrollbar is drawn to be a representation of the Size, assuming that the scroll position is set at Position. If the region to display the scrollbar is larger than three characters, arrow indicators are drawn. Constructors | Edit this page View Source ScrollBarView() Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView() | Edit this page View Source ScrollBarView(int, int, bool) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(int size, int position, bool isVertical) Parameters Type Name Description int size The size that this scrollbar represents. int position The position within this scrollbar. bool isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. | Edit this page View Source ScrollBarView(Rect) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect) Parameters Type Name Description Rect rect Frame for the scrollbar. | Edit this page View Source ScrollBarView(Rect, int, int, bool) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect, int size, int position, bool isVertical) Parameters Type Name Description Rect rect Frame for the scrollbar. int size The size that this scrollbar represents. Sets the Size property. int position The position within this scrollbar. Sets the Position property. bool isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the IsVertical property. | Edit this page View Source ScrollBarView(View, bool, bool) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(View host, bool isVertical, bool showBothScrollIndicator = true) Parameters Type Name Description View host The view that will host this scrollbar. bool isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. bool showBothScrollIndicator If set to true (default) will have the other scrollbar, otherwise will have only one. Properties | Edit this page View Source AutoHideScrollBars If true the vertical/horizontal scroll bars won't be showed if it's not needed. Declaration public bool AutoHideScrollBars { get; set; } Property Value Type Description bool | Edit this page View Source Host Get or sets the view that host this View Declaration public View Host { get; } Property Value Type Description View | Edit this page View Source IsVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Declaration public bool IsVertical { get; set; } Property Value Type Description bool | Edit this page View Source KeepContentAlwaysInViewport Get or sets if the view-port is kept always visible in the area of this ScrollBarView Declaration public bool KeepContentAlwaysInViewport { get; set; } Property Value Type Description bool | Edit this page View Source OtherScrollBarView Represent a vertical or horizontal ScrollBarView other than this. Declaration public ScrollBarView OtherScrollBarView { get; set; } Property Value Type Description ScrollBarView | Edit this page View Source Position The position, relative to Size, to set the scrollbar at. Declaration public int Position { get; set; } Property Value Type Description int The position. | Edit this page View Source ShowScrollIndicator Gets or sets the visibility for the vertical or horizontal scroll indicator. Declaration public bool ShowScrollIndicator { get; set; } Property Value Type Description bool true if show vertical or horizontal scroll indicator; otherwise, false. | Edit this page View Source Size The size of content the scrollbar represents. Declaration public int Size { get; set; } Property Value Type Description int The size. Remarks The Size is typically the size of the virtual content. E.g. when a Scrollbar is part of a View the Size is set to the appropriate dimension of Host. Methods | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnChangedPosition() Virtual method to invoke the ChangedPosition action event. Declaration public virtual void OnChangedPosition() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Refresh() Only used for a hosted view that will update and redraw the scrollbars. Declaration public virtual void Refresh() Events | Edit this page View Source ChangedPosition This event is raised when the position on the scrollbar has changed. Declaration public event Action ChangedPosition Event Type Type Description Action Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.ScrollView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ScrollView.html",
    "title": "Class ScrollView",
    "keywords": "Class ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. Inheritance object Responder View ScrollView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ScrollView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The subviews that are added to this ScrollView are offset by the ContentOffset property. The view itself is a window into the space represented by the ContentSize. Use the Constructors | Edit this page View Source ScrollView() Initializes a new instance of the ScrollView class using Computed positioning. Declaration public ScrollView() | Edit this page View Source ScrollView(Rect) Initializes a new instance of the ScrollView class using Absolute positioning. Declaration public ScrollView(Rect frame) Parameters Type Name Description Rect frame Properties | Edit this page View Source AutoHideScrollBars If true the vertical/horizontal scroll bars won't be showed if it's not needed. Declaration public bool AutoHideScrollBars { get; set; } Property Value Type Description bool | Edit this page View Source ContentOffset Represents the top left corner coordinate that is displayed by the scrollview Declaration public Point ContentOffset { get; set; } Property Value Type Description Point The content offset. | Edit this page View Source ContentSize Represents the contents of the data shown inside the scrollview Declaration public Size ContentSize { get; set; } Property Value Type Description Size The size of the content. | Edit this page View Source KeepContentAlwaysInViewport Get or sets if the view-port is kept always visible in the area of this ScrollView Declaration public bool KeepContentAlwaysInViewport { get; set; } Property Value Type Description bool | Edit this page View Source ShowHorizontalScrollIndicator Gets or sets the visibility for the horizontal scroll indicator. Declaration public bool ShowHorizontalScrollIndicator { get; set; } Property Value Type Description bool true if show horizontal scroll indicator; otherwise, false. | Edit this page View Source ShowVerticalScrollIndicator Gets or sets the visibility for the vertical scroll indicator. Declaration public bool ShowVerticalScrollIndicator { get; set; } Property Value Type Description bool true if show vertical scroll indicator; otherwise, false. Methods | Edit this page View Source Add(View) Adds the view to the scrollview. Declaration public override void Add(View view) Parameters Type Name Description View view The view to add to the scrollview. Overrides View.Add(View) | Edit this page View Source Dispose(bool) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description bool disposing Overrides View.Dispose(bool) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Remove(View) Removes the view from the scrollview. Declaration public override void Remove(View view) Parameters Type Name Description View view The view to remove from the scrollview. Overrides View.Remove(View) | Edit this page View Source RemoveAll() Removes all widgets from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() | Edit this page View Source ScrollDown(int) Scrolls the view down. Declaration public bool ScrollDown(int lines) Parameters Type Name Description int lines Number of lines to scroll. Returns Type Description bool true, if left was scrolled, false otherwise. | Edit this page View Source ScrollLeft(int) Scrolls the view to the left Declaration public bool ScrollLeft(int cols) Parameters Type Name Description int cols Number of columns to scroll by. Returns Type Description bool true, if left was scrolled, false otherwise. | Edit this page View Source ScrollRight(int) Scrolls the view to the right. Declaration public bool ScrollRight(int cols) Parameters Type Name Description int cols Number of columns to scroll by. Returns Type Description bool true, if right was scrolled, false otherwise. | Edit this page View Source ScrollUp(int) Scrolls the view up. Declaration public bool ScrollUp(int lines) Parameters Type Name Description int lines Number of lines to scroll. Returns Type Description bool true, if left was scrolled, false otherwise. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.SelectedItemChangedArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.SelectedItemChangedArgs.html",
    "title": "Class SelectedItemChangedArgs",
    "keywords": "Class SelectedItemChangedArgs Event arguments for the SelectedItemChagned event. Inheritance object EventArgs SelectedItemChangedArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class SelectedItemChangedArgs : EventArgs Constructors | Edit this page View Source SelectedItemChangedArgs(int, int) Initializes a new SelectedItemChangedArgs class. Declaration public SelectedItemChangedArgs(int selectedItem, int previousSelectedItem) Parameters Type Name Description int selectedItem int previousSelectedItem Properties | Edit this page View Source PreviousSelectedItem Gets the index of the item that was previously selected. -1 if there was no previous selection. Declaration public int PreviousSelectedItem { get; } Property Value Type Description int | Edit this page View Source SelectedItem Gets the index of the item that is now selected. -1 if there is no selection. Declaration public int SelectedItem { get; } Property Value Type Description int"
  },
  "api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html",
    "title": "Class ShortcutHelper",
    "keywords": "Class ShortcutHelper Represents a helper to manipulate shortcut keys used on views. Inheritance object ShortcutHelper Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ShortcutHelper Properties | Edit this page View Source Shortcut This is the global setting that can be used as a global shortcut to invoke the action on the view. Declaration public virtual Key Shortcut { get; set; } Property Value Type Description Key | Edit this page View Source ShortcutAction The action to run if the Shortcut is defined. Declaration public virtual Action ShortcutAction { get; set; } Property Value Type Description Action | Edit this page View Source ShortcutTag The keystroke combination used in the Shortcut as string. Declaration public virtual ustring ShortcutTag { get; } Property Value Type Description ustring Methods | Edit this page View Source CheckKeysFlagRange(Key, Key, Key) Lookup for a Key on range of keys. Declaration public static bool CheckKeysFlagRange(Key key, Key first, Key last) Parameters Type Name Description Key key The source key. Key first First key in range. Key last Last key in range. Returns Type Description bool | Edit this page View Source FindAndOpenByShortcut(KeyEvent, View) Allows a view to run a ShortcutAction if defined. Declaration public static bool FindAndOpenByShortcut(KeyEvent kb, View view = null) Parameters Type Name Description KeyEvent kb The KeyEvent View view The View Returns Type Description bool true if defined falseotherwise. | Edit this page View Source GetKeyToString(Key, out Key) Return key as string. Declaration public static ustring GetKeyToString(Key key, out Key knm) Parameters Type Name Description Key key The key to extract. Key knm Correspond to the non modifier key. Returns Type Description ustring | Edit this page View Source GetModifiersKey(KeyEvent) Gets the key with all the keys modifiers, especially the shift key that sometimes have to be injected later. Declaration public static Key GetModifiersKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb The KeyEvent to check. Returns Type Description Key The Key with all the keys modifiers. | Edit this page View Source GetShortcutFromTag(ustring, ustring) Allows to retrieve a Key from a ShortcutTag Declaration public static Key GetShortcutFromTag(ustring tag, ustring delimiter = null) Parameters Type Name Description ustring tag The key as string. ustring delimiter The delimiter string. Returns Type Description Key | Edit this page View Source GetShortcutTag(Key, ustring) Get the Shortcut key as string. Declaration public static ustring GetShortcutTag(Key shortcut, ustring delimiter = null) Parameters Type Name Description Key shortcut The shortcut key. ustring delimiter The delimiter string. Returns Type Description ustring | Edit this page View Source PostShortcutValidation(Key) Used at key up validation. Declaration public static bool PostShortcutValidation(Key key) Parameters Type Name Description Key key The key to validate. Returns Type Description bool true if is valid.falseotherwise. | Edit this page View Source PreShortcutValidation(Key) Used at key down or key press validation. Declaration public static bool PreShortcutValidation(Key key) Parameters Type Name Description Key key The key to validate. Returns Type Description bool true if is valid.falseotherwise."
  },
  "api/Terminal.Gui/Terminal.Gui.Size.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Size.html",
    "title": "Struct Size",
    "keywords": "Struct Size Stores an ordered pair of integers, which specify a Height and Width. Inherited Members object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct Size Constructors | Edit this page View Source Size(int, int) Size Constructor Declaration public Size(int width, int height) Parameters Type Name Description int width int height Remarks Creates a Size from specified dimensions. | Edit this page View Source Size(Point) Size Constructor Declaration public Size(Point pt) Parameters Type Name Description Point pt Remarks Creates a Size from a Point value. Fields | Edit this page View Source Empty Gets a Size structure that has a Height and Width value of 0. Declaration public static readonly Size Empty Field Value Type Description Size Properties | Edit this page View Source Height Height Property Declaration public int Height { get; set; } Property Value Type Description int Remarks The Height coordinate of the Size. | Edit this page View Source IsEmpty IsEmpty Property Declaration public bool IsEmpty { get; } Property Value Type Description bool Remarks Indicates if both Width and Height are zero. | Edit this page View Source Width Width Property Declaration public int Width { get; set; } Property Value Type Description int Remarks The Width coordinate of the Size. Methods | Edit this page View Source Add(Size, Size) Adds the width and height of one Size structure to the width and height of another Size structure. Declaration public static Size Add(Size sz1, Size sz2) Parameters Type Name Description Size sz1 The first Size structure to add. Size sz2 The second Size structure to add. Returns Type Description Size The add. | Edit this page View Source Equals(object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description object obj Returns Type Description bool Overrides ValueType.Equals(object) Remarks Checks equivalence of this Size and another object. | Edit this page View Source GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description int Overrides ValueType.GetHashCode() Remarks Calculates a hashing value. | Edit this page View Source Subtract(Size, Size) Subtracts the width and height of one Size structure to the width and height of another Size structure. Declaration public static Size Subtract(Size sz1, Size sz2) Parameters Type Name Description Size sz1 The first Size structure to subtract. Size sz2 The second Size structure to subtract. Returns Type Description Size The subtract. | Edit this page View Source ToString() ToString Method Declaration public override string ToString() Returns Type Description string Overrides ValueType.ToString() Remarks Formats the Size as a string in coordinate notation. Operators | Edit this page View Source operator +(Size, Size) Addition Operator Declaration public static Size operator +(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description Size Remarks Addition of two Size structures. | Edit this page View Source operator ==(Size, Size) Equality Operator Declaration public static bool operator ==(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description bool Remarks Compares two Size objects. The return value is based on the equivalence of the Width and Height properties of the two Sizes. | Edit this page View Source explicit operator Point(Size) Size to Point Conversion Declaration public static explicit operator Point(Size size) Parameters Type Name Description Size size Returns Type Description Point Remarks Returns a Point based on the dimensions of a given Size. Requires explicit cast. | Edit this page View Source operator !=(Size, Size) Inequality Operator Declaration public static bool operator !=(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description bool Remarks Compares two Size objects. The return value is based on the equivalence of the Width and Height properties of the two Sizes. | Edit this page View Source operator -(Size, Size) Subtraction Operator Declaration public static Size operator -(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description Size Remarks Subtracts two Size structures."
  },
  "api/Terminal.Gui/Terminal.Gui.SizeF.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.SizeF.html",
    "title": "Struct SizeF",
    "keywords": "Struct SizeF Represents the size of a rectangular region with an ordered pair of width and height. Implements IEquatable<SizeF> Inherited Members object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct SizeF : IEquatable<SizeF> Constructors | Edit this page View Source SizeF(float, float) Initializes a new instance of the SizeF class from the specified dimensions. Declaration public SizeF(float width, float height) Parameters Type Name Description float width float height | Edit this page View Source SizeF(PointF) Initializes a new instance of the SizeF class from the specified PointF. Declaration public SizeF(PointF pt) Parameters Type Name Description PointF pt | Edit this page View Source SizeF(SizeF) Initializes a new instance of the SizeF class from the specified existing SizeF. Declaration public SizeF(SizeF size) Parameters Type Name Description SizeF size Fields | Edit this page View Source Empty Initializes a new instance of the SizeF class. Declaration public static readonly SizeF Empty Field Value Type Description SizeF Properties | Edit this page View Source Height Represents the vertical component of this SizeF. Declaration public float Height { get; set; } Property Value Type Description float | Edit this page View Source IsEmpty Tests whether this SizeF has zero width and height. Declaration [Browsable(false)] public bool IsEmpty { get; } Property Value Type Description bool | Edit this page View Source Width Represents the horizontal component of this SizeF. Declaration public float Width { get; set; } Property Value Type Description float Methods | Edit this page View Source Add(SizeF, SizeF) Performs vector addition of two SizeF objects. Declaration public static SizeF Add(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF | Edit this page View Source Equals(object) Tests to see whether the specified object is a SizeF with the same dimensions as this SizeF. Declaration public override bool Equals(object obj) Parameters Type Name Description object obj Returns Type Description bool Overrides ValueType.Equals(object) | Edit this page View Source Equals(SizeF) Tests whether two SizeF objects are identical. Declaration public bool Equals(SizeF other) Parameters Type Name Description SizeF other Returns Type Description bool | Edit this page View Source GetHashCode() Generates a hashcode from the width and height Declaration public override int GetHashCode() Returns Type Description int Overrides ValueType.GetHashCode() | Edit this page View Source Subtract(SizeF, SizeF) Contracts a SizeF by another SizeF. Declaration public static SizeF Subtract(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF | Edit this page View Source ToString() Creates a human-readable string that represents this SizeF. Declaration public override string ToString() Returns Type Description string Overrides ValueType.ToString() Operators | Edit this page View Source operator +(SizeF, SizeF) Performs vector addition of two SizeF objects. Declaration public static SizeF operator +(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF | Edit this page View Source operator /(SizeF, float) Divides SizeF by a float producing SizeF. Declaration public static SizeF operator /(SizeF left, float right) Parameters Type Name Description SizeF left Dividend of type SizeF. float right Divisor of type int. Returns Type Description SizeF Result of type SizeF. | Edit this page View Source operator ==(SizeF, SizeF) Tests whether two SizeF objects are identical. Declaration public static bool operator ==(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description bool | Edit this page View Source explicit operator PointF(SizeF) Converts the specified SizeF to a PointF. Declaration public static explicit operator PointF(SizeF size) Parameters Type Name Description SizeF size Returns Type Description PointF | Edit this page View Source operator !=(SizeF, SizeF) Tests whether two SizeF objects are different. Declaration public static bool operator !=(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description bool | Edit this page View Source operator *(float, SizeF) Multiplies SizeF by a float producing SizeF. Declaration public static SizeF operator *(float left, SizeF right) Parameters Type Name Description float left Multiplier of type float. SizeF right Multiplicand of type SizeF. Returns Type Description SizeF Product of type SizeF. | Edit this page View Source operator *(SizeF, float) Multiplies SizeF by a float producing SizeF. Declaration public static SizeF operator *(SizeF left, float right) Parameters Type Name Description SizeF left Multiplicand of type SizeF. float right Multiplier of type float. Returns Type Description SizeF Product of type SizeF. | Edit this page View Source operator -(SizeF, SizeF) Contracts a SizeF by another SizeF Declaration public static SizeF operator -(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF Implements IEquatable<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.StackExtensions.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.StackExtensions.html",
    "title": "Class StackExtensions",
    "keywords": "Class StackExtensions Extension of Stack<T> helper to work with specific IEqualityComparer<T> Inheritance object StackExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public static class StackExtensions Methods | Edit this page View Source Contains<T>(Stack<T>, T, IEqualityComparer<T>) Check if the stack object contains the value to find. Declaration public static bool Contains<T>(this Stack<T> stack, T valueToFind, IEqualityComparer<T> comparer = null) Parameters Type Name Description Stack<T> stack The stack object. T valueToFind Value to find. IEqualityComparer<T> comparer The comparison object. Returns Type Description bool true If the value was found.false otherwise. Type Parameters Name Description T The stack object type. | Edit this page View Source FindDuplicates<T>(Stack<T>, IEqualityComparer<T>) Find all duplicates stack objects values. Declaration public static Stack<T> FindDuplicates<T>(this Stack<T> stack, IEqualityComparer<T> comparer = null) Parameters Type Name Description Stack<T> stack The stack object. IEqualityComparer<T> comparer The comparison object. Returns Type Description Stack<T> The duplicates stack object. Type Parameters Name Description T The stack object type. | Edit this page View Source MoveNext<T>(Stack<T>) Move the first stack object value to the end. Declaration public static void MoveNext<T>(this Stack<T> stack) Parameters Type Name Description Stack<T> stack The stack object. Type Parameters Name Description T The stack object type. | Edit this page View Source MovePrevious<T>(Stack<T>) Move the last stack object value to the top. Declaration public static void MovePrevious<T>(this Stack<T> stack) Parameters Type Name Description Stack<T> stack The stack object. Type Parameters Name Description T The stack object type. | Edit this page View Source MoveTo<T>(Stack<T>, T, int, IEqualityComparer<T>) Move the stack object value to the index. Declaration public static void MoveTo<T>(this Stack<T> stack, T valueToMove, int index = 0, IEqualityComparer<T> comparer = null) Parameters Type Name Description Stack<T> stack The stack object. T valueToMove Value to move. int index The index where to move. IEqualityComparer<T> comparer The comparison object. Type Parameters Name Description T The stack object type. | Edit this page View Source Replace<T>(Stack<T>, T, T, IEqualityComparer<T>) Replaces an stack object values that match with the value to replace. Declaration public static void Replace<T>(this Stack<T> stack, T valueToReplace, T valueToReplaceWith, IEqualityComparer<T> comparer = null) Parameters Type Name Description Stack<T> stack The stack object. T valueToReplace Value to replace. T valueToReplaceWith Value to replace with to what matches the value to replace. IEqualityComparer<T> comparer The comparison object. Type Parameters Name Description T The stack object type. | Edit this page View Source Swap<T>(Stack<T>, T, T, IEqualityComparer<T>) Swap two stack objects values that matches with the both values. Declaration public static void Swap<T>(this Stack<T> stack, T valueToSwapFrom, T valueToSwapTo, IEqualityComparer<T> comparer = null) Parameters Type Name Description Stack<T> stack The stack object. T valueToSwapFrom Value to swap from. T valueToSwapTo Value to swap to. IEqualityComparer<T> comparer The comparison object. Type Parameters Name Description T The stack object type."
  },
  "api/Terminal.Gui/Terminal.Gui.StatusBar.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.StatusBar.html",
    "title": "Class StatusBar",
    "keywords": "Class StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a statusbar. Inheritance object Responder View StatusBar Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source StatusBar() Initializes a new instance of the StatusBar class. Declaration public StatusBar() | Edit this page View Source StatusBar(StatusItem[]) Initializes a new instance of the StatusBar class with the specified set of StatusItems. The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null). Declaration public StatusBar(StatusItem[] items) Parameters Type Name Description StatusItem[] items A list of statusbar items. Properties | Edit this page View Source Items The items that compose the StatusBar Declaration public StatusItem[] Items { get; set; } Property Value Type Description StatusItem[] | Edit this page View Source ShortcutDelimiter Used for change the shortcut delimiter separator. Declaration public static ustring ShortcutDelimiter { get; set; } Property Value Type Description ustring Methods | Edit this page View Source AddItemAt(int, StatusItem) Inserts a StatusItem in the specified index of Items. Declaration public void AddItemAt(int index, StatusItem item) Parameters Type Name Description int index The zero-based index at which item should be inserted. StatusItem item The item to insert. | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source RemoveItem(int) Removes a StatusItem at specified index of Items. Declaration public StatusItem RemoveItem(int index) Parameters Type Name Description int index The zero-based index of the item to remove. Returns Type Description StatusItem The StatusItem removed. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.StatusItem.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.StatusItem.html",
    "title": "Class StatusItem",
    "keywords": "Class StatusItem StatusItem objects are contained by StatusBar Views. Each StatusItem has a title, a shortcut (hotkey), and an Action that will be invoked when the Shortcut is pressed. The Shortcut will be a global hotkey for the application in the current context of the screen. The colour of the Title will be changed after each ~. A Title set to `~F1~ Help` will render as *F1* using HotNormal and *Help* as HotNormal. Inheritance object StatusItem Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class StatusItem Constructors | Edit this page View Source StatusItem(Key, ustring, Action, Func<bool>) Initializes a new StatusItem. Declaration public StatusItem(Key shortcut, ustring title, Action action, Func<bool> canExecute = null) Parameters Type Name Description Key shortcut Shortcut to activate the StatusItem. ustring title Title for the StatusItem. Action action Action to invoke when the StatusItem is activated. Func<bool> canExecute Function to determine if the action can currently be executed. Properties | Edit this page View Source Action Gets or sets the action to be invoked when the statusbar item is triggered Declaration public Action Action { get; set; } Property Value Type Description Action Action to invoke. | Edit this page View Source CanExecute Gets or sets the action to be invoked to determine if the StatusItem can be triggered. If CanExecute returns true the status item will be enabled. Otherwise, it will be disabled. Declaration public Func<bool> CanExecute { get; set; } Property Value Type Description Func<bool> Function to determine if the action is can be executed or not. | Edit this page View Source Data Gets or sets arbitrary data for the status item. Declaration public object Data { get; set; } Property Value Type Description object Remarks This property is not used internally. | Edit this page View Source Shortcut Gets the global shortcut to invoke the action on the menu. Declaration public Key Shortcut { get; } Property Value Type Description Key | Edit this page View Source Title Gets or sets the title. Declaration public ustring Title { get; set; } Property Value Type Description ustring The title. Remarks The colour of the Title will be changed after each ~. A Title set to `~F1~ Help` will render as *F1* using HotNormal and *Help* as HotNormal. Methods | Edit this page View Source IsEnabled() Returns true if the status item is enabled. This method is a wrapper around CanExecute. Declaration public bool IsEnabled() Returns Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.TabView.Tab.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TabView.Tab.html",
    "title": "Class TabView.Tab",
    "keywords": "Class TabView.Tab A single tab in a TabView Inheritance object TabView.Tab Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TabView.Tab Constructors | Edit this page View Source Tab() Creates a new unamed tab with no controls inside Declaration public Tab() | Edit this page View Source Tab(string, View) Creates a new tab with the given text hosting a view Declaration public Tab(string text, View view) Parameters Type Name Description string text View view Properties | Edit this page View Source Text The text to display in a TabView Declaration public ustring Text { get; set; } Property Value Type Description ustring | Edit this page View Source View The control to display when the tab is selected Declaration public View View { get; set; } Property Value Type Description View"
  },
  "api/Terminal.Gui/Terminal.Gui.TabView.TabChangedEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TabView.TabChangedEventArgs.html",
    "title": "Class TabView.TabChangedEventArgs",
    "keywords": "Class TabView.TabChangedEventArgs Describes a change in SelectedTab Inheritance object EventArgs TabView.TabChangedEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TabView.TabChangedEventArgs : EventArgs Constructors | Edit this page View Source TabChangedEventArgs(Tab, Tab) Documents a tab change Declaration public TabChangedEventArgs(TabView.Tab oldTab, TabView.Tab newTab) Parameters Type Name Description TabView.Tab oldTab TabView.Tab newTab Properties | Edit this page View Source NewTab The currently selected tab. May be null Declaration public TabView.Tab NewTab { get; } Property Value Type Description TabView.Tab | Edit this page View Source OldTab The previously selected tab. May be null Declaration public TabView.Tab OldTab { get; } Property Value Type Description TabView.Tab"
  },
  "api/Terminal.Gui/Terminal.Gui.TabView.TabMouseEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TabView.TabMouseEventArgs.html",
    "title": "Class TabView.TabMouseEventArgs",
    "keywords": "Class TabView.TabMouseEventArgs Describes a mouse event over a specific TabView.Tab in a TabView. Inheritance object EventArgs TabView.TabMouseEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TabView.TabMouseEventArgs : EventArgs Constructors | Edit this page View Source TabMouseEventArgs(Tab, MouseEvent) Creates a new instance of the TabView.TabMouseEventArgs class. Declaration public TabMouseEventArgs(TabView.Tab tab, MouseEvent mouseEvent) Parameters Type Name Description TabView.Tab tab TabView.Tab that the mouse was over when the event occurred. MouseEvent mouseEvent The mouse activity being reported Properties | Edit this page View Source MouseEvent Gets the actual mouse event. Use Handled to cancel this event and perform custom behavior (e.g. show a context menu). Declaration public MouseEvent MouseEvent { get; } Property Value Type Description MouseEvent | Edit this page View Source Tab Gets the TabView.Tab (if any) that the mouse was over when the MouseEvent occurred. Declaration public TabView.Tab Tab { get; } Property Value Type Description TabView.Tab Remarks This will be null if the click is after last tab or before first."
  },
  "api/Terminal.Gui/Terminal.Gui.TabView.TabStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TabView.TabStyle.html",
    "title": "Class TabView.TabStyle",
    "keywords": "Class TabView.TabStyle Describes render stylistic selections of a TabView Inheritance object TabView.TabStyle Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TabView.TabStyle Properties | Edit this page View Source ShowBorder True to show a solid box around the edge of the control. Defaults to true. Declaration public bool ShowBorder { get; set; } Property Value Type Description bool | Edit this page View Source ShowTopLine True to show the top lip of tabs. False to directly begin with tab text during rendering. When true header line occupies 3 rows, when false only 2. Defaults to true. When TabsOnBottom is enabled this instead applies to the bottommost line of the control Declaration public bool ShowTopLine { get; set; } Property Value Type Description bool | Edit this page View Source TabsOnBottom True to render tabs at the bottom of the view instead of the top Declaration public bool TabsOnBottom { get; set; } Property Value Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.TabView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TabView.html",
    "title": "Class TabView",
    "keywords": "Class TabView Control that hosts multiple sub views, presenting a single one at once Inheritance object Responder View TabView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TabView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source TabView() Initializes a TabView class using Computed layout. Declaration public TabView() Fields | Edit this page View Source DefaultMaxTabTextWidth The default MaxTabTextWidth to set on new TabView controls Declaration public const uint DefaultMaxTabTextWidth = 30 Field Value Type Description uint Properties | Edit this page View Source MaxTabTextWidth The maximum number of characters to render in a Tab header. This prevents one long tab from pushing out all the others. Declaration public uint MaxTabTextWidth { get; set; } Property Value Type Description uint | Edit this page View Source SelectedTab The currently selected member of Tabs chosen by the user Declaration public TabView.Tab SelectedTab { get; set; } Property Value Type Description TabView.Tab | Edit this page View Source Style Render choices for how to display tabs. After making changes, call ApplyStyleChanges() Declaration public TabView.TabStyle Style { get; set; } Property Value Type Description TabView.TabStyle | Edit this page View Source TabScrollOffset When there are too many tabs to render, this indicates the first tab to render on the screen. Declaration public int TabScrollOffset { get; set; } Property Value Type Description int | Edit this page View Source Tabs All tabs currently hosted by the control Declaration public IReadOnlyCollection<TabView.Tab> Tabs { get; } Property Value Type Description IReadOnlyCollection<TabView.Tab> Methods | Edit this page View Source AddTab(Tab, bool) Adds the given tab to Tabs Declaration public void AddTab(TabView.Tab tab, bool andSelect) Parameters Type Name Description TabView.Tab tab bool andSelect True to make the newly added Tab the SelectedTab | Edit this page View Source ApplyStyleChanges() Updates the control to use the latest state settings in Style. This can change the size of the client area of the tab (for rendering the selected tab's content). This method includes a call to SetNeedsDisplay() Declaration public void ApplyStyleChanges() | Edit this page View Source Dispose(bool) Disposes the control and all Tabs Declaration protected override void Dispose(bool disposing) Parameters Type Name Description bool disposing Overrides View.Dispose(bool) | Edit this page View Source EnsureSelectedTabIsVisible() Updates TabScrollOffset to ensure that SelectedTab is visible Declaration public void EnsureSelectedTabIsVisible() | Edit this page View Source EnsureValidScrollOffsets() Updates TabScrollOffset to be a valid index of Tabs Declaration public void EnsureValidScrollOffsets() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() | Edit this page View Source OnSelectedTabChanged(Tab, Tab) Raises the SelectedTabChanged event Declaration protected virtual void OnSelectedTabChanged(TabView.Tab oldTab, TabView.Tab newTab) Parameters Type Name Description TabView.Tab oldTab TabView.Tab newTab | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source RemoveTab(Tab) Removes the given tab from Tabs. Caller is responsible for disposing the tab's hosted View if appropriate. Declaration public void RemoveTab(TabView.Tab tab) Parameters Type Name Description TabView.Tab tab | Edit this page View Source SwitchTabBy(int) Changes the SelectedTab by the given amount. Positive for right, negative for left. If no tab is currently selected then the first tab will become selected Declaration public void SwitchTabBy(int amount) Parameters Type Name Description int amount Events | Edit this page View Source SelectedTabChanged Event for when SelectedTab changes Declaration public event EventHandler<TabView.TabChangedEventArgs> SelectedTabChanged Event Type Type Description EventHandler<TabView.TabChangedEventArgs> | Edit this page View Source TabClicked Event fired when a TabView.Tab is clicked. Can be used to cancel navigation, show context menu (e.g. on right click) etc. Declaration public event EventHandler<TabView.TabMouseEventArgs> TabClicked Event Type Type Description EventHandler<TabView.TabMouseEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.CellActivatedEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.CellActivatedEventArgs.html",
    "title": "Class TableView.CellActivatedEventArgs",
    "keywords": "Class TableView.CellActivatedEventArgs Defines the event arguments for CellActivated event Inheritance object EventArgs TableView.CellActivatedEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView.CellActivatedEventArgs : EventArgs Constructors | Edit this page View Source CellActivatedEventArgs(DataTable, int, int) Creates a new instance of arguments describing a cell being activated in TableView Declaration public CellActivatedEventArgs(DataTable t, int col, int row) Parameters Type Name Description DataTable t int col int row Properties | Edit this page View Source Col The column index of the Table cell that is being activated Declaration public int Col { get; } Property Value Type Description int | Edit this page View Source Row The row index of the Table cell that is being activated Declaration public int Row { get; } Property Value Type Description int | Edit this page View Source Table The current table to which the new indexes refer. May be null e.g. if selection change is the result of clearing the table from the view Declaration public DataTable Table { get; } Property Value Type Description DataTable"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html",
    "title": "Class TableView.CellColorGetterArgs",
    "keywords": "Class TableView.CellColorGetterArgs Arguments for a TableView.CellColorGetterDelegate. Describes a cell for which a rendering ColorScheme is being sought Inheritance object TableView.CellColorGetterArgs Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView.CellColorGetterArgs Properties | Edit this page View Source CellValue The hard typed value being rendered in the cell for which color is needed Declaration public object CellValue { get; } Property Value Type Description object | Edit this page View Source ColIdex The index of column in Table for which color is needed Declaration public int ColIdex { get; } Property Value Type Description int | Edit this page View Source Representation The textual representation of CellValue (what will actually be drawn to the screen) Declaration public string Representation { get; } Property Value Type Description string | Edit this page View Source RowIndex The index of the row in Table for which color is needed Declaration public int RowIndex { get; } Property Value Type Description int | Edit this page View Source RowScheme the color scheme that is going to be used to render the cell if no cell specific color scheme is returned Declaration public ColorScheme RowScheme { get; } Property Value Type Description ColorScheme | Edit this page View Source Table The data table hosted by the TableView control. Declaration public DataTable Table { get; } Property Value Type Description DataTable"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html",
    "title": "Delegate TableView.CellColorGetterDelegate",
    "keywords": "Delegate TableView.CellColorGetterDelegate Delegate for providing color to TableView cells based on the value being rendered Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public delegate ColorScheme TableView.CellColorGetterDelegate(TableView.CellColorGetterArgs args) Parameters Type Name Description TableView.CellColorGetterArgs args Contains information about the cell for which color is needed Returns Type Description ColorScheme"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html",
    "title": "Class TableView.ColumnStyle",
    "keywords": "Class TableView.ColumnStyle Describes how to render a given column in a TableView including Alignment and textual representation of cells (e.g. date formats) See TableView Deep Dive for more information. Inheritance object TableView.ColumnStyle Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView.ColumnStyle Fields | Edit this page View Source AlignmentGetter Defines a delegate for returning custom alignment per cell based on cell values. When specified this will override Alignment Declaration public Func<object, TextAlignment> AlignmentGetter Field Value Type Description Func<object, TextAlignment> | Edit this page View Source ColorGetter Defines a delegate for returning a custom color scheme per cell based on cell values. Return null for the default Declaration public TableView.CellColorGetterDelegate ColorGetter Field Value Type Description TableView.CellColorGetterDelegate | Edit this page View Source RepresentationGetter Defines a delegate for returning custom representations of cell values. If not set then ToString() is used. Return values from your delegate may be truncated e.g. based on MaxWidth Declaration public Func<object, string> RepresentationGetter Field Value Type Description Func<object, string> Properties | Edit this page View Source Alignment Defines the default alignment for all values rendered in this column. For custom alignment based on cell contents use AlignmentGetter. Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment | Edit this page View Source Format Defines the format for values e.g. \"yyyy-MM-dd\" for dates Declaration public string Format { get; set; } Property Value Type Description string | Edit this page View Source MaxWidth Set the maximum width of the column in characters. This value will be ignored if more than the tables MaxCellWidth. Defaults to DefaultMaxCellWidth Declaration public int MaxWidth { get; set; } Property Value Type Description int | Edit this page View Source MinAcceptableWidth Enables flexible sizing of this column based on available screen space to render into. Declaration public int MinAcceptableWidth { get; set; } Property Value Type Description int | Edit this page View Source MinWidth Set the minimum width of the column in characters. Setting this will ensure that even when a column has short content/header it still fills a given width of the control. This value will be ignored if more than the tables MaxCellWidth or the MaxWidth For setting a flexible column width (down to a lower limit) use MinAcceptableWidth instead Declaration public int MinWidth { get; set; } Property Value Type Description int | Edit this page View Source Visible Gets or Sets a value indicating whether the column should be visible to the user. This affects both whether it is rendered and whether it can be selected. Defaults to true. Declaration public bool Visible { get; set; } Property Value Type Description bool Remarks If MaxWidth is 0 then Visible will always return false. Methods | Edit this page View Source GetAlignment(object) Returns the alignment for the cell based on cellValue and AlignmentGetter/Alignment Declaration public TextAlignment GetAlignment(object cellValue) Parameters Type Name Description object cellValue Returns Type Description TextAlignment | Edit this page View Source GetRepresentation(object) Returns the full string to render (which may be truncated if too long) that the current style says best represents the given value Declaration public string GetRepresentation(object value) Parameters Type Name Description object value Returns Type Description string"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html",
    "title": "Class TableView.RowColorGetterArgs",
    "keywords": "Class TableView.RowColorGetterArgs Arguments for TableView.RowColorGetterDelegate. Describes a row of data in a DataTable for which ColorScheme is sought. Inheritance object TableView.RowColorGetterArgs Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView.RowColorGetterArgs Properties | Edit this page View Source RowIndex The index of the row in Table for which color is needed Declaration public int RowIndex { get; } Property Value Type Description int | Edit this page View Source Table The data table hosted by the TableView control. Declaration public DataTable Table { get; } Property Value Type Description DataTable"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html",
    "title": "Delegate TableView.RowColorGetterDelegate",
    "keywords": "Delegate TableView.RowColorGetterDelegate Delegate for providing color for a whole row of a TableView Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public delegate ColorScheme TableView.RowColorGetterDelegate(TableView.RowColorGetterArgs args) Parameters Type Name Description TableView.RowColorGetterArgs args Returns Type Description ColorScheme"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html",
    "title": "Class TableView.SelectedCellChangedEventArgs",
    "keywords": "Class TableView.SelectedCellChangedEventArgs Defines the event arguments for SelectedCellChanged Inheritance object EventArgs TableView.SelectedCellChangedEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView.SelectedCellChangedEventArgs : EventArgs Constructors | Edit this page View Source SelectedCellChangedEventArgs(DataTable, int, int, int, int) Creates a new instance of arguments describing a change in selected cell in a TableView Declaration public SelectedCellChangedEventArgs(DataTable t, int oldCol, int newCol, int oldRow, int newRow) Parameters Type Name Description DataTable t int oldCol int newCol int oldRow int newRow Properties | Edit this page View Source NewCol The newly selected column index. Declaration public int NewCol { get; } Property Value Type Description int | Edit this page View Source NewRow The newly selected row index. Declaration public int NewRow { get; } Property Value Type Description int | Edit this page View Source OldCol The previous selected column index. May be invalid e.g. when the selection has been changed as a result of replacing the existing Table with a smaller one Declaration public int OldCol { get; } Property Value Type Description int | Edit this page View Source OldRow The previous selected row index. May be invalid e.g. when the selection has been changed as a result of deleting rows from the table Declaration public int OldRow { get; } Property Value Type Description int | Edit this page View Source Table The current table to which the new indexes refer. May be null e.g. if selection change is the result of clearing the table from the view Declaration public DataTable Table { get; } Property Value Type Description DataTable"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html",
    "title": "Class TableView.TableSelection",
    "keywords": "Class TableView.TableSelection Describes a selected region of the table Inheritance object TableView.TableSelection Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView.TableSelection Constructors | Edit this page View Source TableSelection(Point, Rect) Creates a new selected area starting at the origin corner and covering the provided rectangular area Declaration public TableSelection(Point origin, Rect rect) Parameters Type Name Description Point origin Rect rect Properties | Edit this page View Source Origin Corner of the Rect where selection began Declaration public Point Origin { get; set; } Property Value Type Description Point | Edit this page View Source Rect Area selected Declaration public Rect Rect { get; set; } Property Value Type Description Rect"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html",
    "title": "Class TableView.TableStyle",
    "keywords": "Class TableView.TableStyle Defines rendering options that affect how the table is displayed. See TableView Deep Dive for more information. Inheritance object TableView.TableStyle Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView.TableStyle Properties | Edit this page View Source AlwaysShowHeaders When scrolling down always lock the column headers in place as the first row of the table Declaration public bool AlwaysShowHeaders { get; set; } Property Value Type Description bool | Edit this page View Source ColumnStyles Collection of columns for which you want special rendering (e.g. custom column lengths, text alignment etc) Declaration public Dictionary<DataColumn, TableView.ColumnStyle> ColumnStyles { get; set; } Property Value Type Description Dictionary<DataColumn, TableView.ColumnStyle> | Edit this page View Source ExpandLastColumn Determines rendering when the last column in the table is visible but it's content or MaxWidth is less than the remaining space in the control. True (the default) will expand the column to fill the remaining bounds of the control. False will draw a column ending line and leave a blank column that cannot be selected in the remaining space. Declaration public bool ExpandLastColumn { get; set; } Property Value Type Description bool | Edit this page View Source InvertSelectedCellFirstCharacter True to invert the colors of the first symbol of the selected cell in the TableView. This gives the appearance of a cursor for when the ConsoleDriver doesn't otherwise show this Declaration public bool InvertSelectedCellFirstCharacter { get; set; } Property Value Type Description bool | Edit this page View Source RowColorGetter Delegate for coloring specific rows in a different color. For cell color ColorGetter Declaration public TableView.RowColorGetterDelegate RowColorGetter { get; set; } Property Value Type Description TableView.RowColorGetterDelegate | Edit this page View Source ShowHorizontalHeaderOverline True to render a solid line above the headers Declaration public bool ShowHorizontalHeaderOverline { get; set; } Property Value Type Description bool | Edit this page View Source ShowHorizontalHeaderUnderline True to render a solid line under the headers Declaration public bool ShowHorizontalHeaderUnderline { get; set; } Property Value Type Description bool | Edit this page View Source ShowHorizontalScrollIndicators True to render a arrows on the right/left of the table when there are more column(s) that can be scrolled to. Requires ShowHorizontalHeaderUnderline to be true. Defaults to true Declaration public bool ShowHorizontalScrollIndicators { get; set; } Property Value Type Description bool | Edit this page View Source ShowVerticalCellLines True to render a solid line vertical line between cells Declaration public bool ShowVerticalCellLines { get; set; } Property Value Type Description bool | Edit this page View Source ShowVerticalHeaderLines True to render a solid line vertical line between headers Declaration public bool ShowVerticalHeaderLines { get; set; } Property Value Type Description bool | Edit this page View Source SmoothHorizontalScrolling Determines how ColumnOffset is updated when scrolling right off the end of the currently visible area. If true then when scrolling right the scroll offset is increased the minimum required to show the new column. This may be slow if you have an incredibly large number of columns in your table and/or slow RepresentationGetter implementations If false then scroll offset is set to the currently selected column (i.e. PageRight). Declaration public bool SmoothHorizontalScrolling { get; set; } Property Value Type Description bool Methods | Edit this page View Source GetColumnStyleIfAny(DataColumn) Returns the entry from ColumnStyles for the given col or null if no custom styling is defined for it Declaration public TableView.ColumnStyle GetColumnStyleIfAny(DataColumn col) Parameters Type Name Description DataColumn col Returns Type Description TableView.ColumnStyle | Edit this page View Source GetOrCreateColumnStyle(DataColumn) Returns an existing TableView.ColumnStyle for the given col or creates a new one with default options Declaration public TableView.ColumnStyle GetOrCreateColumnStyle(DataColumn col) Parameters Type Name Description DataColumn col Returns Type Description TableView.ColumnStyle"
  },
  "api/Terminal.Gui/Terminal.Gui.TableView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TableView.html",
    "title": "Class TableView",
    "keywords": "Class TableView View for tabular data based on a DataTable. See TableView Deep Dive for more information. Inheritance object Responder View TableView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TableView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source TableView() Initialzies a TableView class using Computed layout. Set the Table property to begin editing Declaration public TableView() | Edit this page View Source TableView(DataTable) Initialzies a TableView class using Computed layout. Declaration public TableView(DataTable table) Parameters Type Name Description DataTable table The table to display in the control Fields | Edit this page View Source DefaultMaxCellWidth The default maximum cell width for MaxCellWidth and MaxWidth Declaration public const int DefaultMaxCellWidth = 100 Field Value Type Description int | Edit this page View Source DefaultMinAcceptableWidth The default minimum cell width for MinAcceptableWidth Declaration public const int DefaultMinAcceptableWidth = 100 Field Value Type Description int Properties | Edit this page View Source CellActivationKey The key which when pressed should trigger CellActivated event. Defaults to Enter. Declaration public Key CellActivationKey { get; set; } Property Value Type Description Key | Edit this page View Source ColumnOffset Horizontal scroll offset. The index of the first column in Table to display when when rendering the view. Declaration public int ColumnOffset { get; set; } Property Value Type Description int Remarks This property allows very wide tables to be rendered with horizontal scrolling | Edit this page View Source FullRowSelect True to select the entire row at once. False to select individual cells. Defaults to false Declaration public bool FullRowSelect { get; set; } Property Value Type Description bool | Edit this page View Source MaxCellWidth The maximum number of characters to render in any given column. This prevents one long column from pushing out all the others Declaration public int MaxCellWidth { get; set; } Property Value Type Description int | Edit this page View Source MultiSelect True to allow regions to be selected Declaration public bool MultiSelect { get; set; } Property Value Type Description bool | Edit this page View Source MultiSelectedRegions When MultiSelect is enabled this property contain all rectangles of selected cells. Rectangles describe column/rows selected in Table (not screen coordinates) Declaration public Stack<TableView.TableSelection> MultiSelectedRegions { get; } Property Value Type Description Stack<TableView.TableSelection> | Edit this page View Source NullSymbol The text representation that should be rendered for cells with the value Value Declaration public string NullSymbol { get; set; } Property Value Type Description string | Edit this page View Source RowOffset Vertical scroll offset. The index of the first row in Table to display in the first non header line of the control when rendering the view. Declaration public int RowOffset { get; set; } Property Value Type Description int | Edit this page View Source SelectedColumn The index of Columns in Table that the user has currently selected Declaration public int SelectedColumn { get; set; } Property Value Type Description int | Edit this page View Source SelectedRow The index of Rows in Table that the user has currently selected Declaration public int SelectedRow { get; set; } Property Value Type Description int | Edit this page View Source SeparatorSymbol The symbol to add after each cell value and header value to visually seperate values (if not using vertical gridlines) Declaration public char SeparatorSymbol { get; set; } Property Value Type Description char | Edit this page View Source Style Contains options for changing how the table is rendered Declaration public TableView.TableStyle Style { get; set; } Property Value Type Description TableView.TableStyle | Edit this page View Source Table The data table to render in the view. Setting this property automatically updates and redraws the control. Declaration public DataTable Table { get; set; } Property Value Type Description DataTable Methods | Edit this page View Source CellToScreen(int, int) Returns the screen position (relative to the control client area) that the given cell is rendered or null if it is outside the current scroll area or no table is loaded Declaration public Point? CellToScreen(int tableColumn, int tableRow) Parameters Type Name Description int tableColumn The index of the Table column you are looking for, use Ordinal int tableRow The index of the row in Table that you are looking for Returns Type Description Point? | Edit this page View Source ChangeSelectionByOffset(int, int, bool) Moves the SelectedRow and SelectedColumn by the provided offsets. Optionally starting a box selection (see MultiSelect) Declaration public void ChangeSelectionByOffset(int offsetX, int offsetY, bool extendExistingSelection) Parameters Type Name Description int offsetX Offset in number of columns int offsetY Offset in number of rows bool extendExistingSelection True to create a multi cell selection or adjust an existing one | Edit this page View Source ChangeSelectionToEndOfRow(bool) Moves or extends the selection to the last cell in the current row Declaration public void ChangeSelectionToEndOfRow(bool extend) Parameters Type Name Description bool extend true to extend the current selection (if any) instead of replacing | Edit this page View Source ChangeSelectionToEndOfTable(bool) Moves or extends the selection to the final cell in the table (nX,nY). If FullRowSelect is enabled then selection instead moves to (SelectedColumn,nY) i.e. no horizontal scrolling. Declaration public void ChangeSelectionToEndOfTable(bool extend) Parameters Type Name Description bool extend true to extend the current selection (if any) instead of replacing | Edit this page View Source ChangeSelectionToStartOfRow(bool) Moves or extends the selection to the first cell in the current row Declaration public void ChangeSelectionToStartOfRow(bool extend) Parameters Type Name Description bool extend true to extend the current selection (if any) instead of replacing | Edit this page View Source ChangeSelectionToStartOfTable(bool) Moves or extends the selection to the first cell in the table (0,0). If FullRowSelect is enabled then selection instead moves to (SelectedColumn,0) i.e. no horizontal scrolling. Declaration public void ChangeSelectionToStartOfTable(bool extend) Parameters Type Name Description bool extend true to extend the current selection (if any) instead of replacing | Edit this page View Source EnsureSelectedCellIsVisible() Updates scroll offsets to ensure that the selected cell is visible. Has no effect if Table has not been set. Declaration public void EnsureSelectedCellIsVisible() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() | Edit this page View Source EnsureValidScrollOffsets() Updates ColumnOffset and RowOffset where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. Declaration public void EnsureValidScrollOffsets() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() | Edit this page View Source EnsureValidSelection() Updates SelectedColumn, SelectedRow and MultiSelectedRegions where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. Declaration public void EnsureValidSelection() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() | Edit this page View Source GetAllSelectedCells() Returns all cells in any MultiSelectedRegions (if MultiSelect is enabled) and the selected cell Declaration public IEnumerable<Point> GetAllSelectedCells() Returns Type Description IEnumerable<Point> Remarks Return value is not affected by FullRowSelect (i.e. returned Points are not expanded to include all points on row). | Edit this page View Source IsSelected(int, int) Returns true if the given cell is selected either because it is the active cell or part of a multi cell selection (e.g. FullRowSelect). Returns false if Visible is false. Declaration public bool IsSelected(int col, int row) Parameters Type Name Description int col int row Returns Type Description bool | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnCellActivated(CellActivatedEventArgs) Invokes the CellActivated event Declaration protected virtual void OnCellActivated(TableView.CellActivatedEventArgs args) Parameters Type Name Description TableView.CellActivatedEventArgs args | Edit this page View Source OnSelectedCellChanged(SelectedCellChangedEventArgs) Invokes the SelectedCellChanged event Declaration protected virtual void OnSelectedCellChanged(TableView.SelectedCellChangedEventArgs args) Parameters Type Name Description TableView.SelectedCellChangedEventArgs args | Edit this page View Source PageDown(bool) Moves the selection down by one page Declaration public void PageDown(bool extend) Parameters Type Name Description bool extend true to extend the current selection (if any) instead of replacing | Edit this page View Source PageUp(bool) Moves the selection up by one page Declaration public void PageUp(bool extend) Parameters Type Name Description bool extend true to extend the current selection (if any) instead of replacing | Edit this page View Source PositionCursor() Positions the cursor in the area of the screen in which the start of the active cell is rendered. Calls base implementation if active cell is not visible due to scrolling or table is loaded etc Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source RenderCell(Attribute, string, bool) Override to provide custom multi colouring to cells. Use Driver to with AddStr(ustring). The driver will already be in the correct place when rendering and you must render the full render or the view will not look right. For simpler provision of color use ColorGetter For changing the content that is rendered use RepresentationGetter Declaration protected virtual void RenderCell(Attribute cellColor, string render, bool isPrimaryCell) Parameters Type Name Description Attribute cellColor string render bool isPrimaryCell | Edit this page View Source ScreenToCell(int, int) . Returns the column and row of Table that corresponds to a given point on the screen (relative to the control client area). Returns null if the point is in the header, no table is loaded or outside the control bounds. Declaration public Point? ScreenToCell(int clientX, int clientY) Parameters Type Name Description int clientX X offset from the top left of the control. int clientY Y offset from the top left of the control. Returns Type Description Point? Cell clicked or null. | Edit this page View Source ScreenToCell(int, int, out DataColumn) . Returns the column and row of Table that corresponds to a given point on the screen (relative to the control client area). Returns null if the point is in the header, no table is loaded or outside the control bounds. Declaration public Point? ScreenToCell(int clientX, int clientY, out DataColumn headerIfAny) Parameters Type Name Description int clientX X offset from the top left of the control. int clientY Y offset from the top left of the control. DataColumn headerIfAny If the click is in a header this is the column clicked. Returns Type Description Point? Cell clicked or null. | Edit this page View Source SelectAll() When MultiSelect is on, creates selection over all cells in the table (replacing any old selection regions) Declaration public void SelectAll() | Edit this page View Source SetSelection(int, int, bool) Moves the SelectedRow and SelectedColumn to the given col/row in Table. Optionally starting a box selection (see MultiSelect) Declaration public void SetSelection(int col, int row, bool extendExistingSelection) Parameters Type Name Description int col int row bool extendExistingSelection True to create a multi cell selection or adjust an existing one | Edit this page View Source Update() Updates the view to reflect changes to Table and to (ColumnOffset / RowOffset) etc Declaration public void Update() Remarks This always calls SetNeedsDisplay() Events | Edit this page View Source CellActivated This event is raised when a cell is activated e.g. by double clicking or pressing CellActivationKey Declaration public event Action<TableView.CellActivatedEventArgs> CellActivated Event Type Type Description Action<TableView.CellActivatedEventArgs> | Edit this page View Source SelectedCellChanged This event is raised when the selected cell in the table changes. Declaration public event Action<TableView.SelectedCellChangedEventArgs> SelectedCellChanged Event Type Type Description Action<TableView.SelectedCellChangedEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.TextAlignment.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextAlignment.html",
    "title": "Enum TextAlignment",
    "keywords": "Enum TextAlignment Text alignment enumeration, controls how text is displayed. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum TextAlignment Fields Name Description Centered Centers the text in the frame. Justified Shows the text as justified text in the frame. Left Aligns the text to the left of the frame. Right Aligns the text to the right side of the frame."
  },
  "api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html",
    "title": "Class TextChangingEventArgs",
    "keywords": "Class TextChangingEventArgs An EventArgs which allows passing a cancelable new text value event. Inheritance object EventArgs TextChangingEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextChangingEventArgs : EventArgs Constructors | Edit this page View Source TextChangingEventArgs(ustring) Initializes a new instance of TextChangingEventArgs Declaration public TextChangingEventArgs(ustring newText) Parameters Type Name Description ustring newText The new Text to be replaced. Properties | Edit this page View Source Cancel Flag which allows to cancel the new text value. Declaration public bool Cancel { get; set; } Property Value Type Description bool | Edit this page View Source NewText The new text to be replaced. Declaration public ustring NewText { get; set; } Property Value Type Description ustring"
  },
  "api/Terminal.Gui/Terminal.Gui.TextDirection.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextDirection.html",
    "title": "Enum TextDirection",
    "keywords": "Enum TextDirection Text direction enumeration, controls how text is displayed. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum TextDirection Fields Name Description BottomTop_LeftRight This is a vertical direction. O DL LL RE OH W BottomTop_RightLeft This is a vertical direction. D OL LR LO EW H LeftRight_BottomTop This is a horizontal direction. WORLDHELLO LeftRight_TopBottom Normal horizontal direction. HELLOWORLD RightLeft_BottomTop This is a horizontal direction. DLROWOLLEH RightLeft_TopBottom This is a horizontal direction. RTL OLLEHDLROW TopBottom_LeftRight Normal vertical direction. H WE OL RL LO D TopBottom_RightLeft This is a vertical direction. W HO ER LL LD O"
  },
  "api/Terminal.Gui/Terminal.Gui.TextField.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextField.html",
    "title": "Class TextField",
    "keywords": "Class TextField Single-line text entry View Inheritance object Responder View TextField DateField TimeField Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TextField View provides editing functionality and mouse support. Constructors | Edit this page View Source TextField() Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField() | Edit this page View Source TextField(ustring) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(ustring text) Parameters Type Name Description ustring text Initial text contents. | Edit this page View Source TextField(int, int, int, ustring) Initializes a new instance of the TextField class using Absolute positioning. Declaration public TextField(int x, int y, int w, ustring text) Parameters Type Name Description int x The x coordinate. int y The y coordinate. int w The width. ustring text Initial text contents. | Edit this page View Source TextField(string) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(string text) Parameters Type Name Description string text Initial text contents. Properties | Edit this page View Source Autocomplete Provides autocomplete context menu based on suggestions at the current cursor position. Populate AllSuggestions to enable this feature. Declaration public IAutocomplete Autocomplete { get; protected set; } Property Value Type Description IAutocomplete | Edit this page View Source CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description bool true if can focus; otherwise, false. Overrides View.CanFocus | Edit this page View Source ContextMenu Get the ContextMenu for this view. Declaration public ContextMenu ContextMenu { get; } Property Value Type Description ContextMenu | Edit this page View Source CursorPosition Sets or gets the current cursor position. Declaration public virtual int CursorPosition { get; set; } Property Value Type Description int | Edit this page View Source DesiredCursorVisibility Get / Set the wished cursor when the field is focused Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility | Edit this page View Source Frame Gets or sets the frame for the view. The frame is relative to the view's container (SuperView). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView. | Edit this page View Source HasHistoryChanges Indicates whatever the text has history changes or not. true if the text has history changes false otherwise. Declaration public bool HasHistoryChanges { get; } Property Value Type Description bool | Edit this page View Source IsDirty Indicates whatever the text was changed or not. true if the text was changed false otherwise. Declaration public bool IsDirty { get; } Property Value Type Description bool | Edit this page View Source ReadOnly If set to true its not allow any changes in the text. Declaration public bool ReadOnly { get; set; } Property Value Type Description bool | Edit this page View Source ScrollOffset Gets the left offset position. Declaration public int ScrollOffset { get; } Property Value Type Description int | Edit this page View Source Secret Sets the secret property. Declaration public bool Secret { get; set; } Property Value Type Description bool Remarks This makes the text entry suitable for entering passwords. | Edit this page View Source SelectedLength Length of the selected text. Declaration public int SelectedLength { get; } Property Value Type Description int | Edit this page View Source SelectedStart Start position of the selected text. Declaration public int SelectedStart { get; set; } Property Value Type Description int | Edit this page View Source SelectedText The selected text. Declaration public ustring SelectedText { get; } Property Value Type Description ustring | Edit this page View Source Text Sets or gets the text held by the view. Declaration public ustring Text { get; set; } Property Value Type Description ustring | Edit this page View Source Used Tracks whether the text field should be considered \"used\", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry Declaration public bool Used { get; set; } Property Value Type Description bool Methods | Edit this page View Source ClearAllSelection() Clear the selected text. Declaration public void ClearAllSelection() | Edit this page View Source ClearHistoryChanges() Allows clearing the HistoryText.HistoryTextItem items updating the original text. Declaration public void ClearHistoryChanges() | Edit this page View Source Copy() Copy the selected text to the clipboard. Declaration public virtual void Copy() | Edit this page View Source Cut() Cut the selected text to the clipboard. Declaration public virtual void Cut() | Edit this page View Source DeleteAll() Deletes all text. Declaration public void DeleteAll() | Edit this page View Source DeleteCharLeft(bool) Deletes the left character. Declaration public virtual void DeleteCharLeft(bool useOldCursorPos = true) Parameters Type Name Description bool useOldCursorPos | Edit this page View Source DeleteCharRight() Deletes the right character. Declaration public virtual void DeleteCharRight() | Edit this page View Source GetNormalColor() Determines the current ColorScheme based on the Enabled value. Declaration public override Attribute GetNormalColor() Returns Type Description Attribute Normal if Enabled is true or Disabled if Enabled is false. If it's overridden can return other values. Overrides View.GetNormalColor() | Edit this page View Source InsertText(string, bool) Inserts the given toAdd text at the current cursor position exactly as if the user had just typed it Declaration public void InsertText(string toAdd, bool useOldCursorPos = true) Parameters Type Name Description string toAdd Text to add bool useOldCursorPos If uses the oldCursorPos. | Edit this page View Source KillWordBackwards() Deletes word backwards. Declaration public virtual void KillWordBackwards() | Edit this page View Source KillWordForwards() Deletes word forwards. Declaration public virtual void KillWordForwards() | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnLeave(View) | Edit this page View Source OnTextChanging(ustring) Virtual method that invoke the TextChanging event if it's defined. Declaration public virtual TextChangingEventArgs OnTextChanging(ustring newText) Parameters Type Name Description ustring newText The new text to be replaced. Returns Type Description TextChangingEventArgs Returns the TextChangingEventArgs | Edit this page View Source Paste() Paste the selected text from the clipboard. Declaration public virtual void Paste() | Edit this page View Source PositionCursor() Sets the cursor position. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) Processes key presses for the TextField. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete, Backspace Deletes the character before cursor. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source SelectAll() Selects all text. Declaration public void SelectAll() Events | Edit this page View Source TextChanged Changed event, raised when the text has changed. Declaration public event Action<ustring> TextChanged Event Type Type Description Action<ustring> Remarks This event is raised when the Text changes. | Edit this page View Source TextChanging Changing event, raised before the Text changes and can be canceled or changing the new text. Declaration public event Action<TextChangingEventArgs> TextChanging Event Type Type Description Action<TextChangingEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.TextFieldAutocomplete.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextFieldAutocomplete.html",
    "title": "Class TextFieldAutocomplete",
    "keywords": "Class TextFieldAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextField. Inheritance object Autocomplete TextFieldAutocomplete Implements IAutocomplete Inherited Members Autocomplete.HostControl Autocomplete.PopupInsideContainer Autocomplete.MaxWidth Autocomplete.MaxHeight Autocomplete.Visible Autocomplete.Suggestions Autocomplete.AllSuggestions Autocomplete.SelectedIdx Autocomplete.ScrollOffset Autocomplete.ColorScheme Autocomplete.SelectionKey Autocomplete.CloseKey Autocomplete.Reopen Autocomplete.RenderOverlay(Point) Autocomplete.EnsureSelectedIdxIsValid() Autocomplete.ProcessKey(KeyEvent) Autocomplete.MouseEvent(MouseEvent, bool) Autocomplete.RenderSelectedIdxByMouse(MouseEvent) Autocomplete.ClearSuggestions() Autocomplete.GenerateSuggestions(int) Autocomplete.IsWordChar(Rune) Autocomplete.Select() Autocomplete.InsertSelection(string) Autocomplete.IdxToWord(List<Rune>, int, int) Autocomplete.Close() Autocomplete.MoveUp() Autocomplete.MoveDown() Autocomplete.ReopenSuggestions() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextFieldAutocomplete : Autocomplete, IAutocomplete Methods | Edit this page View Source DeleteTextBackwards() Deletes the text backwards before insert the selected text in the HostControl. Declaration protected override void DeleteTextBackwards() Overrides Autocomplete.DeleteTextBackwards() | Edit this page View Source GetCurrentWord(int) Returns the currently selected word from the HostControl. When overriding this method views can make use of IdxToWord(List<Rune>, int, int) Declaration protected override string GetCurrentWord(int columnOffset = 0) Parameters Type Name Description int columnOffset The column offset. Returns Type Description string Overrides Autocomplete.GetCurrentWord(int) | Edit this page View Source InsertText(string) Inser the selected text in the HostControl. Declaration protected override void InsertText(string accepted) Parameters Type Name Description string accepted Overrides Autocomplete.InsertText(string) Implements IAutocomplete"
  },
  "api/Terminal.Gui/Terminal.Gui.TextFormatter.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextFormatter.html",
    "title": "Class TextFormatter",
    "keywords": "Class TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap. Inheritance object TextFormatter Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextFormatter Properties | Edit this page View Source Alignment Controls the horizontal text-alignment property. Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment The text alignment. | Edit this page View Source AutoSize Used by Text to resize the view's Bounds with the Size. Setting AutoSize to true only work if the Width and Height are null or Absolute values and doesn't work with Computed layout, to avoid breaking the Pos and Dim settings. Declaration public bool AutoSize { get; set; } Property Value Type Description bool | Edit this page View Source CursorPosition Gets the cursor position from HotKey. If the HotKey is defined, the cursor will be positioned over it. Declaration public int CursorPosition { get; set; } Property Value Type Description int | Edit this page View Source Direction Controls the text-direction property. Declaration public TextDirection Direction { get; set; } Property Value Type Description TextDirection The text vertical alignment. | Edit this page View Source HotKey Gets the hotkey. Will be an upper case letter or digit. Declaration public Key HotKey { get; } Property Value Type Description Key | Edit this page View Source HotKeyPos The position in the text of the hotkey. The hotkey will be rendered using the hot color. Declaration public int HotKeyPos { get; set; } Property Value Type Description int | Edit this page View Source HotKeySpecifier The specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description Rune | Edit this page View Source Lines Gets the formatted lines. Declaration public List<ustring> Lines { get; } Property Value Type Description List<ustring> Remarks Upon a 'get' of this property, if the text needs to be formatted (if NeedsFormat is true) Format(ustring, int, bool, bool, bool, int, TextDirection) will be called internally. | Edit this page View Source NeedsFormat Gets or sets whether the TextFormatter needs to format the text when Draw(Rect, Attribute, Attribute, Rect, bool) is called. If it is false when Draw is called, the Draw call will be faster. Declaration public bool NeedsFormat { get; set; } Property Value Type Description bool Remarks This is set to true when the properties of TextFormatter are set. | Edit this page View Source PreserveTrailingSpaces Gets or sets a flag that determines whether Text will have trailing spaces preserved or not when WordWrap(ustring, int, bool, int, TextDirection) is enabled. If `true` any trailing spaces will be trimmed when either the Text property is changed or when WordWrap(ustring, int, bool, int, TextDirection) is set to `true`. The default is `false`. Declaration public bool PreserveTrailingSpaces { get; set; } Property Value Type Description bool | Edit this page View Source Size Gets or sets the size of the area the text will be constrained to when formatted. Declaration public Size Size { get; set; } Property Value Type Description Size | Edit this page View Source Text The text to be displayed. This text is never modified. Declaration public virtual ustring Text { get; set; } Property Value Type Description ustring | Edit this page View Source VerticalAlignment Controls the vertical text-alignment property. Declaration public VerticalTextAlignment VerticalAlignment { get; set; } Property Value Type Description VerticalTextAlignment The text vertical alignment. Methods | Edit this page View Source CalcRect(int, int, ustring, TextDirection) Calculates the rectangle required to hold text, assuming no word wrapping. Declaration public static Rect CalcRect(int x, int y, ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom) Parameters Type Name Description int x The x location of the rectangle int y The y location of the rectangle ustring text The text to measure TextDirection direction The text direction. Returns Type Description Rect | Edit this page View Source ClipAndJustify(ustring, int, bool, TextDirection) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, bool justify, TextDirection textDirection = TextDirection.LeftRight_TopBottom) Parameters Type Name Description ustring text The text to justify. int width If the text length is greater that width it will be clipped. bool justify Justify. TextDirection textDirection The text direction. Returns Type Description ustring Justified and clipped text. | Edit this page View Source ClipAndJustify(ustring, int, TextAlignment, TextDirection) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, TextAlignment talign, TextDirection textDirection = TextDirection.LeftRight_TopBottom) Parameters Type Name Description ustring text The text to justify. int width If the text length is greater that width it will be clipped. TextAlignment talign Alignment. TextDirection textDirection The text direction. Returns Type Description ustring Justified and clipped text. | Edit this page View Source ClipOrPad(string, int) Adds trailing whitespace or truncates text so that it fits exactly width console units. Note that some unicode characters take 2+ columns Declaration public static string ClipOrPad(string text, int width) Parameters Type Name Description string text int width Returns Type Description string | Edit this page View Source Draw(Rect, Attribute, Attribute, Rect, bool) Draws the text held by TextFormatter to Driver using the colors specified. Declaration public void Draw(Rect bounds, Attribute normalColor, Attribute hotColor, Rect containerBounds = default, bool fillRemaining = true) Parameters Type Name Description Rect bounds Specifies the screen-relative location and maximum size for drawing the text. Attribute normalColor The color to use for all text except the hotkey Attribute hotColor The color to use to draw the hotkey Rect containerBounds Specifies the screen-relative location and maximum container size. bool fillRemaining Determines if the bounds width will be used (default) or only the text width will be used. | Edit this page View Source FindHotKey(ustring, Rune, bool, out int, out Key) Finds the hotkey and its location in text. Declaration public static bool FindHotKey(ustring text, Rune hotKeySpecifier, bool firstUpperCase, out int hotPos, out Key hotKey) Parameters Type Name Description ustring text The text to look in. Rune hotKeySpecifier The hotkey specifier (e.g. '_') to look for. bool firstUpperCase If true the legacy behavior of identifying the first upper case character as the hotkey will be enabled. Regardless of the value of this parameter, hotKeySpecifier takes precedence. int hotPos Outputs the Rune index into text. Key hotKey Outputs the hotKey. Returns Type Description bool true if a hotkey was found; false otherwise. | Edit this page View Source Format(ustring, int, bool, bool, bool, int, TextDirection) Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. Declaration public static List<ustring> Format(ustring text, int width, bool justify, bool wordWrap, bool preserveTrailingSpaces = false, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom) Parameters Type Name Description ustring text int width The width to bound the text to for word wrapping and clipping. bool justify Specifies whether the text should be justified. bool wordWrap If true, the text will be wrapped to new lines as need. If false, forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width bool preserveTrailingSpaces If true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false, the trailing spaces will be trimmed. int tabWidth The tab width. TextDirection textDirection The text direction. Returns Type Description List<ustring> A list of word wrapped lines. Remarks An empty text string will result in one empty line. If width is 0, a single, empty line will be returned. If width is int.MaxValue, the text will be formatted to the maximum width possible. | Edit this page View Source Format(ustring, int, TextAlignment, bool, bool, int, TextDirection) Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. Declaration public static List<ustring> Format(ustring text, int width, TextAlignment talign, bool wordWrap, bool preserveTrailingSpaces = false, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom) Parameters Type Name Description ustring text int width The width to bound the text to for word wrapping and clipping. TextAlignment talign Specifies how the text will be aligned horizontally. bool wordWrap If true, the text will be wrapped to new lines as need. If false, forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width bool preserveTrailingSpaces If true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false, the trailing spaces will be trimmed. int tabWidth The tab width. TextDirection textDirection The text direction. Returns Type Description List<ustring> A list of word wrapped lines. Remarks An empty text string will result in one empty line. If width is 0, a single, empty line will be returned. If width is int.MaxValue, the text will be formatted to the maximum width possible. | Edit this page View Source GetMaxColsForWidth(List<ustring>, int) Gets the index position from the list based on the width. Declaration public static int GetMaxColsForWidth(List<ustring> lines, int width) Parameters Type Name Description List<ustring> lines The lines. int width The width. Returns Type Description int The index of the list that fit the width. | Edit this page View Source GetMaxLengthForWidth(ustring, int) Gets the index position from the text based on the width. Declaration public static int GetMaxLengthForWidth(ustring text, int width) Parameters Type Name Description ustring text The text. int width The width. Returns Type Description int The index of the text that fit the width. | Edit this page View Source GetMaxLengthForWidth(List<Rune>, int) Gets the index position from the list based on the width. Declaration public static int GetMaxLengthForWidth(List<Rune> runes, int width) Parameters Type Name Description List<Rune> runes The runes. int width The width. Returns Type Description int The index of the list that fit the width. | Edit this page View Source GetSumMaxCharWidth(ustring, int, int) Gets the maximum characters width from the text based on the startIndex and the length. Declaration public static int GetSumMaxCharWidth(ustring text, int startIndex = -1, int length = -1) Parameters Type Name Description ustring text The text. int startIndex The start index. int length The length. Returns Type Description int The maximum characters width. | Edit this page View Source GetSumMaxCharWidth(List<ustring>, int, int) Gets the maximum characters width from the list based on the startIndex and the length. Declaration public static int GetSumMaxCharWidth(List<ustring> lines, int startIndex = -1, int length = -1) Parameters Type Name Description List<ustring> lines The lines. int startIndex The start index. int length The length. Returns Type Description int The maximum characters width. | Edit this page View Source GetTextWidth(ustring) Gets the total width of the passed text. Declaration public static int GetTextWidth(ustring text) Parameters Type Name Description ustring text Returns Type Description int The text width. | Edit this page View Source IsHorizontalDirection(TextDirection) Check if it is a horizontal direction Declaration public static bool IsHorizontalDirection(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description bool | Edit this page View Source IsLeftToRight(TextDirection) Check if it is Left to Right direction Declaration public static bool IsLeftToRight(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description bool | Edit this page View Source IsTopToBottom(TextDirection) Check if it is Top to Bottom direction Declaration public static bool IsTopToBottom(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description bool | Edit this page View Source IsVerticalDirection(TextDirection) Check if it is a vertical direction Declaration public static bool IsVerticalDirection(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description bool | Edit this page View Source Justify(ustring, int, char, TextDirection) Justifies the text to fill the width provided. Space will be added between words (demarked by spaces and tabs) to make the text just fit width. Spaces will not be added to the ends. Declaration public static ustring Justify(ustring text, int width, char spaceChar = ' ', TextDirection textDirection = TextDirection.LeftRight_TopBottom) Parameters Type Name Description ustring text int width char spaceChar Character to replace whitespace and pad with. For debugging purposes. TextDirection textDirection The text direction. Returns Type Description ustring The justified text. | Edit this page View Source MaxLines(ustring, int) Computes the number of lines needed to render the specified text given the width. Declaration public static int MaxLines(ustring text, int width) Parameters Type Name Description ustring text Text, may contain newlines. int width The minimum width for the text. Returns Type Description int Number of lines. | Edit this page View Source MaxWidth(ustring, int) Computes the maximum width needed to render the text (single line or multiple lines) given a minimum width. Declaration public static int MaxWidth(ustring text, int width) Parameters Type Name Description ustring text Text, may contain newlines. int width The minimum width for the text. Returns Type Description int Max width of lines. | Edit this page View Source MaxWidthLine(ustring) Determines the line with the highest width in the text if it contains newlines. Declaration public static int MaxWidthLine(ustring text) Parameters Type Name Description ustring text Text, may contain newlines. Returns Type Description int The highest line width. | Edit this page View Source RemoveHotKeySpecifier(ustring, int, Rune) Removes the hotkey specifier from text. Declaration public static ustring RemoveHotKeySpecifier(ustring text, int hotPos, Rune hotKeySpecifier) Parameters Type Name Description ustring text The text to manipulate. int hotPos Returns the position of the hot-key in the text. -1 if not found. Rune hotKeySpecifier The hot-key specifier (e.g. '_') to look for. Returns Type Description ustring The input text with the hotkey specifier ('_') removed. | Edit this page View Source ReplaceHotKeyWithTag(ustring, int) Replaces the Rune at the index specified by the hotPos parameter with a tag identifying it as the hotkey. Declaration public ustring ReplaceHotKeyWithTag(ustring text, int hotPos) Parameters Type Name Description ustring text The text to tag the hotkey in. int hotPos The Rune index of the hotkey in text. Returns Type Description ustring The text with the hotkey tagged. Remarks The returned string will not render correctly without first un-doing the tag. To undo the tag, search for | Edit this page View Source SplitNewLine(ustring) Splits all newlines in the text into a list and supports both CRLF and LF, preserving the ending newline. Declaration public static List<ustring> SplitNewLine(ustring text) Parameters Type Name Description ustring text The text. Returns Type Description List<ustring> A list of text without the newline characters. | Edit this page View Source WordWrap(ustring, int, bool, int, TextDirection) Formats the provided text to fit within the width provided using word wrapping. Declaration public static List<ustring> WordWrap(ustring text, int width, bool preserveTrailingSpaces = false, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom) Parameters Type Name Description ustring text The text to word wrap int width The width to contain the text to bool preserveTrailingSpaces If true, the wrapped text will keep the trailing spaces. If false, the trailing spaces will be trimmed. int tabWidth The tab width. TextDirection textDirection The text direction. Returns Type Description List<ustring> Returns a list of word wrapped lines. Remarks This method does not do any justification. This method strips Newline ('\\n' and '\\r\\n') sequences before processing. Events | Edit this page View Source HotKeyChanged Event invoked when the HotKey is changed. Declaration public event Action<Key> HotKeyChanged Event Type Type Description Action<Key>"
  },
  "api/Terminal.Gui/Terminal.Gui.TextValidateField.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextValidateField.html",
    "title": "Class TextValidateField",
    "keywords": "Class TextValidateField Text field that validates input through a ITextValidateProvider Inheritance object Responder View TextValidateField Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextValidateField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source TextValidateField() Initializes a new instance of the TextValidateField class using Computed positioning. Declaration public TextValidateField() | Edit this page View Source TextValidateField(ITextValidateProvider) Initializes a new instance of the TextValidateField class using Computed positioning. Declaration public TextValidateField(ITextValidateProvider provider) Parameters Type Name Description ITextValidateProvider provider Properties | Edit this page View Source IsValid This property returns true if the input is valid. Declaration public virtual bool IsValid { get; } Property Value Type Description bool | Edit this page View Source Provider Provider Declaration public ITextValidateProvider Provider { get; set; } Property Value Type Description ITextValidateProvider | Edit this page View Source Text Text Declaration public ustring Text { get; set; } Property Value Type Description ustring Methods | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.ITextValidateProvider.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.ITextValidateProvider.html",
    "title": "Interface ITextValidateProvider",
    "keywords": "Interface ITextValidateProvider TextValidateField Providers Interface. All TextValidateField are created with a ITextValidateProvider. Namespace: Terminal.Gui.TextValidateProviders Assembly: Terminal.Gui.dll Syntax public interface ITextValidateProvider Properties | Edit this page View Source DisplayText Gets the formatted string for display. Declaration ustring DisplayText { get; } Property Value Type Description ustring | Edit this page View Source Fixed Set that this provider uses a fixed width. e.g. Masked ones are fixed. Declaration bool Fixed { get; } Property Value Type Description bool | Edit this page View Source IsValid True if the input is valid, otherwise false. Declaration bool IsValid { get; } Property Value Type Description bool | Edit this page View Source Text Set the input text and get the current value. Declaration ustring Text { get; set; } Property Value Type Description ustring Methods | Edit this page View Source Cursor(int) Set Cursor position to pos. Declaration int Cursor(int pos) Parameters Type Name Description int pos Returns Type Description int Return first valid position. | Edit this page View Source CursorEnd() Find the last valid character position. Declaration int CursorEnd() Returns Type Description int New cursor position. | Edit this page View Source CursorLeft(int) First valid position before pos. Declaration int CursorLeft(int pos) Parameters Type Name Description int pos Returns Type Description int New cursor position if any, otherwise returns pos | Edit this page View Source CursorRight(int) First valid position after pos. Declaration int CursorRight(int pos) Parameters Type Name Description int pos Current position. Returns Type Description int New cursor position if any, otherwise returns pos | Edit this page View Source CursorStart() Find the first valid character position. Declaration int CursorStart() Returns Type Description int New cursor position. | Edit this page View Source Delete(int) Deletes the current character in pos. Declaration bool Delete(int pos) Parameters Type Name Description int pos Returns Type Description bool true if the character was successfully removed, otherwise false. | Edit this page View Source InsertAt(char, int) Insert character ch in position pos. Declaration bool InsertAt(char ch, int pos) Parameters Type Name Description char ch int pos Returns Type Description bool true if the character was successfully inserted, otherwise false."
  },
  "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.NetMaskedTextProvider.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.NetMaskedTextProvider.html",
    "title": "Class NetMaskedTextProvider",
    "keywords": "Class NetMaskedTextProvider .Net MaskedTextProvider Provider for TextValidateField. Wrapper around MaskedTextProvider Masking elements Inheritance object NetMaskedTextProvider Implements ITextValidateProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.TextValidateProviders Assembly: Terminal.Gui.dll Syntax public class NetMaskedTextProvider : ITextValidateProvider Constructors | Edit this page View Source NetMaskedTextProvider(string) Empty Constructor Declaration public NetMaskedTextProvider(string mask) Parameters Type Name Description string mask Properties | Edit this page View Source DisplayText Gets the formatted string for display. Declaration public ustring DisplayText { get; } Property Value Type Description ustring | Edit this page View Source Fixed Set that this provider uses a fixed width. e.g. Masked ones are fixed. Declaration public bool Fixed { get; } Property Value Type Description bool | Edit this page View Source IsValid True if the input is valid, otherwise false. Declaration public bool IsValid { get; } Property Value Type Description bool | Edit this page View Source Mask Mask property Declaration public ustring Mask { get; set; } Property Value Type Description ustring | Edit this page View Source Text Set the input text and get the current value. Declaration public ustring Text { get; set; } Property Value Type Description ustring Methods | Edit this page View Source Cursor(int) Set Cursor position to pos. Declaration public int Cursor(int pos) Parameters Type Name Description int pos Returns Type Description int Return first valid position. | Edit this page View Source CursorEnd() Find the last valid character position. Declaration public int CursorEnd() Returns Type Description int New cursor position. | Edit this page View Source CursorLeft(int) First valid position before pos. Declaration public int CursorLeft(int pos) Parameters Type Name Description int pos Returns Type Description int New cursor position if any, otherwise returns pos | Edit this page View Source CursorRight(int) First valid position after pos. Declaration public int CursorRight(int pos) Parameters Type Name Description int pos Current position. Returns Type Description int New cursor position if any, otherwise returns pos | Edit this page View Source CursorStart() Find the first valid character position. Declaration public int CursorStart() Returns Type Description int New cursor position. | Edit this page View Source Delete(int) Deletes the current character in pos. Declaration public bool Delete(int pos) Parameters Type Name Description int pos Returns Type Description bool true if the character was successfully removed, otherwise false. | Edit this page View Source InsertAt(char, int) Insert character ch in position pos. Declaration public bool InsertAt(char ch, int pos) Parameters Type Name Description char ch int pos Returns Type Description bool true if the character was successfully inserted, otherwise false. Implements ITextValidateProvider"
  },
  "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.TextRegexProvider.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.TextRegexProvider.html",
    "title": "Class TextRegexProvider",
    "keywords": "Class TextRegexProvider Regex Provider for TextValidateField. Inheritance object TextRegexProvider Implements ITextValidateProvider Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.TextValidateProviders Assembly: Terminal.Gui.dll Syntax public class TextRegexProvider : ITextValidateProvider Constructors | Edit this page View Source TextRegexProvider(string) Empty Constructor. Declaration public TextRegexProvider(string pattern) Parameters Type Name Description string pattern Properties | Edit this page View Source DisplayText Gets the formatted string for display. Declaration public ustring DisplayText { get; } Property Value Type Description ustring | Edit this page View Source Fixed Set that this provider uses a fixed width. e.g. Masked ones are fixed. Declaration public bool Fixed { get; } Property Value Type Description bool | Edit this page View Source IsValid True if the input is valid, otherwise false. Declaration public bool IsValid { get; } Property Value Type Description bool | Edit this page View Source Pattern Regex pattern property. Declaration public ustring Pattern { get; set; } Property Value Type Description ustring | Edit this page View Source Text Set the input text and get the current value. Declaration public ustring Text { get; set; } Property Value Type Description ustring | Edit this page View Source ValidateOnInput When true, validates with the regex pattern on each input, preventing the input if it's not valid. Declaration public bool ValidateOnInput { get; set; } Property Value Type Description bool Methods | Edit this page View Source Cursor(int) Set Cursor position to pos. Declaration public int Cursor(int pos) Parameters Type Name Description int pos Returns Type Description int Return first valid position. | Edit this page View Source CursorEnd() Find the last valid character position. Declaration public int CursorEnd() Returns Type Description int New cursor position. | Edit this page View Source CursorLeft(int) First valid position before pos. Declaration public int CursorLeft(int pos) Parameters Type Name Description int pos Returns Type Description int New cursor position if any, otherwise returns pos | Edit this page View Source CursorRight(int) First valid position after pos. Declaration public int CursorRight(int pos) Parameters Type Name Description int pos Current position. Returns Type Description int New cursor position if any, otherwise returns pos | Edit this page View Source CursorStart() Find the first valid character position. Declaration public int CursorStart() Returns Type Description int New cursor position. | Edit this page View Source Delete(int) Deletes the current character in pos. Declaration public bool Delete(int pos) Parameters Type Name Description int pos Returns Type Description bool true if the character was successfully removed, otherwise false. | Edit this page View Source InsertAt(char, int) Insert character ch in position pos. Declaration public bool InsertAt(char ch, int pos) Parameters Type Name Description char ch int pos Returns Type Description bool true if the character was successfully inserted, otherwise false. Implements ITextValidateProvider"
  },
  "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextValidateProviders.html",
    "title": "Namespace Terminal.Gui.TextValidateProviders",
    "keywords": "Namespace Terminal.Gui.TextValidateProviders Classes NetMaskedTextProvider .Net MaskedTextProvider Provider for TextValidateField. Wrapper around MaskedTextProvider Masking elements TextRegexProvider Regex Provider for TextValidateField. Interfaces ITextValidateProvider TextValidateField Providers Interface. All TextValidateField are created with a ITextValidateProvider."
  },
  "api/Terminal.Gui/Terminal.Gui.TextView.ContentsChangedEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextView.ContentsChangedEventArgs.html",
    "title": "Class TextView.ContentsChangedEventArgs",
    "keywords": "Class TextView.ContentsChangedEventArgs Event arguments for events for when the contents of the TextView change. E.g. the ContentsChanged event. Inheritance object EventArgs TextView.ContentsChangedEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextView.ContentsChangedEventArgs : EventArgs Constructors | Edit this page View Source ContentsChangedEventArgs(int, int) Creates a new ContentsChanged instance. Declaration public ContentsChangedEventArgs(int currentRow, int currentColumn) Parameters Type Name Description int currentRow Contains the row where the change occurred. int currentColumn Contains the column where the change occured. Properties | Edit this page View Source Col Contains the column where the change occurred. Declaration public int Col { get; } Property Value Type Description int | Edit this page View Source Row Contains the row where the change occurred. Declaration public int Row { get; } Property Value Type Description int"
  },
  "api/Terminal.Gui/Terminal.Gui.TextView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextView.html",
    "title": "Class TextView",
    "keywords": "Class TextView Multi-line text editing View. Inheritance object Responder View TextView Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks TextView provides a multi-line text editor. Users interact with it with the standard Windows, Mac, and Linux (Emacs) commands. Shortcut Action performed Left cursor, Control-b Moves the editing point left. Right cursor, Control-f Moves the editing point right. Alt-b Moves one word back. Alt-f Moves one word forward. Up cursor, Control-p Moves the editing point one line up. Down cursor, Control-n Moves the editing point one line down Home key, Control-a Moves the cursor to the beginning of the line. End key, Control-e Moves the cursor to the end of the line. Control-Home Scrolls to the first line and moves the cursor there. Control-End Scrolls to the last line and moves the cursor there. Delete, Control-d Deletes the character in front of the cursor. Backspace Deletes the character behind the cursor. Control-k Deletes the text until the end of the line and replaces the kill buffer with the deleted text. You can paste this text in a different place by using Control-y. Control-y Pastes the content of the kill ring into the current position. Alt-d Deletes the word above the cursor and adds it to the kill ring. You can paste the contents of the kill ring with Control-y. Control-q Quotes the next input character, to prevent the normal processing of key handling to take place. Constructors | Edit this page View Source TextView() Initializes a TextView on the specified area, with dimensions controlled with the X, Y, Width and Height properties. Declaration public TextView() | Edit this page View Source TextView(Rect) Initializes a TextView on the specified area, with absolute position and size. Declaration public TextView(Rect frame) Parameters Type Name Description Rect frame Properties | Edit this page View Source AllowsReturn Gets or sets a value indicating whether pressing ENTER in a TextView creates a new line of text in the view or activates the default button for the toplevel. Declaration public bool AllowsReturn { get; set; } Property Value Type Description bool | Edit this page View Source AllowsTab Gets or sets whether the TextView inserts a tab character into the text or ignores tab input. If set to `false` and the user presses the tab key (or shift-tab) the focus will move to the next view (or previous with shift-tab). The default is `true`; if the user presses the tab key, a tab character will be inserted into the text. Declaration public bool AllowsTab { get; set; } Property Value Type Description bool | Edit this page View Source Autocomplete Provides autocomplete context menu based on suggestions at the current cursor position. Populate AllSuggestions to enable this feature Declaration public IAutocomplete Autocomplete { get; protected set; } Property Value Type Description IAutocomplete | Edit this page View Source BottomOffset The bottom offset needed to use a horizontal scrollbar or for another reason. This is only needed with the keyboard navigation. Declaration public int BottomOffset { get; set; } Property Value Type Description int | Edit this page View Source CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description bool true if can focus; otherwise, false. Overrides View.CanFocus | Edit this page View Source ContextMenu Get the ContextMenu for this view. Declaration public ContextMenu ContextMenu { get; } Property Value Type Description ContextMenu | Edit this page View Source CurrentColumn Gets the cursor column. Declaration public int CurrentColumn { get; } Property Value Type Description int The cursor column. | Edit this page View Source CurrentRow Gets the current cursor row. Declaration public int CurrentRow { get; } Property Value Type Description int | Edit this page View Source CursorPosition Sets or gets the current cursor position. Declaration public Point CursorPosition { get; set; } Property Value Type Description Point | Edit this page View Source DesiredCursorVisibility Get / Set the wished cursor when the field is focused Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility | Edit this page View Source Frame Gets or sets the frame for the view. The frame is relative to the view's container (SuperView). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView. | Edit this page View Source HasHistoryChanges Indicates whatever the text has history changes or not. true if the text has history changes false otherwise. Declaration public bool HasHistoryChanges { get; } Property Value Type Description bool | Edit this page View Source IsDirty Indicates whatever the text was changed or not. true if the text was changed false otherwise. Declaration public bool IsDirty { get; } Property Value Type Description bool | Edit this page View Source LeftColumn Gets or sets the left column. Declaration public int LeftColumn { get; set; } Property Value Type Description int | Edit this page View Source Lines Gets the number of lines. Declaration public int Lines { get; } Property Value Type Description int | Edit this page View Source Maxlength Gets the maximum visible length line. Declaration public int Maxlength { get; } Property Value Type Description int | Edit this page View Source Multiline Gets or sets a value indicating whether this TextView is a multiline text view. Declaration public bool Multiline { get; set; } Property Value Type Description bool | Edit this page View Source ReadOnly Gets or sets whether the TextView is in read-only mode or not Declaration public bool ReadOnly { get; set; } Property Value Type Description bool Boolean value(Default false) | Edit this page View Source RightOffset The right offset needed to use a vertical scrollbar or for another reason. This is only needed with the keyboard navigation. Declaration public int RightOffset { get; set; } Property Value Type Description int | Edit this page View Source SelectedLength Length of the selected text. Declaration public int SelectedLength { get; } Property Value Type Description int | Edit this page View Source SelectedText The selected text. Declaration public ustring SelectedText { get; } Property Value Type Description ustring | Edit this page View Source Selecting Get or sets the selecting. Declaration public bool Selecting { get; set; } Property Value Type Description bool | Edit this page View Source SelectionStartColumn Start column position of the selected text. Declaration public int SelectionStartColumn { get; set; } Property Value Type Description int | Edit this page View Source SelectionStartRow Start row position of the selected text. Declaration public int SelectionStartRow { get; set; } Property Value Type Description int | Edit this page View Source TabWidth Gets or sets a value indicating the number of whitespace when pressing the TAB key. Declaration public int TabWidth { get; set; } Property Value Type Description int | Edit this page View Source Text Sets or gets the text in the TextView. Declaration public override ustring Text { get; set; } Property Value Type Description ustring Overrides View.Text Remarks The TextChanged event is fired whenever this property is set. Note, however, that Text is not set by TextView as the user types. | Edit this page View Source TopRow Gets or sets the top row. Declaration public int TopRow { get; set; } Property Value Type Description int | Edit this page View Source Used Tracks whether the text view should be considered \"used\", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry Declaration public bool Used { get; set; } Property Value Type Description bool | Edit this page View Source WordWrap Allows word wrap the to fit the available container width. Declaration public bool WordWrap { get; set; } Property Value Type Description bool Methods | Edit this page View Source ClearHistoryChanges() Allows clearing the HistoryText.HistoryTextItem items updating the original text. Declaration public void ClearHistoryChanges() | Edit this page View Source CloseFile() Closes the contents of the stream into the TextView. Declaration public bool CloseFile() Returns Type Description bool true, if stream was closed, false otherwise. | Edit this page View Source Copy() Copy the selected text to the clipboard contents. Declaration public void Copy() | Edit this page View Source Cut() Cut the selected text to the clipboard contents. Declaration public void Cut() | Edit this page View Source DeleteAll() Deletes all text. Declaration public void DeleteAll() | Edit this page View Source DeleteCharLeft() Deletes all the selected or a single character at left from the position of the cursor. Declaration public void DeleteCharLeft() | Edit this page View Source DeleteCharRight() Deletes all the selected or a single character at right from the position of the cursor. Declaration public void DeleteCharRight() | Edit this page View Source FindNextText(ustring, out bool, bool, bool, ustring, bool) Find the next text based on the match case with the option to replace it. Declaration public bool FindNextText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false) Parameters Type Name Description ustring textToFind The text to find. bool gaveFullTurn trueIf all the text was forward searched.falseotherwise. bool matchCase The match case setting. bool matchWholeWord The match whole word setting. ustring textToReplace The text to replace. bool replace trueIf is replacing.falseotherwise. Returns Type Description bool trueIf the text was found.falseotherwise. | Edit this page View Source FindPreviousText(ustring, out bool, bool, bool, ustring, bool) Find the previous text based on the match case with the option to replace it. Declaration public bool FindPreviousText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false) Parameters Type Name Description ustring textToFind The text to find. bool gaveFullTurn trueIf all the text was backward searched.falseotherwise. bool matchCase The match case setting. bool matchWholeWord The match whole word setting. ustring textToReplace The text to replace. bool replace trueIf the text was found.falseotherwise. Returns Type Description bool trueIf the text was found.falseotherwise. | Edit this page View Source FindTextChanged() Reset the flag to stop continuous find. Declaration public void FindTextChanged() | Edit this page View Source GetCurrentLine() Returns the characters on the current line (where the cursor is positioned). Use CurrentColumn to determine the position of the cursor within that line Declaration public List<Rune> GetCurrentLine() Returns Type Description List<Rune> | Edit this page View Source GetNormalColor() Determines the current ColorScheme based on the Enabled value. Declaration public override Attribute GetNormalColor() Returns Type Description Attribute Normal if Enabled is true or Disabled if Enabled is false. If it's overridden can return other values. Overrides View.GetNormalColor() | Edit this page View Source InsertText(string) Inserts the given toAdd text at the current cursor position exactly as if the user had just typed it Declaration public void InsertText(string toAdd) Parameters Type Name Description string toAdd Text to add | Edit this page View Source LoadFile(string) Loads the contents of the file into the TextView. Declaration public bool LoadFile(string path) Parameters Type Name Description string path Path to the file to load. Returns Type Description bool true, if file was loaded, false otherwise. | Edit this page View Source LoadStream(Stream) Loads the contents of the stream into the TextView. Declaration public void LoadStream(Stream stream) Parameters Type Name Description Stream stream Stream to load the contents from. | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source MoveEnd() Will scroll the TextView to the last line and position the cursor there. Declaration public void MoveEnd() | Edit this page View Source MoveHome() Will scroll the TextView to the first line and position the cursor there. Declaration public void MoveHome() | Edit this page View Source OnContentsChanged() Called when the contents of the TextView change. E.g. when the user types text or deletes text. Raises the ContentsChanged event. Declaration public virtual void OnContentsChanged() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnKeyUp(KeyEvent) Method invoked when a key is released. Declaration public override bool OnKeyUp(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool true if the event was handled Overrides View.OnKeyUp(KeyEvent) | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnLeave(View) | Edit this page View Source OnUnwrappedCursorPosition(int?, int?) Invoke the UnwrappedCursorPosition event with the unwrapped CursorPosition. Declaration public virtual void OnUnwrappedCursorPosition(int? cRow = null, int? cCol = null) Parameters Type Name Description int? cRow int? cCol | Edit this page View Source Paste() Paste the clipboard contents into the current selected position. Declaration public void Paste() | Edit this page View Source PositionCursor() Positions the cursor on the current row and column Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source ReplaceAllText(ustring, bool, bool, ustring) Replaces all the text based on the match case. Declaration public bool ReplaceAllText(ustring textToFind, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null) Parameters Type Name Description ustring textToFind The text to find. bool matchCase The match case setting. bool matchWholeWord The match whole word setting. ustring textToReplace The text to replace. Returns Type Description bool trueIf the text was found.falseotherwise. | Edit this page View Source ScrollTo(int, bool) Will scroll the TextView to display the specified row at the top if isRow is true or will scroll the TextView to display the specified column at the left if isRow is false. Declaration public void ScrollTo(int idx, bool isRow = true) Parameters Type Name Description int idx Row that should be displayed at the top or Column that should be displayed at the left, if the value is negative it will be reset to zero bool isRow If true (default) the idx is a row, column otherwise. | Edit this page View Source SelectAll() Select all text. Declaration public void SelectAll() | Edit this page View Source SetNormalColor() Sets the driver to the default color for the control where no text is being rendered. Defaults to Normal. Declaration protected virtual void SetNormalColor() | Edit this page View Source SetNormalColor(List<Rune>, int) Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to Normal. Declaration protected virtual void SetNormalColor(List<Rune> line, int idx) Parameters Type Name Description List<Rune> line int idx | Edit this page View Source SetReadOnlyColor(List<Rune>, int) Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to Focus. Declaration protected virtual void SetReadOnlyColor(List<Rune> line, int idx) Parameters Type Name Description List<Rune> line int idx | Edit this page View Source SetSelectionColor(List<Rune>, int) Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to Focus. Declaration protected virtual void SetSelectionColor(List<Rune> line, int idx) Parameters Type Name Description List<Rune> line int idx | Edit this page View Source SetUsedColor(List<Rune>, int) Sets the Driver to an appropriate color for rendering the given idx of the current line. Override to provide custom coloring by calling SetAttribute(Attribute) Defaults to HotFocus. Declaration protected virtual void SetUsedColor(List<Rune> line, int idx) Parameters Type Name Description List<Rune> line int idx Events | Edit this page View Source ContentsChanged Raised when the contents of the TextView are changed. Declaration public event Action<TextView.ContentsChangedEventArgs> ContentsChanged Event Type Type Description Action<TextView.ContentsChangedEventArgs> Remarks Unlike the TextChanged event, this event is raised whenever the user types or otherwise changes the contents of the TextView. | Edit this page View Source TextChanged Raised when the Text property of the TextView changes. Declaration public event Action TextChanged Event Type Type Description Action Remarks The Text property of TextView only changes when it is explicitly set, not as the user types. To be notified as the user changes the contents of the TextView see IsDirty. | Edit this page View Source UnwrappedCursorPosition Invoked with the unwrapped CursorPosition. Declaration public event Action<Point> UnwrappedCursorPosition Event Type Type Description Action<Point> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.TextViewAutocomplete.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TextViewAutocomplete.html",
    "title": "Class TextViewAutocomplete",
    "keywords": "Class TextViewAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextView. Inheritance object Autocomplete TextViewAutocomplete Implements IAutocomplete Inherited Members Autocomplete.HostControl Autocomplete.PopupInsideContainer Autocomplete.MaxWidth Autocomplete.MaxHeight Autocomplete.Visible Autocomplete.Suggestions Autocomplete.AllSuggestions Autocomplete.SelectedIdx Autocomplete.ScrollOffset Autocomplete.ColorScheme Autocomplete.SelectionKey Autocomplete.CloseKey Autocomplete.Reopen Autocomplete.RenderOverlay(Point) Autocomplete.EnsureSelectedIdxIsValid() Autocomplete.ProcessKey(KeyEvent) Autocomplete.MouseEvent(MouseEvent, bool) Autocomplete.RenderSelectedIdxByMouse(MouseEvent) Autocomplete.ClearSuggestions() Autocomplete.GenerateSuggestions(int) Autocomplete.IsWordChar(Rune) Autocomplete.Select() Autocomplete.InsertSelection(string) Autocomplete.IdxToWord(List<Rune>, int, int) Autocomplete.Close() Autocomplete.MoveUp() Autocomplete.MoveDown() Autocomplete.ReopenSuggestions() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TextViewAutocomplete : Autocomplete, IAutocomplete Methods | Edit this page View Source DeleteTextBackwards() Deletes the text backwards before insert the selected text in the HostControl. Declaration protected override void DeleteTextBackwards() Overrides Autocomplete.DeleteTextBackwards() | Edit this page View Source GetCurrentWord(int) Returns the currently selected word from the HostControl. When overriding this method views can make use of IdxToWord(List<Rune>, int, int) Declaration protected override string GetCurrentWord(int columnOffset = 0) Parameters Type Name Description int columnOffset The column offset. Returns Type Description string Overrides Autocomplete.GetCurrentWord(int) | Edit this page View Source InsertText(string) Inser the selected text in the HostControl. Declaration protected override void InsertText(string accepted) Parameters Type Name Description string accepted Overrides Autocomplete.InsertText(string) Implements IAutocomplete"
  },
  "api/Terminal.Gui/Terminal.Gui.Thickness.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Thickness.html",
    "title": "Struct Thickness",
    "keywords": "Struct Thickness Describes the thickness of a frame around a rectangle. Four int values describe the Left, Top, Right, and Bottom sides of the rectangle, respectively. Inherited Members ValueType.Equals(object) ValueType.GetHashCode() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public struct Thickness Constructors | Edit this page View Source Thickness(int) Initializes a new instance of the Thickness structure that has the specified uniform length on each side. Declaration public Thickness(int length) Parameters Type Name Description int length | Edit this page View Source Thickness(int, int, int, int) Initializes a new instance of the Thickness structure that has specific lengths (supplied as a int) applied to each side of the rectangle. Declaration public Thickness(int left, int top, int right, int bottom) Parameters Type Name Description int left int top int right int bottom Fields | Edit this page View Source Bottom Gets or sets the width, in integers, of the lower side of the bounding rectangle. Declaration public int Bottom Field Value Type Description int | Edit this page View Source Left Gets or sets the width, in integers, of the left side of the bounding rectangle. Declaration public int Left Field Value Type Description int | Edit this page View Source Right Gets or sets the width, in integers, of the right side of the bounding rectangle. Declaration public int Right Field Value Type Description int | Edit this page View Source Top Gets or sets the width, in integers, of the upper side of the bounding rectangle. Declaration public int Top Field Value Type Description int Methods | Edit this page View Source ToString() Returns the fully qualified type name of this instance. Declaration public override string ToString() Returns Type Description string The fully qualified type name. Overrides ValueType.ToString()"
  },
  "api/Terminal.Gui/Terminal.Gui.TimeField.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TimeField.html",
    "title": "Class TimeField",
    "keywords": "Class TimeField Time editing View Inheritance object Responder View TextField TimeField Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanging TextField.TextChanged TextField.OnLeave(View) TextField.Autocomplete TextField.Frame TextField.Text TextField.Secret TextField.ScrollOffset TextField.IsDirty TextField.HasHistoryChanges TextField.ContextMenu TextField.PositionCursor() TextField.Redraw(Rect) TextField.GetNormalColor() TextField.CanFocus TextField.KillWordBackwards() TextField.KillWordForwards() TextField.SelectAll() TextField.DeleteAll() TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() TextField.OnTextChanging(ustring) TextField.DesiredCursorVisibility TextField.OnEnter(View) TextField.InsertText(string, bool) TextField.ClearHistoryChanges() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TimeField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TimeField View provides time editing functionality with mouse support. Constructors | Edit this page View Source TimeField() Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField() | Edit this page View Source TimeField(int, int, TimeSpan, bool) Initializes a new instance of TimeField using Absolute positioning. Declaration public TimeField(int x, int y, TimeSpan time, bool isShort = false) Parameters Type Name Description int x The x coordinate. int y The y coordinate. TimeSpan time Initial time. bool isShort If true, the seconds are hidden. Sets the IsShortFormat property. | Edit this page View Source TimeField(TimeSpan) Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField(TimeSpan time) Parameters Type Name Description TimeSpan time Initial time Properties | Edit this page View Source CursorPosition Sets or gets the current cursor position. Declaration public override int CursorPosition { get; set; } Property Value Type Description int Overrides TextField.CursorPosition | Edit this page View Source IsShortFormat Get or sets whether TimeField uses the short or long time format. Declaration public bool IsShortFormat { get; set; } Property Value Type Description bool | Edit this page View Source Time Gets or sets the time of the TimeField. Declaration public TimeSpan Time { get; set; } Property Value Type Description TimeSpan Methods | Edit this page View Source DeleteCharLeft(bool) Deletes the left character. Declaration public override void DeleteCharLeft(bool useOldCursorPos = true) Parameters Type Name Description bool useOldCursorPos Overrides TextField.DeleteCharLeft(bool) | Edit this page View Source DeleteCharRight() Deletes the right character. Declaration public override void DeleteCharRight() Overrides TextField.DeleteCharRight() | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description bool true, if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) | Edit this page View Source OnTimeChanged(DateTimeEventArgs<TimeSpan>) Event firing method that invokes the TimeChanged event. Declaration public virtual void OnTimeChanged(DateTimeEventArgs<TimeSpan> args) Parameters Type Name Description DateTimeEventArgs<TimeSpan> args The event arguments | Edit this page View Source ProcessKey(KeyEvent) Processes key presses for the TextField. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete, Backspace Deletes the character before cursor. Events | Edit this page View Source TimeChanged TimeChanged event, raised when the Date has changed. Declaration public event Action<DateTimeEventArgs<TimeSpan>> TimeChanged Event Type Type Description Action<DateTimeEventArgs<TimeSpan>> Remarks This event is raised when the Time changes. Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Toplevel.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Toplevel.html",
    "title": "Class Toplevel",
    "keywords": "Class Toplevel Toplevel views can be modally executed. They are used for both an application's main view (filling the entire screen and for pop-up views such as Dialog, MessageBox, and Wizard. Inheritance object Responder View Toplevel Border.ToplevelContainer Window Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Toplevel : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks Toplevels can be modally executing views, started by calling Run(Toplevel, Func<Exception, bool>). They return control to the caller when RequestStop(Toplevel) has been called (which sets the Running property to false). A Toplevel is created when an application initializes Terminal.Gui by calling Init(ConsoleDriver, IMainLoopDriver). The application Toplevel can be accessed via Top. Additional Toplevels can be created and run (e.g. Dialogs. To run a Toplevel, create the Toplevel and call Run(Toplevel, Func<Exception, bool>). Toplevels can also opt-in to more sophisticated initialization by implementing ISupportInitialize. When they do so, the BeginInit() and EndInit() methods will be called before running the view. If first-run-only initialization is preferred, the ISupportInitializeNotification can be implemented too, in which case the ISupportInitialize methods will only be called if IsInitialized is false. This allows proper View inheritance hierarchies to override base class layout code optimally by doing so only on first run, instead of on every run. Constructors | Edit this page View Source Toplevel() Initializes a new instance of the Toplevel class with Computed layout, defaulting to full screen. Declaration public Toplevel() | Edit this page View Source Toplevel(Rect) Initializes a new instance of the Toplevel class with the specified Absolute layout. Declaration public Toplevel(Rect frame) Parameters Type Name Description Rect frame A superview-relative rectangle specifying the location and size for the new Toplevel Properties | Edit this page View Source CanFocus Gets or sets a value indicating whether this Toplevel can focus. Declaration public override bool CanFocus { get; } Property Value Type Description bool true if can focus; otherwise, false. Overrides View.CanFocus | Edit this page View Source IsMdiChild Gets or sets if this Toplevel is a Mdi child. Declaration public bool IsMdiChild { get; } Property Value Type Description bool | Edit this page View Source IsMdiContainer Gets or sets if this Toplevel is a Mdi container. Declaration public bool IsMdiContainer { get; set; } Property Value Type Description bool | Edit this page View Source MenuBar Gets or sets the menu for this Toplevel. Declaration public virtual MenuBar MenuBar { get; set; } Property Value Type Description MenuBar | Edit this page View Source Modal Determines whether the Toplevel is modal or not. If set to false (the default): ProcessKey(KeyEvent) events will propagate keys upwards. The Toplevel will act as an embedded view (not a modal/pop-up). If set to true: ProcessKey(KeyEvent) events will NOT propogate keys upwards. The Toplevel will and look like a modal (pop-up) (e.g. see Dialog. Declaration public bool Modal { get; set; } Property Value Type Description bool | Edit this page View Source Running Gets or sets whether the MainLoop for this Toplevel is running or not. Declaration public bool Running { get; set; } Property Value Type Description bool Remarks Setting this property directly is discouraged. Use RequestStop(Toplevel) instead. | Edit this page View Source StatusBar Gets or sets the status bar for this Toplevel. Declaration public virtual StatusBar StatusBar { get; set; } Property Value Type Description StatusBar Methods | Edit this page View Source Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides View.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View)RemoveAll() | Edit this page View Source Create() Convenience factory method that creates a new Toplevel with the current terminal dimensions. Declaration public static Toplevel Create() Returns Type Description Toplevel The created Toplevel. | Edit this page View Source Dispose(bool) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description bool disposing Overrides View.Dispose(bool) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. | Edit this page View Source GetTopMdiChild(Type, string[]) Gets the current visible Toplevel Mdi child that matches the arguments pattern. Declaration public View GetTopMdiChild(Type type = null, string[] exclude = null) Parameters Type Name Description Type type The type. string[] exclude The strings to exclude. Returns Type Description View The matched view. | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source MoveNext() Move to the next Mdi child from the MdiTop. Declaration public virtual void MoveNext() | Edit this page View Source MovePrevious() Move to the previous Mdi child from the MdiTop. Declaration public virtual void MovePrevious() | Edit this page View Source OnAlternateBackwardKeyChanged(Key) Virtual method to invoke the AlternateBackwardKeyChanged event. Declaration public virtual void OnAlternateBackwardKeyChanged(Key oldKey) Parameters Type Name Description Key oldKey | Edit this page View Source OnAlternateForwardKeyChanged(Key) Virtual method to invoke the AlternateForwardKeyChanged event. Declaration public virtual void OnAlternateForwardKeyChanged(Key oldKey) Parameters Type Name Description Key oldKey | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnKeyDown(KeyEvent) Method invoked when a key is pressed. Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled Overrides View.OnKeyDown(KeyEvent) | Edit this page View Source OnKeyUp(KeyEvent) Method invoked when a key is released. Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled Overrides View.OnKeyUp(KeyEvent) | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnLeave(View) | Edit this page View Source OnLoaded() Called from Begin(Toplevel) before the Toplevel redraws for the first time. Declaration public virtual void OnLoaded() | Edit this page View Source OnQuitKeyChanged(Key) Virtual method to invoke the QuitKeyChanged event. Declaration public virtual void OnQuitKeyChanged(Key oldKey) Parameters Type Name Description Key oldKey | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source PositionToplevel(Toplevel) Virtual method enabling implementation of specific positions for inherited Toplevel views. Declaration public virtual void PositionToplevel(Toplevel top) Parameters Type Name Description Toplevel top The toplevel. | Edit this page View Source ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description bool Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Remove(View) Removes a subview added via Add(View) or Add(params View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) | Edit this page View Source RemoveAll() Removes all subviews (children) added via Add(View) or Add(params View[]) from this View. Declaration public override void RemoveAll() Overrides View.RemoveAll() | Edit this page View Source RequestStop() Stops and closes this Toplevel. If this Toplevel is the top-most Toplevel, RequestStop(Toplevel) will be called, causing the application to exit. Declaration public virtual void RequestStop() | Edit this page View Source RequestStop(Toplevel) Stops and closes the Toplevel specified by top. If top is the top-most Toplevel, RequestStop(Toplevel) will be called, causing the application to exit. Declaration public virtual void RequestStop(Toplevel top) Parameters Type Name Description Toplevel top The toplevel to request stop. | Edit this page View Source ShowChild(Toplevel) Shows the Mdi child indicated by top, setting it as Current. Declaration public virtual bool ShowChild(Toplevel top = null) Parameters Type Name Description Toplevel top The Toplevel. Returns Type Description bool true if the toplevel can be shown or false if not. | Edit this page View Source WillPresent() Invoked by Begin(Toplevel) as part of Run(Toplevel, Func<Exception, bool>) after the views have been laid out, and before the views are drawn for the first time. Declaration public virtual void WillPresent() Events | Edit this page View Source Activate Invoked when the Toplevel Application.RunState becomes the Current Toplevel. Declaration public event Action<Toplevel> Activate Event Type Type Description Action<Toplevel> | Edit this page View Source AllChildClosed Invoked when the last child of the Toplevel Application.RunState is closed from by End(RunState). Declaration public event Action AllChildClosed Event Type Type Description Action | Edit this page View Source AlternateBackwardKeyChanged Invoked when the AlternateBackwardKey is changed. Declaration public event Action<Key> AlternateBackwardKeyChanged Event Type Type Description Action<Key> | Edit this page View Source AlternateForwardKeyChanged Invoked when the AlternateForwardKey is changed. Declaration public event Action<Key> AlternateForwardKeyChanged Event Type Type Description Action<Key> | Edit this page View Source ChildClosed Invoked when a child of the Toplevel Application.RunState is closed by End(RunState). Declaration public event Action<Toplevel> ChildClosed Event Type Type Description Action<Toplevel> | Edit this page View Source ChildLoaded Invoked when a child Toplevel's Application.RunState has been loaded. Declaration public event Action<Toplevel> ChildLoaded Event Type Type Description Action<Toplevel> | Edit this page View Source ChildUnloaded Invoked when a cjhild Toplevel's Application.RunState has been unloaded. Declaration public event Action<Toplevel> ChildUnloaded Event Type Type Description Action<Toplevel> | Edit this page View Source Closed Invoked when the Toplevel's Application.RunState is closed by End(RunState). Declaration public event Action<Toplevel> Closed Event Type Type Description Action<Toplevel> | Edit this page View Source Closing Invoked when the Toplevel's Application.RunState is being closed by RequestStop(Toplevel). Declaration public event Action<ToplevelClosingEventArgs> Closing Event Type Type Description Action<ToplevelClosingEventArgs> | Edit this page View Source Deactivate Invoked when the ToplevelApplication.RunState ceases to be the Current Toplevel. Declaration public event Action<Toplevel> Deactivate Event Type Type Description Action<Toplevel> | Edit this page View Source Loaded Invoked when the Toplevel Application.RunState has begun to be loaded. A Loaded event handler is a good place to finalize initialization before calling RunLoop(RunState, bool). Declaration public event Action Loaded Event Type Type Description Action | Edit this page View Source QuitKeyChanged Invoked when the QuitKey is changed. Declaration public event Action<Key> QuitKeyChanged Event Type Type Description Action<Key> | Edit this page View Source Ready Invoked when the Toplevel MainLoop has started it's first iteration. Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. changes. A Ready event handler is a good place to finalize initialization after calling Run(Func<Exception, bool>) on this Toplevel. Declaration public event Action Ready Event Type Type Description Action | Edit this page View Source Resized Invoked when the terminal has been resized. The new Size of the terminal is provided. Declaration public event Action<Size> Resized Event Type Type Description Action<Size> | Edit this page View Source Unloaded Invoked when the Toplevel Application.RunState has been unloaded. A Unloaded event handler is a good place to dispose objects after calling End(RunState). Declaration public event Action Unloaded Event Type Type Description Action Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.ToplevelClosingEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ToplevelClosingEventArgs.html",
    "title": "Class ToplevelClosingEventArgs",
    "keywords": "Class ToplevelClosingEventArgs EventArgs implementation for the Closing event. Inheritance object EventArgs ToplevelClosingEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ToplevelClosingEventArgs : EventArgs Constructors | Edit this page View Source ToplevelClosingEventArgs(Toplevel) Initializes the event arguments with the requesting toplevel. Declaration public ToplevelClosingEventArgs(Toplevel requestingTop) Parameters Type Name Description Toplevel requestingTop The RequestingTop. Properties | Edit this page View Source Cancel Provides an event cancellation option. Declaration public bool Cancel { get; set; } Property Value Type Description bool | Edit this page View Source RequestingTop The toplevel requesting stop. Declaration public View RequestingTop { get; } Property Value Type Description View"
  },
  "api/Terminal.Gui/Terminal.Gui.ToplevelComparer.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ToplevelComparer.html",
    "title": "Class ToplevelComparer",
    "keywords": "Class ToplevelComparer Implements the IComparer<T> to sort the Toplevel from the MdiChildes if needed. Inheritance object ToplevelComparer Implements IComparer<Toplevel> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public sealed class ToplevelComparer : IComparer<Toplevel> Methods | Edit this page View Source Compare(Toplevel, Toplevel) Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. Declaration public int Compare(Toplevel x, Toplevel y) Parameters Type Name Description Toplevel x The first object to compare. Toplevel y The second object to compare. Returns Type Description int A signed integer that indicates the relative values of x and y, as shown in the following table.Value Meaning Less than zero x is less than y.Zero x equals y.Greater than zero x is greater than y. Implements IComparer<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.ToplevelEqualityComparer.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.ToplevelEqualityComparer.html",
    "title": "Class ToplevelEqualityComparer",
    "keywords": "Class ToplevelEqualityComparer Implements the IEqualityComparer<T> for comparing two Toplevels used by StackExtensions. Inheritance object ToplevelEqualityComparer Implements IEqualityComparer<Toplevel> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class ToplevelEqualityComparer : IEqualityComparer<Toplevel> Methods | Edit this page View Source Equals(Toplevel, Toplevel) Determines whether the specified objects are equal. Declaration public bool Equals(Toplevel x, Toplevel y) Parameters Type Name Description Toplevel x The first object of type Toplevel to compare. Toplevel y The second object of type Toplevel to compare. Returns Type Description bool true if the specified objects are equal; otherwise, false. | Edit this page View Source GetHashCode(Toplevel) Returns a hash code for the specified object. Declaration public int GetHashCode(Toplevel obj) Parameters Type Name Description Toplevel obj The Toplevel for which a hash code is to be returned. Returns Type Description int A hash code for the specified object. Exceptions Type Condition ArgumentNullException The type of obj is a reference type and obj is null. Implements IEqualityComparer<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.TreeView-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TreeView-1.html",
    "title": "Class TreeView<T>",
    "keywords": "Class TreeView<T> Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder<T>. See TreeView Deep Dive for more information. Inheritance object Responder View TreeView<T> TreeView Implements IDisposable ISupportInitializeNotification ISupportInitialize ITreeView Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TreeView<T> : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, ITreeView where T : class Type Parameters Name Description T Constructors | Edit this page View Source TreeView() Creates a new tree view with absolute positioning. Use AddObjects(IEnumerable<T>) to set set root objects for the tree. Children will not be rendered until you set TreeBuilder. Declaration public TreeView() | Edit this page View Source TreeView(ITreeBuilder<T>) Initialises TreeBuilder.Creates a new tree view with absolute positioning. Use AddObjects(IEnumerable<T>) to set set root objects for the tree. Declaration public TreeView(ITreeBuilder<T> builder) Parameters Type Name Description ITreeBuilder<T> builder Fields | Edit this page View Source Filter Interface for filtering which lines of the tree are displayed e.g. to provide text searching. Defaults to null (no filtering). Declaration public ITreeViewFilter<T> Filter Field Value Type Description ITreeViewFilter<T> | Edit this page View Source NoBuilderError Error message to display when the control is not properly initialized at draw time (nodes added but no tree builder set). Declaration public static ustring NoBuilderError Field Value Type Description ustring Properties | Edit this page View Source AllowLetterBasedNavigation True makes a letter key press navigate to the next visible branch that begins with that letter/digit. Declaration public bool AllowLetterBasedNavigation { get; set; } Property Value Type Description bool | Edit this page View Source AspectGetter Returns the string representation of model objects hosted in the tree. Default implementation is to call ToString(). Declaration public AspectGetterDelegate<T> AspectGetter { get; set; } Property Value Type Description AspectGetterDelegate<T> | Edit this page View Source ColorGetter Delegate for multi colored tree views. Return the ColorScheme to use for each passed object or null to use the default. Declaration public Func<T, ColorScheme> ColorGetter { get; set; } Property Value Type Description Func<T, ColorScheme> | Edit this page View Source ContentHeight The current number of rows in the tree (ignoring the controls bounds). Declaration public int ContentHeight { get; } Property Value Type Description int | Edit this page View Source DesiredCursorVisibility Get / Set the wished cursor when the tree is focused. Only applies when MultiSelect is true. Defaults to Invisible. Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility | Edit this page View Source KeystrokeNavigator Gets the CollectionNavigator that searches the Objects collection as the user types. Declaration public CollectionNavigator KeystrokeNavigator { get; } Property Value Type Description CollectionNavigator | Edit this page View Source MaxDepth Maximum number of nodes that can be expanded in any given branch. Declaration public int MaxDepth { get; set; } Property Value Type Description int | Edit this page View Source MultiSelect True to allow multiple objects to be selected at once. Declaration public bool MultiSelect { get; set; } Property Value Type Description bool | Edit this page View Source ObjectActivationButton Mouse event to trigger ObjectActivated. Defaults to double click (Button1DoubleClicked). Set to null to disable this feature. Declaration public MouseFlags? ObjectActivationButton { get; set; } Property Value Type Description MouseFlags? | Edit this page View Source ObjectActivationKey Key which when pressed triggers ObjectActivated. Defaults to Enter. Declaration public Key ObjectActivationKey { get; set; } Property Value Type Description Key | Edit this page View Source Objects The root objects in the tree, note that this collection is of root objects only. Declaration public IEnumerable<T> Objects { get; } Property Value Type Description IEnumerable<T> | Edit this page View Source ScrollOffsetHorizontal The amount of tree view that has been scrolled to the right (horizontally). Declaration public int ScrollOffsetHorizontal { get; set; } Property Value Type Description int Remarks Setting a value of less than 0 will result in a offset of 0. To see changes in the UI call SetNeedsDisplay(). | Edit this page View Source ScrollOffsetVertical The amount of tree view that has been scrolled off the top of the screen (by the user scrolling down). Declaration public int ScrollOffsetVertical { get; set; } Property Value Type Description int Remarks Setting a value of less than 0 will result in a offset of 0. To see changes in the UI call SetNeedsDisplay(). | Edit this page View Source SelectedObject The currently selected object in the tree. When MultiSelect is true this is the object at which the cursor is at. Declaration public T SelectedObject { get; set; } Property Value Type Description T | Edit this page View Source Style Contains options for changing how the tree is rendered. Declaration public TreeStyle Style { get; set; } Property Value Type Description TreeStyle | Edit this page View Source TreeBuilder Determines how sub branches of the tree are dynamically built at runtime as the user expands root nodes. Declaration public ITreeBuilder<T> TreeBuilder { get; set; } Property Value Type Description ITreeBuilder<T> Methods | Edit this page View Source ActivateSelectedObjectIfAny() Triggers the ObjectActivated event with the SelectedObject. This method also ensures that the selected object is visible. Declaration public void ActivateSelectedObjectIfAny() | Edit this page View Source AddObject(T) Adds a new root level object unless it is already a root of the tree. Declaration public void AddObject(T o) Parameters Type Name Description T o | Edit this page View Source AddObjects(IEnumerable<T>) Adds many new root level objects. Objects that are already root objects are ignored. Declaration public void AddObjects(IEnumerable<T> collection) Parameters Type Name Description IEnumerable<T> collection Objects to add as new root level objects. | Edit this page View Source AdjustSelection(int, bool) The number of screen lines to move the currently selected object by. Supports negative values. offset. Each branch occupies 1 line on screen. Declaration public void AdjustSelection(int offset, bool expandSelection = false) Parameters Type Name Description int offset Positive to move the selection down the screen, negative to move it up bool expandSelection True to expand the selection (assuming MultiSelect is enabled). False to replace. Remarks If nothing is currently selected or the selected object is no longer in the tree then the first object in the tree is selected instead. | Edit this page View Source AdjustSelectionToBranchEnd() Moves the selection to the last child in the currently selected level. Declaration public void AdjustSelectionToBranchEnd() | Edit this page View Source AdjustSelectionToBranchStart() Moves the selection to the first child in the currently selected level. Declaration public void AdjustSelectionToBranchStart() | Edit this page View Source AdjustSelectionToNextItemBeginningWith(char, StringComparison) Moves the SelectedObject to the next item that begins with character. This method will loop back to the start of the tree if reaching the end without finding a match. Declaration public void AdjustSelectionToNextItemBeginningWith(char character, StringComparison caseSensitivity = StringComparison.CurrentCultureIgnoreCase) Parameters Type Name Description char character The first character of the next item you want selected. StringComparison caseSensitivity Case sensitivity of the search. | Edit this page View Source CanExpand(T) Returns true if the given object o is exposed in the tree and can be expanded otherwise false. Declaration public bool CanExpand(T o) Parameters Type Name Description T o Returns Type Description bool | Edit this page View Source ClearObjects() Removes all objects from the tree and clears SelectedObject. Declaration public void ClearObjects() | Edit this page View Source Collapse() Collapses the SelectedObject Declaration public void Collapse() | Edit this page View Source Collapse(T) Collapses the supplied object if it is currently expanded . Declaration public void Collapse(T toCollapse) Parameters Type Name Description T toCollapse The object to collapse. | Edit this page View Source CollapseAll() Collapses all root nodes in the tree. Declaration public void CollapseAll() | Edit this page View Source CollapseAll(T) Collapses the supplied object if it is currently expanded. Also collapses all children branches (this will only become apparent when/if the user expands it again). Declaration public void CollapseAll(T toCollapse) Parameters Type Name Description T toCollapse The object to collapse. | Edit this page View Source CollapseImpl(T, bool) Implementation of Collapse(T) and CollapseAll(T). Performs operation and updates selection if disapeared. Declaration protected void CollapseImpl(T toCollapse, bool all) Parameters Type Name Description T toCollapse bool all | Edit this page View Source CursorLeft(bool) Determines systems behaviour when the left arrow key is pressed. Default behaviour is to collapse the current tree node if possible otherwise changes selection to current branches parent. Declaration protected virtual void CursorLeft(bool ctrl) Parameters Type Name Description bool ctrl | Edit this page View Source EnsureVisible(T) Adjusts the ScrollOffsetVertical to ensure the given model is visible. Has no effect if already visible. Declaration public void EnsureVisible(T model) Parameters Type Name Description T model | Edit this page View Source Expand() Expands the currently SelectedObject. Declaration public void Expand() | Edit this page View Source Expand(T) Expands the supplied object if it is contained in the tree (either as a root object or as an exposed branch object). Declaration public void Expand(T toExpand) Parameters Type Name Description T toExpand The object to expand. | Edit this page View Source ExpandAll() Fully expands all nodes in the tree, if the tree is very big and built dynamically this may take a while (e.g. for file system). Declaration public void ExpandAll() | Edit this page View Source ExpandAll(T) Expands the supplied object and all child objects. Declaration public void ExpandAll(T toExpand) Parameters Type Name Description T toExpand The object to expand. | Edit this page View Source GetAllSelectedObjects() Returns SelectedObject (if not null) and all multi selected objects if MultiSelect is true Declaration public IEnumerable<T> GetAllSelectedObjects() Returns Type Description IEnumerable<T> | Edit this page View Source GetChildren(T) Returns the currently expanded children of the passed object. Returns an empty collection if the branch is not exposed or not expanded. Declaration public IEnumerable<T> GetChildren(T o) Parameters Type Name Description T o An object in the tree. Returns Type Description IEnumerable<T> | Edit this page View Source GetContentWidth(bool) Returns the maximum width line in the tree including prefix and expansion symbols. Declaration public int GetContentWidth(bool visible) Parameters Type Name Description bool visible True to consider only rows currently visible (based on window bounds and ScrollOffsetVertical. False to calculate the width of every exposed branch in the tree. Returns Type Description int | Edit this page View Source GetObjectOnRow(int) Returns the object in the tree list that is currently visible. at the provided row. Returns null if no object is at that location. If you have screen coordinates then use ScreenToView(int, int) to translate these into the client area of the TreeView<T>. Declaration public T GetObjectOnRow(int row) Parameters Type Name Description int row The row of the Bounds of the TreeView<T>. Returns Type Description T The object currently displayed on this row or null. | Edit this page View Source GetObjectRow(T) Returns the Y coordinate within the Bounds of the tree at which toFind would be displayed or null if it is not currently exposed (e.g. its parent is collapsed). Note that the returned value can be negative if the TreeView is scrolled down and the toFind object is off the top of the view. Declaration public int? GetObjectRow(T toFind) Parameters Type Name Description T toFind Returns Type Description int? | Edit this page View Source GetParent(T) Returns the parent object of o in the tree. Returns null if the object is not exposed in the tree. Declaration public T GetParent(T o) Parameters Type Name Description T o An object in the tree. Returns Type Description T | Edit this page View Source GetScrollOffsetOf(T) Returns the index of the object o if it is currently exposed (it's parent(s) have been expanded). This can be used with ScrollOffsetVertical and SetNeedsDisplay() to scroll to a specific object. Declaration public int GetScrollOffsetOf(T o) Parameters Type Name Description T o An object that appears in your tree and is currently exposed. Returns Type Description int The index the object was found at or -1 if it is not currently revealed or not in the tree at all. Remarks Uses the Equals method and returns the first index at which the object is found or -1 if it is not found. | Edit this page View Source GoTo(T) Changes the SelectedObject to toSelect and scrolls to ensure it is visible. Has no effect if toSelect is not exposed in the tree (e.g. its parents are collapsed). Declaration public void GoTo(T toSelect) Parameters Type Name Description T toSelect | Edit this page View Source GoToEnd() Changes the SelectedObject to the last object in the tree and scrolls so that it is visible. Declaration public void GoToEnd() | Edit this page View Source GoToFirst() Changes the SelectedObject to the first root object and resets the ScrollOffsetVertical to 0. Declaration public void GoToFirst() | Edit this page View Source InvalidateLineMap() Clears any cached results of the tree state. Declaration public void InvalidateLineMap() | Edit this page View Source IsExpanded(T) Returns true if the given object o is exposed in the tree and expanded otherwise false. Declaration public bool IsExpanded(T o) Parameters Type Name Description T o Returns Type Description bool | Edit this page View Source IsSelected(T) Returns true if the model is either the SelectedObject or part of a MultiSelect. Declaration public bool IsSelected(T model) Parameters Type Name Description T model Returns Type Description bool | Edit this page View Source MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) | Edit this page View Source MovePageDown(bool) Moves the selection down by the height of the control (1 page). Declaration public void MovePageDown(bool expandSelection = false) Parameters Type Name Description bool expandSelection True if the navigation should add the covered nodes to the selected current selection. Exceptions Type Condition NotImplementedException | Edit this page View Source MovePageUp(bool) Moves the selection up by the height of the control (1 page). Declaration public void MovePageUp(bool expandSelection = false) Parameters Type Name Description bool expandSelection True if the navigation should add the covered nodes to the selected current selection. Exceptions Type Condition NotImplementedException | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnEnter(View) | Edit this page View Source OnObjectActivated(ObjectActivatedEventArgs<T>) Raises the ObjectActivated event. Declaration protected virtual void OnObjectActivated(ObjectActivatedEventArgs<T> e) Parameters Type Name Description ObjectActivatedEventArgs<T> e | Edit this page View Source OnSelectionChanged(SelectionChangedEventArgs<T>) Raises the SelectionChanged event. Declaration protected virtual void OnSelectionChanged(SelectionChangedEventArgs<T> e) Parameters Type Name Description SelectionChangedEventArgs<T> e | Edit this page View Source PositionCursor() Positions the cursor at the start of the selected objects line (if visible). Declaration public override void PositionCursor() Overrides View.PositionCursor() | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source RebuildTree() Rebuilds the tree structure for all exposed objects starting with the root objects. Call this method when you know there are changes to the tree but don't know which objects have changed (otherwise use RefreshObject(T, bool)). Declaration public void RebuildTree() | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source RefreshObject(T, bool) Refreshes the state of the object o in the tree. This will recompute children, string representation etc. Declaration public void RefreshObject(T o, bool startAtTop = false) Parameters Type Name Description T o bool startAtTop True to also refresh all ancestors of the objects branch (starting with the root). False to refresh only the passed node. Remarks This has no effect if the object is not exposed in the tree. | Edit this page View Source Remove(T) Removes the given root object from the tree Declaration public void Remove(T o) Parameters Type Name Description T o Remarks If o is the currently SelectedObject then the selection is cleared | Edit this page View Source ScrollDown() Scrolls the view area down a single line without changing the current selection. Declaration public void ScrollDown() | Edit this page View Source ScrollUp() Scrolls the view area up a single line without changing the current selection. Declaration public void ScrollUp() | Edit this page View Source SelectAll() Selects all objects in the tree when MultiSelect is enabled otherwise does nothing. Declaration public void SelectAll() Events | Edit this page View Source ObjectActivated This event is raised when an object is activated e.g. by double clicking or pressing ObjectActivationKey. Declaration public event Action<ObjectActivatedEventArgs<T>> ObjectActivated Event Type Type Description Action<ObjectActivatedEventArgs<T>> | Edit this page View Source SelectionChanged Called when the SelectedObject changes. Declaration public event EventHandler<SelectionChangedEventArgs<T>> SelectionChanged Event Type Type Description EventHandler<SelectionChangedEventArgs<T>> Implements IDisposable ISupportInitializeNotification ISupportInitialize ITreeView"
  },
  "api/Terminal.Gui/Terminal.Gui.TreeView.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TreeView.html",
    "title": "Class TreeView",
    "keywords": "Class TreeView Convenience implementation of generic TreeView<T> for any tree were all nodes implement ITreeNode. See TreeView Deep Dive for more information. Inheritance object Responder View TreeView<ITreeNode> TreeView Implements IDisposable ISupportInitializeNotification ISupportInitialize ITreeView Inherited Members TreeView<ITreeNode>.TreeBuilder TreeView<ITreeNode>.Style TreeView<ITreeNode>.MultiSelect TreeView<ITreeNode>.MaxDepth TreeView<ITreeNode>.AllowLetterBasedNavigation TreeView<ITreeNode>.SelectedObject TreeView<ITreeNode>.ObjectActivated TreeView<ITreeNode>.ObjectActivationKey TreeView<ITreeNode>.ObjectActivationButton TreeView<ITreeNode>.ColorGetter TreeView<ITreeNode>.NoBuilderError TreeView<ITreeNode>.SelectionChanged TreeView<ITreeNode>.Objects TreeView<ITreeNode>.ScrollOffsetVertical TreeView<ITreeNode>.ScrollOffsetHorizontal TreeView<ITreeNode>.ContentHeight TreeView<ITreeNode>.AspectGetter TreeView<ITreeNode>.Filter TreeView<ITreeNode>.DesiredCursorVisibility TreeView<ITreeNode>.OnEnter(View) TreeView<ITreeNode>.AddObject(ITreeNode) TreeView<ITreeNode>.ClearObjects() TreeView<ITreeNode>.Remove(ITreeNode) TreeView<ITreeNode>.AddObjects(IEnumerable<ITreeNode>) TreeView<ITreeNode>.RefreshObject(ITreeNode, bool) TreeView<ITreeNode>.RebuildTree() TreeView<ITreeNode>.GetChildren(ITreeNode) TreeView<ITreeNode>.GetParent(ITreeNode) TreeView<ITreeNode>.Redraw(Rect) TreeView<ITreeNode>.GetScrollOffsetOf(ITreeNode) TreeView<ITreeNode>.GetContentWidth(bool) TreeView<ITreeNode>.KeystrokeNavigator TreeView<ITreeNode>.ProcessKey(KeyEvent) TreeView<ITreeNode>.ActivateSelectedObjectIfAny() TreeView<ITreeNode>.GetObjectRow(ITreeNode) TreeView<ITreeNode>.AdjustSelectionToNextItemBeginningWith(char, StringComparison) TreeView<ITreeNode>.MovePageUp(bool) TreeView<ITreeNode>.MovePageDown(bool) TreeView<ITreeNode>.ScrollDown() TreeView<ITreeNode>.ScrollUp() TreeView<ITreeNode>.OnObjectActivated(ObjectActivatedEventArgs<ITreeNode>) TreeView<ITreeNode>.GetObjectOnRow(int) TreeView<ITreeNode>.MouseEvent(MouseEvent) TreeView<ITreeNode>.PositionCursor() TreeView<ITreeNode>.CursorLeft(bool) TreeView<ITreeNode>.GoToFirst() TreeView<ITreeNode>.GoToEnd() TreeView<ITreeNode>.GoTo(ITreeNode) TreeView<ITreeNode>.AdjustSelection(int, bool) TreeView<ITreeNode>.AdjustSelectionToBranchStart() TreeView<ITreeNode>.AdjustSelectionToBranchEnd() TreeView<ITreeNode>.EnsureVisible(ITreeNode) TreeView<ITreeNode>.Expand() TreeView<ITreeNode>.Expand(ITreeNode) TreeView<ITreeNode>.ExpandAll(ITreeNode) TreeView<ITreeNode>.ExpandAll() TreeView<ITreeNode>.CanExpand(ITreeNode) TreeView<ITreeNode>.IsExpanded(ITreeNode) TreeView<ITreeNode>.Collapse() TreeView<ITreeNode>.Collapse(ITreeNode) TreeView<ITreeNode>.CollapseAll(ITreeNode) TreeView<ITreeNode>.CollapseAll() TreeView<ITreeNode>.CollapseImpl(ITreeNode, bool) TreeView<ITreeNode>.InvalidateLineMap() TreeView<ITreeNode>.IsSelected(ITreeNode) TreeView<ITreeNode>.GetAllSelectedObjects() TreeView<ITreeNode>.SelectAll() TreeView<ITreeNode>.OnSelectionChanged(SelectionChangedEventArgs<ITreeNode>) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TreeView : TreeView<ITreeNode>, IDisposable, ISupportInitializeNotification, ISupportInitialize, ITreeView Constructors | Edit this page View Source TreeView() Creates a new instance of the tree control with absolute positioning and initialises TreeBuilder<T> with default ITreeNode based builder. Declaration public TreeView() Implements IDisposable ISupportInitializeNotification ISupportInitialize ITreeView"
  },
  "api/Terminal.Gui/Terminal.Gui.TreeViewTextFilter-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TreeViewTextFilter-1.html",
    "title": "Class TreeViewTextFilter<T>",
    "keywords": "Class TreeViewTextFilter<T> ITreeViewFilter<T> implementation which searches the AspectGetter of the model for the given Text. Inheritance object TreeViewTextFilter<T> Implements ITreeViewFilter<T> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TreeViewTextFilter<T> : ITreeViewFilter<T> where T : class Type Parameters Name Description T Constructors | Edit this page View Source TreeViewTextFilter(TreeView<T>) Creates a new instance of the filter for use with forTree. Set Text to begin filtering. Declaration public TreeViewTextFilter(TreeView<T> forTree) Parameters Type Name Description TreeView<T> forTree Exceptions Type Condition ArgumentNullException Properties | Edit this page View Source Comparer The case sensitivity of the search match. Defaults to OrdinalIgnoreCase. Declaration public StringComparison Comparer { get; set; } Property Value Type Description StringComparison | Edit this page View Source Text The text that will be searched for in the TreeView<T> Declaration public string Text { get; set; } Property Value Type Description string Methods | Edit this page View Source IsMatch(T) Returns T if there is no Text or the text matches the AspectGetter of the model. Declaration public bool IsMatch(T model) Parameters Type Name Description T model Returns Type Description bool Implements ITreeViewFilter<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.AspectGetterDelegate-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.AspectGetterDelegate-1.html",
    "title": "Delegate AspectGetterDelegate<T>",
    "keywords": "Delegate AspectGetterDelegate<T> Delegates of this type are used to fetch string representations of user's model objects Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public delegate string AspectGetterDelegate<T>(T toRender) where T : class Parameters Type Name Description T toRender The object that is being rendered Returns Type Description string Type Parameters Name Description T"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.DelegateTreeBuilder-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.DelegateTreeBuilder-1.html",
    "title": "Class DelegateTreeBuilder<T>",
    "keywords": "Class DelegateTreeBuilder<T> Implementation of ITreeBuilder<T> that uses user defined functions Inheritance object TreeBuilder<T> DelegateTreeBuilder<T> Implements ITreeBuilder<T> Inherited Members TreeBuilder<T>.SupportsCanExpand object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public class DelegateTreeBuilder<T> : TreeBuilder<T>, ITreeBuilder<T> Type Parameters Name Description T Constructors | Edit this page View Source DelegateTreeBuilder(Func<T, IEnumerable<T>>) Constructs an implementation of ITreeBuilder<T> that calls the user defined method childGetter to determine children Declaration public DelegateTreeBuilder(Func<T, IEnumerable<T>> childGetter) Parameters Type Name Description Func<T, IEnumerable<T>> childGetter | Edit this page View Source DelegateTreeBuilder(Func<T, IEnumerable<T>>, Func<T, bool>) Constructs an implementation of ITreeBuilder<T> that calls the user defined method childGetter to determine children and canExpand to determine expandability Declaration public DelegateTreeBuilder(Func<T, IEnumerable<T>> childGetter, Func<T, bool> canExpand) Parameters Type Name Description Func<T, IEnumerable<T>> childGetter Func<T, bool> canExpand Methods | Edit this page View Source CanExpand(T) Returns whether a node can be expanded based on the delegate passed during construction Declaration public override bool CanExpand(T toExpand) Parameters Type Name Description T toExpand Returns Type Description bool Overrides TreeBuilder<T>.CanExpand(T) | Edit this page View Source GetChildren(T) Returns children using the delegate method passed during construction Declaration public override IEnumerable<T> GetChildren(T forObject) Parameters Type Name Description T forObject Returns Type Description IEnumerable<T> Overrides TreeBuilder<T>.GetChildren(T) Implements ITreeBuilder<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.ITreeBuilder-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.ITreeBuilder-1.html",
    "title": "Interface ITreeBuilder<T>",
    "keywords": "Interface ITreeBuilder<T> Interface for supplying data to a TreeView<T> on demand as root level nodes are expanded by the user Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public interface ITreeBuilder<T> Type Parameters Name Description T Properties | Edit this page View Source SupportsCanExpand Returns true if CanExpand(T) is implemented by this class Declaration bool SupportsCanExpand { get; } Property Value Type Description bool Methods | Edit this page View Source CanExpand(T) Returns true/false for whether a model has children. This method should be implemented when GetChildren(T) is an expensive operation otherwise SupportsCanExpand should return false (in which case this method will not be called) Declaration bool CanExpand(T toExpand) Parameters Type Name Description T toExpand Returns Type Description bool Remarks Only implement this method if you have a very fast way of determining whether an object can have children e.g. checking a Type (directories can always be expanded) | Edit this page View Source GetChildren(T) Returns all children of a given forObject which should be added to the tree as new branches underneath it Declaration IEnumerable<T> GetChildren(T forObject) Parameters Type Name Description T forObject Returns Type Description IEnumerable<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.ITreeNode.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.ITreeNode.html",
    "title": "Interface ITreeNode",
    "keywords": "Interface ITreeNode Interface to implement when you want the regular (non generic) TreeView to automatically determine children for your class (without having to specify an ITreeBuilder<T>) Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public interface ITreeNode Properties | Edit this page View Source Children The children of your class which should be rendered underneath it when expanded Declaration IList<ITreeNode> Children { get; } Property Value Type Description IList<ITreeNode> | Edit this page View Source Tag Optionally allows you to store some custom data/class here. Declaration object Tag { get; set; } Property Value Type Description object | Edit this page View Source Text Text to display when rendering the node Declaration string Text { get; set; } Property Value Type Description string"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.ObjectActivatedEventArgs-1.html",
    "title": "Class ObjectActivatedEventArgs<T>",
    "keywords": "Class ObjectActivatedEventArgs<T> Event args for the ObjectActivated event Inheritance object ObjectActivatedEventArgs<T> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public class ObjectActivatedEventArgs<T> where T : class Type Parameters Name Description T Constructors | Edit this page View Source ObjectActivatedEventArgs(TreeView<T>, T) Creates a new instance documenting activation of the activated object Declaration public ObjectActivatedEventArgs(TreeView<T> tree, T activated) Parameters Type Name Description TreeView<T> tree Tree in which the activation is happening T activated What object is being activated Properties | Edit this page View Source ActivatedObject The object that was selected at the time of activation Declaration public T ActivatedObject { get; } Property Value Type Description T | Edit this page View Source Tree The tree in which the activation occurred Declaration public TreeView<T> Tree { get; } Property Value Type Description TreeView<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.SelectionChangedEventArgs-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.SelectionChangedEventArgs-1.html",
    "title": "Class SelectionChangedEventArgs<T>",
    "keywords": "Class SelectionChangedEventArgs<T> Event arguments describing a change in selected object in a tree view Inheritance object EventArgs SelectionChangedEventArgs<T> Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public class SelectionChangedEventArgs<T> : EventArgs where T : class Type Parameters Name Description T Constructors | Edit this page View Source SelectionChangedEventArgs(TreeView<T>, T, T) Creates a new instance of event args describing a change of selection in tree Declaration public SelectionChangedEventArgs(TreeView<T> tree, T oldValue, T newValue) Parameters Type Name Description TreeView<T> tree T oldValue T newValue Properties | Edit this page View Source NewValue The newly selected value in the Tree (can be null) Declaration public T NewValue { get; } Property Value Type Description T | Edit this page View Source OldValue The previously selected value (can be null) Declaration public T OldValue { get; } Property Value Type Description T | Edit this page View Source Tree The view in which the change occurred Declaration public TreeView<T> Tree { get; } Property Value Type Description TreeView<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.TreeBuilder-1.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.TreeBuilder-1.html",
    "title": "Class TreeBuilder<T>",
    "keywords": "Class TreeBuilder<T> Abstract implementation of ITreeBuilder<T>. Inheritance object TreeBuilder<T> DelegateTreeBuilder<T> TreeNodeBuilder Implements ITreeBuilder<T> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public abstract class TreeBuilder<T> : ITreeBuilder<T> Type Parameters Name Description T Constructors | Edit this page View Source TreeBuilder(bool) Constructs base and initializes SupportsCanExpand Declaration public TreeBuilder(bool supportsCanExpand) Parameters Type Name Description bool supportsCanExpand Pass true if you intend to implement CanExpand(T) otherwise false Properties | Edit this page View Source SupportsCanExpand Returns true if CanExpand(T) is implemented by this class Declaration public bool SupportsCanExpand { get; protected set; } Property Value Type Description bool Methods | Edit this page View Source CanExpand(T) Override this method to return a rapid answer as to whether GetChildren(T) returns results. If you are implementing this method ensure you passed true in base constructor or set SupportsCanExpand Declaration public virtual bool CanExpand(T toExpand) Parameters Type Name Description T toExpand Returns Type Description bool | Edit this page View Source GetChildren(T) Returns all children of a given forObject which should be added to the tree as new branches underneath it Declaration public abstract IEnumerable<T> GetChildren(T forObject) Parameters Type Name Description T forObject Returns Type Description IEnumerable<T> Implements ITreeBuilder<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.TreeNode.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.TreeNode.html",
    "title": "Class TreeNode",
    "keywords": "Class TreeNode Simple class for representing nodes, use with regular (non generic) TreeView. Inheritance object TreeNode Implements ITreeNode Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public class TreeNode : ITreeNode Constructors | Edit this page View Source TreeNode() Initialises a new instance with no Text Declaration public TreeNode() | Edit this page View Source TreeNode(string) Initialises a new instance and sets starting Text Declaration public TreeNode(string text) Parameters Type Name Description string text Properties | Edit this page View Source Children Children of the current node Declaration public virtual IList<ITreeNode> Children { get; set; } Property Value Type Description IList<ITreeNode> | Edit this page View Source Tag Optionally allows you to store some custom data/class here. Declaration public object Tag { get; set; } Property Value Type Description object | Edit this page View Source Text Text to display in tree node for current entry Declaration public virtual string Text { get; set; } Property Value Type Description string Methods | Edit this page View Source ToString() returns Text Declaration public override string ToString() Returns Type Description string Overrides object.ToString() Implements ITreeNode"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.TreeNodeBuilder.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.TreeNodeBuilder.html",
    "title": "Class TreeNodeBuilder",
    "keywords": "Class TreeNodeBuilder ITreeBuilder<T> implementation for ITreeNode objects Inheritance object TreeBuilder<ITreeNode> TreeNodeBuilder Implements ITreeBuilder<ITreeNode> Inherited Members TreeBuilder<ITreeNode>.SupportsCanExpand TreeBuilder<ITreeNode>.CanExpand(ITreeNode) object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public class TreeNodeBuilder : TreeBuilder<ITreeNode>, ITreeBuilder<ITreeNode> Constructors | Edit this page View Source TreeNodeBuilder() Initialises a new instance of builder for any model objects of Type ITreeNode Declaration public TreeNodeBuilder() Methods | Edit this page View Source GetChildren(ITreeNode) Returns Children from model Declaration public override IEnumerable<ITreeNode> GetChildren(ITreeNode model) Parameters Type Name Description ITreeNode model Returns Type Description IEnumerable<ITreeNode> Overrides TreeBuilder<ITreeNode>.GetChildren(ITreeNode) Implements ITreeBuilder<T>"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.TreeStyle.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.TreeStyle.html",
    "title": "Class TreeStyle",
    "keywords": "Class TreeStyle Defines rendering options that affect how the tree is displayed. Inheritance object TreeStyle Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui.Trees Assembly: Terminal.Gui.dll Syntax public class TreeStyle Properties | Edit this page View Source CollapseableSymbol Symbol to use for branch nodes that can be collapsed (are currently expanded). Defaults to '-'. Set to null to hide. Declaration public Rune? CollapseableSymbol { get; set; } Property Value Type Description Rune? | Edit this page View Source ColorExpandSymbol Set to true to highlight expand/collapse symbols in hot key color. Declaration public bool ColorExpandSymbol { get; set; } Property Value Type Description bool | Edit this page View Source ExpandableSymbol Symbol to use for branch nodes that can be expanded to indicate this to the user. Defaults to '+'. Set to null to hide. Declaration public Rune? ExpandableSymbol { get; set; } Property Value Type Description Rune? | Edit this page View Source HighlightModelTextOnly Set to true to cause the selected item to be rendered with only the Model text to be highlighted. If false (the default), the entire row will be highlighted. Declaration public bool HighlightModelTextOnly { get; set; } Property Value Type Description bool | Edit this page View Source InvertExpandSymbolColors Invert console colours used to render the expand symbol. Declaration public bool InvertExpandSymbolColors { get; set; } Property Value Type Description bool | Edit this page View Source LeaveLastRow true to leave the last row of the control free for overwritting (e.g. by a scrollbar) When true scrolling will be triggered on the second last row of the control rather than. the last. Declaration public bool LeaveLastRow { get; set; } Property Value Type Description bool | Edit this page View Source ShowBranchLines true to render vertical lines under expanded nodes to show which node belongs to which parent. false to use only whitespace. Declaration public bool ShowBranchLines { get; set; } Property Value Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.Trees.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Trees.html",
    "title": "Namespace Terminal.Gui.Trees",
    "keywords": "Namespace Terminal.Gui.Trees Classes DelegateTreeBuilder<T> Implementation of ITreeBuilder<T> that uses user defined functions ObjectActivatedEventArgs<T> Event args for the ObjectActivated event SelectionChangedEventArgs<T> Event arguments describing a change in selected object in a tree view TreeBuilder<T> Abstract implementation of ITreeBuilder<T>. TreeNode Simple class for representing nodes, use with regular (non generic) TreeView. TreeNodeBuilder ITreeBuilder<T> implementation for ITreeNode objects TreeStyle Defines rendering options that affect how the tree is displayed. Interfaces ITreeBuilder<T> Interface for supplying data to a TreeView<T> on demand as root level nodes are expanded by the user ITreeNode Interface to implement when you want the regular (non generic) TreeView to automatically determine children for your class (without having to specify an ITreeBuilder<T>) Delegates AspectGetterDelegate<T> Delegates of this type are used to fetch string representations of user's model objects"
  },
  "api/Terminal.Gui/Terminal.Gui.TrueColor.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.TrueColor.html",
    "title": "Class TrueColor",
    "keywords": "Class TrueColor Indicates the RGB for true colors. Inheritance object TrueColor Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class TrueColor Constructors | Edit this page View Source TrueColor(int, int, int) Initializes a new instance of the TrueColor struct. Declaration public TrueColor(int red, int green, int blue) Parameters Type Name Description int red int green int blue Properties | Edit this page View Source Blue Blue color component. Declaration public int Blue { get; } Property Value Type Description int | Edit this page View Source Green Green color component. Declaration public int Green { get; } Property Value Type Description int | Edit this page View Source Red Red color component. Declaration public int Red { get; } Property Value Type Description int Methods | Edit this page View Source ToConsoleColor() Converts true color to console color. Declaration public Color ToConsoleColor() Returns Type Description Color"
  },
  "api/Terminal.Gui/Terminal.Gui.VerticalTextAlignment.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.VerticalTextAlignment.html",
    "title": "Enum VerticalTextAlignment",
    "keywords": "Enum VerticalTextAlignment Vertical text alignment enumeration, controls how text is displayed. Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public enum VerticalTextAlignment Fields Name Description Bottom Aligns the text to the bottom of the frame. Justified Shows the text as justified text in the frame. Middle Centers the text verticaly in the frame. Top Aligns the text to the top of the frame."
  },
  "api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html",
    "title": "Class View.FocusEventArgs",
    "keywords": "Class View.FocusEventArgs Defines the event arguments for SetFocus(View) Inheritance object EventArgs View.FocusEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class View.FocusEventArgs : EventArgs Constructors | Edit this page View Source FocusEventArgs(View) Constructs. Declaration public FocusEventArgs(View view) Parameters Type Name Description View view The view that gets or loses focus. Properties | Edit this page View Source Handled Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber. Its important to set this value to true specially when updating any View's layout from inside the subscriber method. Declaration public bool Handled { get; set; } Property Value Type Description bool | Edit this page View Source View Indicates the current view that gets or loses focus. Declaration public View View { get; set; } Property Value Type Description View"
  },
  "api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html",
    "title": "Class View.KeyEventEventArgs",
    "keywords": "Class View.KeyEventEventArgs Defines the event arguments for KeyEvent Inheritance object EventArgs View.KeyEventEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class View.KeyEventEventArgs : EventArgs Constructors | Edit this page View Source KeyEventEventArgs(KeyEvent) Constructs. Declaration public KeyEventEventArgs(KeyEvent ke) Parameters Type Name Description KeyEvent ke Properties | Edit this page View Source Handled Indicates if the current Key event has already been processed and the driver should stop notifying any other event subscriber. Its important to set this value to true specially when updating any View's layout from inside the subscriber method. Declaration public bool Handled { get; set; } Property Value Type Description bool | Edit this page View Source KeyEvent The KeyEvent for the event. Declaration public KeyEvent KeyEvent { get; set; } Property Value Type Description KeyEvent"
  },
  "api/Terminal.Gui/Terminal.Gui.View.LayoutEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.View.LayoutEventArgs.html",
    "title": "Class View.LayoutEventArgs",
    "keywords": "Class View.LayoutEventArgs Event arguments for the LayoutComplete event. Inheritance object EventArgs View.LayoutEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class View.LayoutEventArgs : EventArgs Properties | Edit this page View Source OldBounds The view-relative bounds of the View before it was laid out. Declaration public Rect OldBounds { get; set; } Property Value Type Description Rect"
  },
  "api/Terminal.Gui/Terminal.Gui.View.MouseEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.View.MouseEventArgs.html",
    "title": "Class View.MouseEventArgs",
    "keywords": "Class View.MouseEventArgs Specifies the event arguments for MouseEvent. This is a higher-level construct than the wrapped MouseEvent class and is used for the events defined on View and subclasses of View (e.g. MouseEnter and MouseClick). Inheritance object EventArgs View.MouseEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class View.MouseEventArgs : EventArgs Constructors | Edit this page View Source MouseEventArgs(MouseEvent) Constructs. Declaration public MouseEventArgs(MouseEvent me) Parameters Type Name Description MouseEvent me Properties | Edit this page View Source Handled Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber. Its important to set this value to true specially when updating any View's layout from inside the subscriber method. Declaration public bool Handled { get; set; } Property Value Type Description bool Remarks This property forwards to the Handled property and is provided as a convenience and for backwards compatibility | Edit this page View Source MouseEvent The MouseEvent for the event. Declaration public MouseEvent MouseEvent { get; set; } Property Value Type Description MouseEvent"
  },
  "api/Terminal.Gui/Terminal.Gui.View.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.View.html",
    "title": "Class View",
    "keywords": "Class View View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. Inheritance object Responder View Button CheckBox ColorPicker ComboBox FrameView GraphView HexView Label LineView ListView MenuBar PanelView ProgressBar RadioGroup ScrollBarView ScrollView StatusBar TabView TableView TextField TextValidateField TextView Toplevel TreeView<T> Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The View defines the base functionality for user interface elements in Terminal.Gui. Views can contain one or more subviews, can respond to user input and render themselves on the screen. Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View is determined when the View is initialized. To create a View using Absolute layout, call a constructor that takes a Rect parameter to specify the absolute position and size (the View.Frame). To create a View using Computed layout use a constructor that does not take a Rect parameter and set the X, Y, Width and Height properties on the view. Both approaches use coordinates that are relative to the container they are being added to. To switch between Absolute and Computed layout, use the LayoutStyle property. Computed layout is more flexible and supports dynamic console apps where controls adjust layout as the terminal resizes or other Views change size or position. The X, Y, Width and Height properties are Dim and Pos objects that dynamically update the position of a view. The X and Y properties are of type Pos and you can use either absolute positions, percentages or anchor points. The Width and Height properties are of type Dim and can use absolute position, percentages and anchors. These are useful as they will take care of repositioning views when view's frames are resized or if the terminal size changes. Absolute layout requires specifying coordinates and sizes of Views explicitly, and the View will typically stay in a fixed position and size. To change the position and size use the Frame property. Subviews (child views) can be added to a View by calling the Add(View) method. The container of a View can be accessed with the SuperView property. To flag a region of the View's Bounds to be redrawn call SetNeedsDisplay(Rect). To flag the entire view for redraw call SetNeedsDisplay(). Views have a ColorScheme property that defines the default colors that subviews should use for rendering. This ensures that the views fit in the context where they are being used, and allows for themes to be plugged in. For example, the default colors for windows and toplevels uses a blue background, while it uses a white background for dialog boxes and a red background for errors. Subclasses should not rely on ColorScheme being set at construction time. If a ColorScheme is not set on a view, the view will inherit the value from its SuperView and the value might only be valid once a view has been added to a SuperView. By using ColorScheme applications will work both in color as well as black and white displays. Views that are focusable should implement the PositionCursor() to make sure that the cursor is placed in a location that makes sense. Unix terminals do not have a way of hiding the cursor, so it can be distracting to have the cursor left at the last focused view. So views should make sure that they place the cursor in a visually sensible place. The LayoutSubviews() method is invoked when the size or layout of a view has changed. The default processing system will keep the size and dimensions for views that use the Absolute, and will recompute the frames for the vies that use Computed. Constructors | Edit this page View Source View() Initializes a new instance of View using Computed layout. Declaration public View() Remarks Use X, Y, Width, and Height properties to dynamically control the size and location of the view. The View will be created using Computed coordinates. The initial size (Frame) will be adjusted to fit the contents of Text, including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. This constructor initialize a View with a LayoutStyle of Computed. Use X, Y, Width, and Height properties to dynamically control the size and location of the view. | Edit this page View Source View(ustring, TextDirection, Border) Initializes a new instance of View using Computed layout. Declaration public View(ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom, Border border = null) Parameters Type Name Description ustring text text to initialize the Text property with. TextDirection direction The text direction. Border border The Border. Remarks The View will be created using Computed coordinates with the given string. The initial size (Frame) will be adjusted to fit the contents of Text, including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. | Edit this page View Source View(int, int, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(int x, int y, ustring text) Parameters Type Name Description int x column to locate the View. int y row to locate the View. ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The size (Frame) will be adjusted to fit the contents of Text, including newlines ('\\n') for multiple lines. No line wrapping is provided. | Edit this page View Source View(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public View(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor initialize a View with a LayoutStyle of Absolute. Use View to initialize a View with LayoutStyle of Computed | Edit this page View Source View(Rect, ustring, Border) Initializes a new instance of View using Absolute layout. Declaration public View(Rect rect, ustring text, Border border = null) Parameters Type Name Description Rect rect Location. ustring text text to initialize the Text property with. Border border The Border. Remarks The View will be created at the given coordinates with the given string. The initial size (Frame) will be adjusted to fit the contents of Text, including newlines ('\\n') for multiple lines. If rect.Height is greater than one, word wrapping is provided. Properties | Edit this page View Source AutoSize Gets or sets a flag that determines whether the View will be automatically resized to fit the Text. The default is false. Set to true to turn on AutoSize. If AutoSize is true the Width and Height will always be used if the text size is lower. If the text size is higher the bounds will be resized to fit it. In addition, if ForceValidatePosDim is true the new values of Width and Height must be of the same types of the existing one to avoid breaking the Dim settings. Declaration public virtual bool AutoSize { get; set; } Property Value Type Description bool | Edit this page View Source Border Declaration public virtual Border Border { get; set; } Property Value Type Description Border | Edit this page View Source Bounds The bounds represent the View-relative rectangle used for this view; the area inside of the view. Declaration public Rect Bounds { get; set; } Property Value Type Description Rect The bounds. Remarks Updates to the Bounds update the Frame, and has the same side effects as updating the Frame. Because Bounds coordinates are relative to the upper-left corner of the View, the coordinates of the upper-left corner of the rectangle returned by this property are (0,0). Use this property to obtain the size and coordinates of the client area of the control for tasks such as drawing on the surface of the control. | Edit this page View Source CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description bool true if can focus; otherwise, false. Overrides Responder.CanFocus | Edit this page View Source ClearOnVisibleFalse Gets or sets whether a view is cleared if the Visible property is false. Declaration public bool ClearOnVisibleFalse { get; set; } Property Value Type Description bool | Edit this page View Source ColorScheme The color scheme for this view, if it is not defined, it returns the SuperView's color scheme. Declaration public virtual ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme | Edit this page View Source Data Gets or sets arbitrary data for the view. Declaration public object Data { get; set; } Property Value Type Description object Remarks This property is not used internally. | Edit this page View Source Driver Points to the current driver in use by the view, it is a convenience property for simplifying the development of new views. Declaration public static ConsoleDriver Driver { get; } Property Value Type Description ConsoleDriver | Edit this page View Source Enabled Gets or sets a value indicating whether this Responder can respond to user interaction. Declaration public override bool Enabled { get; set; } Property Value Type Description bool Overrides Responder.Enabled | Edit this page View Source Focused Returns the currently focused view inside this view, or null if nothing is focused. Declaration public View Focused { get; } Property Value Type Description View The focused. | Edit this page View Source ForceValidatePosDim Forces validation with Computed layout to avoid breaking the Pos and Dim settings. Declaration public bool ForceValidatePosDim { get; set; } Property Value Type Description bool | Edit this page View Source Frame Gets or sets the frame for the view. The frame is relative to the view's container (SuperView). Declaration public virtual Rect Frame { get; set; } Property Value Type Description Rect The frame. Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView. | Edit this page View Source HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public override bool HasFocus { get; } Property Value Type Description bool true if has focus; otherwise, false. Overrides Responder.HasFocus | Edit this page View Source Height Gets or sets the height of the view. Only used the LayoutStyle is Computed. Declaration public Dim Height { get; set; } Property Value Type Description Dim The height. | Edit this page View Source HotKey Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire. Declaration public virtual Key HotKey { get; set; } Property Value Type Description Key | Edit this page View Source HotKeySpecifier Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public virtual Rune HotKeySpecifier { get; set; } Property Value Type Description Rune | Edit this page View Source Id Gets or sets an identifier for the view; Declaration public ustring Id { get; set; } Property Value Type Description ustring The identifier. Remarks The id should be unique across all Views that share a SuperView. | Edit this page View Source IgnoreBorderPropertyOnRedraw Get or sets whether the view will use Border (if Border is set) to draw a border. If false (the default), Redraw(Rect) will call DrawContent(View, bool) to draw the view's border. If true no border is drawn (and the view is expected to draw the border itself). Declaration public virtual bool IgnoreBorderPropertyOnRedraw { get; set; } Property Value Type Description bool | Edit this page View Source IsAdded Gets information if the view was already added to the SuperView. Declaration public bool IsAdded { get; } Property Value Type Description bool | Edit this page View Source IsCurrentTop Returns a value indicating if this View is currently on Top (Active) Declaration public bool IsCurrentTop { get; } Property Value Type Description bool | Edit this page View Source IsInitialized Get or sets if the View was already initialized. This derived from ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public virtual bool IsInitialized { get; set; } Property Value Type Description bool | Edit this page View Source LayoutStyle Controls how the View's Frame is computed during the LayoutSubviews method, if the style is set to Absolute, LayoutSubviews does not change the Frame. If the style is Computed the Frame is updated using the X, Y, Width, and Height properties. Declaration public LayoutStyle LayoutStyle { get; set; } Property Value Type Description LayoutStyle The layout style. | Edit this page View Source MostFocused Returns the most focused view in the chain of subviews (the leaf view that has the focus). Declaration public View MostFocused { get; } Property Value Type Description View The most focused View. | Edit this page View Source PreserveTrailingSpaces Gets or sets a flag that determines whether Text will have trailing spaces preserved or not when WordWrap(ustring, int, bool, int, TextDirection) is enabled. If true any trailing spaces will be trimmed when either the Text property is changed or when WordWrap(ustring, int, bool, int, TextDirection) is set to true. The default is false. Declaration public virtual bool PreserveTrailingSpaces { get; set; } Property Value Type Description bool | Edit this page View Source Shortcut This is the global setting that can be used as a global shortcut to invoke an action if provided. Declaration public Key Shortcut { get; set; } Property Value Type Description Key | Edit this page View Source ShortcutAction The action to run if the Shortcut is defined. Declaration public virtual Action ShortcutAction { get; set; } Property Value Type Description Action | Edit this page View Source ShortcutTag The keystroke combination used in the Shortcut as string. Declaration public ustring ShortcutTag { get; } Property Value Type Description ustring | Edit this page View Source Subviews This returns a list of the subviews contained by this view. Declaration public IList<View> Subviews { get; } Property Value Type Description IList<View> The subviews. | Edit this page View Source SuperView Returns the container for this view, or null if this view has not been added to a container. Declaration public View SuperView { get; } Property Value Type Description View The super view. | Edit this page View Source TabIndex Indicates the index of the current View from the TabIndexes list. Declaration public int TabIndex { get; set; } Property Value Type Description int | Edit this page View Source TabIndexes This returns a tab index list of the subviews contained by this view. Declaration public IList<View> TabIndexes { get; } Property Value Type Description IList<View> The tabIndexes. | Edit this page View Source TabStop This only be true if the CanFocus is also true and the focus can be avoided by setting this to false Declaration public bool TabStop { get; set; } Property Value Type Description bool | Edit this page View Source Text The text displayed by the View. Declaration public virtual ustring Text { get; set; } Property Value Type Description ustring Remarks If provided, the text will be drawn before any subviews are drawn. The text will be drawn starting at the view origin (0, 0) and will be formatted according to the TextAlignment property. If the view's height is greater than 1, the text will word-wrap to additional lines if it does not fit horizontally. If the view's height is 1, the text will be clipped. Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to (Rune)0xffff. | Edit this page View Source TextAlignment Gets or sets how the View's Text is aligned horizontally when drawn. Changing this property will redisplay the View. Declaration public virtual TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. | Edit this page View Source TextDirection Gets or sets the direction of the View's Text. Changing this property will redisplay the View. Declaration public virtual TextDirection TextDirection { get; set; } Property Value Type Description TextDirection The text alignment. | Edit this page View Source TextFormatter Gets or sets the TextFormatter which can be handled differently by any derived class. Declaration public TextFormatter TextFormatter { get; set; } Property Value Type Description TextFormatter | Edit this page View Source VerticalTextAlignment Gets or sets how the View's Text is aligned vertically when drawn. Changing this property will redisplay the View. Declaration public virtual VerticalTextAlignment VerticalTextAlignment { get; set; } Property Value Type Description VerticalTextAlignment The text alignment. | Edit this page View Source Visible Gets or sets a value indicating whether this Responder and all its child controls are displayed. Declaration public override bool Visible { get; set; } Property Value Type Description bool Overrides Responder.Visible | Edit this page View Source WantContinuousButtonPressed Gets or sets a value indicating whether this View want continuous button pressed event. Declaration public virtual bool WantContinuousButtonPressed { get; set; } Property Value Type Description bool | Edit this page View Source WantMousePositionReports Gets or sets a value indicating whether this View wants mouse position reports. Declaration public virtual bool WantMousePositionReports { get; set; } Property Value Type Description bool true if want mouse position reports; otherwise, false. | Edit this page View Source Width Gets or sets the width of the view. Only used the LayoutStyle is Computed. Declaration public Dim Width { get; set; } Property Value Type Description Dim The width. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. | Edit this page View Source X Gets or sets the X position for the view (the column). Only used if the LayoutStyle is Computed. Declaration public Pos X { get; set; } Property Value Type Description Pos The X Position. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. | Edit this page View Source Y Gets or sets the Y position for the view (the row). Only used if the LayoutStyle is Computed. Declaration public Pos Y { get; set; } Property Value Type Description Pos The y position (line). Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Methods | Edit this page View Source Add(View) Adds a subview (child) to this view. Declaration public virtual void Add(View view) Parameters Type Name Description View view Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() | Edit this page View Source Add(params View[]) Adds the specified views (children) to the view. Declaration public void Add(params View[] views) Parameters Type Name Description View[] views Array of one or more views (can be optional parameter). Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() | Edit this page View Source AddCommand(Command, Func<bool?>) States that the given View supports a given command and what f to perform to make that command happen If the command already has an implementation the f will replace the old one Declaration protected void AddCommand(Command command, Func<bool?> f) Parameters Type Name Description Command command The command. Func<bool?> f The function. | Edit this page View Source AddKeyBinding(Key, params Command[]) Adds a new key combination that will trigger the given command (if supported by the View - see GetSupportedCommands()) If the key is already bound to a different Command it will be rebound to this one Commands are only ever applied to the current View(i.e. this feature cannot be used to switch focus to another view and perform multiple commands there) Declaration public void AddKeyBinding(Key key, params Command[] command) Parameters Type Name Description Key key Command[] command The command(s) to run on the View when key is pressed. When specifying multiple commands, all commands will be applied in sequence. The bound key strike will be consumed if any took effect. | Edit this page View Source AddRune(int, int, Rune) Displays the specified character in the specified column and row of the View. Declaration public void AddRune(int col, int row, Rune ch) Parameters Type Name Description int col Column (view-relative). int row Row (view-relative). Rune ch Ch. | Edit this page View Source BeginInit() This derived from ISupportInitializeNotification to allow notify all the views that are beginning initialized. Declaration public void BeginInit() | Edit this page View Source BringSubviewForward(View) Moves the subview backwards in the hierarchy, only one step Declaration public void BringSubviewForward(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. | Edit this page View Source BringSubviewToFront(View) Brings the specified subview to the front so it is drawn on top of any other views. Declaration public void BringSubviewToFront(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks SendSubviewToBack(View). | Edit this page View Source Clear() Clears the view region with the current color. Declaration public void Clear() Remarks This clears the entire region used by this view. | Edit this page View Source Clear(Rect) Clears the specified region with the current color. Declaration public void Clear(Rect regionScreen) Parameters Type Name Description Rect regionScreen The screen-relative region to clear. | Edit this page View Source ClearKeybinding(params Command[]) Removes all key bindings that trigger the given command. Views can have multiple different keys bound to the same command and this method will clear all of them. Declaration public void ClearKeybinding(params Command[] command) Parameters Type Name Description Command[] command | Edit this page View Source ClearKeybinding(Key) Clears the existing keybinding (if any) for the given key. Declaration public void ClearKeybinding(Key key) Parameters Type Name Description Key key | Edit this page View Source ClearKeybindings() Removes all bound keys from the View and resets the default bindings. Declaration public void ClearKeybindings() | Edit this page View Source ClearLayoutNeeded() Removes the SetNeedsLayout() setting on this view. Declaration protected void ClearLayoutNeeded() | Edit this page View Source ClearNeedsDisplay() Removes the SetNeedsDisplay() and the ChildNeedsDisplay setting on this view. Declaration protected void ClearNeedsDisplay() | Edit this page View Source ClipToBounds() Sets the ConsoleDriver's clip region to the current View's Bounds. Declaration public Rect ClipToBounds() Returns Type Description Rect The existing driver's clip region, which can be then re-applied by setting Driver.Clip (Clip). Remarks Bounds is View-relative. | Edit this page View Source ContainsKeyBinding(Key) Checks if the key binding already exists. Declaration public bool ContainsKeyBinding(Key key) Parameters Type Name Description Key key The key to check. Returns Type Description bool true If the key already exist, false otherwise. | Edit this page View Source Dispose(bool) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description bool disposing Overrides Responder.Dispose(bool) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. | Edit this page View Source DrawFrame(Rect, int, bool) Draws a frame in the current view, clipped by the boundary of this view Declaration public void DrawFrame(Rect region, int padding = 0, bool fill = false) Parameters Type Name Description Rect region View-relative region for the frame to be drawn. int padding The padding to add around the outside of the drawn frame. bool fill If set to true it fill will the contents. | Edit this page View Source DrawHotString(ustring, bool, ColorScheme) Utility function to draw strings that contains a hotkey using a ColorScheme and the \"focused\" state. Declaration public void DrawHotString(ustring text, bool focused, ColorScheme scheme) Parameters Type Name Description ustring text String to display, the underscore before a letter flags the next letter as the hotkey. bool focused If set to true this uses the focused colors from the color scheme, otherwise the regular ones. ColorScheme scheme The color scheme to use. | Edit this page View Source DrawHotString(ustring, Attribute, Attribute) Utility function to draw strings that contain a hotkey. Declaration public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor) Parameters Type Name Description ustring text String to display, the hotkey specifier before a letter flags the next letter as the hotkey. Attribute hotColor Hot color. Attribute normalColor Normal color. Remarks The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default. The hotkey specifier can be changed via HotKeySpecifier | Edit this page View Source EndInit() This derived from ISupportInitializeNotification to allow notify all the views that are ending initialized. Declaration public void EndInit() | Edit this page View Source EnsureFocus() Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, does nothing. Declaration public void EnsureFocus() | Edit this page View Source FocusFirst() Focuses the first focusable subview if one exists. Declaration public void FocusFirst() | Edit this page View Source FocusLast() Focuses the last focusable subview if one exists. Declaration public void FocusLast() | Edit this page View Source FocusNext() Focuses the next view. Declaration public bool FocusNext() Returns Type Description bool true if next was focused, false otherwise. | Edit this page View Source FocusPrev() Focuses the previous view. Declaration public bool FocusPrev() Returns Type Description bool true if previous was focused, false otherwise. | Edit this page View Source GetAutoSize() Gets the size to fit all text if AutoSize is true. Declaration public Size GetAutoSize() Returns Type Description Size The Size | Edit this page View Source GetBoundsTextFormatterSize() Gets the text formatter size from a Bounds size. Declaration public Size GetBoundsTextFormatterSize() Returns Type Description Size The text formatter size more the HotKeySpecifier length. | Edit this page View Source GetCurrentHeight(out int) Calculate the height based on the Height settings. Declaration public bool GetCurrentHeight(out int currentHeight) Parameters Type Name Description int currentHeight The real current height. Returns Type Description bool true if the height can be directly assigned, false otherwise. | Edit this page View Source GetCurrentWidth(out int) Gets the current width based on the Width settings. Declaration public bool GetCurrentWidth(out int currentWidth) Parameters Type Name Description int currentWidth The real current width. Returns Type Description bool true if the width can be directly assigned, false otherwise. | Edit this page View Source GetFocusColor() Determines the current ColorScheme based on the Enabled value. Declaration public virtual Attribute GetFocusColor() Returns Type Description Attribute Focus if Enabled is true or Disabled if Enabled is false. If it's overridden can return other values. | Edit this page View Source GetHotKeySpecifierLength(bool) Get the width or height of the HotKeySpecifier length. Declaration public int GetHotKeySpecifierLength(bool isWidth = true) Parameters Type Name Description bool isWidth true if is the width (default) false if is the height. Returns Type Description int The length of the HotKeySpecifier. | Edit this page View Source GetHotNormalColor() Determines the current ColorScheme based on the Enabled value. Declaration public virtual Attribute GetHotNormalColor() Returns Type Description Attribute HotNormal if Enabled is true or Disabled if Enabled is false. If it's overridden can return other values. | Edit this page View Source GetKeyFromCommand(params Command[]) Gets the key used by a command. Declaration public Key GetKeyFromCommand(params Command[] command) Parameters Type Name Description Command[] command The command to search. Returns Type Description Key The Key used by a Command | Edit this page View Source GetMinWidthHeight(out Size) Verifies if the minimum width or height can be sets in the view. Declaration public bool GetMinWidthHeight(out Size size) Parameters Type Name Description Size size The size. Returns Type Description bool true if the size can be set, false otherwise. | Edit this page View Source GetNormalColor() Determines the current ColorScheme based on the Enabled value. Declaration public virtual Attribute GetNormalColor() Returns Type Description Attribute Normal if Enabled is true or Disabled if Enabled is false. If it's overridden can return other values. | Edit this page View Source GetSupportedCommands() Returns all commands that are supported by this View. Declaration public IEnumerable<Command> GetSupportedCommands() Returns Type Description IEnumerable<Command> | Edit this page View Source GetTextFormatterBoundsSize() Gets the bounds size from a Size. Declaration public Size GetTextFormatterBoundsSize() Returns Type Description Size The bounds size minus the HotKeySpecifier length. | Edit this page View Source GetTopSuperView() Get the top superview of a given View. Declaration public View GetTopSuperView() Returns Type Description View The superview view. | Edit this page View Source InvokeKeybindings(KeyEvent) Invokes any binding that is registered on this View and matches the keyEvent Declaration protected bool? InvokeKeybindings(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent The key event passed. Returns Type Description bool? | Edit this page View Source LayoutSubviews() Invoked when a view starts executing or when the dimensions of the view have changed, for example in response to the container view or terminal resizing. Declaration public virtual void LayoutSubviews() Remarks Calls OnLayoutComplete(LayoutEventArgs) (which raises the LayoutComplete event) before it returns. | Edit this page View Source Move(int, int, bool) This moves the cursor to the specified column and row in the view. Declaration public void Move(int col, int row, bool clipped = false) Parameters Type Name Description int col Col. int row Row. bool clipped Whether to clip the result of the ViewToScreen method, if set to true, the col, row values are clamped to the screen (terminal) dimensions (0..TerminalDim-1). | Edit this page View Source OnAdded(View) Method invoked when a subview is being added to this view. Declaration public virtual void OnAdded(View view) Parameters Type Name Description View view The subview being added. | Edit this page View Source OnCanFocusChanged() Method invoked when the CanFocus property from a view is changed. Declaration public override void OnCanFocusChanged() Overrides Responder.OnCanFocusChanged() | Edit this page View Source OnDrawContent(Rect) Enables overrides to draw infinitely scrolled content and/or a background behind added controls. Declaration public virtual void OnDrawContent(Rect viewport) Parameters Type Name Description Rect viewport The view-relative rectangle describing the currently visible viewport into the View Remarks This method will be called before any subviews added with Add(View) have been drawn. | Edit this page View Source OnDrawContentComplete(Rect) Enables overrides after completed drawing infinitely scrolled content and/or a background behind removed controls. Declaration public virtual void OnDrawContentComplete(Rect viewport) Parameters Type Name Description Rect viewport The view-relative rectangle describing the currently visible viewport into the View Remarks This method will be called after any subviews removed with Remove(View) have been completed drawing. | Edit this page View Source OnEnabledChanged() Method invoked when the Enabled property from a view is changed. Declaration public override void OnEnabledChanged() Overrides Responder.OnEnabledChanged() | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.OnEnter(View) | Edit this page View Source OnKeyDown(KeyEvent) Method invoked when a key is pressed. Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled Overrides Responder.OnKeyDown(KeyEvent) | Edit this page View Source OnKeyUp(KeyEvent) Method invoked when a key is released. Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool true if the event was handled Overrides Responder.OnKeyUp(KeyEvent) | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.OnLeave(View) | Edit this page View Source OnMouseClick(MouseEventArgs) Invokes the MouseClick event. Declaration protected bool OnMouseClick(View.MouseEventArgs args) Parameters Type Name Description View.MouseEventArgs args Returns Type Description bool | Edit this page View Source OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public override bool OnMouseEnter(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.OnMouseEnter(MouseEvent) | Edit this page View Source OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public virtual bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description bool true, if the event was handled, false otherwise. | Edit this page View Source OnMouseLeave(MouseEvent) Method invoked when a mouse event is generated for the last time. Declaration public override bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description bool true, if the event was handled, false otherwise. Overrides Responder.OnMouseLeave(MouseEvent) | Edit this page View Source OnRemoved(View) Method invoked when a subview is being removed from this view. Declaration public virtual void OnRemoved(View view) Parameters Type Name Description View view The subview being removed. | Edit this page View Source OnVisibleChanged() Method invoked when the Visible property from a view is changed. Declaration public override void OnVisibleChanged() Overrides Responder.OnVisibleChanged() | Edit this page View Source PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public virtual void PositionCursor() | Edit this page View Source ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides Responder.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. | Edit this page View Source ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description bool Overrides Responder.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. | Edit this page View Source ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description bool Overrides Responder.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. | Edit this page View Source ProcessResizeView() Can be overridden if the view resize behavior is different than the default. Declaration protected virtual void ProcessResizeView() | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public virtual void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Remove(View) Removes a subview added via Add(View) or Add(params View[]) from this View. Declaration public virtual void Remove(View view) Parameters Type Name Description View view | Edit this page View Source RemoveAll() Removes all subviews (children) added via Add(View) or Add(params View[]) from this View. Declaration public virtual void RemoveAll() | Edit this page View Source ReplaceKeyBinding(Key, Key) Replaces a key combination already bound to Command. Declaration protected void ReplaceKeyBinding(Key fromKey, Key toKey) Parameters Type Name Description Key fromKey The key to be replaced. Key toKey The new key to be used. | Edit this page View Source ScreenToView(int, int) Converts a point from screen-relative coordinates to view-relative coordinates. Declaration public Point ScreenToView(int x, int y) Parameters Type Name Description int x X screen-coordinate point. int y Y screen-coordinate point. Returns Type Description Point The mapped point. | Edit this page View Source SendSubviewBackwards(View) Moves the subview backwards in the hierarchy, only one step Declaration public void SendSubviewBackwards(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. | Edit this page View Source SendSubviewToBack(View) Sends the specified subview to the front so it is the first view drawn Declaration public void SendSubviewToBack(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks BringSubviewToFront(View). | Edit this page View Source SetChildNeedsDisplay() Indicates that any child views (in the Subviews list) need to be repainted. Declaration public void SetChildNeedsDisplay() | Edit this page View Source SetClip(Rect) Sets the clip region to the specified view-relative region. Declaration public Rect SetClip(Rect region) Parameters Type Name Description Rect region View-relative clip region. Returns Type Description Rect The previous screen-relative clip region. | Edit this page View Source SetFocus() Causes the specified view and the entire parent hierarchy to have the focused order updated. Declaration public void SetFocus() | Edit this page View Source SetHeight(int, out int) Calculate the height based on the Height settings. Declaration public bool SetHeight(int desiredHeight, out int resultHeight) Parameters Type Name Description int desiredHeight The desired height. int resultHeight The real result height. Returns Type Description bool true if the height can be directly assigned, false otherwise. | Edit this page View Source SetMinWidthHeight() Sets the minimum width or height if the view can be resized. Declaration public bool SetMinWidthHeight() Returns Type Description bool true if the size can be set, false otherwise. | Edit this page View Source SetNeedsDisplay() Sets a flag indicating this view needs to be redisplayed because its state has changed. Declaration public void SetNeedsDisplay() | Edit this page View Source SetNeedsDisplay(Rect) Flags the view-relative region on this View as needing to be repainted. Declaration public void SetNeedsDisplay(Rect region) Parameters Type Name Description Rect region The view-relative region that must be flagged for repaint. | Edit this page View Source SetWidth(int, out int) Calculate the width based on the Width settings. Declaration public bool SetWidth(int desiredWidth, out int resultWidth) Parameters Type Name Description int desiredWidth The desired width. int resultWidth The real result width. Returns Type Description bool true if the width can be directly assigned, false otherwise. | Edit this page View Source ToString() Pretty prints the View Declaration public override string ToString() Returns Type Description string Overrides object.ToString() | Edit this page View Source UpdateTextFormatterText() Can be overridden if the Text has different format than the default. Declaration protected virtual void UpdateTextFormatterText() Events | Edit this page View Source Added Event fired when a subview is being added to this view. Declaration public event Action<View> Added Event Type Type Description Action<View> | Edit this page View Source CanFocusChanged Event fired when the CanFocus value is being changed. Declaration public event Action CanFocusChanged Event Type Type Description Action | Edit this page View Source DrawContent Event invoked when the content area of the View is to be drawn. Declaration public event Action<Rect> DrawContent Event Type Type Description Action<Rect> Remarks Will be invoked before any subviews added with Add(View) have been drawn. Rect provides the view-relative rectangle describing the currently visible viewport into the View. | Edit this page View Source DrawContentComplete Event invoked when the content area of the View is completed drawing. Declaration public event Action<Rect> DrawContentComplete Event Type Type Description Action<Rect> Remarks Will be invoked after any subviews removed with Remove(View) have been completed drawing. Rect provides the view-relative rectangle describing the currently visible viewport into the View. | Edit this page View Source EnabledChanged Event fired when the Enabled value is being changed. Declaration public event Action EnabledChanged Event Type Type Description Action | Edit this page View Source Enter Event fired when the view gets focus. Declaration public event Action<View.FocusEventArgs> Enter Event Type Type Description Action<View.FocusEventArgs> | Edit this page View Source HotKeyChanged Event invoked when the HotKey is changed. Declaration public event Action<Key> HotKeyChanged Event Type Type Description Action<Key> | Edit this page View Source Initialized Event called only once when the View is being initialized for the first time. Allows configurations and assignments to be performed before the View being shown. This derived from ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public event EventHandler Initialized Event Type Type Description EventHandler | Edit this page View Source KeyDown Invoked when a key is pressed. Declaration public event Action<View.KeyEventEventArgs> KeyDown Event Type Type Description Action<View.KeyEventEventArgs> | Edit this page View Source KeyPress Invoked when a character key is pressed and occurs after the key up event. Declaration public event Action<View.KeyEventEventArgs> KeyPress Event Type Type Description Action<View.KeyEventEventArgs> | Edit this page View Source KeyUp Invoked when a key is released. Declaration public event Action<View.KeyEventEventArgs> KeyUp Event Type Type Description Action<View.KeyEventEventArgs> | Edit this page View Source LayoutComplete Fired after the View's LayoutSubviews() method has completed. Declaration public event Action<View.LayoutEventArgs> LayoutComplete Event Type Type Description Action<View.LayoutEventArgs> Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. | Edit this page View Source LayoutStarted Fired after the View's LayoutSubviews() method has completed. Declaration public event Action<View.LayoutEventArgs> LayoutStarted Event Type Type Description Action<View.LayoutEventArgs> Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. | Edit this page View Source Leave Event fired when the view looses focus. Declaration public event Action<View.FocusEventArgs> Leave Event Type Type Description Action<View.FocusEventArgs> | Edit this page View Source MouseClick Event fired when a mouse event is generated. Declaration public event Action<View.MouseEventArgs> MouseClick Event Type Type Description Action<View.MouseEventArgs> | Edit this page View Source MouseEnter Event fired when the view receives the mouse event for the first time. Declaration public event Action<View.MouseEventArgs> MouseEnter Event Type Type Description Action<View.MouseEventArgs> | Edit this page View Source MouseLeave Event fired when the view receives a mouse event for the last time. Declaration public event Action<View.MouseEventArgs> MouseLeave Event Type Type Description Action<View.MouseEventArgs> | Edit this page View Source Removed Event fired when a subview is being removed from this view. Declaration public event Action<View> Removed Event Type Type Description Action<View> | Edit this page View Source VisibleChanged Event fired when the Visible value is being changed. Declaration public event Action VisibleChanged Event Type Type Description Action Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Window.TitleEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Window.TitleEventArgs.html",
    "title": "Class Window.TitleEventArgs",
    "keywords": "Class Window.TitleEventArgs An EventArgs which allows passing a cancelable new Title value event. Inheritance object EventArgs Window.TitleEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Window.TitleEventArgs : EventArgs Constructors | Edit this page View Source TitleEventArgs(ustring, ustring) Initializes a new instance of Window.TitleEventArgs Declaration public TitleEventArgs(ustring oldTitle, ustring newTitle) Parameters Type Name Description ustring oldTitle The Title that is/has been replaced. ustring newTitle The new Title to be replaced. Properties | Edit this page View Source Cancel Flag which allows cancelling the Title change. Declaration public bool Cancel { get; set; } Property Value Type Description bool | Edit this page View Source NewTitle The new Window Title. Declaration public ustring NewTitle { get; set; } Property Value Type Description ustring | Edit this page View Source OldTitle The old Window Title. Declaration public ustring OldTitle { get; set; } Property Value Type Description ustring"
  },
  "api/Terminal.Gui/Terminal.Gui.Window.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Window.html",
    "title": "Class Window",
    "keywords": "Class Window A Toplevel View that draws a border around its Frame with a Title at the top. Inheritance object Responder View Toplevel Window Dialog Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds. A this time there is no API to determine this rectangle. Constructors | Edit this page View Source Window() Initializes a new instance of the Window class using Computed positioning. Declaration public Window() | Edit this page View Source Window(ustring) Initializes a new instance of the Window class with an optional title using Computed positioning. Declaration public Window(ustring title = null) Parameters Type Name Description ustring title Title. Remarks This constructor initializes a View with a LayoutStyle of Computed. Use X, Y, Width, and Height properties to dynamically control the size and location of the view. | Edit this page View Source Window(ustring, int, Border) Initializes a new instance of the Window using Computed positioning, and an optional title. Declaration public Window(ustring title = null, int padding = 0, Border border = null) Parameters Type Name Description ustring title Title. int padding Number of characters to use for padding of the drawn frame. Border border The Border. Remarks This constructor initializes a View with a LayoutStyle of Computed. Use X, Y, Width, and Height properties to dynamically control the size and location of the view. | Edit this page View Source Window(Rect, ustring) Initializes a new instance of the Window class with an optional title using Absolute positioning. Declaration public Window(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size ustring title Title Remarks This constructor initializes a Window with a LayoutStyle of Absolute. Use constructors that do not take Rect parameters to initialize a Window with Computed. | Edit this page View Source Window(Rect, ustring, int, Border) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(Rect frame, ustring title = null, int padding = 0, Border border = null) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size ustring title Title int padding Number of characters to use for padding of the drawn frame. Border border The Border. Remarks This constructor initializes a Window with a LayoutStyle of Absolute. Use constructors that do not take Rect parameters to initialize a Window with LayoutStyle of Computed Properties | Edit this page View Source Border Declaration public override Border Border { get; set; } Property Value Type Description Border Overrides View.Border | Edit this page View Source Text The text displayed by the Label. Declaration public override ustring Text { get; set; } Property Value Type Description ustring Overrides View.Text | Edit this page View Source TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label. Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment | Edit this page View Source Title The title to be displayed for this window. Declaration public ustring Title { get; set; } Property Value Type Description ustring The title Methods | Edit this page View Source Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides Toplevel.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View)RemoveAll() | Edit this page View Source OnCanFocusChanged() Method invoked when the CanFocus property from a view is changed. Declaration public override void OnCanFocusChanged() Overrides View.OnCanFocusChanged() | Edit this page View Source OnTitleChanged(ustring, ustring) Called when the Title has been changed. Invokes the TitleChanged event. Declaration public virtual void OnTitleChanged(ustring oldTitle, ustring newTitle) Parameters Type Name Description ustring oldTitle The Title that is/has been replaced. ustring newTitle The new Title to be replaced. | Edit this page View Source OnTitleChanging(ustring, ustring) Called before the Title changes. Invokes the TitleChanging event, which can be cancelled. Declaration public virtual bool OnTitleChanging(ustring oldTitle, ustring newTitle) Parameters Type Name Description ustring oldTitle The Title that is/has been replaced. ustring newTitle The new Title to be replaced. Returns Type Description bool `true` if an event handler cancelled the Title change. | Edit this page View Source Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides Toplevel.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the parameter, as this will cause the driver to clip the entire region. | Edit this page View Source Remove(View) Removes a subview added via Add(View) or Add(params View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides Toplevel.Remove(View) | Edit this page View Source RemoveAll() Removes all subviews (children) added via Add(View) or Add(params View[]) from this View. Declaration public override void RemoveAll() Overrides Toplevel.RemoveAll() Events | Edit this page View Source TitleChanged Event fired after the Title has been changed. Declaration public event Action<Window.TitleEventArgs> TitleChanged Event Type Type Description Action<Window.TitleEventArgs> | Edit this page View Source TitleChanging Event fired when the Title is changing. Set Cancel to `true` to cancel the Title change. Declaration public event Action<Window.TitleEventArgs> TitleChanging Event Type Type Description Action<Window.TitleEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Wizard.StepChangeEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Wizard.StepChangeEventArgs.html",
    "title": "Class Wizard.StepChangeEventArgs",
    "keywords": "Class Wizard.StepChangeEventArgs EventArgs for Wizard.WizardStep events. Inheritance object EventArgs Wizard.StepChangeEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Wizard.StepChangeEventArgs : EventArgs Constructors | Edit this page View Source StepChangeEventArgs(WizardStep, WizardStep) Initializes a new instance of Wizard.StepChangeEventArgs Declaration public StepChangeEventArgs(Wizard.WizardStep oldStep, Wizard.WizardStep newStep) Parameters Type Name Description Wizard.WizardStep oldStep The current Wizard.WizardStep. Wizard.WizardStep newStep The new Wizard.WizardStep. Properties | Edit this page View Source Cancel Event handlers can set to true before returning to cancel the step transition. Declaration public bool Cancel { get; set; } Property Value Type Description bool | Edit this page View Source NewStep The Wizard.WizardStep the Wizard is changing to or has changed to. Declaration public Wizard.WizardStep NewStep { get; } Property Value Type Description Wizard.WizardStep | Edit this page View Source OldStep The current (or previous) Wizard.WizardStep. Declaration public Wizard.WizardStep OldStep { get; } Property Value Type Description Wizard.WizardStep"
  },
  "api/Terminal.Gui/Terminal.Gui.Wizard.WizardButtonEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Wizard.WizardButtonEventArgs.html",
    "title": "Class Wizard.WizardButtonEventArgs",
    "keywords": "Class Wizard.WizardButtonEventArgs EventArgs for Wizard.WizardStep transition events. Inheritance object EventArgs Wizard.WizardButtonEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Wizard.WizardButtonEventArgs : EventArgs Constructors | Edit this page View Source WizardButtonEventArgs() Initializes a new instance of Wizard.WizardButtonEventArgs Declaration public WizardButtonEventArgs() Properties | Edit this page View Source Cancel Set to true to cancel the transition to the next step. Declaration public bool Cancel { get; set; } Property Value Type Description bool"
  },
  "api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html",
    "title": "Class Wizard.WizardStep.TitleEventArgs",
    "keywords": "Class Wizard.WizardStep.TitleEventArgs An EventArgs which allows passing a cancelable new Title value event. Inheritance object EventArgs Wizard.WizardStep.TitleEventArgs Inherited Members EventArgs.Empty object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Wizard.WizardStep.TitleEventArgs : EventArgs Constructors | Edit this page View Source TitleEventArgs(ustring, ustring) Initializes a new instance of Wizard.WizardStep.TitleEventArgs Declaration public TitleEventArgs(ustring oldTitle, ustring newTitle) Parameters Type Name Description ustring oldTitle The Title that is/has been replaced. ustring newTitle The new Title to be replaced. Properties | Edit this page View Source Cancel Flag which allows cancelling the Title change. Declaration public bool Cancel { get; set; } Property Value Type Description bool | Edit this page View Source NewTitle The new Window Title. Declaration public ustring NewTitle { get; set; } Property Value Type Description ustring | Edit this page View Source OldTitle The old Window Title. Declaration public ustring OldTitle { get; set; } Property Value Type Description ustring"
  },
  "api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Wizard.WizardStep.html",
    "title": "Class Wizard.WizardStep",
    "keywords": "Class Wizard.WizardStep Represents a basic step that is displayed in a Wizard. The Wizard.WizardStep view is divided horizontally in two. On the left is the content view where Views can be added, On the right is the help for the step. Set HelpText to set the help text. If the help text is empty the help pane will not be shown. If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step. Inheritance object Responder View FrameView Wizard.WizardStep Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members FrameView.Border FrameView.Redraw(Rect) FrameView.Text FrameView.TextAlignment FrameView.OnEnter(View) FrameView.OnCanFocusChanged() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Wizard.WizardStep : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks If Buttons are added, do not set IsDefault to true as this will conflict with the Next button of the Wizard. Subscribe to the VisibleChanged event to be notified when the step is active; see also: StepChanged. To enable or disable a step from being shown to the user, set Enabled. Constructors | Edit this page View Source WizardStep(ustring) Initializes a new instance of the Wizard class using Computed positioning. Declaration public WizardStep(ustring title) Parameters Type Name Description ustring title Title for the Step. Will be appended to the containing Wizard's title as \"Wizard Title - Wizard Step Title\" when this step is active. Properties | Edit this page View Source BackButtonText Sets or gets the text for the back button. The back button will only be visible on steps after the first step. Declaration public ustring BackButtonText { get; set; } Property Value Type Description ustring Remarks The default text is \"Back\" | Edit this page View Source HelpText Sets or gets help text for the Wizard.WizardStep.If HelpText is empty the help pane will not be visible and the content will fill the entire WizardStep. Declaration public ustring HelpText { get; set; } Property Value Type Description ustring Remarks The help text is displayed using a read-only TextView. | Edit this page View Source NextButtonText Sets or gets the text for the next/finish button. Declaration public ustring NextButtonText { get; set; } Property Value Type Description ustring Remarks The default text is \"Next...\" if the Pane is not the last pane. Otherwise it is \"Finish\" | Edit this page View Source Title The title of the Wizard.WizardStep. Declaration public ustring Title { get; set; } Property Value Type Description ustring Remarks The Title is only displayed when the Wizard is used as a modal pop-up (see Modal. Methods | Edit this page View Source Add(View) Add the specified View to the Wizard.WizardStep. Declaration public override void Add(View view) Parameters Type Name Description View view View to add to this container Overrides FrameView.Add(View) | Edit this page View Source OnTitleChanged(ustring, ustring) Called when the Title has been changed. Invokes the TitleChanged event. Declaration public virtual void OnTitleChanged(ustring oldTitle, ustring newTitle) Parameters Type Name Description ustring oldTitle The Title that is/has been replaced. ustring newTitle The new Title to be replaced. | Edit this page View Source OnTitleChanging(ustring, ustring) Called before the Title changes. Invokes the TitleChanging event, which can be cancelled. Declaration public virtual bool OnTitleChanging(ustring oldTitle, ustring newTitle) Parameters Type Name Description ustring oldTitle The Title that is/has been replaced. ustring newTitle The new Title to be replaced. Returns Type Description bool true if an event handler cancelled the Title change. | Edit this page View Source Remove(View) Removes a View from Wizard.WizardStep. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides FrameView.Remove(View) | Edit this page View Source RemoveAll() Removes all Views from the Wizard.WizardStep. Declaration public override void RemoveAll() Overrides FrameView.RemoveAll() Events | Edit this page View Source TitleChanged Event fired after the Title has been changed. Declaration public event Action<Wizard.WizardStep.TitleEventArgs> TitleChanged Event Type Type Description Action<Wizard.WizardStep.TitleEventArgs> | Edit this page View Source TitleChanging Event fired when the Title is changing. Set Cancel to true to cancel the Title change. Declaration public event Action<Wizard.WizardStep.TitleEventArgs> TitleChanging Event Type Type Description Action<Wizard.WizardStep.TitleEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.Wizard.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.Wizard.html",
    "title": "Class Wizard",
    "keywords": "Class Wizard Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (Wizard.WizardStep) can host arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard. Inheritance object Responder View Toplevel Window Dialog Wizard Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Dialog.AddButton(Button) Dialog.ButtonAlignment Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: Terminal.Gui Assembly: Terminal.Gui.dll Syntax public class Wizard : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The Wizard can be displayed either as a modal (pop-up) Window (like Dialog) or as an embedded View. By default, Modal is true. In this case launch the Wizard with Application.Run(wizard). See Modal for more details. Examples using Terminal.Gui; using NStack; Application.Init(); var wizard = new Wizard ($\"Setup Wizard\"); // Add 1st step var firstStep = new Wizard.WizardStep (\"End User License Agreement\"); wizard.AddStep(firstStep); firstStep.NextButtonText = \"Accept!\"; firstStep.HelpText = \"This is the End User License Agreement.\"; // Add 2nd step var secondStep = new Wizard.WizardStep (\"Second Step\"); wizard.AddStep(secondStep); secondStep.HelpText = \"This is the help text for the Second Step.\"; var lbl = new Label (\"Name:\") { AutoSize = true }; secondStep.Add(lbl); var name = new TextField () { X = Pos.Right (lbl) + 1, Width = Dim.Fill () - 1 }; secondStep.Add(name); wizard.Finished += (args) => { MessageBox.Query(\"Wizard\", $\"Finished. The Name entered is '{name.Text}'\", \"Ok\"); Application.RequestStop(); }; Application.Top.Add (wizard); Application.Run (); Application.Shutdown (); Constructors | Edit this page View Source Wizard() Initializes a new instance of the Wizard class using Computed positioning. Declaration public Wizard() Remarks The Wizard will be vertically and horizontally centered in the container. After initialization use X, Y, Width, and Height change size and position. | Edit this page View Source Wizard(ustring) Initializes a new instance of the Wizard class using Computed positioning. Declaration public Wizard(ustring title) Parameters Type Name Description ustring title Sets the Title for the Wizard. Remarks The Wizard will be vertically and horizontally centered in the container. After initialization use X, Y, Width, and Height change size and position. Properties | Edit this page View Source BackButton If the CurrentStep is not the first step in the wizard, this button causes the MovingBack event to be fired and the wizard moves to the previous step. Declaration public Button BackButton { get; } Property Value Type Description Button Remarks Use the MovingBack event to be notified when the user attempts to go back. | Edit this page View Source CurrentStep Gets or sets the currently active Wizard.WizardStep. Declaration public Wizard.WizardStep CurrentStep { get; set; } Property Value Type Description Wizard.WizardStep | Edit this page View Source Modal Determines whether the Wizard is displayed as modal pop-up or not. The default is true. The Wizard will be shown with a frame with Title and will behave like any Toplevel window. If set to false the Wizard will have no frame and will behave like any embedded View. To use Wizard as an embedded View Set Modal to false. Add the Wizard to a containing view with Add(View). If a non-Modal Wizard is added to the application after Run(Func<Exception, bool>) has been called the first step must be explicitly set by setting CurrentStep to GetNextStep(): wizard.CurrentStep = wizard.GetNextStep(); Declaration public bool Modal { get; set; } Property Value Type Description bool | Edit this page View Source NextFinishButton If the CurrentStep is the last step in the wizard, this button causes the Finished event to be fired and the wizard to close. If the step is not the last step, the MovingNext event will be fired and the wizard will move next step. Declaration public Button NextFinishButton { get; } Property Value Type Description Button Remarks Use the MovingNext and Finished events to be notified when the user attempts go to the next step or finish the wizard. | Edit this page View Source Title The title of the Wizard, shown at the top of the Wizard with \" - currentStep.Title\" appended. Declaration public ustring Title { get; set; } Property Value Type Description ustring Remarks The Title is only displayed when the Wizard Modal is set to false. Methods | Edit this page View Source AddStep(WizardStep) Adds a step to the wizard. The Next and Back buttons navigate through the added steps in the order they were added. Declaration public void AddStep(Wizard.WizardStep newStep) Parameters Type Name Description Wizard.WizardStep newStep Remarks The \"Next...\" button of the last step added will read \"Finish\" (unless changed from default). | Edit this page View Source GetFirstStep() Returns the first enabled step in the Wizard Declaration public Wizard.WizardStep GetFirstStep() Returns Type Description Wizard.WizardStep The last enabled step | Edit this page View Source GetLastStep() Returns the last enabled step in the Wizard Declaration public Wizard.WizardStep GetLastStep() Returns Type Description Wizard.WizardStep The last enabled step | Edit this page View Source GetNextStep() Returns the next enabled Wizard.WizardStep after the current step. Takes into account steps which are disabled. If CurrentStep is null returns the first enabled step. Declaration public Wizard.WizardStep GetNextStep() Returns Type Description Wizard.WizardStep The next step after the current step, if there is one; otherwise returns null, which indicates either there are no enabled steps or the current step is the last enabled step. | Edit this page View Source GetPreviousStep() Returns the first enabled Wizard.WizardStep before the current step. Takes into account steps which are disabled. If CurrentStep is null returns the last enabled step. Declaration public Wizard.WizardStep GetPreviousStep() Returns Type Description Wizard.WizardStep The first step ahead of the current step, if there is one; otherwise returns null, which indicates either there are no enabled steps or the current step is the first enabled step. | Edit this page View Source GoBack() Causes the wizad to move to the previous enabled step (or first step if CurrentStep is not set). If there is no previous step, does nothing. Declaration public void GoBack() | Edit this page View Source GoNext() Causes the wizad to move to the next enabled step (or last step if CurrentStep is not set). If there is no previous step, does nothing. Declaration public void GoNext() | Edit this page View Source GoToStep(WizardStep) Changes to the specified Wizard.WizardStep. Declaration public bool GoToStep(Wizard.WizardStep newStep) Parameters Type Name Description Wizard.WizardStep newStep The step to go to. Returns Type Description bool True if the transition to the step succeeded. False if the step was not found or the operation was cancelled. | Edit this page View Source OnStepChanged(WizardStep, WizardStep) Called when the Wizard has completed transition to a new Wizard.WizardStep. Fires the StepChanged event. Declaration public virtual bool OnStepChanged(Wizard.WizardStep oldStep, Wizard.WizardStep newStep) Parameters Type Name Description Wizard.WizardStep oldStep The step the Wizard changed from Wizard.WizardStep newStep The step the Wizard has changed to Returns Type Description bool True if the change is to be cancelled. | Edit this page View Source OnStepChanging(WizardStep, WizardStep) Called when the Wizard is about to transition to another Wizard.WizardStep. Fires the StepChanging event. Declaration public virtual bool OnStepChanging(Wizard.WizardStep oldStep, Wizard.WizardStep newStep) Parameters Type Name Description Wizard.WizardStep oldStep The step the Wizard is about to change from Wizard.WizardStep newStep The step the Wizard is about to change to Returns Type Description bool True if the change is to be cancelled. | Edit this page View Source ProcessKey(KeyEvent) Wizard is derived from Dialog and Dialog causes Esc to call RequestStop(Toplevel), closing the Dialog. Wizard overrides ProcessKey(KeyEvent) to instead fire the Cancelled event when Wizard is being used as a non-modal (see Modal. See ProcessKey(KeyEvent) for more. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description bool Overrides Dialog.ProcessKey(KeyEvent) Events | Edit this page View Source Cancelled Raised when the user has cancelled the Wizard by pressin the Esc key. To prevent a modal (Modal is true) Wizard from closing, cancel the event by setting Cancel to true before returning from the event handler. Declaration public event Action<Wizard.WizardButtonEventArgs> Cancelled Event Type Type Description Action<Wizard.WizardButtonEventArgs> | Edit this page View Source Finished Raised when the Next/Finish button in the Wizard is clicked. The Next/Finish button is always the last button in the array of Buttons passed to the Wizard constructor, if any. This event is only raised if the CurrentStep is the last Step in the Wizard flow (otherwise the Finished event is raised). Declaration public event Action<Wizard.WizardButtonEventArgs> Finished Event Type Type Description Action<Wizard.WizardButtonEventArgs> | Edit this page View Source MovingBack Raised when the Back button in the Wizard is clicked. The Back button is always the first button in the array of Buttons passed to the Wizard constructor, if any. Declaration public event Action<Wizard.WizardButtonEventArgs> MovingBack Event Type Type Description Action<Wizard.WizardButtonEventArgs> | Edit this page View Source MovingNext Raised when the Next/Finish button in the Wizard is clicked (or the user presses Enter). The Next/Finish button is always the last button in the array of Buttons passed to the Wizard constructor, if any. This event is only raised if the CurrentStep is the last Step in the Wizard flow (otherwise the Finished event is raised). Declaration public event Action<Wizard.WizardButtonEventArgs> MovingNext Event Type Type Description Action<Wizard.WizardButtonEventArgs> | Edit this page View Source StepChanged This event is raised after the Wizard has changed the CurrentStep. Declaration public event Action<Wizard.StepChangeEventArgs> StepChanged Event Type Type Description Action<Wizard.StepChangeEventArgs> | Edit this page View Source StepChanging This event is raised when the current CurrentStep) is about to change. Use Cancel to abort the transition. Declaration public event Action<Wizard.StepChangeEventArgs> StepChanging Event Type Type Description Action<Wizard.StepChangeEventArgs> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/Terminal.Gui/Terminal.Gui.html": {
    "href": "api/Terminal.Gui/Terminal.Gui.html",
    "title": "Namespace Terminal.Gui",
    "keywords": "Namespace Terminal.Gui Classes Application A static, singleton class providing the main application driver for Terminal.Gui apps. Application.ResizedEventArgs Event arguments for the Resized event. Application.RunState Captures the execution state for the provided Toplevel view. Autocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. Border Draws a border, background, or both around another element. Border.ToplevelContainer A sealed Toplevel derived class to implement Border feature. This is only a wrapper to get borders on a toplevel and is recommended using another derived, like Window where is possible to have borders with or without border line or spacing around. Button Button is a View that provides an item that invokes an Action when activated by the user. CheckBox The CheckBox View shows an on/off toggle that the user can set Clipboard Provides cut, copy, and paste support for the OS clipboard. ClipboardBase Shared abstract class to enforce rules from the implementation of the IClipboard interface. CollectionNavigator Navigates a collection of items using keystrokes. The keystrokes are used to build a search string. The SearchString is used to find the next item in the collection that matches the search string when GetNextMatchingItem(int, char) is called. If the user types keystrokes that can't be found in the collection, the search string is cleared and the next item is found that starts with the last keystroke. If the user pauses keystrokes for a short time (see TypingDelay), the search string is cleared. CollectionNavigator.KeystrokeNavigatorEventArgs Event arguments for the SearchStringChanged event. ColorPicker The ColorPicker View Color picker. ColorScheme Defines the color Attributes for common visible elements in a View. Containers such as Window and FrameView use ColorScheme to determine the colors used by sub-views. Colors The default ColorSchemes for the application. ComboBox Provides a drop-down list of items the user can select from. ConsoleDriver ConsoleDriver is an abstract class that defines the requirements for a console driver. There are currently three implementations: CursesDriver (for Unix and Mac), WindowsDriver, and NetDriver that uses the .NET Console API. ConsoleKeyMapping Helper class to handle the scan code and virtual key from a ConsoleKey. ContextMenu ContextMenu provides a pop-up menu that can be positioned anywhere within a View. ContextMenu is analogous to MenuBar and, once activated, works like a sub-menu of a MenuBarItem (but can be positioned anywhere). By default, a ContextMenu with sub-menus is displayed in a cascading manner, where each sub-menu pops out of the ContextMenu frame (either to the right or left, depending on where the ContextMenu is relative to the edge of the screen). By setting UseSubMenusSingleFrame to true, this behavior can be changed such that all sub-menus are drawn within the ContextMenu frame. ContextMenus can be activated using the Shift-F10 key (by default; use the Key to change to another key). Callers can cause the ContextMenu to be activated on a right-mouse click (or other interaction) by calling Show(). ContextMenus are located using screen using screen coordinates and appear above all other Views. DateField Simple Date editing View DateTimeEventArgs<T> Defines the event arguments for DateChanged and TimeChanged events. Dialog The Dialog View is a Window that by default is centered and contains one or more Buttons. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Dim Dim properties of a View to control the position. EscSeqReqProc Manages a list of EscSeqReqStatus. EscSeqReqStatus Represents the state of an ANSI escape sequence request. EscSeqUtils Provides a platform-independent API for managing ANSI escape sequence codes. FakeConsole FakeDriver Implements a mock ConsoleDriver for unit testing FakeDriver.Behaviors FakeDriver.FakeClipboard FileDialog Base class for the OpenDialog and the SaveDialog FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. GraphView Control for rendering graphs (bar, scatter etc) HexView An hex viewer and editor View over a Stream HexView.HexViewEventArgs Defines the event arguments for PositionChanged event. KeyEvent Describes a keyboard event. KeyModifiers Identifies the state of the \"shift\"-keys within a event. Label The Label View displays a string at a given position and supports multiple lines separated by newline characters. Multi-line Labels support word wrap. LineView A straight line control either horizontal or vertical ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. ListViewItemEventArgs EventArgs for ListView events. ListViewRowEventArgs EventArgs used by the RowRender event. ListWrapper Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy. MainLoop Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers. MainLoop.Timeout Provides data for timers running manipulation. MenuBar Provides a menu bar that spans the top of a Toplevel View with drop-down and cascading menus. By default, any sub-sub-menus (sub-menus of the MenuItems added to MenuBarItems) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By setting UseSubMenusSingleFrame to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar. MenuBarItem MenuBarItem is a menu item on an app's MenuBar. MenuBarItems do not support Shortcut. MenuClosingEventArgs An EventArgs which allows passing a cancelable menu closing event. MenuItem A MenuItem has title, an associated help text, and an action to execute on activation. MenuItems can also have a checked indicator (see Checked). MenuOpeningEventArgs An EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem. MessageBox MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from. MouseEvent Low-level construct that conveys the details of mouse events, such as coordinates and button state, from ConsoleDrivers up to Application and Views. OpenDialog The OpenDialogprovides an interactive dialog box for users to select files or directories. PanelView A container for single Child that will allow to drawn Border in two ways. If UsePanelFrame the borders and the child will be accommodated in the available panel size, otherwise the panel will be resized based on the child and borders thickness sizes. Pos Describes the position of a View which can be an absolute value, a percentage, centered, or relative to the ending dimension. Integer values are implicitly convertible to an absolute Pos. These objects are created using the static methods Percent, AnchorEnd, and Center. The Pos objects can be combined with the addition and subtraction operators. ProgressBar A Progress Bar view that can indicate progress of an activity visually. RadioGroup Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time. Responder Responder base class implemented by objects that want to participate on keyboard and mouse input. SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. SelectedItemChangedArgs Event arguments for the SelectedItemChagned event. ShortcutHelper Represents a helper to manipulate shortcut keys used on views. StackExtensions Extension of Stack<T> helper to work with specific IEqualityComparer<T> StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a statusbar. StatusItem StatusItem objects are contained by StatusBar Views. Each StatusItem has a title, a shortcut (hotkey), and an Action that will be invoked when the Shortcut is pressed. The Shortcut will be a global hotkey for the application in the current context of the screen. The colour of the Title will be changed after each ~. A Title set to `~F1~ Help` will render as *F1* using HotNormal and *Help* as HotNormal. TabView Control that hosts multiple sub views, presenting a single one at once TabView.Tab A single tab in a TabView TabView.TabChangedEventArgs Describes a change in SelectedTab TabView.TabMouseEventArgs Describes a mouse event over a specific TabView.Tab in a TabView. TabView.TabStyle Describes render stylistic selections of a TabView TableView View for tabular data based on a DataTable. See TableView Deep Dive for more information. TableView.CellActivatedEventArgs Defines the event arguments for CellActivated event TableView.CellColorGetterArgs Arguments for a TableView.CellColorGetterDelegate. Describes a cell for which a rendering ColorScheme is being sought TableView.ColumnStyle Describes how to render a given column in a TableView including Alignment and textual representation of cells (e.g. date formats) See TableView Deep Dive for more information. TableView.RowColorGetterArgs Arguments for TableView.RowColorGetterDelegate. Describes a row of data in a DataTable for which ColorScheme is sought. TableView.SelectedCellChangedEventArgs Defines the event arguments for SelectedCellChanged TableView.TableSelection Describes a selected region of the table TableView.TableStyle Defines rendering options that affect how the table is displayed. See TableView Deep Dive for more information. TextChangingEventArgs An EventArgs which allows passing a cancelable new text value event. TextField Single-line text entry View TextFieldAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextField. TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap. TextValidateField Text field that validates input through a ITextValidateProvider TextView Multi-line text editing View. TextView.ContentsChangedEventArgs Event arguments for events for when the contents of the TextView change. E.g. the ContentsChanged event. TextViewAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextView. TimeField Time editing View Toplevel Toplevel views can be modally executed. They are used for both an application's main view (filling the entire screen and for pop-up views such as Dialog, MessageBox, and Wizard. ToplevelClosingEventArgs EventArgs implementation for the Closing event. ToplevelComparer Implements the IComparer<T> to sort the Toplevel from the MdiChildes if needed. ToplevelEqualityComparer Implements the IEqualityComparer<T> for comparing two Toplevels used by StackExtensions. TreeView Convenience implementation of generic TreeView<T> for any tree were all nodes implement ITreeNode. See TreeView Deep Dive for more information. TreeViewTextFilter<T> ITreeViewFilter<T> implementation which searches the AspectGetter of the model for the given Text. TreeView<T> Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder<T>. See TreeView Deep Dive for more information. TrueColor Indicates the RGB for true colors. View View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. View.FocusEventArgs Defines the event arguments for SetFocus(View) View.KeyEventEventArgs Defines the event arguments for KeyEvent View.LayoutEventArgs Event arguments for the LayoutComplete event. View.MouseEventArgs Specifies the event arguments for MouseEvent. This is a higher-level construct than the wrapped MouseEvent class and is used for the events defined on View and subclasses of View (e.g. MouseEnter and MouseClick). Window A Toplevel View that draws a border around its Frame with a Title at the top. Window.TitleEventArgs An EventArgs which allows passing a cancelable new Title value event. Wizard Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (Wizard.WizardStep) can host arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard. Wizard.StepChangeEventArgs EventArgs for Wizard.WizardStep events. Wizard.WizardButtonEventArgs EventArgs for Wizard.WizardStep transition events. Wizard.WizardStep Represents a basic step that is displayed in a Wizard. The Wizard.WizardStep view is divided horizontally in two. On the left is the content view where Views can be added, On the right is the help for the step. Set HelpText to set the help text. If the help text is empty the help pane will not be shown. If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step. Wizard.WizardStep.TitleEventArgs An EventArgs which allows passing a cancelable new Title value event. Structs Attribute Attributes are used as elements that contain both a foreground and a background or platform specific features. Point Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. PointF Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. Rect Stores a set of four integers that represent the location and size of a rectangle RectangleF Stores the location and size of a rectangular region. Size Stores an ordered pair of integers, which specify a Height and Width. SizeF Represents the size of a rectangular region with an ordered pair of width and height. Thickness Describes the thickness of a frame around a rectangle. Four int values describe the Left, Top, Right, and Bottom sides of the rectangle, respectively. Interfaces IAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. IClipboard Definition to interact with the OS clipboard. IListDataSource Implement IListDataSource to provide custom rendering for a ListView. IMainLoopDriver Public interface to create your own platform specific main loop driver. ITreeView Interface for all non generic members of TreeView<T>. See TreeView Deep Dive for more information. ITreeViewFilter<T> Provides filtering for a TreeView. Enums BorderStyle Specifies the border style for a View and to be used by the Border class. Color Colors that can be used to set the foreground and background colors in console applications. Command Actions which can be performed by the application or bound to keys in a View control. ConsoleDriver.DiagnosticFlags Enables diagnostic functions CursorVisibility Cursors Visibility that are displayed Dialog.ButtonAlignments Determines the horizontal alignment of the Dialog buttons. DisplayModeLayout Used for choose the display mode of this RadioGroup Key The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed. LayoutStyle Determines the LayoutStyle for a View, if Absolute, during LayoutSubviews(), the value from the Frame will be used, if the value is Computed, then Frame will be updated from the X, Y Pos objects and the Width and Height Dim objects. MenuItemCheckStyle Specifies how a MenuItem shows selection state. MouseFlags Mouse flags reported in MouseEvent. OpenDialog.OpenMode Determine which System.IO type to open. ProgressBarFormat Specifies the format that a ProgressBar uses to indicate the visual presentation. ProgressBarStyle Specifies the style that a ProgressBar uses to indicate the progress of an operation. TextAlignment Text alignment enumeration, controls how text is displayed. TextDirection Text direction enumeration, controls how text is displayed. VerticalTextAlignment Vertical text alignment enumeration, controls how text is displayed. Delegates TableView.CellColorGetterDelegate Delegate for providing color to TableView cells based on the value being rendered TableView.RowColorGetterDelegate Delegate for providing color for a whole row of a TableView"
  },
  "api/Terminal.Gui/Unix.Terminal.Curses.Event.html": {
    "href": "api/Terminal.Gui/Unix.Terminal.Curses.Event.html",
    "title": "Enum Curses.Event",
    "keywords": "Enum Curses.Event Namespace: Unix.Terminal Assembly: Terminal.Gui.dll Syntax [Flags] public enum Curses.Event : long Fields Name Description AllEvents Button1Clicked Button1DoubleClicked Button1Pressed Button1Released Button1TripleClicked Button2Clicked Button2DoubleClicked Button2Pressed Button2Released Button2TripleClicked Button3Clicked Button3DoubleClicked Button3Pressed Button3Released Button3TripleClicked Button4Clicked Button4DoubleClicked Button4Pressed Button4Released Button4TripleClicked ButtonAlt ButtonCtrl ButtonShift ButtonWheeledDown ButtonWheeledUp ReportMousePosition"
  },
  "api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html": {
    "href": "api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html",
    "title": "Struct Curses.MouseEvent",
    "keywords": "Struct Curses.MouseEvent Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Namespace: Unix.Terminal Assembly: Terminal.Gui.dll Syntax public struct Curses.MouseEvent Fields | Edit this page View Source ButtonState Declaration public Curses.Event ButtonState Field Value Type Description Curses.Event | Edit this page View Source ID Declaration public short ID Field Value Type Description short | Edit this page View Source X Declaration public int X Field Value Type Description int | Edit this page View Source Y Declaration public int Y Field Value Type Description int | Edit this page View Source Z Declaration public int Z Field Value Type Description int"
  },
  "api/Terminal.Gui/Unix.Terminal.Curses.Window.html": {
    "href": "api/Terminal.Gui/Unix.Terminal.Curses.Window.html",
    "title": "Class Curses.Window",
    "keywords": "Class Curses.Window Inheritance object Curses.Window Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Unix.Terminal Assembly: Terminal.Gui.dll Syntax public class Curses.Window Fields | Edit this page View Source Handle Declaration public readonly nint Handle Field Value Type Description nint Properties | Edit this page View Source Current Declaration public static Curses.Window Current { get; } Property Value Type Description Curses.Window | Edit this page View Source Standard Declaration public static Curses.Window Standard { get; } Property Value Type Description Curses.Window Methods | Edit this page View Source addch(char) Declaration public int addch(char ch) Parameters Type Name Description char ch Returns Type Description int | Edit this page View Source clearok(bool) Declaration public int clearok(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source idcok(bool) Declaration public void idcok(bool bf) Parameters Type Name Description bool bf | Edit this page View Source idlok(bool) Declaration public int idlok(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source immedok(bool) Declaration public void immedok(bool bf) Parameters Type Name Description bool bf | Edit this page View Source intrflush(bool) Declaration public int intrflush(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source keypad(bool) Declaration public int keypad(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source leaveok(bool) Declaration public int leaveok(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source meta(bool) Declaration public int meta(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source move(int, int) Declaration public int move(int line, int col) Parameters Type Name Description int line int col Returns Type Description int | Edit this page View Source notimeout(bool) Declaration public int notimeout(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source redrawwin() Declaration public int redrawwin() Returns Type Description int | Edit this page View Source refresh() Declaration public int refresh() Returns Type Description int | Edit this page View Source scrollok(bool) Declaration public int scrollok(bool bf) Parameters Type Name Description bool bf Returns Type Description int | Edit this page View Source setscrreg(int, int) Declaration public int setscrreg(int top, int bot) Parameters Type Name Description int top int bot Returns Type Description int | Edit this page View Source wnoutrefresh() Declaration public int wnoutrefresh() Returns Type Description int | Edit this page View Source wrefresh() Declaration public int wrefresh() Returns Type Description int | Edit this page View Source wtimeout(int) Declaration public int wtimeout(int delay) Parameters Type Name Description int delay Returns Type Description int"
  },
  "api/Terminal.Gui/Unix.Terminal.Curses.html": {
    "href": "api/Terminal.Gui/Unix.Terminal.Curses.html",
    "title": "Class Curses",
    "keywords": "Class Curses Inheritance object Curses Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: Unix.Terminal Assembly: Terminal.Gui.dll Syntax public class Curses Fields | Edit this page View Source ACS_BLOCK Declaration public const int ACS_BLOCK = 4194352 Field Value Type Description int | Edit this page View Source ACS_BOARD Declaration public const int ACS_BOARD = 4194408 Field Value Type Description int | Edit this page View Source ACS_BTEE Declaration public const int ACS_BTEE = 4194422 Field Value Type Description int | Edit this page View Source ACS_BULLET Declaration public const int ACS_BULLET = 4194430 Field Value Type Description int | Edit this page View Source ACS_CKBOARD Declaration public const int ACS_CKBOARD = 4194401 Field Value Type Description int | Edit this page View Source ACS_DARROW Declaration public const int ACS_DARROW = 4194350 Field Value Type Description int | Edit this page View Source ACS_DEGREE Declaration public const int ACS_DEGREE = 4194406 Field Value Type Description int | Edit this page View Source ACS_DIAMOND Declaration public const int ACS_DIAMOND = 4194400 Field Value Type Description int | Edit this page View Source ACS_HLINE Declaration public const int ACS_HLINE = 4194417 Field Value Type Description int | Edit this page View Source ACS_LANTERN Declaration public const int ACS_LANTERN = 4194409 Field Value Type Description int | Edit this page View Source ACS_LARROW Declaration public const int ACS_LARROW = 4194348 Field Value Type Description int | Edit this page View Source ACS_LLCORNER Declaration public const int ACS_LLCORNER = 4194413 Field Value Type Description int | Edit this page View Source ACS_LRCORNER Declaration public const int ACS_LRCORNER = 4194410 Field Value Type Description int | Edit this page View Source ACS_LTEE Declaration public const int ACS_LTEE = 4194420 Field Value Type Description int | Edit this page View Source ACS_PLMINUS Declaration public const int ACS_PLMINUS = 4194407 Field Value Type Description int | Edit this page View Source ACS_PLUS Declaration public const int ACS_PLUS = 4194414 Field Value Type Description int | Edit this page View Source ACS_RARROW Declaration public const int ACS_RARROW = 4194347 Field Value Type Description int | Edit this page View Source ACS_RTEE Declaration public const int ACS_RTEE = 4194421 Field Value Type Description int | Edit this page View Source ACS_S1 Declaration public const int ACS_S1 = 4194415 Field Value Type Description int | Edit this page View Source ACS_S9 Declaration public const int ACS_S9 = 4194419 Field Value Type Description int | Edit this page View Source ACS_TTEE Declaration public const int ACS_TTEE = 4194423 Field Value Type Description int | Edit this page View Source ACS_UARROW Declaration public const int ACS_UARROW = 4194349 Field Value Type Description int | Edit this page View Source ACS_ULCORNER Declaration public const int ACS_ULCORNER = 4194412 Field Value Type Description int | Edit this page View Source ACS_URCORNER Declaration public const int ACS_URCORNER = 4194411 Field Value Type Description int | Edit this page View Source ACS_VLINE Declaration public const int ACS_VLINE = 4194424 Field Value Type Description int | Edit this page View Source A_BLINK Declaration public const int A_BLINK = 524288 Field Value Type Description int | Edit this page View Source A_BOLD Declaration public const int A_BOLD = 2097152 Field Value Type Description int | Edit this page View Source A_DIM Declaration public const int A_DIM = 1048576 Field Value Type Description int | Edit this page View Source A_INVIS Declaration public const int A_INVIS = 8388608 Field Value Type Description int | Edit this page View Source A_NORMAL Declaration public const int A_NORMAL = 0 Field Value Type Description int | Edit this page View Source A_PROTECT Declaration public const int A_PROTECT = 16777216 Field Value Type Description int | Edit this page View Source A_REVERSE Declaration public const int A_REVERSE = 262144 Field Value Type Description int | Edit this page View Source A_STANDOUT Declaration public const int A_STANDOUT = 65536 Field Value Type Description int | Edit this page View Source A_UNDERLINE Declaration public const int A_UNDERLINE = 131072 Field Value Type Description int | Edit this page View Source AltCtrlKeyEnd Declaration public const int AltCtrlKeyEnd = 532 Field Value Type Description int | Edit this page View Source AltCtrlKeyHome Declaration public const int AltCtrlKeyHome = 537 Field Value Type Description int | Edit this page View Source AltCtrlKeyNPage Declaration public const int AltCtrlKeyNPage = 552 Field Value Type Description int | Edit this page View Source AltCtrlKeyPPage Declaration public const int AltCtrlKeyPPage = 557 Field Value Type Description int | Edit this page View Source AltKeyDown Declaration public const int AltKeyDown = 523 Field Value Type Description int | Edit this page View Source AltKeyEnd Declaration public const int AltKeyEnd = 528 Field Value Type Description int | Edit this page View Source AltKeyHome Declaration public const int AltKeyHome = 533 Field Value Type Description int | Edit this page View Source AltKeyLeft Declaration public const int AltKeyLeft = 543 Field Value Type Description int | Edit this page View Source AltKeyNPage Declaration public const int AltKeyNPage = 548 Field Value Type Description int | Edit this page View Source AltKeyPPage Declaration public const int AltKeyPPage = 553 Field Value Type Description int | Edit this page View Source AltKeyRight Declaration public const int AltKeyRight = 558 Field Value Type Description int | Edit this page View Source AltKeyUp Declaration public const int AltKeyUp = 564 Field Value Type Description int | Edit this page View Source COLOR_BLACK Declaration public const int COLOR_BLACK = 0 Field Value Type Description int | Edit this page View Source COLOR_BLUE Declaration public const int COLOR_BLUE = 4 Field Value Type Description int | Edit this page View Source COLOR_CYAN Declaration public const int COLOR_CYAN = 6 Field Value Type Description int | Edit this page View Source COLOR_GRAY Declaration public const int COLOR_GRAY = 8 Field Value Type Description int | Edit this page View Source COLOR_GREEN Declaration public const int COLOR_GREEN = 2 Field Value Type Description int | Edit this page View Source COLOR_MAGENTA Declaration public const int COLOR_MAGENTA = 5 Field Value Type Description int | Edit this page View Source COLOR_RED Declaration public const int COLOR_RED = 1 Field Value Type Description int | Edit this page View Source COLOR_WHITE Declaration public const int COLOR_WHITE = 7 Field Value Type Description int | Edit this page View Source COLOR_YELLOW Declaration public const int COLOR_YELLOW = 3 Field Value Type Description int | Edit this page View Source CtrlKeyDown Declaration public const int CtrlKeyDown = 525 Field Value Type Description int | Edit this page View Source CtrlKeyEnd Declaration public const int CtrlKeyEnd = 530 Field Value Type Description int | Edit this page View Source CtrlKeyHome Declaration public const int CtrlKeyHome = 535 Field Value Type Description int | Edit this page View Source CtrlKeyLeft Declaration public const int CtrlKeyLeft = 545 Field Value Type Description int | Edit this page View Source CtrlKeyNPage Declaration public const int CtrlKeyNPage = 550 Field Value Type Description int | Edit this page View Source CtrlKeyPPage Declaration public const int CtrlKeyPPage = 555 Field Value Type Description int | Edit this page View Source CtrlKeyRight Declaration public const int CtrlKeyRight = 560 Field Value Type Description int | Edit this page View Source CtrlKeyUp Declaration public const int CtrlKeyUp = 566 Field Value Type Description int | Edit this page View Source DownEnd Declaration public const int DownEnd = 0 Field Value Type Description int | Edit this page View Source ERR Declaration public const int ERR = -1 Field Value Type Description int | Edit this page View Source Home Declaration public const int Home = 0 Field Value Type Description int | Edit this page View Source KEY_CODE_YES Declaration public const int KEY_CODE_YES = 256 Field Value Type Description int | Edit this page View Source KeyAlt Declaration public const int KeyAlt = 8192 Field Value Type Description int | Edit this page View Source KeyBackTab Declaration public const int KeyBackTab = 353 Field Value Type Description int | Edit this page View Source KeyBackspace Declaration public const int KeyBackspace = 263 Field Value Type Description int | Edit this page View Source KeyCSI Declaration public const int KeyCSI = 91 Field Value Type Description int | Edit this page View Source KeyDeleteChar Declaration public const int KeyDeleteChar = 330 Field Value Type Description int | Edit this page View Source KeyDown Declaration public const int KeyDown = 258 Field Value Type Description int | Edit this page View Source KeyEnd Declaration public const int KeyEnd = 360 Field Value Type Description int | Edit this page View Source KeyF1 Declaration public const int KeyF1 = 265 Field Value Type Description int | Edit this page View Source KeyF10 Declaration public const int KeyF10 = 274 Field Value Type Description int | Edit this page View Source KeyF11 Declaration public const int KeyF11 = 275 Field Value Type Description int | Edit this page View Source KeyF12 Declaration public const int KeyF12 = 276 Field Value Type Description int | Edit this page View Source KeyF2 Declaration public const int KeyF2 = 266 Field Value Type Description int | Edit this page View Source KeyF3 Declaration public const int KeyF3 = 267 Field Value Type Description int | Edit this page View Source KeyF4 Declaration public const int KeyF4 = 268 Field Value Type Description int | Edit this page View Source KeyF5 Declaration public const int KeyF5 = 269 Field Value Type Description int | Edit this page View Source KeyF6 Declaration public const int KeyF6 = 270 Field Value Type Description int | Edit this page View Source KeyF7 Declaration public const int KeyF7 = 271 Field Value Type Description int | Edit this page View Source KeyF8 Declaration public const int KeyF8 = 272 Field Value Type Description int | Edit this page View Source KeyF9 Declaration public const int KeyF9 = 273 Field Value Type Description int | Edit this page View Source KeyHome Declaration public const int KeyHome = 262 Field Value Type Description int | Edit this page View Source KeyInsertChar Declaration public const int KeyInsertChar = 331 Field Value Type Description int | Edit this page View Source KeyLeft Declaration public const int KeyLeft = 260 Field Value Type Description int | Edit this page View Source KeyMouse Declaration public const int KeyMouse = 409 Field Value Type Description int | Edit this page View Source KeyNPage Declaration public const int KeyNPage = 338 Field Value Type Description int | Edit this page View Source KeyPPage Declaration public const int KeyPPage = 339 Field Value Type Description int | Edit this page View Source KeyResize Declaration public const int KeyResize = 410 Field Value Type Description int | Edit this page View Source KeyRight Declaration public const int KeyRight = 261 Field Value Type Description int | Edit this page View Source KeyTab Declaration public const int KeyTab = 9 Field Value Type Description int | Edit this page View Source KeyUp Declaration public const int KeyUp = 259 Field Value Type Description int | Edit this page View Source LeftRightUpNPagePPage Declaration public const int LeftRightUpNPagePPage = 0 Field Value Type Description int | Edit this page View Source ShiftAltKeyDown Declaration public const int ShiftAltKeyDown = 524 Field Value Type Description int | Edit this page View Source ShiftAltKeyEnd Declaration public const int ShiftAltKeyEnd = 529 Field Value Type Description int | Edit this page View Source ShiftAltKeyHome Declaration public const int ShiftAltKeyHome = 534 Field Value Type Description int | Edit this page View Source ShiftAltKeyLeft Declaration public const int ShiftAltKeyLeft = 544 Field Value Type Description int | Edit this page View Source ShiftAltKeyNPage Declaration public const int ShiftAltKeyNPage = 549 Field Value Type Description int | Edit this page View Source ShiftAltKeyPPage Declaration public const int ShiftAltKeyPPage = 554 Field Value Type Description int | Edit this page View Source ShiftAltKeyRight Declaration public const int ShiftAltKeyRight = 559 Field Value Type Description int | Edit this page View Source ShiftAltKeyUp Declaration public const int ShiftAltKeyUp = 565 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyDown Declaration public const int ShiftCtrlKeyDown = 526 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyEnd Declaration public const int ShiftCtrlKeyEnd = 531 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyHome Declaration public const int ShiftCtrlKeyHome = 536 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyLeft Declaration public const int ShiftCtrlKeyLeft = 546 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyNPage Declaration public const int ShiftCtrlKeyNPage = 551 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyPPage Declaration public const int ShiftCtrlKeyPPage = 556 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyRight Declaration public const int ShiftCtrlKeyRight = 561 Field Value Type Description int | Edit this page View Source ShiftCtrlKeyUp Declaration public const int ShiftCtrlKeyUp = 567 Field Value Type Description int | Edit this page View Source ShiftKeyDown Declaration public const int ShiftKeyDown = 336 Field Value Type Description int | Edit this page View Source ShiftKeyEnd Declaration public const int ShiftKeyEnd = 386 Field Value Type Description int | Edit this page View Source ShiftKeyHome Declaration public const int ShiftKeyHome = 391 Field Value Type Description int | Edit this page View Source ShiftKeyLeft Declaration public const int ShiftKeyLeft = 393 Field Value Type Description int | Edit this page View Source ShiftKeyNPage Declaration public const int ShiftKeyNPage = 396 Field Value Type Description int | Edit this page View Source ShiftKeyPPage Declaration public const int ShiftKeyPPage = 398 Field Value Type Description int | Edit this page View Source ShiftKeyRight Declaration public const int ShiftKeyRight = 402 Field Value Type Description int | Edit this page View Source ShiftKeyUp Declaration public const int ShiftKeyUp = 337 Field Value Type Description int | Edit this page View Source TIOCGWINSZ Declaration public const int TIOCGWINSZ = 21523 Field Value Type Description int | Edit this page View Source TIOCGWINSZ_MAC Declaration public const int TIOCGWINSZ_MAC = 1074295912 Field Value Type Description int Properties | Edit this page View Source ColorPairs Declaration public static int ColorPairs { get; } Property Value Type Description int | Edit this page View Source Cols Declaration public static int Cols { get; } Property Value Type Description int | Edit this page View Source HasColors Declaration public static bool HasColors { get; } Property Value Type Description bool | Edit this page View Source LC_ALL Declaration public static int LC_ALL { get; } Property Value Type Description int | Edit this page View Source Lines Declaration public static int Lines { get; } Property Value Type Description int Methods | Edit this page View Source COLOR_PAIRS() Declaration public static int COLOR_PAIRS() Returns Type Description int | Edit this page View Source CheckWinChange() Declaration public static bool CheckWinChange() Returns Type Description bool | Edit this page View Source ColorPair(int) Declaration public static int ColorPair(int n) Parameters Type Name Description int n Returns Type Description int | Edit this page View Source InitColorPair(short, short, short) Declaration public static int InitColorPair(short pair, short foreground, short background) Parameters Type Name Description short pair short foreground short background Returns Type Description int | Edit this page View Source IsAlt(int) Declaration public static int IsAlt(int key) Parameters Type Name Description int key Returns Type Description int | Edit this page View Source StartColor() Declaration public static int StartColor() Returns Type Description int | Edit this page View Source UseDefaultColors() Declaration public static int UseDefaultColors() Returns Type Description int | Edit this page View Source addch(int) Declaration public static int addch(int ch) Parameters Type Name Description int ch Returns Type Description int | Edit this page View Source addstr(string, params object[]) Declaration public static int addstr(string format, params object[] args) Parameters Type Name Description string format object[] args Returns Type Description int | Edit this page View Source addwstr(string) Declaration public static int addwstr(string s) Parameters Type Name Description string s Returns Type Description int | Edit this page View Source attroff(int) Declaration public static int attroff(int attrs) Parameters Type Name Description int attrs Returns Type Description int | Edit this page View Source attron(int) Declaration public static int attron(int attrs) Parameters Type Name Description int attrs Returns Type Description int | Edit this page View Source attrset(int) Declaration public static int attrset(int attrs) Parameters Type Name Description int attrs Returns Type Description int | Edit this page View Source cbreak() Declaration public static int cbreak() Returns Type Description int | Edit this page View Source clearok(nint, bool) Declaration public static int clearok(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source curs_set(int) Declaration public static int curs_set(int visibility) Parameters Type Name Description int visibility Returns Type Description int | Edit this page View Source def_prog_mode() Declaration public static int def_prog_mode() Returns Type Description int | Edit this page View Source def_shell_mode() Declaration public static int def_shell_mode() Returns Type Description int | Edit this page View Source doupdate() Declaration public static int doupdate() Returns Type Description int | Edit this page View Source echo() Declaration public static int echo() Returns Type Description int | Edit this page View Source endwin() Declaration public static int endwin() Returns Type Description int | Edit this page View Source flushinp() Declaration public static int flushinp() Returns Type Description int | Edit this page View Source get_wch(out int) Declaration public static int get_wch(out int sequence) Parameters Type Name Description int sequence Returns Type Description int | Edit this page View Source getch() Declaration public static int getch() Returns Type Description int | Edit this page View Source getmouse(out MouseEvent) Declaration public static uint getmouse(out Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description uint | Edit this page View Source halfdelay(int) Declaration public static int halfdelay(int t) Parameters Type Name Description int t Returns Type Description int | Edit this page View Source has_colors() Declaration public static bool has_colors() Returns Type Description bool | Edit this page View Source idcok(nint, bool) Declaration public static void idcok(nint win, bool bf) Parameters Type Name Description nint win bool bf | Edit this page View Source idlok(nint, bool) Declaration public static int idlok(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source immedok(nint, bool) Declaration public static void immedok(nint win, bool bf) Parameters Type Name Description nint win bool bf | Edit this page View Source init_pair(short, short, short) Declaration public static int init_pair(short pair, short f, short b) Parameters Type Name Description short pair short f short b Returns Type Description int | Edit this page View Source initscr() Declaration public static Curses.Window initscr() Returns Type Description Curses.Window | Edit this page View Source intrflush(nint, bool) Declaration public static int intrflush(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source is_term_resized(int, int) Declaration public static bool is_term_resized(int lines, int columns) Parameters Type Name Description int lines int columns Returns Type Description bool | Edit this page View Source isendwin() Declaration public static bool isendwin() Returns Type Description bool | Edit this page View Source keypad(nint, bool) Declaration public static int keypad(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source leaveok(nint, bool) Declaration public static int leaveok(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source meta(nint, bool) Declaration public static int meta(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source mouseinterval(int) Declaration public static int mouseinterval(int interval) Parameters Type Name Description int interval Returns Type Description int | Edit this page View Source mousemask(Event, out Event) Declaration public static Curses.Event mousemask(Curses.Event newmask, out Curses.Event oldmask) Parameters Type Name Description Curses.Event newmask Curses.Event oldmask Returns Type Description Curses.Event | Edit this page View Source move(int, int) Declaration public static int move(int line, int col) Parameters Type Name Description int line int col Returns Type Description int | Edit this page View Source mvaddch(int, int, int) Declaration public static int mvaddch(int y, int x, int ch) Parameters Type Name Description int y int x int ch Returns Type Description int | Edit this page View Source mvaddwstr(int, int, string) Declaration public static int mvaddwstr(int y, int x, string s) Parameters Type Name Description int y int x string s Returns Type Description int | Edit this page View Source mvgetch(int, int) Declaration public static int mvgetch(int y, int x) Parameters Type Name Description int y int x Returns Type Description int | Edit this page View Source nl() Declaration public static int nl() Returns Type Description int | Edit this page View Source nocbreak() Declaration public static int nocbreak() Returns Type Description int | Edit this page View Source noecho() Declaration public static int noecho() Returns Type Description int | Edit this page View Source nonl() Declaration public static int nonl() Returns Type Description int | Edit this page View Source noqiflush() Declaration public static void noqiflush() | Edit this page View Source noraw() Declaration public static int noraw() Returns Type Description int | Edit this page View Source notimeout(nint, bool) Declaration public static int notimeout(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source qiflush() Declaration public static void qiflush() | Edit this page View Source raw() Declaration public static int raw() Returns Type Description int | Edit this page View Source redrawwin(nint) Declaration public static int redrawwin(nint win) Parameters Type Name Description nint win Returns Type Description int | Edit this page View Source refresh() Declaration public static int refresh() Returns Type Description int | Edit this page View Source reset_prog_mode() Declaration public static int reset_prog_mode() Returns Type Description int | Edit this page View Source reset_shell_mode() Declaration public static int reset_shell_mode() Returns Type Description int | Edit this page View Source resetty() Declaration public static int resetty() Returns Type Description int | Edit this page View Source resize_term(int, int) Declaration public static int resize_term(int lines, int columns) Parameters Type Name Description int lines int columns Returns Type Description int | Edit this page View Source resizeterm(int, int) Declaration public static int resizeterm(int lines, int columns) Parameters Type Name Description int lines int columns Returns Type Description int | Edit this page View Source savetty() Declaration public static int savetty() Returns Type Description int | Edit this page View Source scrollok(nint, bool) Declaration public static int scrollok(nint win, bool bf) Parameters Type Name Description nint win bool bf Returns Type Description int | Edit this page View Source set_escdelay(int) Declaration public static int set_escdelay(int size) Parameters Type Name Description int size Returns Type Description int setlocale(int, string) Declaration public static extern int setlocale(int cate, string locale) Parameters Type Name Description int cate string locale Returns Type Description int | Edit this page View Source setscrreg(int, int) Declaration public static int setscrreg(int top, int bot) Parameters Type Name Description int top int bot Returns Type Description int | Edit this page View Source start_color() Declaration public static int start_color() Returns Type Description int | Edit this page View Source timeout(int) Declaration public static int timeout(int delay) Parameters Type Name Description int delay Returns Type Description int | Edit this page View Source typeahead(nint) Declaration public static int typeahead(nint fd) Parameters Type Name Description nint fd Returns Type Description int | Edit this page View Source ungetch(int) Declaration public static int ungetch(int ch) Parameters Type Name Description int ch Returns Type Description int | Edit this page View Source ungetmouse(ref MouseEvent) Declaration public static uint ungetmouse(ref Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description uint | Edit this page View Source use_default_colors() Declaration public static int use_default_colors() Returns Type Description int | Edit this page View Source use_env(bool) Declaration public static void use_env(bool f) Parameters Type Name Description bool f | Edit this page View Source waddch(nint, int) Declaration public static int waddch(nint win, int ch) Parameters Type Name Description nint win int ch Returns Type Description int | Edit this page View Source wmove(nint, int, int) Declaration public static int wmove(nint win, int line, int col) Parameters Type Name Description nint win int line int col Returns Type Description int | Edit this page View Source wnoutrefresh(nint) Declaration public static int wnoutrefresh(nint win) Parameters Type Name Description nint win Returns Type Description int | Edit this page View Source wrefresh(nint) Declaration public static int wrefresh(nint win) Parameters Type Name Description nint win Returns Type Description int | Edit this page View Source wsetscrreg(nint, int, int) Declaration public static int wsetscrreg(nint win, int top, int bot) Parameters Type Name Description nint win int top int bot Returns Type Description int | Edit this page View Source wtimeout(nint, int) Declaration public static int wtimeout(nint win, int delay) Parameters Type Name Description nint win int delay Returns Type Description int"
  },
  "api/Terminal.Gui/Unix.Terminal.html": {
    "href": "api/Terminal.Gui/Unix.Terminal.html",
    "title": "Namespace Unix.Terminal",
    "keywords": "Namespace Unix.Terminal Classes Curses Curses.Window Structs Curses.MouseEvent Enums Curses.Event"
  },
  "api/UICatalog/UICatalog.NumberToWords.html": {
    "href": "api/UICatalog/UICatalog.NumberToWords.html",
    "title": "Class NumberToWords",
    "keywords": "Class NumberToWords Inheritance object NumberToWords Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog Assembly: UICatalog.dll Syntax public static class NumberToWords Methods | Edit this page View Source Convert(long) Declaration public static string Convert(long i) Parameters Type Name Description long i Returns Type Description string | Edit this page View Source ConvertAmount(double) Declaration public static string ConvertAmount(double amount) Parameters Type Name Description double amount Returns Type Description string"
  },
  "api/UICatalog/UICatalog.Scenario.ScenarioCategory.html": {
    "href": "api/UICatalog/UICatalog.Scenario.ScenarioCategory.html",
    "title": "Class Scenario.ScenarioCategory",
    "keywords": "Class Scenario.ScenarioCategory Defines the category names used to catagorize a Scenario Inheritance object Attribute Scenario.ScenarioCategory Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog Assembly: UICatalog.dll Syntax [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class Scenario.ScenarioCategory : Attribute Constructors | Edit this page View Source ScenarioCategory(string) Declaration public ScenarioCategory(string Name) Parameters Type Name Description string Name Properties | Edit this page View Source Name Category Name Declaration public string Name { get; set; } Property Value Type Description string Methods | Edit this page View Source GetCategories(Type) Static helper function to get the Scenario Categories given a Type Declaration public static List<string> GetCategories(Type t) Parameters Type Name Description Type t Returns Type Description List<string> list of category names | Edit this page View Source GetName(Type) Static helper function to get the Scenario Name given a Type Declaration public static string GetName(Type t) Parameters Type Name Description Type t Returns Type Description string Name of the category"
  },
  "api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html": {
    "href": "api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html",
    "title": "Class Scenario.ScenarioMetadata",
    "keywords": "Class Scenario.ScenarioMetadata Defines the metadata (Name and Description) for a Scenario Inheritance object Attribute Scenario.ScenarioMetadata Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog Assembly: UICatalog.dll Syntax [AttributeUsage(AttributeTargets.Class)] public class Scenario.ScenarioMetadata : Attribute Constructors | Edit this page View Source ScenarioMetadata(string, string) Declaration public ScenarioMetadata(string Name, string Description) Parameters Type Name Description string Name string Description Properties | Edit this page View Source Description Scenario Description Declaration public string Description { get; set; } Property Value Type Description string | Edit this page View Source Name Scenario Name Declaration public string Name { get; set; } Property Value Type Description string Methods | Edit this page View Source GetDescription(Type) Static helper function to get the Scenario Description given a Type Declaration public static string GetDescription(Type t) Parameters Type Name Description Type t Returns Type Description string | Edit this page View Source GetName(Type) Static helper function to get the Scenario Name given a Type Declaration public static string GetName(Type t) Parameters Type Name Description Type t Returns Type Description string"
  },
  "api/UICatalog/UICatalog.Scenario.html": {
    "href": "api/UICatalog/UICatalog.Scenario.html",
    "title": "Class Scenario",
    "keywords": "Class Scenario Base class for each demo/scenario. To define a new scenario: Create a new .cs file in the Scenarios directory that derives from Scenario. Annotate the Scenario derived class with a Scenario.ScenarioMetadata attribute specifying the scenario's name and description. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the scenario belongs to. If you don't specify a category the scenario will show up in \"_All\". Implement the Setup() override which will be called when a user selects the scenario to run. Optionally, implement the Init(Toplevel, ColorScheme) and/or Run() overrides to provide a custom implementation. The UI Catalog program uses reflection to find all scenarios and adds them to the ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / Inheritance object Scenario ASCIICustomButtonTest AllViewsTester Animation AutoSizeAndDirectionText BackgroundWorkerCollection BasicColors Borders BordersComparisons BordersOnFrameView BordersOnToplevel BordersOnWindow Buttons CenteredWindowInsideMdiContainerWindow CenteredWindowInsideWindow CharacterMap ClassExplorer Clipping CollectionNavigatorTester ColorPickers ComboBoxIteration ComputedLayout ContextMenus CsvEditor Dialogs DynamicMenuBar DynamicStatusBar Editor GraphViewExample HexEditor InteractiveTree InvertColors Keys LabelsAsLabels LineDrawing LineViewExample ListViewWithSelection ListsAndCombos MessageBoxes Mouse MultiColouredTable MyScenario Notepad Progress ProgressBarStyles RunTExample RuneWidthGreaterThanOne Scrolling SendKeys SingleBackgroundWorker Snake SyntaxHighlighting TabViewExample TableEditor Text TextAlignments TextAlignmentsAndDirections TextFormatterDemo TextViewAutocompletePopup Threading TimeAndDate TreeUseCases TreeViewFileSystem UnicodeInMenu VkeyPacketSimulator WindowsAndFrameViews WizardAsView Wizards Implements IDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog Assembly: UICatalog.dll Syntax public class Scenario : IDisposable Examples The example below is provided in the Scenarios directory as a generic sample that can be copied and re-named: using Terminal.Gui; namespace UICatalog { [ScenarioMetadata (Name: \"Generic\", Description: \"Generic sample - A template for creating new Scenarios\")] [ScenarioCategory (\"Controls\")] class MyScenario : Scenario { public override void Setup () { // Put your scenario code here, e.g. Win.Add (new Button (\"Press me!\") { X = Pos.Center (), Y = Pos.Center (), Clicked = () => MessageBox.Query (20, 7, \"Hi\", \"Neat?\", \"Yes\", \"No\") }); } } } Properties | Edit this page View Source Win The Window for the Scenario. This should be set to Top in most cases. Declaration public Window Win { get; set; } Property Value Type Description Window Methods | Edit this page View Source Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration public void Dispose() | Edit this page View Source Dispose(bool) Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description bool disposing | Edit this page View Source GetCategories() Helper function to get the list of categories a Scenario belongs to (defined in Scenario.ScenarioCategory) Declaration public List<string> GetCategories() Returns Type Description List<string> list of category names | Edit this page View Source GetDescription() Helper to get the Scenario Description (defined in Scenario.ScenarioMetadata) Declaration public string GetDescription() Returns Type Description string | Edit this page View Source GetName() Helper to get the Scenario Name (defined in Scenario.ScenarioMetadata) Declaration public string GetName() Returns Type Description string | Edit this page View Source GetScenarios() Returns a list of all Scenario instanaces defined in the project, sorted by Name. https://stackoverflow.com/questions/5411694/get-all-inherited-classes-of-an-abstract-class Declaration public static List<Scenario> GetScenarios() Returns Type Description List<Scenario> | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public virtual void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source RequestStop() Stops the scenario. Override to change shutdown behavior for the Scenario. Declaration public virtual void RequestStop() | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public virtual void Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public virtual void Setup() Remarks This is typically the best place to put scenario logic code. | Edit this page View Source ToString() Gets the Scenario Name + Description with the Description padded based on the longest known Scenario name. Declaration public override string ToString() Returns Type Description string Overrides object.ToString() Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ASCIICustomButtonTest.ASCIICustomButton.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ASCIICustomButtonTest.ASCIICustomButton.html",
    "title": "Class ASCIICustomButtonTest.ASCIICustomButton",
    "keywords": "Class ASCIICustomButtonTest.ASCIICustomButton Inheritance object Responder View Button ASCIICustomButtonTest.ASCIICustomButton Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Button.IsDefault Button.HotKey Button.UpdateTextFormatterText() Button.ProcessHotKey(KeyEvent) Button.ProcessColdKey(KeyEvent) Button.ProcessKey(KeyEvent) Button.OnClicked() Button.Clicked Button.MouseEvent(MouseEvent) Button.PositionCursor() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(View) View.Add(params View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class ASCIICustomButtonTest.ASCIICustomButton : Button, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ASCIICustomButton(string, string, Pos, Pos, int, int) Declaration public ASCIICustomButton(string id, string text, Pos x, Pos y, int width, int height) Parameters Type Name Description string id string text Pos x Pos y int width int height | Edit this page View Source ASCIICustomButton(string, Pos, Pos, int, int) Declaration public ASCIICustomButton(string text, Pos x, Pos y, int width, int height) Parameters Type Name Description string text Pos x Pos y int width int height Properties | Edit this page View Source Description Declaration public string Description { get; } Property Value Type Description string Methods | Edit this page View Source OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides Button.OnEnter(View) | Edit this page View Source OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnLeave(View) | Edit this page View Source OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description bool true, if the event was handled, false otherwise. Overrides View.OnMouseEvent(MouseEvent) Events | Edit this page View Source PointerEnter Declaration public event Action<ASCIICustomButtonTest.ASCIICustomButton> PointerEnter Event Type Type Description Action<ASCIICustomButtonTest.ASCIICustomButton> Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.ASCIICustomButtonTest.ScrollViewTestWindow.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ASCIICustomButtonTest.ScrollViewTestWindow.html",
    "title": "Class ASCIICustomButtonTest.ScrollViewTestWindow",
    "keywords": "Class ASCIICustomButtonTest.ScrollViewTestWindow Inheritance object Responder View Toplevel Window ASCIICustomButtonTest.ScrollViewTestWindow Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class ASCIICustomButtonTest.ScrollViewTestWindow : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ScrollViewTestWindow() Declaration public ScrollViewTestWindow() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.ASCIICustomButtonTest.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ASCIICustomButtonTest.html",
    "title": "Class ASCIICustomButtonTest",
    "keywords": "Class ASCIICustomButtonTest Inheritance object Scenario ASCIICustomButtonTest Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"ASCIICustomButtonTest\", \"ASCIICustomButton sample\")] [Scenario.ScenarioCategory(\"Controls\")] public class ASCIICustomButtonTest : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.AllViewsTester.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.AllViewsTester.html",
    "title": "Class AllViewsTester",
    "keywords": "Class AllViewsTester Inheritance object Scenario AllViewsTester Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"All Views Tester\", \"Provides a test UI for all classes derived from View.\")] [Scenario.ScenarioCategory(\"Layout\")] [Scenario.ScenarioCategory(\"Tests\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] public class AllViewsTester : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Animation.BitmapToBraille.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Animation.BitmapToBraille.html",
    "title": "Class Animation.BitmapToBraille",
    "keywords": "Class Animation.BitmapToBraille Renders an image as unicode Braille. Inheritance object Animation.BitmapToBraille Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class Animation.BitmapToBraille Constructors | Edit this page View Source BitmapToBraille(int, int, Func<int, int, bool>) Declaration public BitmapToBraille(int widthPixels, int heightPixels, Func<int, int, bool> pixelIsLit) Parameters Type Name Description int widthPixels int heightPixels Func<int, int, bool> pixelIsLit Fields | Edit this page View Source CHAR_HEIGHT Declaration public const int CHAR_HEIGHT = 4 Field Value Type Description int | Edit this page View Source CHAR_WIDTH Declaration public const int CHAR_WIDTH = 2 Field Value Type Description int Properties | Edit this page View Source HeightPixels Declaration public int HeightPixels { get; } Property Value Type Description int | Edit this page View Source PixelIsLit Declaration public Func<int, int, bool> PixelIsLit { get; } Property Value Type Description Func<int, int, bool> | Edit this page View Source WidthPixels Declaration public int WidthPixels { get; } Property Value Type Description int Methods | Edit this page View Source GenerateImage() Declaration public string GenerateImage() Returns Type Description string"
  },
  "api/UICatalog/UICatalog.Scenarios.Animation.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Animation.html",
    "title": "Class Animation",
    "keywords": "Class Animation Inheritance object Scenario Animation Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Animation\", \"Demonstration of how to render animated images with threading.\")] [Scenario.ScenarioCategory(\"Colors\")] public class Animation : Scenario, IDisposable Methods | Edit this page View Source Dispose(bool) Declaration protected override void Dispose(bool disposing) Parameters Type Name Description bool disposing Overrides Scenario.Dispose(bool) | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.AutoSizeAndDirectionText.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.AutoSizeAndDirectionText.html",
    "title": "Class AutoSizeAndDirectionText",
    "keywords": "Class AutoSizeAndDirectionText Inheritance object Scenario AutoSizeAndDirectionText Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Text Direction and AutoSize\", \"Demos TextFormatter Direction and View AutoSize.\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] public class AutoSizeAndDirectionText : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.BackgroundWorkerCollection.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.BackgroundWorkerCollection.html",
    "title": "Class BackgroundWorkerCollection",
    "keywords": "Class BackgroundWorkerCollection Inheritance object Scenario BackgroundWorkerCollection Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"BackgroundWorker Collection\", \"A persisting multi Toplevel BackgroundWorker threading\")] [Scenario.ScenarioCategory(\"Threading\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] [Scenario.ScenarioCategory(\"Dialogs\")] [Scenario.ScenarioCategory(\"Controls\")] public class BackgroundWorkerCollection : Scenario, IDisposable Methods | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.BasicColors.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.BasicColors.html",
    "title": "Class BasicColors",
    "keywords": "Class BasicColors Inheritance object Scenario BasicColors Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Basic Colors\", \"Show all basic colors.\")] [Scenario.ScenarioCategory(\"Colors\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] public class BasicColors : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Borders.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Borders.html",
    "title": "Class Borders",
    "keywords": "Class Borders Inheritance object Scenario Borders Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Borders with/without PanelView\", \"Demonstrate with/without PanelView borders manipulation.\")] [Scenario.ScenarioCategory(\"Layout\")] [Scenario.ScenarioCategory(\"Borders\")] public class Borders : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.BordersComparisons.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.BordersComparisons.html",
    "title": "Class BordersComparisons",
    "keywords": "Class BordersComparisons Inheritance object Scenario BordersComparisons Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Borders Comparisons\", \"Compares Window, Toplevel and FrameView borders.\")] [Scenario.ScenarioCategory(\"Layout\")] [Scenario.ScenarioCategory(\"Borders\")] public class BordersComparisons : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.BordersOnFrameView.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.BordersOnFrameView.html",
    "title": "Class BordersOnFrameView",
    "keywords": "Class BordersOnFrameView Inheritance object Scenario BordersOnFrameView Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Borders on FrameView\", \"Demonstrate FrameView borders manipulation.\")] [Scenario.ScenarioCategory(\"Layout\")] [Scenario.ScenarioCategory(\"Borders\")] public class BordersOnFrameView : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.BordersOnToplevel.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.BordersOnToplevel.html",
    "title": "Class BordersOnToplevel",
    "keywords": "Class BordersOnToplevel Inheritance object Scenario BordersOnToplevel Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Borders on Toplevel\", \"Demonstrates Toplevel borders manipulation.\")] [Scenario.ScenarioCategory(\"Layout\")] [Scenario.ScenarioCategory(\"Borders\")] public class BordersOnToplevel : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.BordersOnWindow.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.BordersOnWindow.html",
    "title": "Class BordersOnWindow",
    "keywords": "Class BordersOnWindow Inheritance object Scenario BordersOnWindow Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Borders on Window\", \"Demonstrates Window borders manipulation.\")] [Scenario.ScenarioCategory(\"Layout\")] [Scenario.ScenarioCategory(\"Borders\")] public class BordersOnWindow : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Buttons.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Buttons.html",
    "title": "Class Buttons",
    "keywords": "Class Buttons Inheritance object Scenario Buttons Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Buttons\", \"Demonstrates all sorts of Buttons.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Layout\")] public class Buttons : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.CenteredWindowInsideMdiContainerWindow.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.CenteredWindowInsideMdiContainerWindow.html",
    "title": "Class CenteredWindowInsideMdiContainerWindow",
    "keywords": "Class CenteredWindowInsideMdiContainerWindow Inheritance object Scenario CenteredWindowInsideMdiContainerWindow Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"CenteredWindowInsideMdiContainerWindow\", \"Centered Window Inside MdiContainer Window\")] [Scenario.ScenarioCategory(\"Controls\")] public class CenteredWindowInsideMdiContainerWindow : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.CenteredWindowInsideWindow.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.CenteredWindowInsideWindow.html",
    "title": "Class CenteredWindowInsideWindow",
    "keywords": "Class CenteredWindowInsideWindow Inheritance object Scenario CenteredWindowInsideWindow Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"CenteredWindowInsideWindow\", \"Centered Window Inside Window\")] [Scenario.ScenarioCategory(\"Controls\")] public class CenteredWindowInsideWindow : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.CharacterMap.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.CharacterMap.html",
    "title": "Class CharacterMap",
    "keywords": "Class CharacterMap This Scenario demonstrates building a custom control (a class deriving from View) that: Provides a \"Character Map\" application (like Windows' charmap.exe). Helps test unicode character rendering in Terminal.Gui Illustrates how to use ScrollView to do infinite scrolling Inheritance object Scenario CharacterMap Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Character Map\", \"A Unicode character set viewier built as a custom control using the ScrollView control.\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"ScrollView\")] public class CharacterMap : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ChildWindowClass.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ChildWindowClass.html",
    "title": "Class ChildWindowClass",
    "keywords": "Class ChildWindowClass Inheritance object Responder View Toplevel Window ChildWindowClass Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class ChildWindowClass : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ChildWindowClass() Declaration public ChildWindowClass() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.ClassExplorer.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ClassExplorer.html",
    "title": "Class ClassExplorer",
    "keywords": "Class ClassExplorer Inheritance object Scenario ClassExplorer Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Class Explorer\", \"Tree view explorer for classes by namespace based on TreeView.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"TreeView\")] public class ClassExplorer : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Clipping.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Clipping.html",
    "title": "Class Clipping",
    "keywords": "Class Clipping Inheritance object Scenario Clipping Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Clipping\", \"Used to test that things clip correctly\")] [Scenario.ScenarioCategory(\"Tests\")] public class Clipping : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.CollectionNavigatorTester.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.CollectionNavigatorTester.html",
    "title": "Class CollectionNavigatorTester",
    "keywords": "Class CollectionNavigatorTester Inheritance object Scenario CollectionNavigatorTester Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Collection Navigator\", \"Demonstrates keyboard navigation in ListView & TreeView (CollectionNavigator).\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"ListView\")] [Scenario.ScenarioCategory(\"TreeView\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Mouse and Keyboard\")] public class CollectionNavigatorTester : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ColorPickers.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ColorPickers.html",
    "title": "Class ColorPickers",
    "keywords": "Class ColorPickers Inheritance object Scenario ColorPickers Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Color Picker\", \"Color Picker.\")] [Scenario.ScenarioCategory(\"Colors\")] [Scenario.ScenarioCategory(\"Controls\")] public class ColorPickers : Scenario, IDisposable Methods | Edit this page View Source Setup() Setup the scenario. Declaration public override void Setup() Overrides Scenario.Setup() Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ComboBoxIteration.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ComboBoxIteration.html",
    "title": "Class ComboBoxIteration",
    "keywords": "Class ComboBoxIteration Inheritance object Scenario ComboBoxIteration Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"ComboBoxIteration\", \"ComboBox iteration.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"ComboBox\")] public class ComboBoxIteration : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ComputedLayout.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ComputedLayout.html",
    "title": "Class ComputedLayout",
    "keywords": "Class ComputedLayout This Scenario demonstrates how to use Termina.gui's Dim and Pos Layout System. [x] - Using Dim.Fill to fill a window [x] - Using Dim.Fill and Dim.Pos to automatically align controls based on an initial control [ ] - ... Inheritance object Scenario ComputedLayout Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Computed Layout\", \"Demonstrates the Computed (Dim and Pos) Layout System.\")] [Scenario.ScenarioCategory(\"Layout\")] public class ComputedLayout : Scenario, IDisposable Methods | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ContextMenus.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ContextMenus.html",
    "title": "Class ContextMenus",
    "keywords": "Class ContextMenus Inheritance object Scenario ContextMenus Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"ContextMenus\", \"Context Menu Sample.\")] [Scenario.ScenarioCategory(\"Menus\")] public class ContextMenus : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.CsvEditor.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.CsvEditor.html",
    "title": "Class CsvEditor",
    "keywords": "Class CsvEditor Inheritance object Scenario CsvEditor Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Csv Editor\", \"Open and edit simple CSV files using the TableView class.\")] [Scenario.ScenarioCategory(\"TableView\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Dialogs\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Dialogs\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] [Scenario.ScenarioCategory(\"Files and IO\")] public class CsvEditor : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Dialogs.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Dialogs.html",
    "title": "Class Dialogs",
    "keywords": "Class Dialogs Inheritance object Scenario Dialogs Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Dialogs\", \"Demonstrates how to the Dialog class\")] [Scenario.ScenarioCategory(\"Dialogs\")] public class Dialogs : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.Binding.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.Binding.html",
    "title": "Class DynamicMenuBar.Binding",
    "keywords": "Class DynamicMenuBar.Binding Inheritance object DynamicMenuBar.Binding Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.Binding Constructors | Edit this page View Source Binding(View, string, View, string, IValueConverter) Declaration public Binding(View source, string sourcePropertyName, View target, string targetPropertyName, DynamicMenuBar.IValueConverter valueConverter = null) Parameters Type Name Description View source string sourcePropertyName View target string targetPropertyName DynamicMenuBar.IValueConverter valueConverter Properties | Edit this page View Source Source Declaration public View Source { get; } Property Value Type Description View | Edit this page View Source SourcePropertyName Declaration public string SourcePropertyName { get; } Property Value Type Description string | Edit this page View Source Target Declaration public View Target { get; } Property Value Type Description View | Edit this page View Source TargetPropertyName Declaration public string TargetPropertyName { get; } Property Value Type Description string"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarDetails.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarDetails.html",
    "title": "Class DynamicMenuBar.DynamicMenuBarDetails",
    "keywords": "Class DynamicMenuBar.DynamicMenuBarDetails Inheritance object Responder View FrameView DynamicMenuBar.DynamicMenuBarDetails Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members FrameView.Title FrameView.Border FrameView.Add(View) FrameView.Remove(View) FrameView.RemoveAll() FrameView.Redraw(Rect) FrameView.Text FrameView.TextAlignment FrameView.OnEnter(View) FrameView.OnCanFocusChanged() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.DynamicMenuBarDetails : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source DynamicMenuBarDetails(ustring) Declaration public DynamicMenuBarDetails(ustring title) Parameters Type Name Description ustring title | Edit this page View Source DynamicMenuBarDetails(MenuItem, bool) Declaration public DynamicMenuBarDetails(MenuItem menuItem = null, bool hasParent = false) Parameters Type Name Description MenuItem menuItem bool hasParent Fields | Edit this page View Source _ckbIsTopLevel Declaration public CheckBox _ckbIsTopLevel Field Value Type Description CheckBox | Edit this page View Source _ckbSubMenu Declaration public CheckBox _ckbSubMenu Field Value Type Description CheckBox | Edit this page View Source _menuItem Declaration public MenuItem _menuItem Field Value Type Description MenuItem | Edit this page View Source _rbChkStyle Declaration public RadioGroup _rbChkStyle Field Value Type Description RadioGroup | Edit this page View Source _txtAction Declaration public TextView _txtAction Field Value Type Description TextView | Edit this page View Source _txtHelp Declaration public TextField _txtHelp Field Value Type Description TextField | Edit this page View Source _txtShortcut Declaration public TextField _txtShortcut Field Value Type Description TextField | Edit this page View Source _txtTitle Declaration public TextField _txtTitle Field Value Type Description TextField Methods | Edit this page View Source CreateAction(MenuItem, DynamicMenuItem) Declaration public Action CreateAction(MenuItem menuItem, DynamicMenuBar.DynamicMenuItem item) Parameters Type Name Description MenuItem menuItem DynamicMenuBar.DynamicMenuItem item Returns Type Description Action | Edit this page View Source EditMenuBarItem(MenuItem) Declaration public void EditMenuBarItem(MenuItem menuItem) Parameters Type Name Description MenuItem menuItem | Edit this page View Source EnterMenuItem() Declaration public DynamicMenuBar.DynamicMenuItem EnterMenuItem() Returns Type Description DynamicMenuBar.DynamicMenuItem | Edit this page View Source UpdateParent(ref MenuItem) Declaration public void UpdateParent(ref MenuItem menuItem) Parameters Type Name Description MenuItem menuItem Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarSample.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuBarSample.html",
    "title": "Class DynamicMenuBar.DynamicMenuBarSample",
    "keywords": "Class DynamicMenuBar.DynamicMenuBarSample Inheritance object Responder View Toplevel Window DynamicMenuBar.DynamicMenuBarSample Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.DynamicMenuBarSample : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source DynamicMenuBarSample(ustring) Declaration public DynamicMenuBarSample(ustring title) Parameters Type Name Description ustring title Properties | Edit this page View Source DataContext Declaration public DynamicMenuBar.DynamicMenuItemModel DataContext { get; set; } Property Value Type Description DynamicMenuBar.DynamicMenuItemModel Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItem.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItem.html",
    "title": "Class DynamicMenuBar.DynamicMenuItem",
    "keywords": "Class DynamicMenuBar.DynamicMenuItem Inheritance object DynamicMenuBar.DynamicMenuItem Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.DynamicMenuItem Constructors | Edit this page View Source DynamicMenuItem() Declaration public DynamicMenuItem() | Edit this page View Source DynamicMenuItem(ustring, ustring, ustring, bool, bool, MenuItemCheckStyle, ustring) Declaration public DynamicMenuItem(ustring title, ustring help, ustring action, bool isTopLevel, bool hasSubMenu, MenuItemCheckStyle checkStyle = MenuItemCheckStyle.NoCheck, ustring shortcut = null) Parameters Type Name Description ustring title ustring help ustring action bool isTopLevel bool hasSubMenu MenuItemCheckStyle checkStyle ustring shortcut | Edit this page View Source DynamicMenuItem(ustring, bool) Declaration public DynamicMenuItem(ustring title, bool hasSubMenu = false) Parameters Type Name Description ustring title bool hasSubMenu Fields | Edit this page View Source action Declaration public ustring action Field Value Type Description ustring | Edit this page View Source checkStyle Declaration public MenuItemCheckStyle checkStyle Field Value Type Description MenuItemCheckStyle | Edit this page View Source hasSubMenu Declaration public bool hasSubMenu Field Value Type Description bool | Edit this page View Source help Declaration public ustring help Field Value Type Description ustring | Edit this page View Source isTopLevel Declaration public bool isTopLevel Field Value Type Description bool | Edit this page View Source shortcut Declaration public ustring shortcut Field Value Type Description ustring | Edit this page View Source title Declaration public ustring title Field Value Type Description ustring"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemList.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemList.html",
    "title": "Class DynamicMenuBar.DynamicMenuItemList",
    "keywords": "Class DynamicMenuBar.DynamicMenuItemList Inheritance object DynamicMenuBar.DynamicMenuItemList Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.DynamicMenuItemList Constructors | Edit this page View Source DynamicMenuItemList() Declaration public DynamicMenuItemList() | Edit this page View Source DynamicMenuItemList(ustring, MenuItem) Declaration public DynamicMenuItemList(ustring title, MenuItem menuItem) Parameters Type Name Description ustring title MenuItem menuItem Properties | Edit this page View Source MenuItem Declaration public MenuItem MenuItem { get; set; } Property Value Type Description MenuItem | Edit this page View Source Title Declaration public ustring Title { get; set; } Property Value Type Description ustring Methods | Edit this page View Source ToString() Returns a string that represents the current object. Declaration public override string ToString() Returns Type Description string A string that represents the current object. Overrides object.ToString()"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemModel.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.DynamicMenuItemModel.html",
    "title": "Class DynamicMenuBar.DynamicMenuItemModel",
    "keywords": "Class DynamicMenuBar.DynamicMenuItemModel Inheritance object DynamicMenuBar.DynamicMenuItemModel Implements INotifyPropertyChanged Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.DynamicMenuItemModel : INotifyPropertyChanged Constructors | Edit this page View Source DynamicMenuItemModel() Declaration public DynamicMenuItemModel() Properties | Edit this page View Source MenuBar Declaration public ustring MenuBar { get; set; } Property Value Type Description ustring | Edit this page View Source Menus Declaration public List<DynamicMenuBar.DynamicMenuItemList> Menus { get; set; } Property Value Type Description List<DynamicMenuBar.DynamicMenuItemList> | Edit this page View Source Parent Declaration public ustring Parent { get; set; } Property Value Type Description ustring Methods | Edit this page View Source GetPropertyName(string) Declaration public string GetPropertyName(string propertyName = null) Parameters Type Name Description string propertyName Returns Type Description string Events | Edit this page View Source PropertyChanged Occurs when a property value changes. Declaration public event PropertyChangedEventHandler PropertyChanged Event Type Type Description PropertyChangedEventHandler Implements INotifyPropertyChanged"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.IValueConverter.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.IValueConverter.html",
    "title": "Interface DynamicMenuBar.IValueConverter",
    "keywords": "Interface DynamicMenuBar.IValueConverter Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public interface DynamicMenuBar.IValueConverter Methods | Edit this page View Source Convert(object, object) Declaration object Convert(object value, object parameter = null) Parameters Type Name Description object value object parameter Returns Type Description object"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.ListWrapperConverter.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.ListWrapperConverter.html",
    "title": "Class DynamicMenuBar.ListWrapperConverter",
    "keywords": "Class DynamicMenuBar.ListWrapperConverter Inheritance object DynamicMenuBar.ListWrapperConverter Implements DynamicMenuBar.IValueConverter Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.ListWrapperConverter : DynamicMenuBar.IValueConverter Methods | Edit this page View Source Convert(object, object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description object value object parameter Returns Type Description object Implements DynamicMenuBar.IValueConverter"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.UStringValueConverter.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.UStringValueConverter.html",
    "title": "Class DynamicMenuBar.UStringValueConverter",
    "keywords": "Class DynamicMenuBar.UStringValueConverter Inheritance object DynamicMenuBar.UStringValueConverter Implements DynamicMenuBar.IValueConverter Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicMenuBar.UStringValueConverter : DynamicMenuBar.IValueConverter Methods | Edit this page View Source Convert(object, object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description object value object parameter Returns Type Description object Implements DynamicMenuBar.IValueConverter"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicMenuBar.html",
    "title": "Class DynamicMenuBar",
    "keywords": "Class DynamicMenuBar Inheritance object Scenario DynamicMenuBar Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Dynamic MenuBar\", \"Demonstrates how to change a MenuBar dynamically.\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] [Scenario.ScenarioCategory(\"Menus\")] public class DynamicMenuBar : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.Binding.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.Binding.html",
    "title": "Class DynamicStatusBar.Binding",
    "keywords": "Class DynamicStatusBar.Binding Inheritance object DynamicStatusBar.Binding Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.Binding Constructors | Edit this page View Source Binding(View, string, View, string, IValueConverter) Declaration public Binding(View source, string sourcePropertyName, View target, string targetPropertyName, DynamicStatusBar.IValueConverter valueConverter = null) Parameters Type Name Description View source string sourcePropertyName View target string targetPropertyName DynamicStatusBar.IValueConverter valueConverter Properties | Edit this page View Source Source Declaration public View Source { get; } Property Value Type Description View | Edit this page View Source SourcePropertyName Declaration public string SourcePropertyName { get; } Property Value Type Description string | Edit this page View Source Target Declaration public View Target { get; } Property Value Type Description View | Edit this page View Source TargetPropertyName Declaration public string TargetPropertyName { get; } Property Value Type Description string"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarDetails.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarDetails.html",
    "title": "Class DynamicStatusBar.DynamicStatusBarDetails",
    "keywords": "Class DynamicStatusBar.DynamicStatusBarDetails Inheritance object Responder View FrameView DynamicStatusBar.DynamicStatusBarDetails Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members FrameView.Title FrameView.Border FrameView.Add(View) FrameView.Remove(View) FrameView.RemoveAll() FrameView.Redraw(Rect) FrameView.Text FrameView.TextAlignment FrameView.OnEnter(View) FrameView.OnCanFocusChanged() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(bool) View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.MouseEvent(MouseEvent) Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.DynamicStatusBarDetails : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source DynamicStatusBarDetails(ustring) Declaration public DynamicStatusBarDetails(ustring title) Parameters Type Name Description ustring title | Edit this page View Source DynamicStatusBarDetails(StatusItem) Declaration public DynamicStatusBarDetails(StatusItem statusItem = null) Parameters Type Name Description StatusItem statusItem Fields | Edit this page View Source _statusItem Declaration public StatusItem _statusItem Field Value Type Description StatusItem | Edit this page View Source _txtAction Declaration public TextView _txtAction Field Value Type Description TextView | Edit this page View Source _txtShortcut Declaration public TextField _txtShortcut Field Value Type Description TextField | Edit this page View Source _txtTitle Declaration public TextField _txtTitle Field Value Type Description TextField Methods | Edit this page View Source CreateAction(DynamicStatusItem) Declaration public Action CreateAction(DynamicStatusBar.DynamicStatusItem item) Parameters Type Name Description DynamicStatusBar.DynamicStatusItem item Returns Type Description Action | Edit this page View Source EditStatusItem(StatusItem) Declaration public void EditStatusItem(StatusItem statusItem) Parameters Type Name Description StatusItem statusItem | Edit this page View Source EnterStatusItem() Declaration public DynamicStatusBar.DynamicStatusItem EnterStatusItem() Returns Type Description DynamicStatusBar.DynamicStatusItem Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarSample.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusBarSample.html",
    "title": "Class DynamicStatusBar.DynamicStatusBarSample",
    "keywords": "Class DynamicStatusBar.DynamicStatusBarSample Inheritance object Responder View Toplevel Window DynamicStatusBar.DynamicStatusBarSample Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.DynamicStatusBarSample : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source DynamicStatusBarSample(ustring) Declaration public DynamicStatusBarSample(ustring title) Parameters Type Name Description ustring title Properties | Edit this page View Source DataContext Declaration public DynamicStatusBar.DynamicStatusItemModel DataContext { get; set; } Property Value Type Description DynamicStatusBar.DynamicStatusItemModel Methods | Edit this page View Source SetTitleText(ustring, ustring) Declaration public static ustring SetTitleText(ustring title, ustring shortcut) Parameters Type Name Description ustring title ustring shortcut Returns Type Description ustring Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItem.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItem.html",
    "title": "Class DynamicStatusBar.DynamicStatusItem",
    "keywords": "Class DynamicStatusBar.DynamicStatusItem Inheritance object DynamicStatusBar.DynamicStatusItem Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.DynamicStatusItem Constructors | Edit this page View Source DynamicStatusItem() Declaration public DynamicStatusItem() | Edit this page View Source DynamicStatusItem(ustring) Declaration public DynamicStatusItem(ustring title) Parameters Type Name Description ustring title | Edit this page View Source DynamicStatusItem(ustring, ustring, ustring) Declaration public DynamicStatusItem(ustring title, ustring action, ustring shortcut = null) Parameters Type Name Description ustring title ustring action ustring shortcut Fields | Edit this page View Source action Declaration public ustring action Field Value Type Description ustring | Edit this page View Source shortcut Declaration public ustring shortcut Field Value Type Description ustring | Edit this page View Source title Declaration public ustring title Field Value Type Description ustring"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemList.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemList.html",
    "title": "Class DynamicStatusBar.DynamicStatusItemList",
    "keywords": "Class DynamicStatusBar.DynamicStatusItemList Inheritance object DynamicStatusBar.DynamicStatusItemList Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.DynamicStatusItemList Constructors | Edit this page View Source DynamicStatusItemList() Declaration public DynamicStatusItemList() | Edit this page View Source DynamicStatusItemList(ustring, StatusItem) Declaration public DynamicStatusItemList(ustring title, StatusItem statusItem) Parameters Type Name Description ustring title StatusItem statusItem Properties | Edit this page View Source StatusItem Declaration public StatusItem StatusItem { get; set; } Property Value Type Description StatusItem | Edit this page View Source Title Declaration public ustring Title { get; set; } Property Value Type Description ustring Methods | Edit this page View Source ToString() Returns a string that represents the current object. Declaration public override string ToString() Returns Type Description string A string that represents the current object. Overrides object.ToString()"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemModel.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.DynamicStatusItemModel.html",
    "title": "Class DynamicStatusBar.DynamicStatusItemModel",
    "keywords": "Class DynamicStatusBar.DynamicStatusItemModel Inheritance object DynamicStatusBar.DynamicStatusItemModel Implements INotifyPropertyChanged Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.DynamicStatusItemModel : INotifyPropertyChanged Constructors | Edit this page View Source DynamicStatusItemModel() Declaration public DynamicStatusItemModel() Properties | Edit this page View Source Items Declaration public List<DynamicStatusBar.DynamicStatusItemList> Items { get; set; } Property Value Type Description List<DynamicStatusBar.DynamicStatusItemList> | Edit this page View Source StatusBar Declaration public ustring StatusBar { get; set; } Property Value Type Description ustring Methods | Edit this page View Source GetPropertyName(string) Declaration public string GetPropertyName(string propertyName = null) Parameters Type Name Description string propertyName Returns Type Description string Events | Edit this page View Source PropertyChanged Occurs when a property value changes. Declaration public event PropertyChangedEventHandler PropertyChanged Event Type Type Description PropertyChangedEventHandler Implements INotifyPropertyChanged"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.IValueConverter.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.IValueConverter.html",
    "title": "Interface DynamicStatusBar.IValueConverter",
    "keywords": "Interface DynamicStatusBar.IValueConverter Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public interface DynamicStatusBar.IValueConverter Methods | Edit this page View Source Convert(object, object) Declaration object Convert(object value, object parameter = null) Parameters Type Name Description object value object parameter Returns Type Description object"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.ListWrapperConverter.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.ListWrapperConverter.html",
    "title": "Class DynamicStatusBar.ListWrapperConverter",
    "keywords": "Class DynamicStatusBar.ListWrapperConverter Inheritance object DynamicStatusBar.ListWrapperConverter Implements DynamicStatusBar.IValueConverter Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.ListWrapperConverter : DynamicStatusBar.IValueConverter Methods | Edit this page View Source Convert(object, object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description object value object parameter Returns Type Description object Implements DynamicStatusBar.IValueConverter"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.UStringValueConverter.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.UStringValueConverter.html",
    "title": "Class DynamicStatusBar.UStringValueConverter",
    "keywords": "Class DynamicStatusBar.UStringValueConverter Inheritance object DynamicStatusBar.UStringValueConverter Implements DynamicStatusBar.IValueConverter Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class DynamicStatusBar.UStringValueConverter : DynamicStatusBar.IValueConverter Methods | Edit this page View Source Convert(object, object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description object value object parameter Returns Type Description object Implements DynamicStatusBar.IValueConverter"
  },
  "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.DynamicStatusBar.html",
    "title": "Class DynamicStatusBar",
    "keywords": "Class DynamicStatusBar Inheritance object Scenario DynamicStatusBar Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Dynamic StatusBar\", \"Demonstrates how to add and remove a StatusBar and change items dynamically.\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] public class DynamicStatusBar : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Editor.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Editor.html",
    "title": "Class Editor",
    "keywords": "Class Editor Inheritance object Scenario Editor Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Editor\", \"A Text Editor using the TextView control.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Dialogs\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] [Scenario.ScenarioCategory(\"Files and IO\")] [Scenario.ScenarioCategory(\"TextView\")] public class Editor : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.GraphViewExample.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.GraphViewExample.html",
    "title": "Class GraphViewExample",
    "keywords": "Class GraphViewExample Inheritance object Scenario GraphViewExample Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Graph View\", \"Demos the GraphView control.\")] [Scenario.ScenarioCategory(\"Controls\")] public class GraphViewExample : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.HexEditor.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.HexEditor.html",
    "title": "Class HexEditor",
    "keywords": "Class HexEditor Inheritance object Scenario HexEditor Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"HexEditor\", \"A binary (hex) editor using the HexView control.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Dialogs\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] [Scenario.ScenarioCategory(\"Files and IO\")] public class HexEditor : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.InteractiveTree.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.InteractiveTree.html",
    "title": "Class InteractiveTree",
    "keywords": "Class InteractiveTree Inheritance object Scenario InteractiveTree Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Interactive Tree\", \"Create nodes and child nodes in TreeView.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"TreeView\")] public class InteractiveTree : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.InvertColors.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.InvertColors.html",
    "title": "Class InvertColors",
    "keywords": "Class InvertColors Inheritance object Scenario InvertColors Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Invert Colors\", \"Invert the foreground and the background colors.\")] [Scenario.ScenarioCategory(\"Colors\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] public class InvertColors : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Keys.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Keys.html",
    "title": "Class Keys",
    "keywords": "Class Keys Inheritance object Scenario Keys Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Keys\", \"Shows how to handle keyboard input\")] [Scenario.ScenarioCategory(\"Mouse and Keyboard\")] public class Keys : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.LabelsAsLabels.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.LabelsAsLabels.html",
    "title": "Class LabelsAsLabels",
    "keywords": "Class LabelsAsLabels Inheritance object Scenario LabelsAsLabels Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Labels As Buttons\", \"Illustrates that Button is really just a Label++\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Proof of Concept\")] public class LabelsAsLabels : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.LineDrawing.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.LineDrawing.html",
    "title": "Class LineDrawing",
    "keywords": "Class LineDrawing Inheritance object Scenario LineDrawing Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Line Drawing\", \"Demonstrates LineCanvas.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Layout\")] public class LineDrawing : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.LineViewExample.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.LineViewExample.html",
    "title": "Class LineViewExample",
    "keywords": "Class LineViewExample Inheritance object Scenario LineViewExample Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Line View\", \"Demonstrates drawing lines using the LineView control.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"LineView\")] public class LineViewExample : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ListViewWithSelection.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ListViewWithSelection.html",
    "title": "Class ListViewWithSelection",
    "keywords": "Class ListViewWithSelection Inheritance object Scenario ListViewWithSelection Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"List View With Selection\", \"ListView with columns and selection\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"ListView\")] public class ListViewWithSelection : Scenario, IDisposable Fields | Edit this page View Source _allowMarkingCB Declaration public CheckBox _allowMarkingCB Field Value Type Description CheckBox | Edit this page View Source _allowMultipleCB Declaration public CheckBox _allowMultipleCB Field Value Type Description CheckBox | Edit this page View Source _customRenderCB Declaration public CheckBox _customRenderCB Field Value Type Description CheckBox | Edit this page View Source _listView Declaration public ListView _listView Field Value Type Description ListView | Edit this page View Source _scenarios Declaration public List<Scenario> _scenarios Field Value Type Description List<Scenario> Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ListsAndCombos.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ListsAndCombos.html",
    "title": "Class ListsAndCombos",
    "keywords": "Class ListsAndCombos Inheritance object Scenario ListsAndCombos Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"ListView & ComboBox\", \"Demonstrates a ListView populating a ComboBox that acts as a filter.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"ListView\")] [Scenario.ScenarioCategory(\"ComboBox\")] public class ListsAndCombos : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.MdiChildWindowClass.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.MdiChildWindowClass.html",
    "title": "Class MdiChildWindowClass",
    "keywords": "Class MdiChildWindowClass Inheritance object Responder View Toplevel Window MdiChildWindowClass Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class MdiChildWindowClass : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source MdiChildWindowClass() Declaration public MdiChildWindowClass() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.MessageBoxes.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.MessageBoxes.html",
    "title": "Class MessageBoxes",
    "keywords": "Class MessageBoxes Inheritance object Scenario MessageBoxes Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"MessageBoxes\", \"Demonstrates how to use the MessageBox class.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Dialogs\")] public class MessageBoxes : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Mouse.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Mouse.html",
    "title": "Class Mouse",
    "keywords": "Class Mouse Inheritance object Scenario Mouse Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Mouse\", \"Demonstrates how to capture mouse events\")] [Scenario.ScenarioCategory(\"Mouse and Keyboard\")] public class Mouse : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.MultiColouredTable.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.MultiColouredTable.html",
    "title": "Class MultiColouredTable",
    "keywords": "Class MultiColouredTable Inheritance object Scenario MultiColouredTable Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"MultiColouredTable\", \"Demonstrates how to multi color cell contents.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Colors\")] [Scenario.ScenarioCategory(\"TableView\")] public class MultiColouredTable : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.MyScenario.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.MyScenario.html",
    "title": "Class MyScenario",
    "keywords": "Class MyScenario Inheritance object Scenario MyScenario Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Generic\", \"Generic sample - A template for creating new Scenarios\")] [Scenario.ScenarioCategory(\"Controls\")] public class MyScenario : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Notepad.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Notepad.html",
    "title": "Class Notepad",
    "keywords": "Class Notepad Inheritance object Scenario Notepad Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Notepad\", \"Multi-tab text editor uising the TabView control.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"TabView\")] public class Notepad : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Save() Declaration public void Save() | Edit this page View Source Save(Tab) Declaration public void Save(TabView.Tab tabToSave) Parameters Type Name Description TabView.Tab tabToSave | Edit this page View Source SaveAs() Declaration public bool SaveAs() Returns Type Description bool | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ParentWindowClass.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ParentWindowClass.html",
    "title": "Class ParentWindowClass",
    "keywords": "Class ParentWindowClass Inheritance object Responder View Toplevel Window ParentWindowClass Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class ParentWindowClass : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ParentWindowClass() Declaration public ParentWindowClass() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.ParentWindowMdiContainerClass.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ParentWindowMdiContainerClass.html",
    "title": "Class ParentWindowMdiContainerClass",
    "keywords": "Class ParentWindowMdiContainerClass Inheritance object Responder View Toplevel Window ParentWindowMdiContainerClass Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class ParentWindowMdiContainerClass : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ParentWindowMdiContainerClass() Declaration public ParentWindowMdiContainerClass() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.Progress.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Progress.html",
    "title": "Class Progress",
    "keywords": "Class Progress Inheritance object Scenario Progress Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Progress\", \"Shows off ProgressBar and Threading.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Threading\")] [Scenario.ScenarioCategory(\"ProgressBar\")] public class Progress : Scenario, IDisposable Methods | Edit this page View Source Dispose(bool) Declaration protected override void Dispose(bool disposing) Parameters Type Name Description bool disposing Overrides Scenario.Dispose(bool) | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.ProgressBarStyles.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.ProgressBarStyles.html",
    "title": "Class ProgressBarStyles",
    "keywords": "Class ProgressBarStyles Inheritance object Scenario ProgressBarStyles Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"ProgressBar Styles\", \"Shows the ProgressBar Styles.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"ProgressBar\")] [Scenario.ScenarioCategory(\"Threading\")] public class ProgressBarStyles : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.RunTExample.ExampleWindow.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.RunTExample.ExampleWindow.html",
    "title": "Class RunTExample.ExampleWindow",
    "keywords": "Class RunTExample.ExampleWindow Inheritance object Responder View Toplevel Window RunTExample.ExampleWindow Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class RunTExample.ExampleWindow : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source ExampleWindow() Declaration public ExampleWindow() Fields | Edit this page View Source usernameText Declaration public TextField usernameText Field Value Type Description TextField Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.RunTExample.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.RunTExample.html",
    "title": "Class RunTExample",
    "keywords": "Class RunTExample Inheritance object Scenario RunTExample Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Run<T> Example\", \"Illustrates using Application.Run<T> to run a custom class\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] public class RunTExample : Scenario, IDisposable Methods | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.RuneWidthGreaterThanOne.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.RuneWidthGreaterThanOne.html",
    "title": "Class RuneWidthGreaterThanOne",
    "keywords": "Class RuneWidthGreaterThanOne Inheritance object Scenario RuneWidthGreaterThanOne Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"RuneWidthGreaterThanOne\", \"Test rune width greater than one\")] [Scenario.ScenarioCategory(\"Controls\")] public class RuneWidthGreaterThanOne : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Scrolling.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Scrolling.html",
    "title": "Class Scrolling",
    "keywords": "Class Scrolling Inheritance object Scenario Scrolling Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Scrolling\", \"Demonstrates ScrollView etc...\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"ScrollView\")] public class Scrolling : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.SendKeys.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.SendKeys.html",
    "title": "Class SendKeys",
    "keywords": "Class SendKeys Inheritance object Scenario SendKeys Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"SendKeys\", \"SendKeys sample - Send key combinations.\")] [Scenario.ScenarioCategory(\"Mouse and Keyboard\")] public class SendKeys : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.MainApp.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.MainApp.html",
    "title": "Class SingleBackgroundWorker.MainApp",
    "keywords": "Class SingleBackgroundWorker.MainApp Inheritance object Responder View Toplevel SingleBackgroundWorker.MainApp Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.Add(View) Toplevel.Remove(View) Toplevel.RemoveAll() Toplevel.PositionToplevel(Toplevel) Toplevel.Redraw(Rect) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.Border View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class SingleBackgroundWorker.MainApp : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source MainApp() Declaration public MainApp() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.StagingUIController.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.StagingUIController.html",
    "title": "Class SingleBackgroundWorker.StagingUIController",
    "keywords": "Class SingleBackgroundWorker.StagingUIController Inheritance object Responder View Toplevel Window SingleBackgroundWorker.StagingUIController Implements IDisposable ISupportInitializeNotification ISupportInitialize Inherited Members Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Resized Toplevel.OnLoaded() Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessHotKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, string[]) Toplevel.ShowChild(Toplevel) Toplevel.OnEnter(View) Toplevel.OnLeave(View) Toplevel.Dispose(bool) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.ForceValidatePosDim View.GetMinWidthHeight(out Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() View.SetNeedsDisplay() View.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() View.Add(params View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(int, int) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, int, bool) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, bool, ColorScheme) View.Move(int, int, bool) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(int, int, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, params Command[]) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(params Command[]) View.AddCommand(Command, Func<bool?>) View.GetSupportedCommands() View.GetKeyFromCommand(params Command[]) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.ClearOnVisibleFalse View.Visible View.IgnoreBorderPropertyOnRedraw View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(bool) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(int, out int) View.SetHeight(int, out int) View.GetCurrentWidth(out int) View.GetCurrentHeight(out int) View.GetNormalColor() View.GetFocusColor() View.GetHotNormalColor() View.GetTopSuperView() Responder.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax public class SingleBackgroundWorker.StagingUIController : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors | Edit this page View Source StagingUIController(DateTime?, List<string>) Declaration public StagingUIController(DateTime? start, List<string> list) Parameters Type Name Description DateTime? start List<string> list Methods | Edit this page View Source Load() Declaration public void Load() Implements IDisposable ISupportInitializeNotification ISupportInitialize"
  },
  "api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.SingleBackgroundWorker.html",
    "title": "Class SingleBackgroundWorker",
    "keywords": "Class SingleBackgroundWorker Inheritance object Scenario SingleBackgroundWorker Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Single BackgroundWorker\", \"A single BackgroundWorker threading opening another Toplevel\")] [Scenario.ScenarioCategory(\"Threading\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] public class SingleBackgroundWorker : Scenario, IDisposable Methods | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Snake.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Snake.html",
    "title": "Class Snake",
    "keywords": "Class Snake Inheritance object Scenario Snake Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Snake\", \"The game of apple eating.\")] [Scenario.ScenarioCategory(\"Colors\")] public class Snake : Scenario, IDisposable Methods | Edit this page View Source Dispose(bool) Declaration protected override void Dispose(bool disposing) Parameters Type Name Description bool disposing Overrides Scenario.Dispose(bool) | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.SyntaxHighlighting.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.SyntaxHighlighting.html",
    "title": "Class SyntaxHighlighting",
    "keywords": "Class SyntaxHighlighting Inheritance object Scenario SyntaxHighlighting Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Syntax Highlighting\", \"Text editor with keyword highlighting using the TextView control.\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"TextView\")] public class SyntaxHighlighting : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TabViewExample.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TabViewExample.html",
    "title": "Class TabViewExample",
    "keywords": "Class TabViewExample Inheritance object Scenario TabViewExample Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Tab View\", \"Demos TabView control with limited screen space in Absolute layout.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"TabView\")] public class TabViewExample : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TableEditor.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TableEditor.html",
    "title": "Class TableEditor",
    "keywords": "Class TableEditor Inheritance object Scenario TableEditor Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"TableEditor\", \"Implements data table editor using the TableView control.\")] [Scenario.ScenarioCategory(\"TableView\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Dialogs\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] public class TableEditor : Scenario, IDisposable Methods | Edit this page View Source BuildDemoDataTable(int, int) Generates a new demo DataTable with the given number of cols (min 5) and rows Declaration public static DataTable BuildDemoDataTable(int cols, int rows) Parameters Type Name Description int cols int rows Returns Type Description DataTable | Edit this page View Source BuildSimpleDataTable(int, int) Builds a simple table in which cell values contents are the index of the cell. This helps testing that scrolling etc is working correctly and not skipping out any rows/columns when paging Declaration public static DataTable BuildSimpleDataTable(int cols, int rows) Parameters Type Name Description int cols int rows Returns Type Description DataTable | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Text.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Text.html",
    "title": "Class Text",
    "keywords": "Class Text Inheritance object Scenario Text Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Text Input Controls\", \"Tests all text input controls\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Mouse and Keyboard\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] public class Text : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TextAlignments.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TextAlignments.html",
    "title": "Class TextAlignments",
    "keywords": "Class TextAlignments Inheritance object Scenario TextAlignments Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Simple Text Alignment\", \"Demonstrates horizontal text alignment\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] public class TextAlignments : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TextAlignmentsAndDirections.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TextAlignmentsAndDirections.html",
    "title": "Class TextAlignmentsAndDirections",
    "keywords": "Class TextAlignmentsAndDirections Inheritance object Scenario TextAlignmentsAndDirections Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Text Alignment and Direction\", \"Demos horiztonal and vertical text alignment and text direction.\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] public class TextAlignmentsAndDirections : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TextFormatterDemo.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TextFormatterDemo.html",
    "title": "Class TextFormatterDemo",
    "keywords": "Class TextFormatterDemo Inheritance object Scenario TextFormatterDemo Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"TextFormatter Demo\", \"Demos and tests the TextFormatter class.\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] public class TextFormatterDemo : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TextViewAutocompletePopup.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TextViewAutocompletePopup.html",
    "title": "Class TextViewAutocompletePopup",
    "keywords": "Class TextViewAutocompletePopup Inheritance object Scenario TextViewAutocompletePopup Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"TextView Autocomplete Popup\", \"Shows five TextView Autocomplete Popup effects\")] [Scenario.ScenarioCategory(\"TextView\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"Mouse and Keyboard\")] public class TextViewAutocompletePopup : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Threading.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Threading.html",
    "title": "Class Threading",
    "keywords": "Class Threading Inheritance object Scenario Threading Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Threading\", \"Demonstration of how to use threading in different ways\")] [Scenario.ScenarioCategory(\"Threading\")] public class Threading : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TimeAndDate.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TimeAndDate.html",
    "title": "Class TimeAndDate",
    "keywords": "Class TimeAndDate Inheritance object Scenario TimeAndDate Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Time And Date\", \"Illustrates TimeField and time & date handling\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"DateTime\")] public class TimeAndDate : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TreeUseCases.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TreeUseCases.html",
    "title": "Class TreeUseCases",
    "keywords": "Class TreeUseCases Inheritance object Scenario TreeUseCases Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Tree View\", \"Simple tree view examples.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"TreeView\")] public class TreeUseCases : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.TreeViewFileSystem.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.TreeViewFileSystem.html",
    "title": "Class TreeViewFileSystem",
    "keywords": "Class TreeViewFileSystem Inheritance object Scenario TreeViewFileSystem Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"File System Explorer\", \"Hierarchical file system explorer demonstrating TreeView.\")] [Scenario.ScenarioCategory(\"Controls\")] [Scenario.ScenarioCategory(\"TreeView\")] [Scenario.ScenarioCategory(\"Files and IO\")] public class TreeViewFileSystem : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.UnicodeInMenu.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.UnicodeInMenu.html",
    "title": "Class UnicodeInMenu",
    "keywords": "Class UnicodeInMenu Inheritance object Scenario UnicodeInMenu Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Unicode\", \"Tries to test Unicode in all controls (#204)\")] [Scenario.ScenarioCategory(\"Text and Formatting\")] [Scenario.ScenarioCategory(\"Controls\")] public class UnicodeInMenu : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.VkeyPacketSimulator.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.VkeyPacketSimulator.html",
    "title": "Class VkeyPacketSimulator",
    "keywords": "Class VkeyPacketSimulator Inheritance object Scenario VkeyPacketSimulator Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"VkeyPacketSimulator\", \"Simulates the Virtual Key Packet\")] [Scenario.ScenarioCategory(\"Mouse and Keyboard\")] public class VkeyPacketSimulator : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.WindowsAndFrameViews.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.WindowsAndFrameViews.html",
    "title": "Class WindowsAndFrameViews",
    "keywords": "Class WindowsAndFrameViews Inheritance object Scenario WindowsAndFrameViews Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Windows & FrameViews\", \"Stress Tests Windows, sub-Windows, and FrameViews.\")] [Scenario.ScenarioCategory(\"Layout\")] public class WindowsAndFrameViews : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.WizardAsView.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.WizardAsView.html",
    "title": "Class WizardAsView",
    "keywords": "Class WizardAsView Inheritance object Scenario WizardAsView Implements IDisposable Inherited Members Scenario.Win Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Setup() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"WizardAsView\", \"Shows using the Wizard class in an non-modal way\")] [Scenario.ScenarioCategory(\"Wizards\")] public class WizardAsView : Scenario, IDisposable Methods | Edit this page View Source Init(ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override Init(ColorScheme) to provide any Toplevel behavior needed. Declaration public override void Init(ColorScheme colorScheme) Parameters Type Name Description ColorScheme colorScheme The colorscheme to use. Overrides Scenario.Init(ColorScheme) Remarks The base implementation calls Init(ConsoleDriver, IMainLoopDriver) and creates a Window for Win and adds it to Top. Overrides that do not call the base.Run(), must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. | Edit this page View Source Run() Runs the Scenario. Override to start the Scenario using a Toplevel different than Top. Declaration public override void Run() Overrides Scenario.Run() Remarks Overrides that do not call the base.Run(), must call Shutdown() before returning. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.Wizards.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.Wizards.html",
    "title": "Class Wizards",
    "keywords": "Class Wizards Inheritance object Scenario Wizards Implements IDisposable Inherited Members Scenario.Win Scenario.Init(ColorScheme) Scenario.GetName() Scenario.GetDescription() Scenario.GetCategories() Scenario.ToString() Scenario.Run() Scenario.RequestStop() Scenario.GetScenarios() Scenario.Dispose(bool) Scenario.Dispose() object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) Namespace: UICatalog.Scenarios Assembly: UICatalog.dll Syntax [Scenario.ScenarioMetadata(\"Wizards\", \"Demonstrates the Wizard class\")] [Scenario.ScenarioCategory(\"Dialogs\")] [Scenario.ScenarioCategory(\"Top Level Windows\")] [Scenario.ScenarioCategory(\"Wizards\")] public class Wizards : Scenario, IDisposable Methods | Edit this page View Source Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public override void Setup() Overrides Scenario.Setup() Remarks This is typically the best place to put scenario logic code. Implements IDisposable"
  },
  "api/UICatalog/UICatalog.Scenarios.html": {
    "href": "api/UICatalog/UICatalog.Scenarios.html",
    "title": "Namespace UICatalog.Scenarios",
    "keywords": "Namespace UICatalog.Scenarios Classes ASCIICustomButtonTest ASCIICustomButtonTest.ASCIICustomButton ASCIICustomButtonTest.ScrollViewTestWindow AllViewsTester Animation Animation.BitmapToBraille Renders an image as unicode Braille. AutoSizeAndDirectionText BackgroundWorkerCollection BasicColors Borders BordersComparisons BordersOnFrameView BordersOnToplevel BordersOnWindow Buttons CenteredWindowInsideMdiContainerWindow CenteredWindowInsideWindow CharacterMap This Scenario demonstrates building a custom control (a class deriving from View) that: Provides a \"Character Map\" application (like Windows' charmap.exe). Helps test unicode character rendering in Terminal.Gui Illustrates how to use ScrollView to do infinite scrolling ChildWindowClass ClassExplorer Clipping CollectionNavigatorTester ColorPickers ComboBoxIteration ComputedLayout This Scenario demonstrates how to use Termina.gui's Dim and Pos Layout System. [x] - Using Dim.Fill to fill a window [x] - Using Dim.Fill and Dim.Pos to automatically align controls based on an initial control [ ] - ... ContextMenus CsvEditor Dialogs DynamicMenuBar DynamicMenuBar.Binding DynamicMenuBar.DynamicMenuBarDetails DynamicMenuBar.DynamicMenuBarSample DynamicMenuBar.DynamicMenuItem DynamicMenuBar.DynamicMenuItemList DynamicMenuBar.DynamicMenuItemModel DynamicMenuBar.ListWrapperConverter DynamicMenuBar.UStringValueConverter DynamicStatusBar DynamicStatusBar.Binding DynamicStatusBar.DynamicStatusBarDetails DynamicStatusBar.DynamicStatusBarSample DynamicStatusBar.DynamicStatusItem DynamicStatusBar.DynamicStatusItemList DynamicStatusBar.DynamicStatusItemModel DynamicStatusBar.ListWrapperConverter DynamicStatusBar.UStringValueConverter Editor GraphViewExample HexEditor InteractiveTree InvertColors Keys LabelsAsLabels LineDrawing LineViewExample ListViewWithSelection ListsAndCombos MdiChildWindowClass MessageBoxes Mouse MultiColouredTable MyScenario Notepad ParentWindowClass ParentWindowMdiContainerClass Progress ProgressBarStyles RunTExample RunTExample.ExampleWindow RuneWidthGreaterThanOne Scrolling SendKeys SingleBackgroundWorker SingleBackgroundWorker.MainApp SingleBackgroundWorker.StagingUIController Snake SyntaxHighlighting TabViewExample TableEditor Text TextAlignments TextAlignmentsAndDirections TextFormatterDemo TextViewAutocompletePopup Threading TimeAndDate TreeUseCases TreeViewFileSystem UnicodeInMenu VkeyPacketSimulator WindowsAndFrameViews WizardAsView Wizards Interfaces DynamicMenuBar.IValueConverter DynamicStatusBar.IValueConverter"
  },
  "api/UICatalog/UICatalog.html": {
    "href": "api/UICatalog/UICatalog.html",
    "title": "Namespace UICatalog",
    "keywords": "Namespace UICatalog Classes NumberToWords Scenario Base class for each demo/scenario. To define a new scenario: Create a new .cs file in the Scenarios directory that derives from Scenario. Annotate the Scenario derived class with a Scenario.ScenarioMetadata attribute specifying the scenario's name and description. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the scenario belongs to. If you don't specify a category the scenario will show up in \"_All\". Implement the Setup() override which will be called when a user selects the scenario to run. Optionally, implement the Init(Toplevel, ColorScheme) and/or Run() overrides to provide a custom implementation. The UI Catalog program uses reflection to find all scenarios and adds them to the ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / Scenario.ScenarioCategory Defines the category names used to catagorize a Scenario Scenario.ScenarioMetadata Defines the metadata (Name and Description) for a Scenario"
  },
  "index.html": {
    "href": "index.html",
    "title": "Terminal.Gui - Cross Platform Terminal UI toolkit for .NET",
    "keywords": "Terminal.Gui - Cross Platform Terminal UI toolkit for .NET These are the v1 API docs. The v2 API docs are here. A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. Terminal.Gui Project on GitHub Terminal.Gui API Documentation API Reference Views and controls built into the Terminal.Gui library Terminal.Gui API Overview Keyboard Event Processing Event Processing and the Application Main Loop Cross-platform Driver Model TableView Deep Dive TreeView Deep Dive UI Catalog UI Catalog is a comprehensive sample library for Terminal.Gui. It provides a simple UI for adding to the catalog of scenarios. UI Catalog API Reference UI Catalog Source"
  }
}