Class FrameView
The FrameView is a container frame that draws a frame around the contents. It is similar to
a GroupBox in Windows.
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class FrameView : ViewConstructors
FrameView()
Declaration
public FrameView()FrameView(ustring, Border)
Declaration
public FrameView(ustring title, Border border = null)Parameters
| Type | Name | Description |
|---|---|---|
| NStack.ustring | title | Title. |
| Border | border | The Border. |
FrameView(Rect, ustring, View[], Border)
Declaration
public FrameView(Rect frame, ustring title = null, View[] views = null, Border border = null)Parameters
| Type | Name | Description |
|---|---|---|
| Rect | frame | Frame. |
| NStack.ustring | title | Title. |
| View[] | views | Views. |
| Border | border | The Border. |
Properties
Border
Declaration
public override Border Border { get; set; }Property Value
| Type | Description |
|---|---|
| Border |
Overrides
Text
The text displayed by the Label.
Declaration
public override ustring Text { get; set; }Property Value
| Type | Description |
|---|---|
| NStack.ustring |
Overrides
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
Title
The title to be displayed for this FrameView.
Declaration
public ustring Title { get; set; }Property Value
| Type | Description |
|---|---|
| NStack.ustring | The title. |
Methods
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
OnCanFocusChanged()
Method invoked when the CanFocus property from a view is changed.
Declaration
public override void OnCanFocusChanged()Overrides
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 |
|---|---|
| System.Boolean | true, if the event was handled, false otherwise. |
Overrides
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
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 region parameter.
Remove(View)
Removes a View from this container.
Declaration
public override void Remove(View view)Parameters
| Type | Name | Description |
|---|---|---|
| View | view |
Overrides
Remarks
RemoveAll()
Removes all Views from this container.
Declaration
public override void RemoveAll()Overrides
Remarks
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize