PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • 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/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
The docParagraph type is used to handle the characteristics of a paragraph found in a DOCX document. The characteristics of this paragraph can be defined and modified by several WLanguage functions and properties.
This type of variable is handled by the Document variables.
Note: See Declaring a variable for more details.
Caution: This documentation presents the last features of the Word Processing control. Make sure that all the necessary modules are updated.
Example
WP_MyDoc = DocOpen(fExeDir() + fSep() + "MyDoc.docx")

TextFragment is docFragment(WP_MyDoc, 1, Length(DocToText(WP_MyDoc)))

FOR EACH MyCurrentElement OF TextFragment..Element
MyParagraph is docParagraph = MyCurrentElement..Paragraph
Trace(MyParagraph..StartPosition)
Trace(MyParagraph..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.
This property is available from version 220071.
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.
This property is available in read-only.
Notes:
  • The ..EndSection property of a paragraph returns the same value as the ..StartSection property of 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.
This property is available in read-only.
Notes:
  • The ..EndSection property of a paragraph returns the same value as the ..StartSection property of next paragraph.
  • The ..EndSection property of last paragraph returns the ssNoBreak constant.
ParagraphIndexIntegerIndex of current paragraph in the table of parent paragraphs.
This property is available in read-only.
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.
Note: the rounded corners are not supported.
PageLayout..BrushColorIntegerBackground 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..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 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..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.
NumberingNumbering information.
Numbering..IdentifierIntegerIdentifier of numbering used for the paragraph. Used to identify or associate a numbering with the paragraph. See docNumberingLevel (Type of variable) for more details.
Numbering..LevelIntegerIdentifier of numbering level used for the paragraph. Used to identify or associate a numbering level with the paragraph. See docNumberingLevel (Type of variable) for more details
Versions 23 and later
Parent
New in version 23
Parent
Parent
docElementElement that contains the paragraph.
StartPositionIntegerStart position of paragraph in the document.
EndPositionIntegerEnd 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.
Note: the change of paragraph or fragment style automatically applies the linked paragraph style and character style if they exist.
TabledocTable 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..Element[1]..Paragraph
IF para..Table = Null THEN
// This is not an array
RETURN
END
Caution: This property is available from WINDEV version 220059U (update module of Word Processing control applicable to WINDEV Pre-release).

Note: These properties can be handled by using one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>
Minimum required version
  • Version 22
This page is also available for…
Comments
Click [Add] to post a comment