DocReplace (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DocReplace (Function)

In french: DocRemplace

Finds all the instances of a character string and replaces them with another string:

in an entire Word Processing document.
Versions 24 and later
in a fragment.
New in version 24
in a fragment.
in a fragment.

Caution: This documentation presents the last features of the Word Processing control. Make sure that all the necessary modules are updated.

Example

// Replace all "%CustomerName%" by the customer name
DocReplace(WP_MyDocument, "%CustomerLastName%", Customer.LastName)

// Replace "Presentation" by "PRESENTATION"
DocReplace(WP_NoName1, "Presentation", "PRESENTATION", WholeWord)

Syntax

DocReplace(<Search scope> , <Text to replace> , <Replacement text> [, <Options>])

<Search scope>: Document variable, docFragment variable or control name

Element in which the the find and replace must be done. This element can correspond to:
the name of a Word Processing control.
a Document variable.
Versions 24 and later
a docFragment variable.
New in version 24
a docFragment variable.
a docFragment variable.

<Text to replace>: Character string (with quotes)

Text to find and to replace in the document. If this parameter corresponds to an empty string (""), the document will not be modified.

<Replacement text>: Character string (with quotes)

Character string that will replace <Text to replace>. If this parameter corresponds to an empty string (""), all the occurrences of <Text to replace> will be deleted

<Options>: Optional constant (or combination of constants)

Search options for the text to replace:
WholeWord Search for the whole word (enclosed in punctuation characters or in space characters).
IgnoreCase Search while ignoring the case (lowercase/uppercase characters) and the accented characters.

The search is case sensitive by default: the searched text and the text to find must have the same case. To perform a search while ignoring the case, use the IgnoreCase constant.

Business / UI classification: UI Code

Component: wd260mdl.dll