docElement (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / Word Processing functions / Types of variables

Properties specific to docElement variables
Functions that use docElement variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

docElement (Variable type)

In french: docElément

The docElement type handles each element in a docParagraph variable.

You can define and change the characteristics of this element using different WLanguage functions and properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

// Opens a docx file in the Word Processing control
WP_MyDoc = DocOpen(fExeDir() + fSep() + "MyDoc.docx")

// Fragment positioned at the end of document
fEnd is docFragment(WP_MyDoc, -1)
// Selects the document
TextFragment is docFragment(WP_MyDoc, 1, fEnd.EndPosition)

FOR EACH MyCurrentElement OF TextFragment.Element
MyParagraph is docParagraph = MyCurrentElement.Paragraph
Trace(MyParagraph.StartPosition)
Trace(MyParagraph.EndPosition)
END

Remarks

Properties specific to docElement variables

The following properties can be used to handle docElement variables:

Cell	docCell variable	Cell characteristics (only if the element corresponds to a table cell).

EndPosition	Integer	End position of element in the document. This property is read-only.
Formula	docElementFormula variable	Characteristics of formula: formula, formula formatting, formula result (for a formula element only).
Image	docElementImage variable	Image characteristics (can be used for an Image element only).
Link	docElementLink variable	Link characteristics (only if the element corresponds to a link). These characteristics are available in read-only.
Paragraph	docParagraph variable	Paragraph that contains the element.
Parent	docElement variable	Element that contains the element. This property is read-only.
Property name	Type used	Effect
StartPosition	Integer	Start position of element in the document. This property is read-only.
TableOfContents	docTableOfContents variable	Characteristics of the table of contents of the document.
Text	docElementText variable	Text characteristics (can be used for a Text element only).
TextArea	docElementTextArea variable	Characteristics of text area (can be used for a Text Area element only).
Type	Integer	Type of element corresponding to one of the following constants: typeDocElementCell: Table Cell element. typeDocElementDocument: Document element. typeDocElementHeader: Header element. typeDocElementFormula: Formula element. typeDocElementImage: Image element. typeDocElementUnknown: Unrecognized element. typeDocElementLink: Link element. typeDocElementParagraph: Paragraph element with no text (empty text). typeDocElementFooter: Footer element. typeDocElementTableOfContents: Table of Contents element. typeDocElementText: Text element. typeDocElementTextArea: Text Area element.

Functions that use docElement variables


DocAdd	Adds: at the end of a Word Processing document: an element, a document, a paragraph, a text, an image or a fragment. at the end of a fragment: an element, a text or an image.
DocChangeZOrder	Changes the Z-order of an Image or Text Area element in a DocX document.
DocDelete	Deletes an element from a document. This element is deleted from its associated document.
DocInsert	Inserts an object into a Word Processing document or replaces the content of the current fragment. The objects that can be used are: an element, a document, a paragraph, a text, an image, a fragment.