PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of docElement 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 docElement type is used to handle each element found in a docParagraph variable.
The characteristics of this element can be defined and modified by several WLanguage functions and properties.
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
// 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 the description of docElement variables

The following properties can be used to handle a docElement variable:
Property nameType usedEffect
CelldocCell variableCell characteristics (only if the element corresponds to a table cell).
This property is available from version 220059U (module dated 05/17/2017).
FormuladocElementFormula variableCharacteristics of formula: formula, formula formatting, formula result (for a formula element only).
This property is available from version 220059U (module dated 05/17/2017).
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.
This property is available from version 220071.
ParagraphdocParagraph variableParagraph that contains the element.
ParentdocElement variableElement that contains the element.
This property is available in read-only.
This property is available from version 220059U (module dated 05/17/2017).
StartPositionIntegerStart position of element in the document.
This property is available in read-only.
EndPositionIntegerEnd position of element in the document.
This property is available in read-only.
TextdocElementText variableText characteristics (can be used for a Text element only).
TypeIntegerType of element corresponding to one of the following constants:
  • typeDocElementCell: Table Cell element. This constant is available from version 220059U (module dated 05/17/2017).
  • Versions 23 and later
    typeDocElementDocument: Document element.
    New in version 23
    typeDocElementDocument: Document element.
    typeDocElementDocument: Document element.
  • Versions 23 and later
    typeDocElementHeader: Header element.
    New in version 23
    typeDocElementHeader: Header element.
    typeDocElementHeader: Header element.
  • typeDocElementFormula: Formula element. This constant is available from version 220059U (module dated 05/17/2017).
  • typeDocElementImage: Image element.
  • typeDocElementUnknown: Unrecognized element.
  • typeDocElementLink: Link element.
  • typeDocElementParagraph: Paragraph element with no text (empty text).
  • Versions 23 and later
    typeDocElementFooter: Footer element.
    New in version 23
    typeDocElementFooter: Footer element.
    typeDocElementFooter: Footer element.
  • typeDocElementText: Text element.
  • Versions 23 and later
    typeDocElementTextArea: Text Area element.
    New in version 23
    typeDocElementTextArea: Text Area element.
    typeDocElementTextArea: Text Area element.
This property is available in read-only.
Versions 23 and later
TextArea
New in version 23
TextArea
TextArea
docElementTextArea variableCharacteristics of text area (can be used for a Text Area element only).

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