ANSI Functions

All ANSI related functions are mapped on the Ansi table. These functions are used to retrieve ANSI escape sequences to accomplish various tasks like moving the cursor, clearing/deleting characters and so on.

• Ansi.GetClearCharacters(chars)
• Ansi.GetCursorDown(lines)
• Ansi.GetCursorLeft(columns)
• Ansi.GetCursorMove(row, column)
• Ansi.GetCursorRight(columns)
• Ansi.GetCursorUp(lines)
• Ansi.GetDeleteLines(lines)
• Ansi.GetDeleteCharacters(chars)
• Ansi.GetInsertBlankLines(lines)
• Ansi.GetInsertCharacters(chars)

code = Ansi.GetClearCharacters(chars)

Returns a string with the ANSI escape sequence needed to clear 'chars' characters.

INPUT

• chars : How many charaters we have to clear

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetCursorDown(lines)

Return the escape sequence to move the cursor down <lines> lines.

INPUT

• lines : How many lines we want to move the cursor down

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetCursorLeft(columns)

Return the escape sequence to move the cursor left <columns> chars.

INPUT

• columns : How many columns we want to move the cursor to the left

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetCursorMove(row, column)

Return the escape sequence to move the cursor to (row, column).

INPUT

• row : Row position
• column : Column position

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetCursorRight(columns)

Return the escape sequence to move the cursor right <columns> chars.

INPUT

• columns : How many columns we want to move the cursor to the right

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetCursorUp(lines)

Return the escape sequence to move the cursor up <lines> lines.

INPUT

• lines : How many lines we want to move the cursor up

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetDeleteCharacters(chars)

Return the escape sequence to delete <chars> characters.

INPUT

• chars : How many charaters we have to delete

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetDeleteLines(lines)

Return the escape sequence to delete <lines> rows.

INPUT

• lines : How many lines we have to delete

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetInsertBlankLines(lines)

Return the escape sequence to insert <lines> blank rows.

INPUT

• lines : How many blank lines we have to insert

OUTPUT

• result : String with the requested ANSI escape sequence

code = Ansi.GetInsertCharacters(chars)

Return the escape sequence to insert <chars> characters.

INPUT

• chars : How many charaters we have to insert

OUTPUT

• result : String with the requested ANSI escape sequence