4D v17
WP Get footer
- 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
4D v17
WP Get footer
WP Get footer
| WP Get footer ( rangeObj ) | (wpDoc ; sectionIndex {; sectionSubType} ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| rangeObj | Object |
|
4D Write Pro range | |||||
| wpDoc | Object |
|
4D Write Pro document | |||||
| sectionIndex | Longint |
|
Section index | |||||
| sectionSubType | Longint |
|
Sub-type of the section (wk first page, wk left page, or wk right page) | |||||
| Function result | Object |
|
4D Write Pro footer reference | |||||
The WP Get footer command returns a reference to the footer associated to the rangeObj range or to the specified sectionIndex of the wpDoc document.
- With the first syntax (using the rangeObj parameter), the command returns the footer of the first page in the range. If a sub-section is active on the page, the command returns the footer of the active sub-section, so it always returns the visible footer.
- With the second syntax (using the wpDoc parameter), the command returns the footer of the specified sectionIndex section (sectionIndex value must be >=1).
If the subSectionType parameter is passed, the command returns the footer associated to the specified sub-section type. You can pass one of the following constants in the subSectionType parameter:
Constant Type Value wk first page Longint 1 wk left page Longint 2 wk right page Longint 3
If the subSectionType is not specified, the main section footer will be returned. In this case, if a sub-section is active, the main section footer object is undefined (the main section footer is available only if there is no active wk first page or wk left page sub-section).
You want to copy the footer of the first page of a 4D Write Pro document to the footer of all pages of another 4D Write Pro document:
C_OBJECT($footerSource;$rangeSource;$tempoc;$footerTarget;$rangeTarget)
$footerSource:=WP Get footer([TEMPLATES]WPtemplate;1;wk first page) //get the first page footer of section 1
$rangeSource:=WP Create range($footerSource;wk start text;wk end text)
$tempoc:=WP New($rangeSource)
$footerTarget:=WP Get footer([Docs]MyWPDoc;1) //all pages of section 1
$rangeTarget:=WP Create range($footerTarget;wk start text;wk end text)
WP INSERT DOCUMENT($rangeTarget;$tempoc;wk replace)
See also
PROPERTIES
Product: 4D
Theme: 4D Write Pro Language
Number:
1504
HISTORY
Created: 4D v16 R5
ARTICLE USAGE
4D Write Pro Reference ( 4D v17)
© 1985-2020 4D SAS / 4D, Inc. All rights reserved.