Word.Paragraph class
Stellt einen einzelnen Absatz in einer Auswahl, einem Bereich, Inhaltssteuerelement oder Hauptteil des Dokuments dar.
- Extends
Hinweise
Eigenschaften
| alignment | Gibt die Ausrichtung für einen Absatz an. Der Wert kann "left", "centered", "right" oder "justified" lauten. |
| content |
Ruft die Auflistung von Inhaltssteuerelementobjekten im Absatz ab. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| first |
Gibt den Wert für eine erste Zeile oder einen hängenden Einzug in Punkt an. Verwenden Sie zum Festlegen eines Erstzeileneinzugs einen positiven Wert, und verwenden Sie für einen negativen Wert für einen hängenden Einzug. |
| font | Ruft das Textformat des Abschnitts ab. Verwenden Sie diese Option zum Abrufen und Festlegen der Schriftart, Größe, Farbe und anderer Eigenschaften. |
| inline |
Ruft die Auflistung von InlinePicture-Objekten im Absatz ab. Die Auflistung enthält keine unverankerten Bilder. |
| left |
Gibt den linken Einzugswert für den Absatz in Punkt an. |
| line |
Gibt den Zeilenabstand für den angegebenen Absatz in Punkt an. Auf der Word-Benutzeroberfläche wird dieser Wert durch 12 dividiert. |
| line |
Gibt den Abstand in Rasterlinien nach dem Absatz an. |
| line |
Gibt den Abstand in Rasterlinien vor dem Absatz an. |
| outline |
Gibt die Gliederungsebene für den Absatz an. |
| parent |
Ruft das Inhaltssteuerelement ab, das den Abschnitt enthält. Löst einen Fehler aus |
| right |
Gibt den rechten Einzugswert für den Absatz in Punkt an. |
| space |
Gibt den Abstand nach dem Absatz in Punkt an. |
| space |
Gibt den Abstand in Punkt vor dem Absatz an. |
| style | Gibt den Formatvorlagennamen für den Absatz an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn". |
| text | Ruft den Text des Absatzes ab. |
Methoden
| clear() | Löscht den Inhalt des Abschnittsobjekts. Der Benutzer kann den Rückgängig-Vorgang auf den gelöschten Inhalt durchführen. |
| delete() | Löscht den Absatz und seinen Inhalt aus dem Dokument. |
| get |
Ruft eine HTML-Darstellung des Absatzobjekts ab. Wenn sie in einer Webseite oder einem HTML-Viewer gerendert wird, ist die Formatierung eine enge, aber nicht exakte Übereinstimmung mit der Formatierung des Dokuments. Diese Methode gibt nicht genau denselben HTML-Code für dasselbe Dokument auf verschiedenen Plattformen (Windows, Mac, Word im Web usw.) zurück. Wenn Sie genaue Genauigkeit oder plattformübergreifende Konsistenz benötigen, verwenden |
| get |
Ruft die Office Open XML (OOXML)-Darstellung des Abschnittsobjekts ab. |
| insert |
Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein. |
| insert |
Umschließt das Paragraph-Objekt mit einem Inhaltssteuerelement. |
| insert |
Fügt ein Dokument an der angegebenen Position in den Absatz ein. |
| insert |
Fügt in den aktuellen Abschnitt an der angegebenen Position HTML-Code ein. |
| insert |
Fügt in den aktuellen Abschnitt an der angegebenen Position ein Bild ein. |
| insert |
Fügt OOXML an der angegebenen Position in den Absatz ein. |
| insert |
Fügt an der angegebenen Position einen Absatz ein. |
| insert |
Fügt in den Abschnitt an der angegebenen Position Text ein. |
| 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 " |
| search(search |
Führt eine Suche mit den angegebenen SearchOptions für den Bereich des Absatzobjekts aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten. |
| select(selection |
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Absatz. |
| select(selection |
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Absatz. |
| 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. |
| 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
alignment
Gibt die Ausrichtung für einen Absatz an. Der Wert kann "left", "centered", "right" oder "justified" lauten.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";Eigenschaftswert
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Center last paragraph alignment.
context.document.body.paragraphs.getLast().alignment = "Centered";
await context.sync();
});
contentControls
Ruft die Auflistung von Inhaltssteuerelementobjekten im Absatz ab.
readonly contentControls: Word.ContentControlCollection;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
firstLineIndent
Gibt den Wert für eine erste Zeile oder einen hängenden Einzug in Punkt an. Verwenden Sie zum Festlegen eines Erstzeileneinzugs einen positiven Wert, und verwenden Sie für einen negativen Wert für einen hängenden Einzug.
firstLineIndent: number;Eigenschaftswert
number
Hinweise
font
Ruft das Textformat des Abschnitts ab. Verwenden Sie diese Option zum Abrufen und Festlegen der Schriftart, Größe, Farbe und anderer Eigenschaften.
readonly font: Word.Font;Eigenschaftswert
Hinweise
inlinePictures
Ruft die Auflistung von InlinePicture-Objekten im Absatz ab. Die Auflistung enthält keine unverankerten Bilder.
readonly inlinePictures: Word.InlinePictureCollection;Eigenschaftswert
Hinweise
leftIndent
Gibt den linken Einzugswert für den Absatz in Punkt an.
leftIndent: number;Eigenschaftswert
number
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Indent the first paragraph.
context.document.body.paragraphs.getFirst().leftIndent = 75; //units = points
return context.sync();
});
lineSpacing
Gibt den Zeilenabstand für den angegebenen Absatz in Punkt an. Auf der Word-Benutzeroberfläche wird dieser Wert durch 12 dividiert.
lineSpacing: number;Eigenschaftswert
number
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Adjust line spacing.
context.document.body.paragraphs.getFirst().lineSpacing = 20;
await context.sync();
});
lineUnitAfter
Gibt den Abstand in Rasterlinien nach dem Absatz an.
lineUnitAfter: number;Eigenschaftswert
number
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Set the space (in line units) after the first paragraph.
context.document.body.paragraphs.getFirst().lineUnitAfter = 1;
await context.sync();
});
lineUnitBefore
Gibt den Abstand in Rasterlinien vor dem Absatz an.
lineUnitBefore: number;Eigenschaftswert
number
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Set the space (in line units) before the first paragraph.
context.document.body.paragraphs.getFirst().lineUnitBefore = 1;
await context.sync();
});
outlineLevel
Gibt die Gliederungsebene für den Absatz an.
outlineLevel: number;Eigenschaftswert
number
Hinweise
parentContentControl
Ruft das Inhaltssteuerelement ab, das den Abschnitt enthält. Löst einen Fehler aus ItemNotFound , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.
readonly parentContentControl: Word.ContentControl;Eigenschaftswert
Hinweise
rightIndent
Gibt den rechten Einzugswert für den Absatz in Punkt an.
rightIndent: number;Eigenschaftswert
number
Hinweise
spaceAfter
Gibt den Abstand nach dem Absatz in Punkt an.
spaceAfter: number;Eigenschaftswert
number
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Set the space (in points) after the first paragraph.
context.document.body.paragraphs.getFirst().spaceAfter = 20;
await context.sync();
});
spaceBefore
Gibt den Abstand in Punkt vor dem Absatz an.
spaceBefore: number;Eigenschaftswert
number
Hinweise
style
Gibt den Formatvorlagennamen für den Absatz an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn".
style: string;Eigenschaftswert
string
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml
// Applies the specified style to a paragraph.
await Word.run(async (context) => {
const styleName = $("#style-name-to-use").val() as string;
if (styleName == "") {
console.warn("Enter a style name to apply.");
return;
}
const style = context.document.getStyles().getByNameOrNullObject(styleName);
style.load();
await context.sync();
if (style.isNullObject) {
console.warn(`There's no existing style with the name '${styleName}'.`);
} else if (style.type != Word.StyleType.paragraph) {
console.log(`The '${styleName}' style isn't a paragraph style.`);
} else {
const body = context.document.body;
body.clear();
body.insertParagraph(
"Video provides a powerful way to help you prove your point. When you click Online Video, you can paste in the embed code for the video you want to add. You can also type a keyword to search online for the video that best fits your document.",
"Start"
);
const paragraph = body.paragraphs.getFirst();
paragraph.style = style.nameLocal;
console.log(`'${styleName}' style applied to first paragraph.`);
}
});
text
Ruft den Text des Absatzes ab.
readonly text: string;Eigenschaftswert
string
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml
await Word.run(async (context) => {
// The collection of paragraphs of the current selection returns the full paragraphs contained in it.
const paragraph = context.document.getSelection().paragraphs.getFirst();
paragraph.load("text");
await context.sync();
console.log(paragraph.text);
});
Details zur Methode
clear()
Löscht den Inhalt des Abschnittsobjekts. Der Benutzer kann den Rückgängig-Vorgang auf den gelöschten Inhalt durchführen.
clear(): void;Gibt zurück
void
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for all of the paragraphs.
paragraphs.load('style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to clear the contents of the first paragraph.
paragraphs.items[0].clear();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Cleared the contents of the first paragraph.');
});
delete()
Löscht den Absatz und seinen Inhalt aus dem Dokument.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the text property for all of the paragraphs.
paragraphs.load('text');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to delete the first paragraph.
paragraphs.items[0].delete();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Deleted the first paragraph.');
});
getHtml()
Ruft eine HTML-Darstellung des Absatzobjekts ab. Wenn sie in einer Webseite oder einem HTML-Viewer gerendert wird, ist die Formatierung eine enge, aber nicht exakte Übereinstimmung mit der Formatierung des Dokuments. Diese Methode gibt nicht genau denselben HTML-Code für dasselbe Dokument auf verschiedenen Plattformen (Windows, Mac, Word im Web usw.) zurück. Wenn Sie genaue Genauigkeit oder plattformübergreifende Konsistenz benötigen, verwenden Paragraph.getOoxml() Und konvertieren Sie den zurückgegebenen XML-Code in HTML.
getHtml(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for all of the paragraphs.
paragraphs.load('style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a set of commands to get the HTML of the first paragraph.
const html = paragraphs.items[0].getHtml();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Paragraph HTML: ' + html.value);
});
getOoxml()
Ruft die Office Open XML (OOXML)-Darstellung des Abschnittsobjekts ab.
getOoxml(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a set of commands to get the OOXML of the first paragraph.
const ooxml = paragraphs.items[0].getOoxml();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Paragraph OOXML: ' + ooxml.value);
});
insertBreak(breakType, insertLocation)
Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein.
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;Parameter
- breakType
-
Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"
Erforderlich. Der zum Dokument hinzuzufügende Umbruchtyp.
Erforderlich. Der Wert muss "Before" oder "After" sein.
Gibt zurück
void
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
// We never perform an empty load. We always must request a property.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
// Queue a command to insert a page break after the first paragraph.
paragraph.insertBreak(Word.BreakType.page, Word.InsertLocation.after);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Inserted a page break after the paragraph.');
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-line-and-page-breaks.yaml
Word.run(async (context) => {
context.document.body.paragraphs.getFirst().insertBreak(Word.BreakType.line, "After");
await context.sync();
console.log("success");
});
insertContentControl(contentControlType)
Umschließt das Paragraph-Objekt mit einem Inhaltssteuerelement.
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;Parameter
Optional. Inhaltssteuerelementtyp, der eingefügt werden soll. Muss "RichText", "PlainText" oder "CheckBox" sein. Der Standardwert ist "RichText".
Gibt zurück
Hinweise
Hinweis: Der contentControlType Parameter wurde in WordApi 1.5 eingeführt. PlainText Unterstützung wurde in WordApi 1.5 hinzugefügt. CheckBox Unterstützung wurde in WordApi 1.7 hinzugefügt.
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
// We never perform an empty load. We always must request a property.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
// Queue a command to wrap the first paragraph in a rich text content control.
paragraph.insertContentControl();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Wrapped the first paragraph in a content control.');
});
insertFileFromBase64(base64File, insertLocation)
Fügt ein Dokument an der angegebenen Position in den Absatz ein.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;Parameter
- base64File
-
string
Erforderlich. Der Base64-codierte Inhalt einer .docx Datei.
Erforderlich. Der Wert muss "Replace", "Start" oder "End" sein.
Gibt zurück
Hinweise
Hinweis: Das Einfügen wird nicht unterstützt, wenn das eingefügte Dokument ein ActiveX-Steuerelement (wahrscheinlich in einem Formularfeld) enthält. Erwägen Sie, ein solches Formularfeld durch ein Inhaltssteuerelement oder eine andere für Ihr Szenario geeignete Option zu ersetzen.
insertHtml(html, insertLocation)
Fügt in den aktuellen Abschnitt an der angegebenen Position HTML-Code ein.
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;Parameter
- html
-
string
Erforderlich. Der in den Abschnitt einzufügende HTML-Code.
Erforderlich. Der Wert muss "Replace", "Start" oder "End" sein.
Gibt zurück
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
// We never perform an empty load. We always must request a property.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
// Queue a command to insert HTML content at the end of the first paragraph.
paragraph.insertHtml('<strong>Inserted HTML.</strong>', Word.InsertLocation.end);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Inserted HTML content at the end of the first paragraph.');
});
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)
Fügt in den aktuellen Abschnitt an der angegebenen Position ein Bild ein.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;Parameter
- base64EncodedImage
-
string
Erforderlich. Das einzufügende Base64-codierte Bild.
Erforderlich. Der Wert muss "Replace", "Start" oder "End" sein.
Gibt zurück
Hinweise
Beispiele
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for all of the paragraphs.
paragraphs.load('style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
const b64encodedImg = "iVBORw0KGgoAAAANSUhEUgAAAB4AAAANCAIAAAAxEEnAAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACFSURBVDhPtY1BEoQwDMP6/0+XgIMTBAeYoTqso9Rkx1zG+tNj1H94jgGzeNSjteO5vtQQuG2seO0av8LzGbe3anzRoJ4ybm/VeKEerAEbAUpW4aWQCmrGFWykRzGBCnYy2ha3oAIq2MloW9yCCqhgJ6NtcQsqoIKdjLbFLaiACnYyf2fODbrjZcXfr2F4AAAAAElFTkSuQmCC";
// Queue a command to insert a base64 encoded image at the beginning of the first paragraph.
paragraph.insertInlinePictureFromBase64(b64encodedImg, Word.InsertLocation.start);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Added an image to the first paragraph.');
});
insertOoxml(ooxml, insertLocation)
Fügt OOXML an der angegebenen Position in den Absatz ein.
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;Parameter
- ooxml
-
string
Erforderlich. Die OOXML, die in den Absatz eingefügt werden soll.
Erforderlich. Der Wert muss "Replace", "Start" oder "End" sein.
Gibt zurück
Hinweise
insertParagraph(paragraphText, insertLocation)
Fügt an der angegebenen Position einen Absatz ein.
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;Parameter
- paragraphText
-
string
Erforderlich. Der einzufügende Absatztext.
Erforderlich. Der Wert muss "Before" oder "After" sein.
Gibt zurück
Hinweise
insertText(text, insertLocation)
Fügt in den Abschnitt an der angegebenen Position Text ein.
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;Parameter
- text
-
string
Erforderlich. Der einzufügende Text.
Erforderlich. Der Wert muss "Replace", "Start" oder "End" sein.
Gibt zurück
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-in-different-locations.yaml
await Word.run(async (context) => {
// Replace the last paragraph.
const range = context.document.body.paragraphs.getLast().insertText("Just replaced the last paragraph!", "Replace");
range.font.highlightColor = "black";
range.font.color = "white";
await context.sync();
});
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.ParagraphLoadOptions): Word.Paragraph;Parameter
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.Paragraph;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.Paragraph;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
search(searchText, searchOptions)
Führt eine Suche mit den angegebenen SearchOptions für den Bereich des Absatzobjekts aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.
search(searchText: string, searchOptions?: Word.SearchOptions | {
ignorePunct?: boolean;
ignoreSpace?: boolean;
matchCase?: boolean;
matchPrefix?: boolean;
matchSuffix?: boolean;
matchWholeWord?: boolean;
matchWildcards?: boolean;
}): Word.RangeCollection;Parameter
- searchText
-
string
Erforderlich. Der Suchtext.
- searchOptions
-
Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }
Optional. Optionen für die Suche.
Gibt zurück
Hinweise
select(selectionMode)
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Absatz.
select(selectionMode?: Word.SelectionMode): void;Parameter
- selectionMode
- Word.SelectionMode
Optional. Der Auswahlmodus muss "Select", "Start" oder "End" sein. „Select“ ist die Standardeinstellung.
Gibt zurück
void
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/scroll-to-range.yaml
await Word.run(async (context) => {
// If select is called with no parameters, it selects the object.
context.document.body.paragraphs.getLast().select();
await context.sync();
});
...
await Word.run(async (context) => {
// Select can be at the start or end of a range; this by definition moves the insertion point without selecting the range.
context.document.body.paragraphs.getLast().select(Word.SelectionMode.end);
await context.sync();
});
select(selectionModeString)
Wählt und navigiert die Word-Benutzeroberfläche zu diesem Absatz.
select(selectionModeString?: "Select" | "Start" | "End"): void;Parameter
- selectionModeString
-
"Select" | "Start" | "End"
Optional. Der Auswahlmodus muss "Select", "Start" oder "End" sein. „Select“ ist die Standardeinstellung.
Gibt zurück
void
Hinweise
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.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.ParagraphUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/multiple-property-set.yaml
await Word.run(async (context) => {
const paragraph = context.document.body.paragraphs.getFirst();
paragraph.set({
leftIndent: 30,
font: {
bold: true,
color: "red"
}
});
await context.sync();
});
...
await Word.run(async (context) => {
const firstParagraph = context.document.body.paragraphs.getFirst();
const secondParagraph = firstParagraph.getNext();
firstParagraph.load("text, font/color, font/bold, leftIndent");
await context.sync();
secondParagraph.set(firstParagraph);
await context.sync();
});
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.Paragraph): void;Parameter
- properties
- Word.Paragraph
Gibt zurück
void
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.) Die ursprüngliche Word. Paragraph-Objekt ist ein API-Objekt, die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.ParagraphData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.ParagraphData;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.Paragraph;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.Paragraph;Gibt zurück
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für