Word.Page class
Stellt eine Seite im Dokument dar.
Page -Objekte verwalten das Seitenlayout und den Inhalt.
- Extends
Hinweise
[ API-Satz: WordApiDesktop 1.2 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets pages of the selection.
const pages: Word.PageCollection = context.document.getSelection().pages;
pages.load();
await context.sync();
// Log info for pages included in selection.
console.log(pages);
const pagesIndexes = [];
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
range.load("text");
pagesText.push(range);
}
await context.sync();
for (let i = 0; i < pagesIndexes.length; i++) {
console.log(`Index info for page ${i + 1} in the selection: ${pagesIndexes[i].index}`);
console.log("Text of that page in the selection:", pagesText[i].text);
}
});
Eigenschaften
| breaks | Ruft ein |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| height | Ruft die Höhe des im Dialogfeld Seite einrichten definierten Papiers in Punkt ab. |
| index | Ruft den Index der Seite ab. Der Seitenindex ist 1-basiert und unabhängig von der benutzerdefinierten Seitennummerierung des Benutzers. |
| width | Ruft die Breite des im Dialogfeld Seite einrichten definierten Papiers in Punkt ab. |
Methoden
| get |
Ruft die nächste Seite im Bereich ab. Löst einen Fehler aus |
| get |
Ruft die nächste Seite ab. Wenn es sich bei dieser Seite um die letzte Seite handelt, gibt diese Methode ein -Objekt zurück, dessen |
| get |
Ruft die gesamte Seite oder den Start- oder Endpunkt der Seite als Bereich ab. |
| 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 " |
| 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 über |
| 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 aufrufen |
Details zur Eigenschaft
breaks
Ruft ein BreakCollection -Objekt ab, das die Umbrüche auf der Seite darstellt.
readonly breaks: Word.BreakCollection;Eigenschaftswert
Hinweise
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
height
Ruft die Höhe des im Dialogfeld Seite einrichten definierten Papiers in Punkt ab.
readonly height: number;Eigenschaftswert
number
Hinweise
index
Ruft den Index der Seite ab. Der Seitenindex ist 1-basiert und unabhängig von der benutzerdefinierten Seitennummerierung des Benutzers.
readonly index: number;Eigenschaftswert
number
Hinweise
[ API-Satz: WordApiDesktop 1.2 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets the pages that contain the third paragraph.
const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
paragraphs.load();
await context.sync();
const paraThree = paragraphs.items[2];
const rangeOfParagraph = paraThree.getRange();
const pages: Word.PageCollection = rangeOfParagraph.pages;
pages.load();
await context.sync();
// Log info for pages in range.
console.log(pages);
const pagesIndexes = [];
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
range.load("text");
pagesText.push(range);
}
await context.sync();
for (let i = 0; i < pagesIndexes.length; i++) {
console.log(`Index of page ${i + 1} that contains the third paragraph: ${pagesIndexes[i].index}`);
console.log("Text of that page:", pagesText[i].text);
}
});
width
Ruft die Breite des im Dialogfeld Seite einrichten definierten Papiers in Punkt ab.
readonly width: number;Eigenschaftswert
number
Hinweise
Details zur Methode
getNext()
Ruft die nächste Seite im Bereich ab. Löst einen Fehler aus ItemNotFound , wenn diese Seite die letzte ist.
getNext(): Word.Page;Gibt zurück
Hinweise
getNextOrNullObject()
Ruft die nächste Seite ab. Wenn es sich bei dieser Seite um die letzte Seite handelt, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getNextOrNullObject(): Word.Page;Gibt zurück
Hinweise
getRange(rangeLocation)
Ruft die gesamte Seite oder den Start- oder Endpunkt der Seite als Bereich ab.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;Parameter
Optional. Der Bereichsspeicherort muss , startoder endseinwhole.
Gibt zurück
Hinweise
[ API-Satz: WordApiDesktop 1.2 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml
await Word.run(async (context) => {
// Gets pages of the selection.
const pages: Word.PageCollection = context.document.getSelection().pages;
pages.load();
await context.sync();
// Log info for pages included in selection.
console.log(pages);
const pagesIndexes = [];
const pagesText = [];
for (let i = 0; i < pages.items.length; i++) {
const page = pages.items[i];
page.load("index");
pagesIndexes.push(page);
const range = page.getRange();
range.load("text");
pagesText.push(range);
}
await context.sync();
for (let i = 0; i < pagesIndexes.length; i++) {
console.log(`Index info for page ${i + 1} in the selection: ${pagesIndexes[i].index}`);
console.log("Text of that page in the selection:", pagesText[i].text);
}
});
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.PageLoadOptions): Word.Page;Parameter
- options
- Word.Interfaces.PageLoadOptions
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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.Page;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.Page;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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 das Objekt übergeben wird.) Während das ursprüngliche Word.Page Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.PageData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.PageData;Gibt zurück
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 über .sync Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.Page;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 aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.Page;