docElement (Variable type)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

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.

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

Example

// Ouvre un fichier docx dans le champ Traitement de texte
TT_MonDoc = DocOpen(fExeDir() + fSep() + "MonDoc.docx")

// Fragment positionné à la fin du document
fFin is docFragment(TT_MonDoc, -1)
// Sélectionne le document
FragmentTexte is docFragment(TT_MonDoc, 1, fFin.EndPosition)

FOR EACH MonElementCourant OF FragmentTexte.Element
	MonParagraphe is docParagraph = MonElementCourant.Paragraphe
	Trace(MonParagraphe.StartPosition)
	Trace(MonParagraphe.EndPosition)
END

// Ouvre un fichier docx dans le champ Traitement de texte
TT_MonDoc = DocOpen(fExeDir() + fSep() + "MonDoc.docx")
MonDoc is Document = TT_MonDoc
// Parcours les paragraphes pour trouver les interrupteurs
sElement is string
sParagraphe is string
sValeur,sDebut,sFin,sType are strings
FOR EACH MonPara OF MonDoc.Paragraph
	sParagraphe = sParagraphe + [CR] + sElement
	sElement = ""
	FOR EACH MonElement OF MonPara.Element
		sDebut = MonElement.PositionDébut
		sFin = MonElement.PositionFin
		SWITCH MonElement.Type
			CASE typeDocElementCheckBoxControl
			sType = "Case à cocher"
			CheckBox is docElementCheckBox <- MonElement..Control
			sValeur = CheckBox.Checked
		END
		sElement = sElement + [CR] + sValeur + TAB + sDebut + TAB + sFin + TAB + sType
	END
END

Properties

Properties specific to docElement variables

The following properties can be used to define the characteristics of docElement variables:

Property name	Type used	Effect

Cell	docCell variable	Cell characteristics (only if the element corresponds to a table cell).
Champ		Field characteristics (e.g. Check Box control field). For Check Box control fields, use the elt;- operator to retrieve the switch's characteristics.. Example: `CheckBox is docElementCheckBox <- MonElement..Control`
EndPosition	Integer	End position of element in the document. This property is read-only.
Formula	docElementFormula variable	Formula characteristics: formula, formula formatting, formula result (only for formula elements).
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.
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: typeDocCellElement Cell type element of an array.= typeDocElementSwitchField* Check Box control element (check box on a form). typeDocDocumentElement Document type element. typeDocHeaderElement Page header element. typeDocFormulaElement Element of type Formula typeDocImageElement Image element. typeDocUnrecognizedElement Unrecognized element type. typeDocLinkElement Link element. typeDocParagraphElement Paragraph element with no text (empty text). typeDocFooterElement Footer element. typeDocTableOfContents element Table of contents element. typeDocTextElement Text element. typeDocTextBoxElement Text area element type.

Remarks

Functions that use docElement variables


DocAdd	Adds: at the end of a word processing document: an element, document, paragraph, text, image or fragment. at the end of a fragment: an element, text or 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.