Word. Inline Picture class

altTextTitle

Spécifie une chaîne qui contient le titre de l’image incluse.

altTextTitle: string;

Valeur de propriété

string

Remarques

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Word.RequestContext

height

Spécifie un nombre qui décrit la hauteur de l’image incluse.

height: number;

Valeur de propriété

number

Remarques

hyperlink

Spécifie un lien hypertexte sur l’image. Utilisez un « # » pour séparer la partie d’adresse de la partie d’emplacement facultative.

hyperlink: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.1 ]

imageFormat

Obtient le format de l’image incluse.

readonly imageFormat: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg";

Valeur de propriété

Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"

Remarques

Exemples

// 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

Spécifie une valeur qui indique si l’image inline conserve ses proportions d’origine lorsque vous la redimensionnez.

lockAspectRatio: boolean;

Valeur de propriété

boolean

Remarques

paragraph

Obtient le paragraphe parent qui contient l’image insérée.

readonly paragraph: Word.Paragraph;

Valeur de propriété

Word.Paragraph

Remarques

parentContentControl

Obtient le contrôle de contenu qui contient l’image incluse. Génère une ItemNotFound erreur s’il n’existe pas de contrôle de contenu parent.

readonly parentContentControl: Word.ContentControl;

Valeur de propriété

Word.ContentControl

Remarques

parentContentControlOrNullObject

Obtient le contrôle de contenu qui contient l’image incluse. S’il n’existe pas de contrôle de contenu parent, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

readonly parentContentControlOrNullObject: Word.ContentControl;

Valeur de propriété

Word.ContentControl

Remarques

parentTable

Obtient le tableau qui contient l’image insérée. Génère une ItemNotFound erreur si elle n’est pas contenue dans une table.

readonly parentTable: Word.Table;

Valeur de propriété

Word.Table

Remarques

parentTableCell

Obtient la cellule de tableau qui contient l’image insérée. Génère une ItemNotFound erreur si elle n’est pas contenue dans une cellule de tableau.

readonly parentTableCell: Word.TableCell;

Valeur de propriété

Word.TableCell

Remarques

parentTableCellOrNullObject

Obtient la cellule de tableau qui contient l’image insérée. Si elle n’est pas contenue dans une cellule de tableau, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

readonly parentTableCellOrNullObject: Word.TableCell;

Valeur de propriété

Word.TableCell

Remarques

parentTableOrNullObject

Obtient le tableau qui contient l’image insérée. Si elle n’est pas contenue dans une table, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

readonly parentTableOrNullObject: Word.Table;

Valeur de propriété

Word.Table

Remarques

width

Spécifie un nombre qui décrit la largeur de l’image inline.

width: number;

Valeur de propriété

number

Remarques

Détails de la méthode

delete()

Supprime l’image insérée du document.

delete(): void;

Retours

void

Remarques

getBase64ImageSrc()

Obtient la représentation sous forme de chaîne encodée en Base64 de l’image inline.

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Remarques

Exemples

// 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()

Obtient l’image insérée suivante. Génère une ItemNotFound erreur si cette image inline est la dernière.

getNext(): Word.InlinePicture;

Retours

Word.InlinePicture

Remarques

Exemples

// 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()

Obtient l’image insérée suivante. Si cette image inline est la dernière, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getNextOrNullObject(): Word.InlinePicture;

Retours

Word.InlinePicture

Remarques

Exemples

// 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)

Obtient l’image, ou le point de départ ou de fin de l’image, sous la forme d’une plage.

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;

Paramètres

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

Optional. L’emplacement de la plage doit être « Entier », « Début » ou « Fin ».

Retours

Word.Range

Remarques

insertBreak(breakType, insertLocation)

Insère un saut à l’emplacement spécifié du document principal.

insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;

Paramètres

breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"

Obligatoire. Type d’arrêt à ajouter.

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

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

void

Remarques

insertContentControl()

Encadre l’image incluse avec un contrôle de contenu de texte enrichi.

insertContentControl(): Word.ContentControl;

Retours

Word.ContentControl

Remarques

insertFileFromBase64(base64File, insertLocation)

Insère un document à l’emplacement spécifié.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

Paramètres

base64File: string

Obligatoire. Contenu encodé en Base64 d’un fichier .docx.

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

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

Word.Range

Remarques

Remarque : l’insertion n’est pas prise en charge si le document inséré contient un contrôle ActiveX (probablement dans un champ de formulaire). Envisagez de remplacer un tel champ de formulaire par un contrôle de contenu ou une autre option appropriée pour votre scénario.

insertHtml(html, insertLocation)

Insère du code HTML à l’emplacement spécifié.

insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

Paramètres

html: string

Obligatoire. Code HTML à insérer.

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

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

Word.Range

Remarques

insertInlinePictureFromBase64(base64EncodedImage, insertLocation)

Insère une image insérée à l’emplacement spécifié.

insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;

Paramètres

base64EncodedImage: string

Obligatoire. Image encodée en Base64 à insérer.

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

Obligatoire. La valeur doit être « Replace », « Before » ou « After ».

Retours

Word.InlinePicture

Remarques

insertOoxml(ooxml, insertLocation)

Insère du code OOXML à l’emplacement spécifié.

insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

Paramètres

ooxml: string

Obligatoire. Code OOXML à insérer.

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

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

Word.Range

Remarques

insertParagraph(paragraphText, insertLocation)

Insère un paragraphe à l’emplacement spécifié.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Paramètres

paragraphText: string

Obligatoire. Texte de paragraphe à insérer.

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

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

Word.Paragraph

Remarques

insertText(text, insertLocation)

Insère du texte à l’emplacement spécifié.

insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;

Paramètres

text: string

Obligatoire. Texte à insérer.

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

Obligatoire. La valeur doit être « Before » ou « After ».

Retours

Word.Range

Remarques

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture;

Paramètres

options: Word.Interfaces.InlinePictureLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.InlinePicture

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.InlinePicture;

Paramètres

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Word.InlinePicture

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.InlinePicture;

Paramètres

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Word.InlinePicture

select(selectionMode)

Sélectionne l’image insérée. Word fait défiler le document jusqu’à accéder à la sélection.

select(selectionMode?: Word.SelectionMode): void;

Paramètres

selectionMode: Word.SelectionMode

Optional. Le mode de sélection doit être « Select », « Start » ou « End ». « Select » (sélectionner) est la valeur par défaut.

Retours

void

Remarques

select(selectionModeString)

Sélectionne l’image insérée. Word fait défiler le document jusqu’à accéder à la sélection.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Paramètres

selectionModeString: "Select" | "Start" | "End"

Optional. Le mode de sélection doit être « Select », « Start » ou « End ». « Select » (sélectionner) est la valeur par défaut.

Retours

void

Remarques