WP Get header

Home

4D v20 R7

WP Get header


WP Get header ( targetObj ) \| (wpDoc ; sectionIndex {; subSectionType} ) -> Funktionsergebnis

Parameter	Typ	Beschreibung
targetObj	Objekt	4D Write Pro Range oder Element Abschnitt/Unterabschnitt
wpDoc	Objekt	4D Write Pro Dokument
sectionIndex	Lange Ganzzahl	Index des Abschnitts
subSectionType	Lange Ganzzahl	Typ des Unterabschnitts (wk first page, wk left page oder wk right page)
Funktionsergebnis	Objekt	4D Write Pro Referenz auf Kopfteil

Beschreibung

Die Funktion WP Get header gibt den Kopfteil zurück, der im Parameter targetObj oder sectionIndex des Dokuments wpDoc zugewiesen ist.Wenn kein Kopfteil in Bezug auf den/die Parameter gefunden wird, gibt der Befehl Null zurück.

Mit der ersten Syntax (Parameter targetObj) gibt die Funktion den Kopfteil der ersten Seite in "Range" oder dem Abschnitt/Unterabschnitt zurück. Ist auf der Seite ein Unterabschnitt aktiv, wird der Kopfteil des aktiven Unterabschnitts zurückgegeben, so dass immer der sichtbare Kopfteil zurückgegeben wird.

Mit der zweiten Syntax (Parameter wpDoc) gibt die Funktion den in sectionIndex angegebenen Kopfteil zurück (Wert von sectionIndex muss >=1 sein).
Ist der Parameter sectionIndexType übergeben, gibt die Funktion den Kopfteil des hier angegebenen Typs zurück. Sie können eine der folgenden Konstanten übergeben:

Konstante	Typ	Wert
wk first page	Lange Ganzzahl	1
wk left page	Lange Ganzzahl	2
wk right page	Lange Ganzzahl	3

Ist subsectionType nicht angegeben, wird der Kopfteil des Hauptabschnitts zurückgegeben. Ist in diesem Fall ein Unterabschnitt aktiv, ist der Kopfteil des Hauptabschnitts undefiníert, d.h. der Kopfteil des Hauptabschnitts ist nur verfügbar, wenn es keinen aktiven Unterabschnitt wk first page oder wk left page gibt.

Beispiel

Den Kopfteil der ersten Seite eines 4D Write Pro Dokuments in die Kopfteile aller Seiten eines anderen 4D Write Pro Dokuments kopieren:

 C_OBJECT($headerSource;$rangeSource;$tempoc;$headerTarget;$rangeTarget)

 

 $headerSource:=WP Get header([TEMPLATES]WPtemplate;1;wk first page) //den Kopfteil von Abschnitt 1 auf der ersten Seite erhalten

 $rangeSource:=WP Text range($headerSource;wk start text;wk end text)

 $tempoc:=WP New($rangeSource)

 

 $headerTarget:=WP Get header([Docs]MyWPDoc;1) //alle Seiten von Abschnitt 1

 $rangeTarget:=WP Text range($headerTarget;wk start text;wk end text)

 

 WP INSERT DOCUMENT($rangeTarget;$tempoc;wk replace)

Siehe auch

4D Write Pro Bereich verwenden
WP DELETE HEADER
WP Get footer
WP New header
WP Text range