4D v17
WP Get selection
- 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 Get selection
| WP Get selection ( {* ;} wpArea ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| * | Operator |
|
If specified, wpArea is a form object name (string). If omitted, wpArea is an object field or variable. | |||||
| wpArea | String |
|
Form object name (if * is specified) or 4D Write Pro object variable or field (if * is omitted) | |||||
| Function result | Object |
|
Range or Picture object | |||||
The WP Get selection command returns a new range object or a picture object based upon the currently selected content in the wpArea 4D Write Pro area.
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, an empty object is returned.
Note: This command can only be used if a wpArea is associated to a form object (i.e., it's displayed on the form).
If an anchored image (picture at a fixed location) is selected in wpArea, WP Get selection returns a picture reference object and not a range object (for more information, please refer to the WP Add picture command description). Otherwise, WP Get selection returns a new range object. For more information on range objects, please refer to Range handling commands.
You want to get the selected text from a 4D Write Pro area:
$range:=WP Get selection(*;"WParea")
WP Create paragraph range
WP Create picture range
WP Create range
Product: 4D
Theme: 4D Write Pro Language
Number:
1340
Created: 4D v15 R4
Modified: 4D v16 R6
4D Write Pro Reference ( 4D v17)
