4D v18
WP SET 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 Bookmark range
- WP DELETE BOOKMARK
- WP DELETE FOOTER
- WP DELETE HEADER
- WP DELETE STYLE SHEETNew
- WP DELETE SUBSECTION
- WP EXPORT DOCUMENT
- WP EXPORT VARIABLE
- WP GET ATTRIBUTES
- WP Get body
- WP GET BOOKMARKS
- WP Get element by ID
- WP Get elements
- WP Get footer
- WP Get frame
- WP Get header
- WP Get links
- WP Get page count
- WP Get position
- WP Get section
- WP Get sections
- WP Get style sheetNew
- WP Get style sheetsNew
- WP Get subsection
- WP Get text
- WP Get view properties
- WP Import document
- WP IMPORT STYLE SHEETSNew
- WP INSERT BREAK
- WP INSERT DOCUMENT
- WP INSERT PICTURE
- WP Insert table
- WP Is font style supported
- WP New
- WP NEW BOOKMARK
- WP New footer
- WP New header
- WP New style sheetNew
- WP New subsection
- WP Paragraph range
- WP Picture range
- WP PRINT
- WP RESET ATTRIBUTES
- WP SELECT
- WP Selection range
- WP SET ATTRIBUTES
- WP SET FRAME
- WP SET LINK
- WP SET TEXT
- WP SET VIEW PROPERTIES
- WP Table append row
- WP TABLE DELETE COLUMNSNew
- WP TABLE DELETE ROWSNew
- WP Table get cellsUpd
- WP Table get columnsUpd
- WP Table get rowsUpd
- WP Table insert columnsNew
- WP Table insert rowsNew
- WP Table range
- WP Text range
- WP USE PAGE SETUP
- 4D Write Pro Attributes
4D v18
WP SET FRAME
WP SET FRAME
| WP SET FRAME ( {* ;} wpArea ; frameSelector ) | ||||||||
| 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) | |||||
| frameSelector | Longint |
|
Frame where the cursor should be set | |||||
The WP SET FRAME command sets the cursor into the frame designated by frameSelector in 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).
You can pass in frameSelector 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 page footer | Longint | 2 | |
| wk current page header | Longint | 1 | |
| 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 |
- If wk current page header or wk current page footer is passed in frameSelector, WP SET FRAME will give focus to the first selected page header or footer, no matter the sub-section type (if it does not contain any header or footer, the command will do nothing).
- If any of the wk current section[...] constants are passed in frameSelector, WP SET FRAME will give focus to the specified sub-section header or footer of the first selected section (if it does not contain any header or footer, the command will do nothing).
- WP SET FRAME will do nothing if the frameSelector frame does not exist for the selection section (for example, wk current section left header when there is no distinction between left and right pages in wpArea).
You want to set the cursor to the left footer of the current section:
WP SET FRAME(*;"WPArea";wk current section left footer)
See also
PROPERTIES
Product: 4D
Theme: 4D Write Pro Language
Number:
1518
HISTORY
Created: 4D v16 R5
ARTICLE USAGE
4D Write Pro Reference ( 4D v18)
© 1985-2020 4D SAS / 4D, Inc. All rights reserved.