Partager via


Word.InlinePicture class

Représente une image incluse.

Extends

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Exemples

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

Propriétés

altTextDescription

Spécifie une chaîne qui représente le texte de remplacement associé à l’image inline.

altTextTitle

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

context

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

height

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

hyperlink

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

lockAspectRatio

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

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.

width

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

Méthodes

getBase64ImageSrc()

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

insertContentControl()

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

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(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(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.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.InlinePicture est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.InlinePictureDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

Détails de la propriété

altTextDescription

Spécifie une chaîne qui représente le texte de remplacement associé à l’image inline.

altTextDescription: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

altTextTitle

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

altTextTitle: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.1 ]

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é

height

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

height: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

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

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

[ Ensemble d’API : WordApi 1.1 ]

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é

Remarques

[ Ensemble d’API : WordApi 1.1 ]

width

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

width: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApi 1.1 ]

Détails de la méthode

getBase64ImageSrc()

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

getBase64ImageSrc(): OfficeExtension.ClientResult<string>;

Retours

Remarques

[ Ensemble d’API : WordApi 1.1 ]

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);
});

insertContentControl()

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

insertContentControl(): Word.ContentControl;

Retours

Remarques

[ Ensemble d’API : WordApi 1.1 ]

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

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

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

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Word.Interfaces.InlinePictureUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.InlinePicture): void;

Paramètres

properties
Word.InlinePicture

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.InlinePicture est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.InlinePictureDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.InlinePictureData;

Retours

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.InlinePicture;

Retours

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.InlinePicture;

Retours