Help / WLanguage / WLanguage functions / Controls, pages and windows / Word Processing functions / Types of variables
  • Properties specific to docElement variables
  • Functions that use docElement variables
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
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.
// 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

Properties specific to docElement variables

The following properties can be used to handle docElement variables:
CelldocCell variableCell characteristics (only if the element corresponds to a table cell).
EndPositionIntegerEnd position of element in the document.
This property is read-only.
FormuladocElementFormula variableCharacteristics of formula: formula, formula formatting, formula result (for a formula element only).
ImagedocElementImage variableImage characteristics (can be used for an Image element only).
LinkdocElementLink variableLink characteristics (only if the element corresponds to a link).
These characteristics are available in read-only.
ParagraphdocParagraph variableParagraph that contains the element.
ParentdocElement variableElement that contains the element.
This property is read-only.
Property nameType usedEffect
StartPositionIntegerStart position of element in the document.
This property is read-only.
TableOfContentsdocTableOfContents variableCharacteristics of the table of contents of the document.
TextdocElementText variableText characteristics (can be used for a Text element only).
TextAreadocElementTextArea variableCharacteristics of text area (can be used for a Text Area element only).
TypeIntegerType 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

  • 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.
DocChangeZOrderChanges the Z-order of an Image or Text Area element in a DocX document.
DocDeleteDeletes an element from a document. This element is deleted from its associated document.
DocInsertInserts 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.
Minimum version required
  • Version 22
This page is also available for…
Click [Add] to post a comment

Last update: 01/04/2024

Send a report | Local help