TextReplace

$image\bltlrgss.gif$ Editions $image\bltlrgss.gif$ Related Transactions $image\bltlrgss.gif$ Example

The TextReplace transaction searches for a text string in the specified edit layer and replaces it with a new text string. Only text in text objects and annotations can be found and replaced. Text from text documents cannot.

Type XTYP_EXECUTE or XTYP_REQUEST

Syntax [TextReplace(docwinID, layerID, searchType, "searchString", "replaceString", occurrence, <pageID>)]

Parameter	Data type	Values	Meaning
docwinID	DWORD	0 \| docwinID	active \| specific
layerID	DWORD	identifier of the edit layer to search
searchType	WORD	0	exact match
searchString	string	string to search for
replaceString	string	string to replace searchString with
occurrence	WORD	0 other number	all matches specific number of matches
pageID	DWORD	0 \| pageID	current \| specific. Optional parameter.
Reply	Data type	Values	Meaning
count	WORD	0 1 \| 2 \| 3 \| ...	no matches number of matches replaced. See Remarks.

Remarks

A reply is only returned if this transaction is set up as an XTYP_REQUEST.

The display must be redrawn (using either the user interface or the Refresh transaction) for the result of this transaction to be visible.

$image\tips.gif$ Parameter tip

Release information

Added in Release 3.80.