Interface IScreenSurface

A screen object that has mouse input, surface, and render information.

Inherited Members
Namespace: SadConsole
Assembly: SadConsole.dll
Syntax
public interface IScreenSurface : IScreenObject, IPositionable, IComponentHost

Properties

AbsoluteArea

The pixel area on the screen this surface occupies.

Declaration
Rectangle AbsoluteArea { get; }
Property Value
Type Description
Rectangle

DefaultRendererName

The name of the default renderer for this object.

Declaration
string DefaultRendererName { get; }
Property Value
Type Description
string

FocusOnMouseClick

When true, this object will set IsFocused to true when the mouse is clicked.

Declaration
bool FocusOnMouseClick { get; set; }
Property Value
Type Description
bool

Font

Font used with rendering.

Declaration
IFont Font { get; set; }
Property Value
Type Description
IFont

FontSize

The size of the Font cells applied to the object when rendering.

Declaration
Point FontSize { get; set; }
Property Value
Type Description
Point

ForceRendererRefresh

When true, forces the Renderer to refresh the backing texture with the latest state of the object.

Declaration
bool ForceRendererRefresh { get; set; }
Property Value
Type Description
bool

HeightPixels

The height of the surface in pixels.

Declaration
int HeightPixels { get; }
Property Value
Type Description
int

IsDirty

Indicates the surface has changed and needs to be rendered.

Declaration
bool IsDirty { get; set; }
Property Value
Type Description
bool

MoveToFrontOnMouseClick

When true, this object will move to the front of its parent object when the mouse is clicked.

Declaration
bool MoveToFrontOnMouseClick { get; set; }
Property Value
Type Description
bool

Renderer

The renderer used to draw this surface.

Declaration
IRenderer? Renderer { get; }
Property Value
Type Description
IRenderer

Surface

The surface.

Declaration
ICellSurface Surface { get; }
Property Value
Type Description
ICellSurface

Tint

A tint used in rendering.

Declaration
Color Tint { get; set; }
Property Value
Type Description
Color

UsePixelPositioning

Treats the Position of the object as if it is pixels and not cells.

Declaration
bool UsePixelPositioning { get; set; }
Property Value
Type Description
bool

WidthPixels

The width of the surface in pixels.

Declaration
int WidthPixels { get; }
Property Value
Type Description
int

Events

MouseButtonClicked

Raised when a mouse button is clicked on this object.

Declaration
event EventHandler<MouseScreenObjectState> MouseButtonClicked
Event Type
Type Description
EventHandler<MouseScreenObjectState>

MouseEnter

Raised when the mouse enters this object.

Declaration
event EventHandler<MouseScreenObjectState> MouseEnter
Event Type
Type Description
EventHandler<MouseScreenObjectState>

MouseExit

Raised when the mouse exits this object.

Declaration
event EventHandler<MouseScreenObjectState> MouseExit
Event Type
Type Description
EventHandler<MouseScreenObjectState>

MouseMove

Raised when the mouse moves around the this object.

Declaration
event EventHandler<MouseScreenObjectState> MouseMove
Event Type
Type Description
EventHandler<MouseScreenObjectState>

Extension Methods