Table of Contents

Class CharMap

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

A scrollable map of the Unicode codepoints.

public class CharMap : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IDesignable, IValue<Rune>, IValue
Inheritance
CharMap
Implements
Inherited Members
Extension Methods

Remarks

Default key bindings:

KeyAction
Left / RightMoves one codepoint left or right.
Up / DownMoves one row up or down.
PageUp / PageDownMoves one page up or down.
Home / EndMoves to the first or last codepoint.

Default mouse bindings:

Mouse EventAction
ClickSelects the clicked codepoint (Activate).
Double-ClickAccepts the clicked codepoint (Accept).
Right-Click / Ctrl+ClickOpens the context menu.
Wheel Up / Down / Left / RightScrolls the map.

Constructors

CharMap()

Initializes a new instance.

Properties

DefaultCursorStyle

Gets or sets the default cursor style.

SelectedCodePoint

Gets or sets the currently selected codepoint. Causes the Viewport to scroll to make the selected code point visible.

ShowGlyphWidths

Gets or sets whether the number of columns each glyph is displayed.

ShowUnicodeCategory

When set, only glyphs whose UnicodeCategory matches the value are rendered. If null (default), all glyphs are rendered.

StartCodePoint

Specifies the starting offset for the character map. The default is 0x2500 which is the Box Drawing characters.

Value

Gets or sets the value.

Methods

OnAccepted(ICommandContext?)

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

OnActivated(ICommandContext?)

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

OnDrawingContent(DrawContext?)

Called when the View's content is to be drawn. The default implementation does nothing.

OnValueChanged(ValueChangedEventArgs<Rune>)

Called when the CharMap Value has changed.

OnValueChanging(ValueChangingEventArgs<Rune>)

Called when the CharMap Value is changing.

ToCamelCase(string)

Helper to convert a string into camel case.

Events

ValueChanged

Raised when Value has changed.

ValueChangedUntyped

Raised when Value has changed, providing the value as an un-typed object.

ValueChanging

Raised when Value is about to change. Set Handled to true to cancel the change.