WP Get footer

Home

4D v20 R7

WP Get footer


WP Get footer ( 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 Fußteil

Beschreibung

Die Funktion WP Get footer gibt den Fußteil zurück, der dem Range targetObj oder in sectionIndex des Dokuments wpDoc zugewiesen ist. Wenn kein Fußteil in Bezug auf den/die Parameter gefunden wird, gibt der Befehl Null zurück.

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

Mit der zweiten Syntax (Parameter wpDoc) gibt die Funktion den in sectionIndex angegebenen Fußteil zurück (Wert von sectionIndex muss >=1 sein).
Ist der Parameter subSectionType übergeben, gibt die Funktion den Fußteil 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 Fußteil des Hauptabschnitts zurückgegeben. Ist in diesem Fall ein Unterabschnitt aktiv, ist der Fußteil des Hauptabschnitts undefiníert, d.h. der Fußteil des Hauptabschnitts ist nur verfügbar, wenn es keinen aktiven Unterabschnitt wk first page oder wk left page gibt.

Beispiel

Den Fußteil der ersten Seite eines 4D Write Pro Dokuments in die Fußteile aller Seiten eines anderen 4D Write Pro Dokuments kopieren:

 C_OBJECT($footerSource;$rangeSource;$tempoc;$footerTarget;$rangeTarget)

 

 $footerSource:=WP Get footer([TEMPLATES]WPtemplate;1;wk first page) //den Fußteil von Abschnitt 1 auf der ersten Seite erhalten

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

 $tempoc:=WP New($rangeSource)

 

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

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

 

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

Siehe auch

4D Write Pro Bereich verwenden
WP DELETE FOOTER
WP Get frame
WP Get header
WP New footer