Class SubPad

Represents a Curses sub-pad and contains all it's functionality.

Inheritance
object
Surface
SubPad
Implements
Inherited Members
Namespace: Sharpie
Assembly: sharpie.dll
Syntax
[PublicAPI]
public sealed class SubPad : Surface, IDisposable, ISubPad, ISurface, IDrawSurface

Properties

Location

Gets or sets the location of the sub-pad within its parent pad.

Declaration
public Point Location { get; set; }
Property Value
Type Description
Point
Remarks

This operation is not thread safe.

Exceptions
Type Condition
ArgumentOutOfRangeException

The value is outside the parent's bounds.
ObjectDisposedException

Sub-pad is no longer usable.
CursesSynchronizationException

Thrown if this operation was expected to run on the main thread/context but wasn't.
CursesOperationException

A Curses error occurred.

Origin

Returns the value of Location.

Declaration
protected override Point Origin { get; }
Property Value
Type Description
Point
Overrides
Exceptions
Type Condition
CursesOperationException

A Curses error occurred.

Pad

The parent pad of this sub-pad.

Declaration
public Pad Pad { get; }
Property Value
Type Description
Pad

Size

Gets or sets the size of the sub-pad.

Declaration
public Size Size { get; set; }
Property Value
Type Description
Size
Remarks

This operation is not thread safe.

Exceptions
Type Condition
ArgumentOutOfRangeException

The value is outside the bounds.
ObjectDisposedException

Sub-pad is no longer usable.
CursesSynchronizationException

Thrown if this operation was expected to run on the main thread/context but wasn't.
CursesOperationException

A Curses error occurred.

Methods

AssertSynchronized()

Asserts that executing thread is bound to the correct synchronization context.

Declaration
protected override void AssertSynchronized()
Overrides
Exceptions
Type Condition
CursesSynchronizationException

Thrown if current thread is not bound to the correct context.

Delete()

Deletes the surface from the curses backend.

Declaration
protected override void Delete()
Overrides

Duplicate()

Duplicates and existing sub-pad, including its attributes.

Declaration
public ISubPad Duplicate()
Returns
Type Description
ISubPad

A new sub-pad object.
Remarks

This operation is not thread safe.

Exceptions
Type Condition
ObjectDisposedException

Sub-pad is no longer usable.
CursesSynchronizationException

Thrown if this operation was expected to run on the main thread/context but wasn't.
CursesOperationException

A Curses error occurred.

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

Implements