Interface ISubPad

Describes the traits specific to the SubPad.

Inherited Members
Namespace: Sharpie.Abstractions
Assembly: sharpie.dll
Syntax
[PublicAPI]
public interface ISubPad : ISurface, IDrawSurface

Properties

Location

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

Declaration
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.

Pad

The parent pad of this sub-pad.

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

Size

Gets or sets the size of the sub-pad.

Declaration
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.

Methods

Duplicate()

Duplicates and existing sub-pad, including its attributes.

Declaration
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.