WP Get breaks

Home

4D v20 R7

WP Get breaks


WP Get breaks ( targetObj {; breakType} ) -> Funktionsergebnis

Parameter	Typ	Beschreibung
targetObj	Objekt	Range, Element oder 4D Write Pro Dokument
breakType	Lange Ganzzahl	Umbruchtyp zum Zurückgeben
Funktionsergebnis	Collection	Collection der Ranges

Beschreibung

Der Befehl WP Get breaks gibt die Collection aller in targetObj eingefügten Umbrüche zurück.

Dieser Befehl gibt nur Umbrüche zurück, die von einem Benutzer oder über Code eingegeben wurden, und nicht solche, die automatisch von 4D Write Pro zu Layoutzwecken erzeugt wurden.

Im Parameter targetObj können Sie übergeben:

ein Range oder
ein Element (Tabelle / Zeile / Zelle(n) / Absatz / Hauptteil / Kopfteil / Fußteil / Abschnitt / Unterabschnitt / Textfeld) oder
ein 4D Write Pro Dokument.

Standardmäßig werden Umbrüche eines beliebigen Typs zurückgegeben. Sie können einen bestimmten Umbruchtyp für die Rückgabe auswählen, indem Sie eine der folgenden Konstanten im optionalen Parameter breakType übergeben:

Konstante	Wert	Kommentar
wk column break	3	Spaltenumbruch: Fügt einen Spaltenumbruch ein
wk continuous section break	5	Definiert einen kontinuierlichen Abschnittswechsel (wird oft verwendet, um die Anzahl der Spalten zu ändern, ohne eine neue Seite zu beginnen).
wk line break	0	Zeilenumbruch (im gleichen Absatz)
wk page break	2	Seitenumbruch: definiert eine neue Seite
wk paragraph break	4	Absatzumbruch: definiert einen neuen Absatz
wk section break	1	Abschnittsumbruch: definiert einen neuen Abschnitt

Zurückgegebener Wert

WP Get breaks gibt eine Collection von Range-Objekten zurück, von denen jedes einen Umbruch innerhalb des targetObj beschreibt. In jedem Range-Objekt ist eine bestimmte schreibgeschützte Eigenschaft verfügbar, die den Umbruchtyp angibt:

Eigenschaft	Typ	Konstant	Beschreibung
[ ].breakType	Zahl	wk break type	Read-only: Art des Umbruchs

Wenn targetObj ein Range oder Element ist, werden Umbrüche in der Reihenfolge zurückgegeben, in der sie gefunden werden. Wenn targetObj ein 4D Write Pro Dokument ist, werden Umbrüche in der folgenden Reihenfolge zurückgegeben:

Hauptteil
Kopfteil erste Seite für Abschnitt 1 (falls vorhanden)
Fußteil erste Seite für Abschnitt 1 (falls vorhanden)
Kopfteil linke Seite für Abschnitt 1 (falls vorhanden)
Fußteil linke Seite für Abschnitt 1 (falls vorhanden)
Kopfteil rechte Seite für Abschnitt (falls vorhanden)
Fußteil rechte Seite für Abschnitt 1 (falls vorhanden)
Hauptkopfteil für Abschnitt 1 (falls vorhanden)
Hauptfußteil für Abschnitt 1 (falls vorhanden)
Wiederholen mit Abschnitt 2, Abschnitt 3 und so weiter.
Textfelder.

Eine leere Collection wird zurückgegeben, wenn targetObj keinen Umbruch (bzw. des angeforderten BreakType) enthält.

Beispiel

Sie möchten alle Zeilenumbrüche durch Absatzumbrüche im Dokument ersetzen:

 var $_filteredBreaks : Collection

 var $break : Object

 $_filteredBreaks:=WP Get breaks(WParea;wk line break)

 For each($break;$_filteredBreaks)

    WP INSERT BREAK($break;wk paragraph break;wk replace)

 End for each

Siehe auch

WP Get elements
WP INSERT BREAK