PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
This content has been translated automatically. Click here to view the French version.
  • Properties specific to the description of docParagraph variables
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
The docParagraph type is used to handle the characteristics of a paragraph in a DOCX document. The characteristics of this paragraph can be defined and modified using different WLanguage functions and properties.
This type of variable is used by Document variables.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
Caution: This documentation presents the last features of the Word Processing control. Make sure that all the necessary modules are updated.
Example
TT_MonDoc = DocOpen(fExeDir() + fSep() + "MonDoc.docx")
 
FragmentTexte is docFragment(TT_MonDoc, 1, Length(DocToText(TT_MonDoc)))
 
FOR EACH MonElementCourant OF FragmentTexte.Elément
MonParagraphe is docParagraph = MonElementCourant.Paragraphe
Trace(MonParagraphe.StartPosition)
Trace(MonParagraphe.EndPosition)
END
Remarks

Properties specific to the description of docParagraph variables

The following properties can be used to handle a docParagraph variable:
Property nameType usedEffect
CelldocCell variableUsed to access the cell of parent table.
StartSectionInteger constantSection break to apply before the paragraph. Can correspond to one of the following constants:
  • ssNoBreak: No section break is found before the paragraph.
  • ssSectionBreak: A section break (page break type) is found before the paragraph.
  • ssSectionBreakContinuous: A continuous section break is found before the paragraph.
  • ssSectionBreakOddPage: A section break (odd page break type) is found before the paragraph.
  • ssSectionBreakEvenPage: A section break (even page break type) is found before the paragraph.
Remarks:
  • The EndSection property of a paragraph returns the same value as the StartSection property of the next paragraph.
  • The StartSection property of the first paragraph returns the ssNoBreak constant.
ElementArray of docElementElements included in the paragraph. The elements found in the paragraph can be browsed via the FOR EACH statement.
EndSectionInteger constantSection break to apply after the paragraph. Can correspond to one of the following constants:
  • ssNoBreak: No section break is found after the paragraph.
  • ssSectionBreak: A section break (page break type) is found after the paragraph.
  • ssSectionBreakContinuous: A continuous section break is found after the paragraph.
  • ssSectionBreakOddPage: A section break (odd page break type) is found after the paragraph.
  • ssSectionBreakEvenPage: A section break (even page break type) is found after the paragraph.
Remarks:
  • The EndSection property of a paragraph returns the same value as the StartSection property of the next paragraph.
  • The EndSection property of the last paragraph returns the ssNoBreak constant.
ParagraphIndexentierIndex of current paragraph in the table of parent paragraphs.
This property is available in read-only mode.
PageLayoutInformation about paragraph layout
PageLayout.AlignmentInteger constantHorizontal alignment used:
  • haCenter: Centered
  • haRight: Aligned to right
  • haLeft: Aligned to left
  • haJustified: Justified.
PageLayout.BorderBorder variableIdentifier of border used for the paragraph.
Remark: the rounded corners are not supported.
PageLayout.BackgroundColorentierBackground color of paragraph. This color can correspond to:
PageLayout.SpaceBottomBorderRealSpacing between the text and the bottom side of paragraph border (expressed in millimeters).
This property is set to 0 by default.
PageLayout.SpaceRightBorderRealSpacing between the text and the right side of paragraph border (expressed in millimeters).
This property is set to 0 by default.
PageLayout.SpaceLeftBorderRealSpacing between the text and the left side of paragraph border (expressed in millimeters).
This property is set to 0 by default.
PageLayout.SpaceTopBorderRealSpacing between the text and the top side of paragraph border (expressed in millimeters).
This property is set to 0 by default.
PageLayout.SpacingAfterRealSpacing after the paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout.SpacingBeforeRealSpacing before the paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout.InterlineRealLine spacing (expressed in millimeters).
Used if the InterlineType property is set to interlineExact or interlineMinimum.
By default, this property is set to 0.
PageLayout.RightIndentRealRight indent of paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout.LeftIndentRealLeft indent of paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout.IndentFirstLineRealIndent of first line in paragraph (expressed in millimeters).
This property is set to 0 by default.
PageLayout.CustomTabulationArray of docTabulationCustom tabulations of paragraph.
PageLayout.BackgroundPatternBackground variableCharacteristics of paragraph background.
In previous versions, this Property was called "BackgroundFrame".
PageLayout.InterlineTypeInteger constantType of line spacing used:
  • interlineExact: The line spacing corresponds to the value of the Interline property.
  • interlineMinimum: The line spacing is at least the value of the Interline property. If the default line spacing of the font used on the previous line is greater than the Interline property, the default line spacing of the font is used.
  • interlineMultiple (default value): The line spacing is obtained by multiplying the Interline property by the default line spacing of the font of the previous line and dividing the result by 240.
NumberingNumbering information.
Numbering.IdentifierentierIdentifier of numbering used for the paragraph. Used to identify or associate a numbering with the paragraph. For more details, see docNumberingLevel.
Numbering.LevelentierIdentifier of numbering level used for the paragraph. Used to identify or associate a numbering level with the paragraph. For more details, see docNumberingLevel.
Versions 23 and later
Parent
New in version 23
Parent
Parent
docElementElement that contains the paragraph.
StartPositionentierStart position of paragraph in the document.
EndPositionentierEnd position of paragraph in the document.
SectiondocSectionCharacteristics of the section to which the paragraph belongs.
StyleIDCharacter stringIdentifier of paragraph style. This identifier must exist among the styles linked to the document.
Remark: changing the paragraph or fragment style automatically applies the linked paragraph style and character style if they exist.
ArraydocTable variableCharacteristics of the table corresponding to the paragraph.
This property is used to find out whether the paragraph corresponds to a Text paragraph or to a Table paragraph. Example:
let para <- f.Elément[1].Paragraphe
IF para.Tableau = Null THEN
// Ce n'est pas un tableau
RETURN
END
Minimum version required
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment