docParagraph (Type of variable)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Properties specific to the description of docParagraph variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

docParagraph (Type of variable)

In french: docParagraphe

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.

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

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 name		Type used	Effect
Cell		docCell variable	Used to access the cell of parent table. This property is available from version 220071.
StartSection		Integer constant	Section 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. Remarks: 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.
Element		Array of docElement	Elements included in the paragraph. The elements found in the paragraph can be browsed via the FOR EACH statement.
EndSection		Integer constant	Section 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. Remarks: 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.
ParagraphIndex		Integer	Index of current paragraph in the table of parent paragraphs. This property is available in read-only.
PageLayout			Information about paragraph layout
	PageLayout..Alignment	Integer constant	Horizontal alignment used: haCenter: Centered haRight: Aligned to right haLeft: Aligned to left haJustified: Justified.
	PageLayout..Border	Border variable	Identifier of border used for the paragraph. Remark: the rounded corners are not supported.
	PageLayout..BrushColor	Integer	Background color of paragraph. This color can correspond to: an RGB color (returned by RGB), a preset color.
	PageLayout..SpaceBottomBorder	Real	Spacing between the text and the bottom side of paragraph border (expressed in millimeters). This property is set to 0 by default.
	PageLayout..SpaceRightBorder	Real	Spacing between the text and the right side of paragraph border (expressed in millimeters). This property is set to 0 by default.
	PageLayout..SpaceLeftBorder	Real	Spacing between the text and the left side of paragraph border (expressed in millimeters). This property is set to 0 by default.
	PageLayout..SpaceTopBorder	Real	Spacing between the text and the top side of paragraph border (expressed in millimeters). This property is set to 0 by default.
	PageLayout..SpacingAfter	Real	Spacing after the paragraph (expressed in millimeters). This property is set to 0 by default.
	PageLayout..SpacingBefore	Real	Spacing before the paragraph (expressed in millimeters). This property is set to 0 by default.
	PageLayout..Interline	Real	Interline (expressed in millimeters). Used if ..InterlineType is set to interlineExact or interlineMinimum. This property is set to 0 by default.
	PageLayout..RightIndent	Real	Right indent of paragraph (expressed in millimeters). This property is set to 0 by default.
	PageLayout..LeftIndent	Real	Left indent of paragraph (expressed in millimeters). This property is set to 0 by default.
	PageLayout..IndentFirstLine	Real	Indent of first line in paragraph (expressed in millimeters). This property is set to 0 by default.
	PageLayout..CustomTabulation	Array of docTabulation	Custom tabulations of paragraph.
	PageLayout..BackgroundFrame	Background variable	Characteristics of paragraph background.
	PageLayout..InterlineType	Integer constant	Type 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.
Numbering			Numbering information.
	Numbering..Identifier	Integer	Identifier 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..Level	Integer	Identifier 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		docElement	Element that contains the paragraph.
StartPosition		Integer	Start position of paragraph in the document.
EndPosition		Integer	End position of paragraph in the document.
Section		docSection	Characteristics of the section to which the paragraph belongs.
StyleID		Character string	Identifier of paragraph style. This identifier must exist among the styles linked to the document. Remark: the change of paragraph or fragment style automatically applies the linked paragraph style and character style if they exist.
Table		docTable variable	Characteristics 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).

Remark: These properties can be handled by using one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>