4D v19
WP Get header
- 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 COMPUTE FORMULAS
- WP DELETE BOOKMARK
- WP DELETE FOOTER
- WP DELETE HEADER
- WP DELETE PICTURE
- WP DELETE STYLE SHEET
- WP DELETE SUBSECTION
- WP EXPORT DOCUMENT
- WP EXPORT VARIABLE
- WP Find allNew
- WP Find nextNew
- WP Find previousNew
- WP FREEZE FORMULAS
- WP GET ATTRIBUTES
- WP Get body
- WP GET BOOKMARKS
- WP Get breaksNew
- WP Get element by ID
- WP Get elements
- WP Get footer
- WP Get formulas
- 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 sheet
- WP Get style sheets
- WP Get subsection
- WP Get text
- WP Get view properties
- WP Import documentUpd
- WP IMPORT STYLE SHEETS
- WP INSERT BREAK
- WP INSERT DOCUMENT
- WP INSERT FORMULA
- 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 sheet
- 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 COLUMNS
- WP TABLE DELETE ROWS
- WP Table get cells
- WP Table get columns
- WP Table get rows
- WP Table insert columns
- WP Table insert rows
- WP Table range
- WP Text range
- WP USE PAGE SETUP
- 4D Write Pro Attributes
4D v19
WP Get header
WP Get header
| WP Get header ( targetObj ) | (wpDoc ; sectionIndex {; subSectionType} ) -> Function result | ||||||||
| Parameter | Type | Description | ||||||
| targetObj | Object |
|
4D Write Pro range or section/sub-section element | |||||
| wpDoc | Object |
|
4D Write Pro document | |||||
| sectionIndex | Longint |
|
Section index | |||||
| subSectionType | Longint |
|
Sub-section type (wk first page, wk left page, or wk right page) | |||||
| Function result | Object |
|
4D Write Pro header | |||||
The WP Get header command returns the header associated to the targetObj or to the specified sectionIndex of the wpDoc document.
- With the first syntax (using the targetObj parameter), the command returns the header of the first page in the range or section/sub-section passed in parameter. If a sub-section is active on the page, the command returns the header of the active sub-section, so it always returns the visible header.
- With the second syntax (using the wpDoc parameter), the command returns the header of the specified sectionIndex section (sectionIndex value must be >=1).
If the subSectionType parameter is passed, the command returns the header 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 header will be returned. In this case, if a sub-section is active, the main section header object is undefined (the main section header is available only if there is no active wk first page or wk left page sub-section).
You want to copy the header of the first page of a 4D Write Pro document to the headers of all pages of another 4D Write Pro document:
C_OBJECT($headerSource;$rangeSource;$tempoc;$headerTarget;$rangeTarget)
$headerSource:=WP Get header([TEMPLATES]WPtemplate;1;wk first page) //get the first page header of section 1
$rangeSource:=WP Text range($headerSource;wk start text;wk end text)
$tempoc:=WP New($rangeSource)
$headerTarget:=WP Get header([Docs]MyWPDoc;1) //all pages of section 1
$rangeTarget:=WP Text range($headerTarget;wk start text;wk end text)
WP INSERT DOCUMENT($rangeTarget;$tempoc;wk replace)
See also
Using a 4D Write Pro area
WP DELETE HEADER
WP Get footer
WP New header
WP Text range
PROPERTIES
Product: 4D
Theme: 4D Write Pro Language
Number:
1503
HISTORY
Created: 4D v16 R5
Modified: 4D v17 R3
ARTICLE USAGE
4D Write Pro Reference ( 4D v19)
© 1985-2021 4D SAS / 4D, Inc. All rights reserved.