Manipulating Word Processing controls programmatically (prefix syntax)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Word Processing control

Overview
Manipulating Word Processing controls programmatically
Opening and creating a docx document in a Word Processing control
Saving a docx document
Performing a search in a document and modifying the search result
Handling the selection
Adding text into a document
Adding a page break into a document
Management of bookmarks
Sequencing reports and Word Processing documents
Word Processing control properties

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Manipulating Word Processing controls programmatically (prefix syntax)

Overview

Word Processing controls can be manipulated programmatically.

To handle the Word Processing control, WLanguage proposes:

a set of functions used to perform all the common operations (direct programming via the WLanguage DocXXX functions. For more details, see Word Processing control functions.
an advanced programming via the different advanced types of WLanguage used to directly handle the content of the docx file displayed by the Word Processing control. For more details, see Types associated with the Word Processing control.

This help page explains how to programmatically manipulate Word Processing controls.

Manipulating Word Processing controls programmatically

Opening and creating a docx document in a Word Processing control

To open an existing docx document through programming in a Word Processing control, you can:

assign the docx file to the Word Processing control. For example:

// Select a .docx file in the current directory
sFileName is string
sFileName = fSelect("", "presentation.docx", ...
	"Selecting DocX files", ...
	"Docx file (*.docx)" + TAB + "*.docx", "*.docx", fselOpen)

IF sFileName ~= "" THEN
	// No selected file
	RETURN
END

// Load the docx file
WP_MyDocument = sFileName

use <Word Processing>.Open.
For example:

WP_MyDocument = Open("C:\Users\test\Documents\file.docx")
IF ErrorOccurred() THEN
	Error(ErrorInfo())
RETURN

use a Document variable and assign it to the Word Processing control.
For example:

MyDocument is Document
MyDocument = "C:\temp\presentation.docx"
WP_MyDocument = MyDocument

or:

MyDocument is Document
MyDocument = DocOpen("C:\Users\test\Documents\file.docx")
IF ErrorOccurred() THEN
	Error(ErrorInfo())
ELSE
	WP_MyDocument = MyDocument
END

Please note: only files in docx format can be manipulated by the Word Processing control.

Tip To display an empty document in a Word Processing control, simply assign the Word Processing control with an empty string.
Example:

// Create a blank document
WP_MyDocument = ""

Saving a docx document

To save a docx document, all you have to do is use <Word Processing>.Save.

Example:

// On choisit le répertoire et le nom de sauvegarde 
sNomFichier is string = fSelect(CompleteDir(fExeDir()), "présentation.docx", ...
	"Sélection de fichiers DocX","Fichier Docx (*.docx)" + TAB + "*.docx" , "*.docx", fselCreate)

// On sauvegarde le fichier
TT_SansNom1.Sauve(sNomFichier)

IF ErrorOccurred THEN
	Error(StringBuild("Le fichier %1 n'a pas pu être enregistré.", sNomFichier), ErrorInfo())
	RETURN
END

Remarks:

The content of Word Processing control can also be:
- printed (iPrintDoc).
- saved in PDF format (<Word Processing>.ToPDF).
<Word Processing>.ToText is used to retrieve the document text.
<Word Processing>.ToImage is used to convert a document page into image.

Performing a search in a document and modifying the search result

To perform a search in a Word Processing document, all you have to do is use <Word Processing>.Seek.

Example:

// Recherche du mot "BEAUGRAND" dans le texte 
// Sélectionne uniquement le premier trouvé pour changer sa couleur
tabFragments is array of docFragment = TT_SansNom1.Recherche("BEAUGRAND")

IF tabFragments.Count >= 1 THEN
	// Positionnement du curseur au début du premier mot trouvé
	TT_SansNom1.Curseur = tabFragments[1].StartPosition
	// Calcul de la longueur de la sélection
	TT_SansNom1.LongueurSélection = ...
				tabFragments[1].EndPosition - tabFragments[1].StartPosition+1
	// Modification de la couleur du texte
	tabFragments[1].Formatting.TextColor = PastelRed
	BREAK
END

In this code, the docFragment variable corresponds to the text section containing the searched word, as well as its position in the entire text. Then, you have the ability to handle the fragment found.

Handling the selection

To handle the selection currently performed in a Word Processing control, you have the ability to retrieve this selection in a docFragment variable.

The following code is used to change the color of selected text.
Example:

// Changement de la couleur de la sélection
// Récupération de la sélection actuelle
MaSélection is docFragment(TT_MonDocument, TT_MonDocument.Curseur, ...
		TT_MonDocument.LongueurSélection)
// Changement de la couleur
MaSélection.Formatting.TextColor = PastelRed

The docFragment variable owns a specific constructor used to easily retrieve the selection.

Adding text into a document

Several methods can be used to add text into an existing document:

Inserting a fragment at the desired position. Example:

// Insert a text at the end of document 
frag2 is docFragment(WP_MyDoc, -1 , 0)
frag2.Text += "End text"

Inserting a text from a given position with <Word Processing>.Insert.
```
WP_Document.Insert(WP_Document.Cursor, "My inserted text")
```
Adding a text at the end of document with <Word Processing>.Add.

To add text into an empty document, you can:

use the direct assignment of control:
<Word Processing control> = "Text to insert"
Example:
```
WP_MyDocument = "I am the first sentence of this document."
```
add the text with <Word Processing>.Add.

insert a fragment in first position. Example:

// sInitialText contains the text to insert 
frag is docFragment(WP_MyDoc, WP_MyDoc.Cursor, 0)
frag.Text += sInitialText

insert a text from position 1 with <Word Processing>.Insert.
```
WP_Document.Insert(1, "My inserted text")
```

Adding a page break into a document

The following code is used to add a page break into a document:

// Add a page break 
WP_NoName1.Add(Charact(12))

You can also use the following constants to add the desired type of break to a document or fragment:

docColumnJump: Adds a column jump to a multicolumn section. If the section is not multicolumn, a page break is added.
docLineFeed: Adds a line feed.
docPageFeed: Adds a page feed.
docParagraphJump: Adds a paragraph break.

Example:

// Add a page break 
WP_NoName1.Add(docPageBreak + "Text on next page")

Management of bookmarks

You have the ability to manage bookmarks in a Word Processing document. For example:

Add a bookmark: Adds a bookmark named MyBookmark with the selected text.

doc is Document
doc <- WP_MyDocument
fragSelection is docFragment = TT_MyDocument.Selection.Fragment
doc.Bookmark["MyBookmark"] = fragSelection

Delete a bookmark: Deletes the bookmark with the name Bookmark1:

doc is Document
doc <- WP_MyDocument
Delete(doc.Bookmark, "Bookmark1")

List bookmarks: Lists the bookmarks of a document:

doc is Document 
doc <- WP_MyDocument
FOR EACH uABookmark,BookmarkName of doc.Bookmark
	Trace(BookmarkName) // Bookmark name
	Trace(uABookmark.Text) // Bookmark text
END

Inserting a text at the end of bookmark:

doc is Document <- TT_MonDocument.Valeur
// Recherche de la position du signet 
fragmentSignet is docFragment = doc.Bookmark["Signet 1"]
IF fragmentSignet <> Null THEN
	// Insertion du texte à la fin du signet
	let nPositionInsertion = fragmentSignet.EndPosition
	// Insertion à proprement dite
	TT_MonDocument.Insère(nPositionInsertion, "Texte à insérer à la position du signet")
ELSE
	Error("Signet 'Signet 1' non trouvé dans le document")
END

Sequencing reports and Word Processing documents

You now have the ability to sequence reports and Word Processing documents.

To do so, iSequencingAddDoc must be used in addition to the standard functions for creating sequences of reports. For example:

MyDocument is Document = "c:\temp\generalconditions.docx"

// Print in the report viewer
iDestination(iViewer)
// Add reports into the sequence
iSequencingAdd(RPT_Report1)
iSequencingAdd(RPT_Report2, 3)
// Add the general conditions in document format
iSequencingAddDoc(MyDocument)
iSequencingPrint()

For more details, see Sequencing reports.

Word Processing control properties

The following properties are specific to the Word Processing control. They are mainly used to handle the control characteristics:


AutoCorrect	The AutoCorrect property allows you to define a set of automatic corrections to be applied in a Word Processing control as the user types.
AutomaticLink	The property AutomaticLink property allows you to: determine if the automatic link detection mode is enabled, enable or disable the automatic link detection mode.
DisplayBookmarks	The DisplayBookmarks property is used to: identify the display mode of bookmarks in a Word Processing control. show or hide bookmarks in a Word Processing control.
DisplayFormattingMarks	The DisplayFormattingMarks property is used to: Determine if formatting marks are shown or hidden in a Word Processing control. Show or hide formatting marks in a Word Processing control.
DisplayMode	The DisplayMode property gets and changes: the display mode in a Word Processing control, the display mode in a PDF Reader control the display mode in an HTML Editor control, the display mode in a Kanban control
FilePath	The FilePath property gets: the name of the xlsx file associated with a Spreadsheet control. the name of the file associated with an Image Editor control. the name of the PDF file associated with a PDF Reader control. the name of the DOCX file associated with a Word Processing control. the name of the wddiag file associated with a Diagram Editor control.
FormattingMarksColor	The FormattingMarksColor property is used to: get the color of the formatting marks in a Word Processing control. change the color of the formatting marks in a Word Processing control.
HTMLEdit	The property EditionHTML property property allows you to: find out whether a Word Processing control is displayed in optimized mode for HTML editing, modify a Word Processing control to display it (or not) in optimized mode for HTML editing.
NumberAccessiblePages	The NumberAccessiblePages property is used to get the number of pages currently loaded in a PDF Reader or Word Processing control.
NumberDisplayedPage	The NumberDisplayedPage property is used to identify and change the number of the page currently displayed in the PDF Reader or Word Processing control.
NumberPage	The property PageNumber property is used to identify: the number of pages in a "multi-page" image file. This image is displayed in an Image control or in the background of a Chart control. the number of pages in a PDF file displayed in an Image control. the number of pages found in a PDF file displayed in a PDF Reader control. the number of pages found in a DOCX file displayed in a Word Processing control.
RuleVisible	The property RuleVisible property allows you to: Find out whether the rulers are visible or invisible in a Word Processing control. Make the rulers visible or invisible in a Word Processing control.
Selection	The property Selection property displays the characteristics of the selection (or cursor): in a Word Processing control. Note: This selection is located in the part being edited (body, header or footer). in a Spreadsheet control. in an HTML Editor control. in a Diagram Editor control.
SelectionLength	The SelectionLength property gets and sets the length of the selection made in a Word Processing control.
ToolbarVisible	The property BarreOutilsVisible property: determine if the toolbar or the ribbon is displayed in a control. show or hide the toolbar or the ribbon in a control.

For a complete list of WLanguage properties that can be used with Word Processing controls, see Word Processing control properties.