TRVListLevel.FormatString

<< Click to display table of contents >>

TRVListLevel.FormatString

Defines format for text list markers.

property FormatString: TRVUnicodeString;

This property is used for the following list types:

rvlstBullet,

rvlstDecimal,

rvlstDecimalLeadingZero,

rvlstLowerAlpha,

rvlstUpperAlpha,

rvlstLowerRoman,

rvlstUpperRoman,

rvlstLowerGreek.

For rvlstBullet list type, it completely defines a text to display.

For rvlstDecimal..rvlstUpperRoman, it defines how to display numbers. The actual string  = Format(FormatString, [CL0, CL1, ..., CLN])

where

CL0 - string containing value of counter of the 0-th level marker;

CL1 - ---------------------"" ------------------------------- 1st level marker;

...

CLN - string containing value of counter of this level marker.

Example1:

FormatString = '*' // no numbering

  * aaaaa

  * aaaaa

  * aaaaa

Example2:

For 0-th level: FormatString = '%s.', ListType=rvlstDecimal

For 1-th level: FormatString = '%s.%s.', ListType=rvlstDecimal

  1. aaaaa

  2. aaaaa

    2.1. aaaaa

    2.2. aaaaa

  3. aaaaa

The same result will be with '%0:s.' and '%0:s.%1:s.'

Example3:

For 0-th level: FormatString = 'Chapter %s.', ListType=rvlstDecimal

For 1-th level: FormatString = '%1:s)', ListType=rvlstLowerAlpha

  Chapter 1. aaaaa

  Chapter 2. aaaaa

    a) aaaaa

    b) aaaaa

  Chapter 3. aaaaa

The same result will be with 'Chapter %0:s.' and '%1:s)'

Default value:

· (#$00B7, middle dot)