ICellSurface Interface
Definition
Section titled “Definition”An array of ColoredGlyphBase objects used to represent a 2D surface.
public interface ICellSurface : IGridView<ColoredGlyphBase>, IEnumerable<ColoredGlyphBase>, IEnumerable, ISurfaceProperties
Section titled “Properties”TimesShiftedDown
Section titled “TimesShiftedDown”A variable that tracks how many times this editor shifted the surface down.
int TimesShiftedDown { get; set; }TimesShiftedRight
Section titled “TimesShiftedRight”A variable that tracks how many times this editor shifted the surface right.
int TimesShiftedRight { get; set; }TimesShiftedLeft
Section titled “TimesShiftedLeft”A variable that tracks how many times this editor shifted the surface left.
int TimesShiftedLeft { get; set; }TimesShiftedUp
Section titled “TimesShiftedUp”A variable that tracks how many times this editor shifted the surface up.
int TimesShiftedUp { get; set; }UsePrintProcessor
Section titled “UsePrintProcessor”When true, the Parser is used to generate a ColoredString before printing.
bool UsePrintProcessor { get; set; }Effects
Section titled “Effects”Processes the effects added to cells with CellSurfaceEditor.SetEffect*.
EffectsManager Effects { get; }Returns a rectangle that represents the entire size of the surface.
Rectangle Area { get; }DefaultBackground
Section titled “DefaultBackground”The default background for glyphs on this surface.
Color DefaultBackground { get; set; }DefaultForeground
Section titled “DefaultForeground”The default foreground for glyphs on this surface.
Color DefaultForeground { get; set; }DefaultGlyph
Section titled “DefaultGlyph”The default glyph used in clearing and erasing.
int DefaultGlyph { get; set; }IsDirty
Section titled “IsDirty”Indicates the surface has changed and needs to be rendered.
bool IsDirty { get; set; }IsScrollable
Section titled “IsScrollable”Returns true when the View width or height is different from Area; otherwise false.
bool IsScrollable { get; }The visible portion of the surface.
Rectangle View { get; set; }ViewHeight
Section titled “ViewHeight”Gets or sets the visible height of the surface in cells.
int ViewHeight { get; set; }ViewPosition
Section titled “ViewPosition”The position of the view within the buffer.
Point ViewPosition { get; set; }ViewWidth
Section titled “ViewWidth”Gets or sets the visible width of the surface in cells.
int ViewWidth { get; set; }ConnectedLineThin
Section titled “ConnectedLineThin”Glyph indexes for a thin line.
public static int[] ConnectedLineThin { get; }ConnectedLineThick
Section titled “ConnectedLineThick”Glyph indexes for a thick line.
public static int[] ConnectedLineThick { get; }Connected3dBox
Section titled “Connected3dBox”Glyph indexes for a block box that looks 3d.
public static int[] Connected3dBox { get; }ConnectedLineThinExtended
Section titled “ConnectedLineThinExtended”Glyph indexes for a thin line using a SadConsole extended font.
public static int[] ConnectedLineThinExtended { get; }ConnectedLineEmpty
Section titled “ConnectedLineEmpty”Glyph indexes for an empty line 0.
public static int[] ConnectedLineEmpty { get; }Methods
Section titled “Methods”CreateLine(int)
Section titled “CreateLine(int)”Creates an array of glyphs that can be used as a connected line.
public static int[] CreateLine(int singleGlyph)Parameters
Section titled “Parameters”singleGlyph int
The glyph to use for the connected line array.
Returns
Section titled “Returns”int[]
An array of glyphs.
ValidateLineStyle<T>(in T[])
Section titled “ValidateLineStyle<T>(in T[])”Returns a value that indicates a line style array is not null and contains the required number of elements.
public static bool ValidateLineStyle<T>(in T[] connectedLineStyle)Parameters
Section titled “Parameters”connectedLineStyle T[]
The array to check based on the ICellSurface.ConnectedLineIndex enum.
Returns
Section titled “Returns”bool
True when the line style is correct.
Events
Section titled “Events”IsDirtyChanged
Section titled “IsDirtyChanged”An event that is raised when IsDirty changes.
event EventHandler IsDirtyChanged