Word.InlinePicture class
Stellt ein eingebundenes Bild dar.
- Extends
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml
// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
context.document.body.paragraphs
.getLast()
.insertParagraph("", "After")
.insertInlinePictureFromBase64(base64Image, "End");
await context.sync();
});
Eigenschaften
| alt |
Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der dem Inlinebild zugeordnet ist. |
| alt |
Gibt eine Zeichenfolge an, die den Titel für das Inlinebild enthält. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| height | Gibt eine Zahl an, die die Höhe des Inlinebilds beschreibt. |
| hyperlink | Gibt einen Link für das Bild an. Verwenden Sie "#", um den Adressteil vom optionalen Standortteil zu trennen. |
| image |
Ruft das Format des Inlinebilds ab. |
| lock |
Gibt einen Wert an, der angibt, ob das Inlinebild seine ursprünglichen Proportionen beibehält, wenn Sie dessen Größe ändern. |
| paragraph | Ruft den übergeordneten Absatz ab, der das Inlinebild enthält. |
| parent |
Ruft das Inhaltssteuerelement ab, das das eingebundene Bild enthält. Löst einen Fehler aus |
| parent |
Ruft das Inhaltssteuerelement ab, das das eingebundene Bild enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
| parent |
Ruft die Tabelle ab, die das Inlinebild enthält. Löst einen Fehler aus |
| parent |
Ruft die Tabellenzelle ab, die das Inlinebild enthält. Löst einen Fehler aus |
| parent |
Ruft die Tabellenzelle ab, die das Inlinebild enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen |
| parent |
Ruft die Tabelle ab, die das Inlinebild enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein -Objekt zurück, dessen |
| width | Gibt eine Zahl an, die die Breite des Inlinebilds beschreibt. |
Methoden
| delete() | Löscht das Inlinebild aus dem Dokument. |
| get |
Ruft die Base64-codierte Zeichenfolgendarstellung des Inlinebilds ab. |
| get |
Ruft das nächste Inlinebild ab. Löst einen Fehler aus |
| get |
Ruft das nächste Inlinebild ab. Wenn es sich bei diesem Inlinebild um das letzte Bild handelt, gibt diese Methode ein -Objekt zurück, dessen |
| get |
Ruft das Bild oder den Start- bzw. Endpunkt des Bilds als Bereich ab. |
| insert |
Fügt an der angegebenen Position im Hauptdokument einen Umbruch ein. |
| insert |
Umschließt das eingebundene Bild mit einem Rich-Text-Inhaltssteuerelement. |
| insert |
Fügt an der angegebenen Position ein Dokument ein. |
| insert |
Fügt an der angegebenen Position HTML-Code ein. |
| insert |
Fügt an der angegebenen Position ein Inlinebild ein. |
| insert |
Fügt an der angegebenen Position OOXML-Code ein. |
| insert |
Fügt an der angegebenen Position einen Absatz ein. |
| insert |
Fügt 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 " |
| select(selection |
Wählt das Inlinebild aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt. |
| select(selection |
Wählt das Inlinebild aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt. |
| 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
altTextDescription
Gibt eine Zeichenfolge an, die den alternativen Text darstellt, der dem Inlinebild zugeordnet ist.
altTextDescription: string;Eigenschaftswert
string
Hinweise
altTextTitle
Gibt eine Zeichenfolge an, die den Titel für das Inlinebild enthält.
altTextTitle: string;Eigenschaftswert
string
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
Gibt eine Zahl an, die die Höhe des Inlinebilds beschreibt.
height: number;Eigenschaftswert
number
Hinweise
hyperlink
Gibt einen Link für das Bild an. Verwenden Sie "#", um den Adressteil vom optionalen Standortteil zu trennen.
hyperlink: string;Eigenschaftswert
string
Hinweise
imageFormat
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft das Format des Inlinebilds ab.
readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";Eigenschaftswert
Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"
Hinweise
[ API-Satz: WordApi BETA (NUR VORSCHAU) ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/insert-and-get-pictures.yaml
// Gets the first image in the document.
await Word.run(async (context) => {
const firstPicture = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height, imageFormat");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`, `Image format: ${firstPicture.imageFormat}`);
// Get the image encoded as Base64.
const base64 = firstPicture.getBase64ImageSrc();
await context.sync();
console.log(base64.value);
});
lockAspectRatio
Gibt einen Wert an, der angibt, ob das Inlinebild seine ursprünglichen Proportionen beibehält, wenn Sie dessen Größe ändern.
lockAspectRatio: boolean;Eigenschaftswert
boolean
Hinweise
paragraph
Ruft den übergeordneten Absatz ab, der das Inlinebild enthält.
readonly paragraph: Word.Paragraph;Eigenschaftswert
Hinweise
parentContentControl
Ruft das Inhaltssteuerelement ab, das das eingebundene Bild enthält. Löst einen Fehler aus ItemNotFound , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.
readonly parentContentControl: Word.ContentControl;Eigenschaftswert
Hinweise
parentContentControlOrNullObject
Ruft das Inhaltssteuerelement ab, das das eingebundene Bild enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
readonly parentContentControlOrNullObject: Word.ContentControl;Eigenschaftswert
Hinweise
parentTable
Ruft die Tabelle ab, die das Inlinebild enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabelle enthalten ist.
readonly parentTable: Word.Table;Eigenschaftswert
Hinweise
parentTableCell
Ruft die Tabellenzelle ab, die das Inlinebild enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabellenzelle enthalten ist.
readonly parentTableCell: Word.TableCell;Eigenschaftswert
Hinweise
parentTableCellOrNullObject
Ruft die Tabellenzelle ab, die das Inlinebild enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
readonly parentTableCellOrNullObject: Word.TableCell;Eigenschaftswert
Hinweise
parentTableOrNullObject
Ruft die Tabelle ab, die das Inlinebild enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
readonly parentTableOrNullObject: Word.Table;Eigenschaftswert
Hinweise
width
Gibt eine Zahl an, die die Breite des Inlinebilds beschreibt.
width: number;Eigenschaftswert
number
Hinweise
Details zur Methode
delete()
Löscht das Inlinebild aus dem Dokument.
delete(): void;Gibt zurück
void
Hinweise
getBase64ImageSrc()
Ruft die Base64-codierte Zeichenfolgendarstellung des Inlinebilds ab.
getBase64ImageSrc(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/15-images/insert-and-get-pictures.yaml
// Gets the first image in the document.
await Word.run(async (context) => {
const firstPicture = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`);
// Get the image encoded as Base64.
const base64 = firstPicture.getBase64ImageSrc();
await context.sync();
console.log(base64.value);
});
getNext()
Ruft das nächste Inlinebild ab. Löst einen Fehler aus ItemNotFound , wenn dieses Inlinebild das letzte ist.
getNext(): Word.InlinePicture;Gibt zurück
Hinweise
Beispiele
// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the first inline picture.
const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();
// Queue a command to load the alternative text title of the picture.
firstPicture.load('altTextTitle');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (firstPicture.isNullObject) {
console.log('There are no inline pictures in this document.')
} else {
console.log(firstPicture.altTextTitle);
}
});
getNextOrNullObject()
Ruft das nächste Inlinebild ab. Wenn es sich bei diesem Inlinebild um das letzte Bild 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.InlinePicture;Gibt zurück
Hinweise
Beispiele
// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the first inline picture.
const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();
// Queue a command to load the alternative text title of the picture.
firstPicture.load('altTextTitle');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (firstPicture.isNullObject) {
console.log('There are no inline pictures in this document.')
} else {
console.log(firstPicture.altTextTitle);
}
});
getRange(rangeLocation)
Ruft das Bild oder den Start- bzw. Endpunkt des Bilds als Bereich ab.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;Parameter
Optional. Der Bereichsspeicherort muss "Ganz", "Start" oder "Ende" sein.
Gibt zurück
Hinweise
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 hinzuzufügende Umbruchtyp.
Erforderlich. Der Wert muss "Before" oder "After" sein.
Gibt zurück
void
Hinweise
insertContentControl()
Umschließt das eingebundene Bild mit einem Rich-Text-Inhaltssteuerelement.
insertContentControl(): Word.ContentControl;Gibt zurück
Hinweise
insertFileFromBase64(base64File, insertLocation)
Fügt an der angegebenen Position ein Dokument ein.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameter
- base64File
-
string
Erforderlich. Der Base64-codierte Inhalt einer .docx Datei.
Erforderlich. Der Wert muss "Before" oder "After" 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 an der angegebenen Position HTML-Code ein.
insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameter
- html
-
string
Erforderlich. Der html-Code, der eingefügt werden soll.
Erforderlich. Der Wert muss "Before" oder "After" sein.
Gibt zurück
Hinweise
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)
Fügt an der angegebenen Position ein Inlinebild ein.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;Parameter
- base64EncodedImage
-
string
Erforderlich. Das einzufügende Base64-codierte Bild.
Erforderlich. Der Wert muss "Replace", "Before" oder "After" sein.
Gibt zurück
Hinweise
insertOoxml(ooxml, insertLocation)
Fügt an der angegebenen Position OOXML-Code ein.
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameter
- ooxml
-
string
Erforderlich. Der einzufügende OOXML-Code.
Erforderlich. Der Wert muss "Before" oder "After" 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 an der angegebenen Position Text ein.
insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parameter
- text
-
string
Erforderlich. Der einzufügende Text.
Erforderlich. Der Wert muss "Before" oder "After" sein.
Gibt zurück
Hinweise
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.InlinePictureLoadOptions): Word.InlinePicture;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.InlinePicture;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.InlinePicture;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
select(selectionMode)
Wählt das Inlinebild aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt.
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
select(selectionModeString)
Wählt das Inlinebild aus. Dies bewirkt, dass Word einen Bildlauf zur Auswahl durchführt.
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.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.InlinePictureUpdateData
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
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Word.InlinePicture): void;Parameter
- properties
- Word.InlinePicture
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. Das InlinePicture-Objekt ist ein API-Objekt. Die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.InlinePictureData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.InlinePictureData;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.InlinePicture;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.InlinePicture;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