TextLayout Class

Represents one or more paragraphs of multi-formatted text. Provides text analysis and layout functionality.

Object Model

Syntax

'Declaration
 
Public Class TextLayout

public class TextLayout

Remarks

In the simplest scenario, these steps can be followed to render a text on a graphics object using TextLayout:

Create a new instance of the TextLayout class, or call Clear on an existing instance to clear its content.
Set the layout properties (such as MaxWidth, MaxHeight, MarginLeft etc.) to the desired values.
Use Append(String) and its overloads to add text and formatting to the TextLayout instance. Use DefaultFormat to specify the default formatting for text fragments that are added without an explicitly associated format.
Call RecalculateGlyphs to calculate the glyphs needed to render the text. This also performs the required shaping. (If the content is modified (e.g. new text added) after this step, it can/should be repeated to recalculate the glyphs.)
Call PerformLayout to layout the formatted paragraphs within the specified bounds. This step can be done multiple times to layout the text within different bounds.

Inheritance Hierarchy

System.Object
GrapeCity.Documents.Text.TextLayout