Document (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Properties specific to the description of Document variables
WLanguage functions that use Document variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Document (Type of variable)

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."

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

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..Text)
END
END

Remarks

Properties specific to the description of Document variables

The following properties can be used to handle a Document variable:

Property name	Type used	Effect

FilePath	Character string	Name and full path of docx file associated with the document. This property is available in 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 corresponds to an empty string ("").
Versions 24 and later PageColor New in version 24 PageColor PageColor	Color variable	Background color of the page.
ReadOnly	Boolean	True if the document is read-only, False otherwise. This property is available in read-only.
Modified	Boolean	True if the document was modified since its opening (by programming or by the user), False otherwise. This property is available in read-only.
Versions 24 and later Password New in version 24 Password Password	Character 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.
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.
Numbering	Array of docNumbering	Numberings associated with the document. The document numberings can be browsed via the FOR EACH statement.
Paragraph	Array of docParagraph	Paragraphs included in the document body. The document paragraphs can be browsed via the FOR EACH statement.
Property	docProperty variable	Properties of document.
Section	docSection variable	Section information (information global to the document).
Versions 23 and later Bookmark[Bookmark Name] New in version 23 Bookmark[Bookmark Name] Bookmark[Bookmark Name]	Associative array of DocFragment variables	Fragment associated with the bookmark.
Style	Array of docStyle variables	Information about the styles linked to the document (information global to the document).

Remark: These properties can be handled by using one of the following syntaxes:

<Variable name>..<Property name>
<Variable name>.<Property name>

WLanguage functions that use Document variables

Document variables can be handled using the following WLanguage functions:

standard syntax:


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

prefixed syntax:


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