Document (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 Document variables
WLanguage functions that use Document variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Document (Variable type)

In french: Document

The Document type is used to handle a "docx" document. The content of this document can be viewed and modified by several WLanguage functions and properties.

A Document variable can be initialized:

with the content of a Word Processing control.
with a ".docx" file or an ".rtf" file.
with a buffer (containing a docx or rtf).
with a Binary Memo item of a data file.

with a character string. For example:

MyDoc is Document = "a paragraph." + CR + "a second paragraph."

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

Example

See additional examples

// Load the document
MyDoc is Document = "c:\temp\doc.docx"
// Browse the paragraphs of the document
FOR EACH para OF MyDoc.Paragraph
	FOR EACH MyElement OF para.Element
		Trace(MyElement.Texte)
	END
END

Properties

Properties specific to Document variables

The following properties can be used to handle Document variables:

Property name	Type used	Effect

Bookmark[Bookmark Name]	Associative array of DocFragment variables	Fragment associated with the bookmark.
EvenOddPageDifferent	Boolean	True if the document must have different headers and footers for the even and odd pages, False otherwise. In this case, the headers and footers are identical for the even and odd pages.
FilePath	Character string	Name and full path of docx file associated with the document. This property is read-only. It is assigned when using DocOpen. Remarks: When assigning a Document variable into another one, this property is not copied (except during the call to DocOpen). If the document comes from a buffer, this property is set to an empty string ("").
Modified	Boolean	True if the document was modified since its opening (through programming or by the user), False otherwise. This property is read-only.
Numbering	Array of docNumbering	Numberings associated with the document. The document numberings can be browsed via the FOR EACH statement.
PageColor	Color variable	Background color of the page.
Paragraph	Array of docParagraph	Paragraphs included in the document body. The document paragraphs can be browsed via the FOR EACH statement.
Password	Character string or Secret string	Password for the docx file. This password is used to encrypt the docx file. This password will be requested when opening the docx file. New in version 2025 Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "Ansi or Unicode string". To learn more about secret strings and how to use the vault, see Secret string vault.
Property	docProperty variable	Document properties.
ReadOnly	Boolean	True if the document is read-only, False otherwise. This property is read-only.
Section	docSection variable	Section information (information global to the document).
Style	Array of docStyle variables	Information about the styles linked to the document (information global to the document).

Remarks

WLanguage functions that use Document variables

Document variables can be handled using the following WLanguage functions:

standard syntax:


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.
DocClose	Closes a docx file and frees the document.
DocEndModification	Signals the end of the grouping of a set of operations into a single event (undo/redo management).
DocFind	Finds a character string: in an entire Word Processing document. in a fragment.
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.
DocInsertTable	Inserts a table into a Word Processing document.
DocOpen	Opens a Word Processing file (docx format) in Read/Write mode. The docx file is opened and locked until it is closed.
DocPrint	Prints a document in "docx" format.
DocRedo	Restores the last undone action on a Word Processing document.
DocRedoCount	Returns the number of canceled actions that can be redone on a Word Processing document.
DocReplace	Finds all the instances of a character string and replaces them with another string: in an entire Word Processing document. in a fragment.
DocSave	Saves a document as a "docx" file.
DocStartModification	Signals the start of the grouping of a set of operations on a document into a single event (undo/redo management).
DocToHTML	Converts a Word Processing document into an HTML file.
DocToImage	Exports a page found in a Word Processing document in image format.
DocToPDF	Converts a Word Processing document into a PDF file.
DocToText	Creates a character string from the data: found in a Word Processing control or in a Word Processing document. found in a paragraph of a Word Processing control.
DocUndo	Undoes the last action performed on a Word Processing document.
DocUndoCount	Returns the number of actions that can be undone on a document.
DocUndoRedoDeleteAll	Deletes the entire history of Undo/Redo mechanism for a Word Processing document.
iPrintDoc	Prints a document in "docx" format.

prefix syntax:


<Document variable>.Add	Adds an element, document, paragraph, text, image or fragment to the end of a Document variable..
<Document variable>.Close	Closes the docx file associated with the Document variable and frees the document.
<Document variable>.EndModification	Indicates the end of a series of actions performed in a Document variable in a single event ("undo/redo").
<Document variable>.Insert	Inserts an object in a Document variable. The objects that can be used are: an element, a document, a paragraph, a text, an image, a fragment.
<Document variable>.InsertTable	Inserts a table in a Document variable.
<Document variable>.Print	Prints the content of a Document in "docx" format.
<Document variable>.Redo	Restores the last action canceled on a Document variable.
<Document variable>.Replace	Finds all the instances of a character string and replaces them with another string in a Document variable.
<Document variable>.Save	Saves a document as a "docx" file.
<Document variable>.Seek	Finds a character string in an entire Document variable.
<Document variable>.StartModification	Indicates the start of a series of actions performed on a Document variable in a single event ("undo/redo").
<Document variable>.ToHTML	Converts a Document variable into an HTML file.
<Document variable>.ToImage	Exports a page contained in a Document variable in image format.
<Document variable>.ToText	Creates a character string with the data of a Document variable.
<Document variable>.Undo	Undoes the last action performed on a Document variable.
<Document variable>.UndoCount	Returns the number of actions that can be undone in a Document variable.
<Document variable>.UndoRedoDeleteAll	Deletes the entire history of Undo/Redo mechanism for a Word Processing document.