4D v17
WP Get frame
- 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 frame
| WP Get frame ( {* ;} 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 | Longint |
|
Frame where the cursor is currently set | |||||
The WP Get frame command returns the frame where the cursor is currently set within the 4D Write Pro wpArea 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.
Note: This command can only be used if the wpArea is associated with a form object (i.e. it is displayed in the current form/page).
The returned value can be compared to one of the following constants from the 4D Write Pro Constants theme:
| Constant | Type | Value | Comment |
| wk body | Longint | 0 | Body frame of the section |
| wk current section default footer | Longint | 10 | Default footer of the section (available only if there is no active subsection footer) |
| wk current section default header | Longint | 9 | Default header of the section (available only if there is no active subsection header) |
| wk current section first footer | Longint | 4 | Footer of the first page of the section |
| wk current section first header | Longint | 3 | Header of the first page of the section |
| wk current section left footer | Longint | 6 | Footer of the left page(s) of the section |
| wk current section left header | Longint | 5 | Header of the left page(s) of the section |
| wk current section right footer | Longint | 8 | Footer of the right page(s) of the section |
| wk current section right header | Longint | 7 | Header of the right page(s) of the section |
You want to make sure the user has set the cursor in a header or a footer frame:
C_LONGINT($frameGet)
$frameGet:=WP Get frame(*;"WParea")
If($frameGet=wk body)
ALERT("Please select a footer or a header.")
End if
Product: 4D
Theme: 4D Write Pro Language
Number:
1519
Created: 4D v16 R5
4D Write Pro Reference ( 4D v17)
