Unit 'WText' Package
[Overview][Classes][Index] [#fcl]

TTextWriter

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Plain text output writer with line wrapping and formatting support

Declaration

Source position: wtext.pp line 48

type TTextWriter = class(TFormattingWriter)

public

  constructor Create(); override;

  

Creates a new text writer instance

  destructor Destroy; override;

  

Destroys the text writer instance

  function EscapeText(); override;

  

Returns the input text unchanged

  procedure DocumentStart(); override;

  

Begins document output with title

  procedure DocumentEnd; override;

  

Completes document output

  procedure HeaderStart(); override;

  

Begins header section

  procedure HeaderEnd(); override;

  

Completes header section with underline

  procedure ParagraphStart; override;

  

Begins paragraph

  procedure ParagraphEnd; override;

  

Completes paragraph with blank line

  procedure LineBreak; override;

  

Forces line break

  procedure Rule; override;

  

Writes horizontal rule

  procedure BoldStart; override;

  

Begins bold formatting with asterisk

  procedure BoldEnd; override;

  

Ends bold formatting with asterisk

  procedure ItalicStart; override;

  

Begins italic formatting with underscore

  procedure ItalicEnd; override;

  

Ends italic formatting with underscore

  procedure UnderlineStart; override;

  

Begins underline formatting with underscore

  procedure UnderlineEnd; override;

  

Ends underline formatting with underscore

  procedure PreformatStart; override;

  

Begins preformatted text section

  procedure PreformatEnd; override;

  

Ends preformatted text section

  procedure TableStart(); override;

  

Begins ASCII table with specified columns

  procedure TableEnd; override;

  

Completes table output

  procedure RowStart; override;

  

Begins table row

  procedure RowEnd; override;

  

Completes table row with formatting

  procedure CellStart; override;

  

Begins table cell

  procedure CellEnd; override;

  

Completes table cell

  procedure HeaderCellStart; override;

  

Begins table header cell

  procedure HeaderCellEnd; override;

  

Completes table header cell

  procedure ListStart(); override;

  

Begins list with specified type

  procedure ListEnd(); override;

  

Completes list and reduces indentation

  procedure ListItemStart; override;

  

Begins list item with numbering or bullet

  procedure ListItemEnd; override;

  

Completes list item

  procedure ListItem();

  

Writes complete list item with text

  procedure DefinitionItem(); override;

  

Writes definition item with term and description

  procedure Write(); override;

  

Writes text with line wrapping

  property MaxLineLength: Integer; [rw]

  

Maximum line length for text wrapping

end;

Inheritance

TTextWriter

  

Plain text output writer with line wrapping and formatting support

|

TFormattingWriter

  

Abstract base class for formatted document writers

|

TObject

Description

TTextWriter generates plain text output from formatted content.

The writer supports automatic line wrapping at configurable line lengths, headers with underline characters (= for level 0-1, - for level 2+), ASCII-formatted tables with borders and column alignment, lists with numbered or bullet formatting, and preformatted text blocks with indentation.

Text formatting is rendered using asterisks for bold (*text*), underscores for italic and underline (_text_).

See also

TFormattingWriter


Documentation generated on: Mar 09 2026