Word.InlinePicture class

Paquet:

word

Représente une image incluse.

Extends

OfficeExtension.ClientObject

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.
paragraph	Obtient le paragraphe parent qui contient l’image insérée.
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

delete()	Supprime l’image insérée du document.
getBase64ImageSrc()	Obtient la représentation sous forme de chaîne encodée en Base64 de l’image inline.
insertBreak(breakType, insertLocation)	Insère un saut à l’emplacement spécifié du document principal.
insertContentControl()	Encadre l’image incluse avec un contrôle de contenu de texte enrichi.
insertFileFromBase64(base64File, insertLocation)	Insère un document à l’emplacement spécifié.
insertHtml(html, insertLocation)	Insère du code HTML à l’emplacement spécifié.
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)	Insère une image insérée à l’emplacement spécifié.
insertOoxml(ooxml, insertLocation)	Insère du code OOXML à l’emplacement spécifié.
insertParagraph(paragraphText, insertLocation)	Insère un paragraphe à l’emplacement spécifié.
insertText(text, insertLocation)	Insère du texte à l’emplacement spécifié.
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.
select(selectionMode)	Sélectionne l’image insérée. Word fait défiler le document jusqu’à accéder à la sélection.
select(selectionModeString)	Sélectionne l’image insérée. Word fait défiler le document jusqu’à accéder à la sélection.
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é

Word.RequestContext

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 ]

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

paragraph

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

readonly paragraph: Word.Paragraph;

Valeur de propriété

Word.Paragraph

Remarques

[ Ensemble d’API : WordApi 1.2 ]

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

[ 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

delete()

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

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.2 ]

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

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

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

[ Ensemble d’API : WordApi 1.2 ]

insertContentControl()

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

insertContentControl(): Word.ContentControl;

Retours

Word.ContentControl

Remarques

[ Ensemble d’API : WordApi 1.1 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

[ Ensemble d’API : WordApi 1.2 ]

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

Word.Interfaces.InlinePictureData

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

Word.InlinePicture

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

Word.InlinePicture