Word.PageSetup class
Stellt die Einstellungen für die Seiteneinrichtung für ein Word-Dokument oder einen Abschnitt dar.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-section-starts.yaml
await Word.run(async (context) => {
// Configure document-wide page settings for a report that will be printed and bound.
const pageSetup: Word.PageSetup = context.document.pageSetup;
pageSetup.set({
paperSize: Word.PaperSize.letter,
orientation: Word.PageOrientation.portrait,
topMargin: 72,
bottomMargin: 72,
leftMargin: 90,
rightMargin: 72,
gutter: 18,
gutterPosition: Word.GutterPosition.left,
mirrorMargins: true,
oddAndEvenPagesHeaderFooter: true
});
const sections: Word.SectionCollection = context.document.sections;
sections.load("items");
await context.sync();
// Start the main chapter on an odd-numbered page so it appears on the right in a bound document.
const chapterPageSetup: Word.PageSetup = sections.items[1].pageSetup;
chapterPageSetup.sectionStart = Word.SectionStart.oddPage;
chapterPageSetup.differentFirstPageHeaderFooter = true;
// Keep the appendix in a separate section, but let it begin on the current page.
sections.items[2].pageSetup.sectionStart = Word.SectionStart.continuous;
await context.sync();
console.log("Applied print and binding settings to the report.");
});
Eigenschaften
| book |
Gibt an, ob Microsoft Word das Dokument als Broschüre druckt. |
| book |
Gibt die Anzahl der Seiten für jede Broschüre an. |
| book |
Gibt an, ob Microsoft Word die Druckreihenfolge beim Buchfalzdruck von bidirektionalen oder asiatischsprachigen Dokumenten umkehrt. |
| bottom |
Gibt den Abstand (in Punkt) zwischen dem oberen Rand der Seite und der unteren Begrenzungslinie des Textkörpers an. |
| chars |
Gibt die Anzahl der Zeichen pro Zeile im Dokumentraster an. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| different |
Gibt an, ob die erste Seite unterschiedliche Kopf- und Fußzeilen hat. |
| footer |
Gibt den Abstand zwischen der Fußzeile und dem unteren Seitenrand in Punkten an. |
| gutter | Gibt die Menge (in Punkt) des zusätzlichen Randbereichs an, der jeder Seite in einem Dokument oder Abschnitt für die Bindung hinzugefügt wird. |
| gutter |
Gibt an, auf welcher Seite die Bundstege in einem Dokument angezeigt wird. |
| gutter |
Gibt an, ob Microsoft Word für das aktuelle Dokument Rinnstege basierend auf einer Rechts-nach-links-Sprache oder einer Links-nach-rechts-Sprache verwendet. |
| header |
Gibt den Abstand zwischen der Kopfzeile und dem oberen Rand der Seite in Punkten an. |
| layout |
Gibt den Layoutmodus für das aktuelle Dokument an. |
| left |
Gibt den Abstand (in Punkt) zwischen dem linken Rand der Seite und der linken Begrenzungslinie des Textkörpers an. |
| line |
Gibt ein |
| lines |
Gibt die Anzahl der Zeilen pro Seite im Dokumentraster an. |
| mirror |
Gibt an, ob der Innen- und Außenrand von gegenüberliegenden Seiten dieselbe Breite aufweisen. |
| odd |
Gibt an, ob gerade und ungerade Seiten unterschiedliche Kopf- und Fußzeilen haben. |
| orientation | Gibt die Ausrichtung der Seite an. |
| page |
Gibt die Seitenhöhe in Punkt an. |
| page |
Gibt die Seitenbreite in Punkt an. |
| paper |
Gibt das Papierformat der Seite an. |
| right |
Gibt den Abstand (in Punkt) zwischen dem rechten Rand der Seite und der rechten Begrenzungslinie des Textkörpers an. |
| section |
Gibt die Leserichtung und Ausrichtung für die angegebenen Abschnitte an. |
| section |
Gibt den Typ des Abschnittsumbruchs für das angegebene Objekt an. |
| show |
Gibt an, ob das Raster angezeigt werden soll. |
| suppress |
Gibt an, ob Endnoten am Ende des nächsten Abschnitts gedruckt werden, ohne dass Endnoten unterdrückt werden. |
| text |
Ruft ein |
| top |
Gibt den oberen Seitenrand in Punkt an. |
| two |
Gibt an, ob zwei Seiten pro Blatt gedruckt werden sollen. |
| vertical |
Gibt die vertikale Ausrichtung von Text auf jeder Seite in einem Dokument oder Abschnitt an. |
Methoden
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| set |
Legt die angegebene Seiteneinrichtungsformatierung als Standard für das aktive Dokument und alle neuen Dokumente fest, die auf der aktiven Vorlage basieren. |
| toggle |
Schaltet für ein Dokument oder einen Abschnitt zwischen den Seitenausrichtungen Hochformat und Querformat um. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen |
Details zur Eigenschaft
bookFoldPrinting
Gibt an, ob Microsoft Word das Dokument als Broschüre druckt.
bookFoldPrinting: boolean;Eigenschaftswert
boolean
Hinweise
bookFoldPrintingSheets
Gibt die Anzahl der Seiten für jede Broschüre an.
bookFoldPrintingSheets: number;Eigenschaftswert
number
Hinweise
bookFoldReversePrinting
Gibt an, ob Microsoft Word die Druckreihenfolge beim Buchfalzdruck von bidirektionalen oder asiatischsprachigen Dokumenten umkehrt.
bookFoldReversePrinting: boolean;Eigenschaftswert
boolean
Hinweise
bottomMargin
Gibt den Abstand (in Punkt) zwischen dem oberen Rand der Seite und der unteren Begrenzungslinie des Textkörpers an.
bottomMargin: number;Eigenschaftswert
number
Hinweise
charsLine
Gibt die Anzahl der Zeichen pro Zeile im Dokumentraster an.
charsLine: number;Eigenschaftswert
number
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
differentFirstPageHeaderFooter
Gibt an, ob die erste Seite unterschiedliche Kopf- und Fußzeilen hat.
differentFirstPageHeaderFooter: boolean;Eigenschaftswert
boolean
Hinweise
footerDistance
Gibt den Abstand zwischen der Fußzeile und dem unteren Seitenrand in Punkten an.
footerDistance: number;Eigenschaftswert
number
Hinweise
gutter
Gibt die Menge (in Punkt) des zusätzlichen Randbereichs an, der jeder Seite in einem Dokument oder Abschnitt für die Bindung hinzugefügt wird.
gutter: number;Eigenschaftswert
number
Hinweise
gutterPosition
Gibt an, auf welcher Seite die Bundstege in einem Dokument angezeigt wird.
gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top";Eigenschaftswert
Word.GutterPosition | "Left" | "Right" | "Top"
Hinweise
gutterStyle
Gibt an, ob Microsoft Word für das aktuelle Dokument Rinnstege basierend auf einer Rechts-nach-links-Sprache oder einer Links-nach-rechts-Sprache verwendet.
gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin";Eigenschaftswert
Word.GutterStyle | "Bidirectional" | "Latin"
Hinweise
headerDistance
Gibt den Abstand zwischen der Kopfzeile und dem oberen Rand der Seite in Punkten an.
headerDistance: number;Eigenschaftswert
number
Hinweise
layoutMode
Gibt den Layoutmodus für das aktuelle Dokument an.
layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko";Eigenschaftswert
Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"
Hinweise
leftMargin
Gibt den Abstand (in Punkt) zwischen dem linken Rand der Seite und der linken Begrenzungslinie des Textkörpers an.
leftMargin: number;Eigenschaftswert
number
Hinweise
lineNumbering
Gibt ein LineNumbering Objekt an, das die Zeilennummern für das PageSetup Objekt darstellt.
lineNumbering: Word.LineNumbering;Eigenschaftswert
Hinweise
linesPage
Gibt die Anzahl der Zeilen pro Seite im Dokumentraster an.
linesPage: number;Eigenschaftswert
number
Hinweise
mirrorMargins
Gibt an, ob der Innen- und Außenrand von gegenüberliegenden Seiten dieselbe Breite aufweisen.
mirrorMargins: boolean;Eigenschaftswert
boolean
Hinweise
oddAndEvenPagesHeaderFooter
Gibt an, ob gerade und ungerade Seiten unterschiedliche Kopf- und Fußzeilen haben.
oddAndEvenPagesHeaderFooter: boolean;Eigenschaftswert
boolean
Hinweise
orientation
Gibt die Ausrichtung der Seite an.
orientation: Word.PageOrientation | "Portrait" | "Landscape";Eigenschaftswert
Word.PageOrientation | "Portrait" | "Landscape"
Hinweise
pageHeight
Gibt die Seitenhöhe in Punkt an.
pageHeight: number;Eigenschaftswert
number
Hinweise
pageWidth
Gibt die Seitenbreite in Punkt an.
pageWidth: number;Eigenschaftswert
number
Hinweise
paperSize
Gibt das Papierformat der Seite an.
paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom";Eigenschaftswert
Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"
Hinweise
rightMargin
Gibt den Abstand (in Punkt) zwischen dem rechten Rand der Seite und der rechten Begrenzungslinie des Textkörpers an.
rightMargin: number;Eigenschaftswert
number
Hinweise
sectionDirection
Gibt die Leserichtung und Ausrichtung für die angegebenen Abschnitte an.
sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight";Eigenschaftswert
Word.SectionDirection | "RightToLeft" | "LeftToRight"
Hinweise
sectionStart
Gibt den Typ des Abschnittsumbruchs für das angegebene Objekt an.
sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage";Eigenschaftswert
Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"
Hinweise
showGrid
Gibt an, ob das Raster angezeigt werden soll.
showGrid: boolean;Eigenschaftswert
boolean
Hinweise
suppressEndnotes
Gibt an, ob Endnoten am Ende des nächsten Abschnitts gedruckt werden, ohne dass Endnoten unterdrückt werden.
suppressEndnotes: boolean;Eigenschaftswert
boolean
Hinweise
textColumns
Ruft ein TextColumnCollection Objekt ab, das die Gruppe von Textspalten für das PageSetup Objekt darstellt.
readonly textColumns: Word.TextColumnCollection;Eigenschaftswert
Hinweise
topMargin
Gibt den oberen Seitenrand in Punkt an.
topMargin: number;Eigenschaftswert
number
Hinweise
twoPagesOnOne
Gibt an, ob zwei Seiten pro Blatt gedruckt werden sollen.
twoPagesOnOne: boolean;Eigenschaftswert
boolean
Hinweise
verticalAlignment
Gibt die vertikale Ausrichtung von Text auf jeder Seite in einem Dokument oder Abschnitt an.
verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom";Eigenschaftswert
Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"
Hinweise
Details zur Methode
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Word.PageSetup;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.PageSetup;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.PageSetupUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.PageSetup): void;Parameter
- properties
- Word.PageSetup
Gibt zurück
void
setAsTemplateDefault()
Legt die angegebene Seiteneinrichtungsformatierung als Standard für das aktive Dokument und alle neuen Dokumente fest, die auf der aktiven Vorlage basieren.
setAsTemplateDefault(): void;Gibt zurück
void
Hinweise
togglePortrait()
Schaltet für ein Dokument oder einen Abschnitt zwischen den Seitenausrichtungen Hochformat und Querformat um.
togglePortrait(): void;Gibt zurück
void
Hinweise
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Word.PageSetup Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.PageSetupData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.PageSetupData;Gibt zurück
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-section-starts.yaml
await Word.run(async (context) => {
const pageSetup: Word.PageSetup = context.document.pageSetup;
pageSetup.load();
const sections: Word.SectionCollection = context.document.sections;
sections.load("items");
await context.sync();
sections.items.forEach((section) => section.pageSetup.load("sectionStart"));
await context.sync();
console.log("Document page setup:", pageSetup.toJSON());
sections.items.forEach((section, index) => {
console.log(`Section ${index + 1} starts: ${section.pageSetup.sectionStart}`);
});
});
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt aufrufübergreifend .sync und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.PageSetup;Gibt zurück
untrack()
Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.PageSetup;