Table of Contents

Class FlagSelector

Namespace
Terminal.Gui.Views
Assembly
Terminal.Gui.dll

Provides a user interface for displaying and selecting non-mutually-exclusive flags from a provided dictionary. FlagSelector<TFlagsEnum> provides a type-safe version where a [Flags] enum can be provided.

public class FlagSelector : SelectorBase, IDisposable, ISupportInitializeNotification, ISupportInitialize, IOrientation, IValue<int?>, IValue, IDesignable
Inheritance
FlagSelector
Implements
Derived
FlagSelector<TFlagsEnum>
Inherited Members
Extension Methods

Remarks

FlagSelector demo

Constructors

FlagSelector()

Initializes a new instance of the FlagSelector class.

Properties

ActivateOnAccept

FlagSelector does not toggle on Enter — Enter only accepts.

ConsumeDispatch

Consumes: FlagSelector owns toggle semantics.

Value

Gets or sets the value of the selected flags.

Methods

CreateSubViews()

Creates the subviews for this selector.

EnableForDesign()

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

GetDemoKeyStrokes()

Returns a tuirec-format keystroke string for recording a demo GIF of this view. The string uses tuirec token syntax (e.g. "wait:500,Enter,wait:800,Escape"). This is a new API added in v2 to support automated documentation generation.

GetDispatchTarget(ICommandContext?)

Returns the dispatch target for composite command handling. Only dispatches for Activate commands — Accept should bubble normally.

OnActivated(ICommandContext?)

Called when the View has been activated. This is called after Accepting has been raised and not cancelled.

OnHandlingHotKey(CommandEventArgs)

Called when the View is handling the user pressing the View's HotKey. Set CommandEventArgs.Handled to true to indicate the event was handled and processing should stop.

OnSubViewAdded(View)

Called when a SubView has been added to this View.

UpdateChecked()

Called when the checked state of the checkboxes needs to be updated.