4D v17
WP SELECT
- 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 SELECT
| WP SELECT ( {* ;} wpArea {; targetObj} | {; startRange ; endRange} ) | ||||||||
| Parameter | Type | Description | ||||||
| * | Operator |
|
If specified, wpArea is a form object name (string). If omitted, wpArea is an object field or variable. | |||||
| wpArea | String, Object |
|
Form object name (if * is specified) or 4D Write Pro object variable or field (if * is omitted) | |||||
| targetObj | Object |
|
Range or element reference | |||||
| startRange | Longint |
|
Starting offset of text range | |||||
| endRange | Longint |
|
Ending offset of text range | |||||
The WP SELECT command creates a new selection in the 4D Write Pro wpArea area, based upon the targetObj or a new range defined by startRange and endRange.
If you pass the optional * parameter, you indicate that wpArea is a form object name (string). If you do not pass this parameter, you indicate that wpArea is a 4D Write Pro object variable or field. If no valid 4D Write Pro area is passed in the wpArea parameter, the command does nothing.
Note: This command can only be used if the wpArea is associated with a form object (i.e. it is displayed in the form).
To define the selection, you can either pass an existing object in targetObj, or pass a pair of startRange / endRange boundaries:
- First syntax: WP SELECT({* ;} wpArea ; targetObj)
targetObj can be:- a range, or
- an element reference (table / row / paragraph / anchored or inline picture / body / header / footer)
- Second syntax: WP SELECT({* ;} wpArea ; startRange ; endRange)
In startRange and endRange, pass values corresponding to the position of the first and last characters to select in the area.
You can pass wk start text in startRange to define the beginning of the area, and wk end text in endRange to define the end of the area. Keep in mind that a 4D Write Pro document not only contains visible text but also formatting tags that are included in the range.
The following code:
$range:=WP Create range([SAMPLE]WP;wk start text;12)
WP SELECT(*;"WParea";$range)... will have the same result as:
WP SELECT(*;"WParea";wk start text;12)
Product: 4D
Theme: 4D Write Pro Language
Number:
1348
Created: 4D v15 R4
Modified: 4D v16 R5
Modified: 4D v16 R6
4D Write Pro Reference ( 4D v17)
