4D v17
WP SET TEXT
- 4D Write Pro Reference
-
- 4D Write Pro Language
-
- About 4D Write Pro objects
- Using commands from the Objects (Forms) theme
- Using commands from the Styled Text theme
- Accessing document contents by programming
- 4D Write Pro Constants
- WP Add picture
- WP CREATE BOOKMARK
- WP Create paragraph range
- WP Create picture range
- WP Create range
- WP Create table rangeNew
- WP DELETE BOOKMARK
- WP EXPORT DOCUMENT
- WP EXPORT VARIABLE
- WP GET ATTRIBUTES
- WP Get body
- WP Get bookmark range
- WP GET BOOKMARKS
- WP Get element by IDNew
- WP Get elementsNew
- WP Get footer
- WP Get frame
- WP Get header
- WP Get page count
- WP Get positionNew
- WP Get selection
- WP Get textNew
- WP Import document
- WP INSERT BREAKUpd
- WP INSERT DOCUMENT
- WP INSERT PICTURE
- WP Insert table
- WP Is font style supported
- WP New
- WP PRINT
- WP RESET ATTRIBUTES
- WP SELECT
- WP SET ATTRIBUTES
- WP SET FRAME
- WP SET TEXTNew
- WP Table append row
- WP Table get cellsUpd
- WP Table get columnsUpd
- WP Table get rowsUpd
- WP USE PAGE SETUP
- 4D Write Pro Attributes
WP SET TEXT
| WP SET TEXT ( wpRange ; newText ; textPosition {; rangeUpdate} ) | ||||||||
| Parameter | Type | Description | ||||||
| wpRange | Object |
|
Range object | |||||
| newText | Text |
|
Text to insert | |||||
| textPosition | Number |
|
Insertion position (replace, before, after) | |||||
| rangeUpdate | Number |
|
Includes or excludes the inserted content within the range | |||||
The WP SET TEXT command inserts the text passed in the newText parameter as plain text into a 4D Write Pro document at a specific position designated by the wpRange and textPosition parameters.
In the wpRange parameter, pass a range object to designate the position where text will be inserted. The range can be an explicit location in the 4D Write Pro document or it can be based on a user's selection.
The newText parameter contains the text to be inserted within wpRange. WP SET TEXT inserts plain text only, exactly as its written, but without any style tags.
In the textPosition parameter, the location of the inserted text can be specified by passing one of the following selectors:
| Constant | Comment |
| wk append | Insert contents at end of target |
| wk prepend | Insert contents at beginning of target |
| wk replace | Replace target contents |
In the optional rangeUpdate parameter, you can pass one of the following constants to specify whether or not the inserted contents are included in the resulting range:
| Constant | Comment |
| wk exclude from range | Inserted contents not included in updated range |
| wk include in range | Inserted contents included in updated range (default) |
You want to add text to this document:
Before the existing text:
$range:=WP Create range(myDoc;wk start text;wk end text)
WP SET TEXT($range;" Hello world!";wk prepend)
//writes " Hello world! The quick brown fox jumps over the lazy dog."After the existing text:
$range:=WP Create range(myDoc;wk start text;wk end text)
WP SET TEXT($range;" Hello world!";wk append)
//writes "The quick brown fox jumps over the lazy dog. Hello world!"Replace the existing text:
$range:=WP Create range(myDoc;wk start text;wk end text)
WP SET TEXT($range;" Hello world!";wk replace)
//writes " Hello world!"
Product: 4D
Theme: 4D Write Pro Language
Number:
1574
Created: 4D v17
4D Write Pro Reference ( 4D v17)
