WP Get header

Home

4D v17

WP Get header


WP Get header ( AusschnittObj ) \| (wpDok ; AusschnittIndex {; UnterAbschnittTyp} ) -> Funktionsergebnis

Parameter	Typ	Beschreibung
AusschnittObj	Objekt	4D Write Pro Ausschnitt
wpDok	Objekt	4D Write Dokument
AusschnittIndex	Lange Ganzzahl	Index des Ausschnitts
UnterAbschnittTyp	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 eine Referenz auf den Kopfteil zurück, der dem Ausschnitt AusschnittObj zugewiesen oder in AbschnittIndex des Dokuments wpDok angegeben ist.

Mit der ersten Syntax (Parameter AusschnittObj) gibt die Funktion den Kopfteil der ersten Seite im Ausschnitt 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 wpDok) gibt die Funktion den in AbschnittIndex angegebenen Kopfteil zurück (Wert von AbschnittIndex muss >=1 sein).
Ist der Parameter UnterAbschnittTyp ü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 UnterAbschnittTyp 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 [#cst id="3479137"/] 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 Create 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 Create range($headerTarget;wk start text;wk end text)

 

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

Siehe auch

4D Write Pro Bereich verwenden
WP Create range
WP Get footer