TCustomRichView.AddTextNL, AddTextNLA, AddTextNLW

<< Click to display table of contents >>

TCustomRichView.AddTextNL, AddTextNLA, AddTextNLW

These methods add one or more text lines to the end of document.

procedure AddTextNL(const s: String;
  StyleNo, FirstParaNo, OtherParaNo: Integer;
  AsSingleParagraph: Boolean = False;
  const Tag: TRVTag = RVEMPTYTAG);
procedure AddTextNLA(const s: TRVAnsiString;
  StyleNo, FirstParaNo, OtherParaNo: Integer;
  AsSingleParagraph: Boolean = False; 
  const Tag: TRVTag = RVEMPTYTAG;
  CodePage: TRVCodePage = CP_ACP);
procedure AddTextNLW(const S: TRVUnicodeString;
  StyleNo, FirstParaNo, OtherParaNo: Integer;
  DefAsSingleParagraph: Boolean = False;
  const Tag: TRVTag = RVEMPTYTAG);

(changed in version 18)

Parameters:

s is a text string to add. It may contain special characters:CR, LF, TAB, FF (#13, #10, #9, #12). #9 characters may be inserted as tabulators, depending on value of SpacesInTab property of the linked RVStyle component. #12 characters add page breaks. All possible line breaks modes (CR, LF, CR+LF, LF+CR) are supported.

StyleNo is an index in the TextStyles collection of the linked RVStyle component, or rvsDefStyle constant. It defines font attributes for the text.

If ParaNo=-1, the method adds the first line of text to the end of the last paragraph. If ParaNo>=0, this item starts a new paragraph using attributes defined in Style.ParaStyles[ParaNo].

OtherParaNo defines paragraph attributes for the subsequent lines of text. Must be >=0.

DefAsSingleParagraph: If False, AddTextNLW uses the current add-paragraph mode (see SetAddParagraphMode). If True, it treats #13 and #10 as line breaks, not paragraph breaks. WideChar($2029) ("paragraph separator") always initiates a new paragraph. WideChar($2028) ("line separator") always initiates a new line.

AsSingleParagraph: If False, AddTextNLA uses the current add-paragraph mode (see SetAddParagraphMode). If True, it treats #13 and #10 as line breaks, not paragraph breaks.

Tag – tag of this picture item.

AddTextNLW supports the Unicode byte order marks characters (if it's present, it must be the first character in s).

 

Methods type: viewerstyle viewer-style.

unicode Unicode notes:

Internally, text is stored as Unicode. AddTextNLA converts ANSI string to Unicode using CodePage.

If CodePage = CP_ACP, Style.DefCodePage is used instead.

AddTextNL works:

▪like AddTextNLA, in Delphi 2007 and older

▪like AddTextNLW, in Delphi 2009 and newer

▪with UTF-8 string, in Lazarus

If style templates are used, the component may automatically change text style indexes of text items, to provide a consistency of text and paragraph style templates.

See also methods:

▪AddNL and others;

▪AddTab;

▪LoadText, LoadTextW;

▪LoadTextFromStream, LoadTextFromStreamW;

▪Format;

▪FormatTail;

▪SetAddParagraphMode.

See also methods of TRichViewEdit:

▪InsertText, -A, -W.

See also properties of TRVStyle:

▪TextStyles;

▪SpacesInTab.

See also:

▪Other methods for appending items;

▪Unicode in RichView;

▪Example how to load UTF-8 files.