Word. Inline Picture class

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

Word.RequestContext

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

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: WordApiDesktop 1.1 ]

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: Word.InlinePicture = 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

Word.Paragraph

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

Word.ContentControl

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

Word.ContentControl

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

Word.Table

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

Word.TableCell

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

Word.TableCell

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

Word.Table

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: Word.InlinePicture = 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);
});

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

Word.InlinePicture

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

Word.InlinePicture

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

rangeLocation: whole | start | end | "Whole" | "Start" | "End"

Optional. Der Bereichsspeicherort muss "Ganz", "Start" oder "Ende" sein.

Gibt zurück

Word.Range

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.

insertLocation: before | after | "Before" | "After"

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

Word.ContentControl

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.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

Word.Range

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.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

Word.Range

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.

insertLocation: replace | before | after | "Replace" | "Before" | "After"

Erforderlich. Der Wert muss "Replace", "Before" oder "After" sein.

Gibt zurück

Word.InlinePicture

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.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

Word.Range

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.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

Word.Paragraph

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.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

Word.Range

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

options: Word.Interfaces.InlinePictureLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Word.InlinePicture

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

Word.InlinePicture

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

Word.InlinePicture

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