ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Version: 2025

Category: Word Processing functions
92 results
<docFragment variable>.Add (Function)
Adds an element, text or image at the end of a docFragment variable.
<docFragment variable>.ClearFormatting (Function)
Replaces the current formatting of a selection with the default formatting.
<docFragment variable>.Insert (Function)
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.
<docFragment variable>.InsertTable (Function)
Replaces the specified fragment with a table.
<Document variable>.Add (Function)
Adds an element, document, paragraph, text, image or fragment to the end of a Document variable..
<Document variable>.Close (Function)
Closes the docx file associated with the Document variable and frees the document.
<Document variable>.EndModification (Function)
Indicates the end of a series of actions performed in a Document variable in a single event ("undo/redo").
<Document variable>.Insert (Function)
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 (Function)
Inserts a table in a Document variable.
<Document variable>.Print (Function)
Prints the content of a Document in "docx" format.
<Document variable>.Redo (Function)
Restores the last action canceled on a Document variable.
<Document variable>.RedoCount (Function)
Returns the number of canceled actions that can be redone on a Document variable.
<Document variable>.Replace (Function)
Finds all the instances of a character string and replaces them with another string in a Document variable.
<Document variable>.Save (Function)
Saves a document as a "docx" file.
<Document variable>.Seek (Function)
Finds a character string in an entire Document variable.
<Document variable>.StartModification (Function)
Indicates the start of a series of actions performed on a Document variable in a single event ("undo/redo").
<Document variable>.ToHTML (Function)
Converts a Document variable into an HTML file.
<Document variable>.ToImage (Function)
Exports a page contained in a Document variable in image format.
<Document variable>.ToText (Function)
Creates a character string with the data of a Document variable.
<Document variable>.Undo (Function)
Undoes the last action performed on a Document variable.
<Document variable>.UndoCount (Function)
Returns the number of actions that can be undone in a Document variable.
<Document variable>.UndoRedoDeleteAll (Function)
Deletes the entire history of Undo/Redo mechanism for a Word Processing document.
<Document>.FindElementByName (Function)
Searches for an element by its name in a Word Processing document.
<Word Processing>.Add (Function)
Adds an element, document, paragraph, text, image or fragment to the end of a Word Processing control.
<Word Processing>.ClearFormatting (Function)
Replaces the current formatting of a selection in a Word Processing control with the default formatting.
<Word Processing>.Close (Function)
Closes the docx file associated with the Word Processing control and frees the document.
<Word Processing>.EndModification (Function)
Indicates the end of a series of actions performed in a Word Processing control in a single event ("undo/redo").
<Word Processing>.ExitEdit (Function)
Exits from the current edit. The entry in edit was performed by DocGoIntoEdit.
<Word Processing>.FindElementByName (Function)
Searches for an element by its name in a Word Processing document.
<Word Processing>.FormatPainterMode (Function)
Enables the format painter mode in the Word Processing control or determines if this mode is enabled.
<Word Processing>.GoIntoEdit (Function)
Enters Word Processing control in a specific part of the document: body, header or footer.
<Word Processing>.InfoXY (Function)
For a given position (coordinates of a point) in a Word Processing control, returns one of the following:
  • the number of the corresponding page,
  • the corresponding X-position (in mm),
  • the corresponding Y-position (in mm).
<Word Processing>.Insert (Function)
Inserts an object in a Word Processing control. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
<Word Processing>.InsertTable (Function)
Inserts a table into a Word Processing control.
<Word Processing>.Open (Function)
Opens a Word Processing file (docx format) in Read/Write mode. The docx file is opened and locked until it is closed.
<Word Processing>.Position (Function)
Triggers the scroll of Word Processing control in order for the requested text to be entirely displayed.
<Word Processing>.Print (Function)
Prints the content of a Word Processing control in "docx" format.
<Word Processing>.Redo (Function)
Restores the last undone action on a Word Processing control.
<Word Processing>.RedoCount (Function)
Returns the number of canceled actions that can be redone on a Word Processing control.
<Word Processing>.Replace (Function)
Finds all the instances of a character string and replaces them with another string in a Word Processing control.
<Word Processing>.Save (Function)
Saves a document as a "docx" file.
<Word Processing>.Seek (Function)
Finds a character string in an entire Word Processing control.
<Word Processing>.Select (Function)
Selects a fragment in a Word Processing control.
<Word Processing>.StartModification (Function)
Indicates the start of a series of actions performed in a Word Processing control in a single event ("undo/redo").
<Word Processing>.ToHTML (Function)
Converts the content of a Word Processing control into an HTML file.
<Word Processing>.ToImage (Function)
Exports a page from a Word Processing control in image format.
<Word Processing>.ToPDF (Function)
Converts a Word Processing document into a PDF file.
<Word Processing>.ToText (Function)
Creates a character string from the data of a Word Processing control.
<Word Processing>.Undo (Function)
Undoes the last action performed on a Word Processing control.
<Word Processing>.UndoCount (Function)
Returns the number of actions that can be undone in a Word Processing control.
<Word Processing>.UndoRedoDeleteAll (Function)
Deletes the entire history of the Undo/Redo mechanism for a Word Processing control.
DocAdd (Function)
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 (Function)
Changes the Z-order of an Image or Text Area element in a DocX document.
DocClearFormatting (Function)
Replaces the current formatting of a selection with the default formatting.
DocClose (Function)
Closes a docx file and frees the document.
DocDelete (Function)
Deletes an element from a document. This element is deleted from its associated document.
DocDeleteTableOfContents (Function)
Deletes a table of contents from a document.
DocEndModification (Function)
Signals the end of the grouping of a set of operations into a single event (undo/redo management).
DocExitEdit (Function)
Exits from the current edit. The entry in edit was performed by DocGoIntoEdit.
DocFind (Function)
Finds a character string:
  • in an entire Word Processing document.
  • in a fragment.
DocFindElementByName (Function)
Searches for an element by its name in a Word Processing document.
DocFormatPainterMode (Function)
Enables the format painter mode in the Word Processing control or determines if this mode is enabled.
DocGoIntoEdit (Function)
Enters Word Processing control in a specific part of the document: body, header or footer.
docHeaderFooter (Variable type)
The docHeaderFooter type is used to define the text of the different paragraphs found in a page header or footer.
DocInfoXY (Function)
For a given position (coordinates of a point) in a Word Processing control, returns one of the following:
  • the number of the corresponding page,
  • the corresponding X-position (in mm),
  • the corresponding Y-position (in mm)
DocInsert (Function)
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 (Function)
Inserts a table into a Word Processing document.
DocInsertTableOfContents (Function)
Inserts a table of contents in a Word Processing document.
DocOpen (Function)
Opens a Word Processing file (docx format) in Read/Write mode. The docx file is opened and locked until it is closed.
DocPosition (Function)
Triggers the scroll of Word Processing control in order for the requested text to be entirely displayed.
DocPositionTopPage (Function)
Returns the position of the first character in a given page in a Text Processing control.
DocPrint (Function)
Prints a document in "docx" format.
DocRedo (Function)
Restores the last undone action on a Word Processing document.
DocRedoCount (Function)
Returns the number of canceled actions that can be redone on a Word Processing document.
DocReplace (Function)
Finds all the instances of a character string and replaces them with another string:
  • in an entire Word Processing document.
  • in a fragment.
DocSave (Function)
Saves a document as a "docx" file.
DocSelect (Function)
Selects a fragment in a Word Processing control.
DocStartModification (Function)
Signals the start of the grouping of a set of operations on a document into a single event (undo/redo management).
DocToHTML (Function)
Converts a Word Processing document into an HTML file.
DocToImage (Function)
Exports a page found in a Word Processing document in image format.
DocToPDF (Function)
Converts a Word Processing document into a PDF file.
DocToText (Function)
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 (Function)
Undoes the last action performed on a Word Processing document.
DocUndoCount (Function)
Returns the number of actions that can be undone on a document.
DocUndoRedoDeleteAll (Function)
Deletes the entire history of Undo/Redo mechanism for a Word Processing document.
DocUpdateFormula (Function)
Updates the formulas in a document.
DocUpdateTableOfContents (Function)
Updates the table of the contents of a document.
Functions for managing the Word Processing control (prefix syntax)
The following functions are used to manage Word Processing controls:
Types of variables
24 documents
Types associated with Word processors
WINDEV and WEBDEV propose several types of variables allowing you to handle Word Processing documents...
Word Processing constants
The following constants are used by the functions for managing the Word Processing control:
Word Processing control functions
The following functions are used to manage Word Processing controls: