PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of docNumberingLevel variables
  • Adding a numbering description to a document
  • Adding a numbering level to a document
  • Using numberings created by programming
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
The docNumberingLevel type is used to define the advanced characteristics of a numbering level used in a Word Processing document. The characteristics of this numbering level can be defined and modified by several WLanguage properties.
This type is used by the docNumbering variables.
Note: See Declaring a variable for more details.
Caution: This type of variable is available from WINDEV version 220052s (module for updating the Word Processing control applicable on WINDEV Update 1).
Caution: This documentation presents the last features of the Word Processing control. Make sure that all the necessary modules are updated.
Example
MyDoc is Document = WP_NoName1
MyNumbering is docNumbering
Level is docNumberingLevel

// Define the numbering

// 1st numbering level
Level..Text = "%1) "
Level..Text = "%1) "
Level..InitialValue = 1
Level..PageLayout..IndentFirstLine = 10
Level..Format = numfRomanUppercase
Add(MyNumbering..Level, Level)

// Second numbering level
Level..Text = "%2] "
Level..InitialValue = 1
Level..PageLayout..IndentFirstLine = 20
Level..Format = numfUppercaseLetter
Add(MyNumbering..Level, Level)

// Third numbering level
Level..Text = "%3\ "
Level..InitialValue = 1
Level..PageLayout..IndentFirstLine = 30
Level..Format = numfLowercaseLetter
Add(MyNumbering..Level, Level)


// Add the numbering to the document
let id = Add(MyDoc..Numbering, MyNumbering)

// Define the numbering associated with paragraph 1
MyDoc..Paragraph[1]..Numbering..Identifier = id
MyDoc..Paragraph[1]..Numbering..Level = 1

// Display the document in the Word Processing control
WP_NoName1 = MyDoc
Remarks

Properties specific to the description of docNumberingLevel variables

The following properties can be used to handle a numbering level:
Property nameType usedEffect
AlignmentInteger constantThe numbering is positioned in relation to the start position of paragraph:
  • haCenter: The numbering is centered in relation to the start of paragraph.
  • haRight: The numbering is positioned on the right in relation to the start of paragraph.
  • haLeft: The numbering is positioned on the left in relation to the start of paragraph.
FormatInteger constantFormatting for this level of numbering (digits, roman digits, letters, ...):
  • numfUppercaseLetter: Numbering in uppercase letters: A, B, C, D, ...
  • numfLowercaseLetter: Numbering in lowercase letters: a, b, c, d, ...
  • numfNumeric: Numbering in digits: 1, 2, 3, 4, ...
  • numfNumericInLetters: Numbering in digits written in letters: one, two, three, four, ...
  • numfOrdinal: Ordered numbering: 1st, 2nd, 3rd, ...
  • numfOrdinalInLetters: Ordered numbering in letters: first, second, third, ...
  • numfBullet: Numbering in bullet format. Only the bullets represented by a font character are available. You cannot create a bullet associated with an image.
  • numfRomanUppercase: Numbering in uppercase Roman digits: I, II, III, ...
  • numfRomanLowercase: Numbering in lowercase Roman digits: i, ii, iii, ...
FormattingdocFormatting variableParameters for numbering formatting.
PageLayoutLayout of numbered paragraph.
PageLayout..AlignmentInteger constantHorizontal alignment used for the numbered paragraph:
  • haCenter: Centered
  • haRight: Aligned to right
  • haLeft: Aligned to left
  • haJustified: Justified.
PageLayout..BorderBorder variableCharacteristics of border used for the numbered paragraph.
Note: the rounded corners are not supported.
PageLayout..BrushColorIntegerBackground color of numbered paragraph. This color can correspond to:
PageLayout..SpacingAfterRealSpacing after the numbered paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout..SpacingBeforeRealSpacing before the numbered paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout..InterlineRealInterline (expressed in millimeters).
Used if ..InterlineType is set to interlineExact or interlineMinimum.
This property is set to 0 by default.
PageLayout..RightIndentRealRight indent of numbered paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout..LeftIndentRealLeft indent of numbered paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout..IndentFirstLineRealIndent of first line in numbered paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout..CustomTabulationArray of docTabulationCustom tabulations of numbered paragraph.
PageLayout..BackgroundFrameBackground variableCharacteristics of paragraph background.
PageLayout..InterlineTypeInteger constantType of interline used:
  • interlineExact: The interline corresponds to the value of ..Interline.
  • interlineMinimum: The interline corresponds at least to the value of ..Interline. If the default interline of the character font used on the previous line is greater than ..Interline, the default interline of font is used.
  • interlineMultiple (default value): The interline is obtained by multiplying ..Interline by the default interline of the character font found on the previous line and by dividing the result by 240.
RestartAfterIntegerLevel after which the numbering must be reinitialized. This property can correspond to:
  • 0: the numbering is never reinitialized.
  • -1: the numbering is reinitialized as soon as a higher level is incremented.
  • a value x greater than 0: the numbering is reinitialized as soon as the level x is incremented.
SeparatorInteger constantType of separator used to perform the spacing between the paragraph numbering and the rest of text:
  • numsepNone: No separator.
  • numsepSpace: The separator is a space.
  • numsepTabulation: The separator is a tabulation.
TextCharacter stringNumbering to use. The % symbol followed by a digit will contain the numbering value for the level defined by this digit.
Examples:
  • "%1 )" is using the numbering of level 1 followed by a bracket.
  • "%1. %2" displays the numbering of level 1 followed by the numbering of level 2.
For a list with bullets, characters representing the requested bullet. This character will be displayed in the font selected for the numbering formatting.
Caution: The number of previous levels will be formatted as defined by the previous level except if ..AllInDigit is set to True.
AllInDigitBoolean
  • True in order for all the level numbers (current level and previous levels) to be written in Arabic digits,
  • False to keep the characteristics of each level.
TplcCharacter stringSpecific identifier for MS Word.
This property is available in read-only.
InitialValueIntegerStart value of numbering (must be a positive integer).


Note: These properties can be handled by using one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Adding a numbering description to a document

To add a numbering description to a document, you have the ability to use Add with the following syntax:
Add(Document..Numbering, MyNumbering)
where:

Adding a numbering level to a document

To add a numbering level to a document, you have the ability to use Add with the following syntax:
Add(Numbering..Level, MyLevel)
where:
  • Numbering is a docNumbering variable.
  • MyLevel is a docNumberingLevel variable.

Using numberings created by programming

The numberings created by programming can be used via the ribbon. They appear in the ribbon, in the "Paragraphs" group, by expanding the Numbering option, in the "Document numbering" group.
Minimum required version
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment