4D v16
WP INSERT PICTURE
- 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 CREATE BOOKMARKNew
- WP DELETE BOOKMARKNew
- WP EXPORT DOCUMENT
- WP EXPORT VARIABLE
- WP GET ATTRIBUTES
- WP Get bookmark rangeNew
- WP GET BOOKMARKSNew
- WP Get page countNew
- WP Get paragraphs
- WP Get pictures
- WP Get range
- WP Get selection
- WP Import document
- WP INSERT BREAKNew
- WP INSERT DOCUMENTNew
- WP INSERT PICTURENew
- WP Is font style supported
- WP NewUpd
- WP PRINTUpd
- WP RESET ATTRIBUTES
- WP SELECT
- WP SET ATTRIBUTES
- WP USE PAGE SETUP
- 4D Write Pro Attributes
WP INSERT PICTURE
| WP INSERT PICTURE ( rangeObj ; picture ; mode {; rangeUpdate} ) | ||||||||
| Parameter | Type | Description | ||||||
| rangeObj | Object |
|
Range object | |||||
| picture | Picture, String |
|
Picture field or variable, or path to picture file on disk | |||||
| mode | Longint |
|
Insertion mode | |||||
| rangeUpdate | Longint |
|
Range update mode | |||||
The WP INSERT PICTURE command inserts the picture in the rangeObj according to the specified insertion mode and rangeUpdate parameter. The picture will be inserted as a character in the rangeObj.
In rangeObj, pass a valid 4D Write Pro standard range object. A rangeObj is a part of a 4D Write Pro document; it can be created using the , WP Get bookmark range or WP Get range commands.
In picture, you can pass:
- either a 4D picture field or variable,
- or a string containing a path to a picture file stored on disk, expressed using the system syntax. If you use a string, you can pass either a full pathname, or a pathname relative to the database structure file. You can also pass a file name, in which case the file must be located next to the database structure file. If you pass a file name, you need to indicate the file extension.
Any picture format supported by 4D can be used (see the Pictures section). You can get the list of available picture formats using the PICTURE CODEC LIST command. If the picture encapsulates several formats (codecs), 4D Write Pro only keeps one format for display and one format for printing (if different) in the document; the "best" formats are automatically selected.
In the mode parameter, pass one of the following constants to indicate the insertion mode to be used on the picture in the document:
| Constant | Type | Value | Comment |
| wk append | Longint | 2 | Insert contents at end of range |
| wk prepend | Longint | 1 | Insert contents at beginning of range |
| wk replace | Longint | 0 | Replace range contents |
In the optional rangeUpdate parameter, you can pass one of the following constants to specify whether or not the inserted picture is included in the range:
| Constant | Type | Value | Comment |
| wk exclude from range | Longint | 1 | Inserted contents not included in updated range |
| wk include in range | Longint | 0 | Inserted contents included in updated range (default) |
Note: If you do not pass a rangeUpdate parameter, by default the inserted picture is included in the range.
In the following example, a user selects the picture they want to insert into the range object and will be warned if this picture could not be inserted:
C_OBJECT($wpRange)
$wpRange:=WP Get selection([EXAMPLES]wpDoc)
C_BOOLEAN($fail)
$fail:=False
//ask user to choose a picture on the disk that they want to insert
$imgRef:=Open document("")
//if user does not cancel
If(OK=1)
//if the file is a supported picture file
If(Is picture file(document))
// insert picture selected by user
WP INSERT PICTURE($wpRange;document;wk replace)
Else
$fail:=True
End if
Else
$fail:=True
End if
//if the insertion failed, alert the user
If($fail)
ALERT("Picture insertion failed")
End if
Product: 4D
Theme: 4D Write Pro Language
Created: 4D v16
4D Write Pro Reference ( 4D v16)
