Parameters
text - The text value.
addIndent - Indicates if the element can be indented.
allowNewLine - Indicates if a new line can be added.
Returns
The potentially indented and wrapped new text value.
Syntax
| JavaScript |
|
GetText(text, addIndent = true, allowNewLine = true)
|
Gets the potentially indented and wrapped text.
Remarks
GetText() is a "Get Text" method. It creates and returns the potentially
indented and wrapped text. It will start the returned text with a new line
if the builder already has text.
The applied indent is the product of the class properties IndentCount
and IndentCharCount. (IndentCount * IndentCharCount).
The "addIndent" parameter defaults to true. Set it to false to prevent
indenting the line further.
The "allowNewLine" parameter defaults to true. Set it to false to prevent
starting with a new line.
Wraps the text with a newline if the WrapEnabled parameter is true and the
line length is greater than LineLimit.
Example
| JavaScript |
// Gets the potentially indented and wrapped text.
GetText()
{
const tb = new LJCTextBuilder();
tb.AddIndent();
// Example Method:
// Starts the text with a newline if the builder already has text, param
// allowNewLine = true and builder text does not end with a newline.
// The text begins with the current indent string if param
// addIndent = true.
let result = tb.GetText("First Line");
result += tb.GetText("This is some indented text.");
// result:
// " First Line This is some indented text."
}
|
Copyright © Lester J. Clark and Contributors.
Licensed under the MIT License.