Objet InlinePicture (interface API JavaScript pour Word)

Office and SharePoint Add-ins

La dernière version de ce complément Office est disponible dans le référentiel GitHub des compléments.


Représente une image incluse.

S’applique à : Word 2016, Word pour iPad, Word pour Mac

PropriétéTypeDescription
altTextDescriptionstringObtient ou définit une chaîne qui représente le texte de remplacement associé à l’image incluse.
altTextTitlestringObtient ou définit une chaîne qui contient le titre de l’image incluse.
hyperlinkstringObtient ou définit le lien hypertexte associé à l’image incluse.
lockAspectRatioboolObtient ou définit une valeur qui indique si l’image incluse conserve ses proportions d’origine lorsque vous la redimensionnez.

Voir des exemples d’accès aux propriétés.

RelationTypeDescription
heightfloatObtient ou définit un nombre qui décrit la hauteur de l’image incluse. La mesure est exprimée en points.
parentContentControlContentControlObtient le contrôle de contenu qui contient l’image incluse. Renvoie null s’il n’existe pas de contrôle de contenu parent. En lecture seule.
ParagraphparagraphObtient le paragraphe qui contient l’image incluse. En lecture seule.
widthfloatObtient ou définit un nombre qui décrit la largeur de l’image incluse. La mesure est exprimée en points.
MéthodeType renvoyéDescription
delete()voidSupprime l’image du document.
getBase64ImageSrc()stringObtient un objet dont la valeur est la représentation de chaîne encodée au format Base64 de l’image incluse.
insertBreak(breakType: BreakType, insertLocation: InsertLocation)voidInsère un saut à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).
insertContentControl()ContentControlEncadre l’image incluse avec un contrôle de contenu de texte enrichi.
insertFileFromBase64(base64File: string, insertLocation: InsertLocation)RangeInsère un document dans le corps à l’emplacement spécifié. La valeur insertLocation peut être « Before » (avant) ou « After » (après).
insertHtml(html: string, insertLocation: InsertLocation)RangeInsère du code HTML à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: InsertLocation)InlinePictureInsère une image dans le corps à l’emplacement spécifié. La valeur insertLocation peut être « Replace » (remplacer), « Before » (avant) ou « After » (après).
insertOoxml(ooxml: string, insertLocation: InsertLocation)RangeInsère du code OOXML à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).
insertParagraph(paragraphText: string, insertLocation: InsertLocation)ParagraphInsère un paragraphe à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).
insertText(text: string, insertLocation: InsertLocation)RangeInsère du texte dans le corps à l’emplacement spécifié. La valeur insertLocation peut être « Before » (avant) ou « After » (après).
select(selectionMode: SelectionMode)voidSélectionne l’image et y accède via l’interface utilisateur de Word. Les valeurs selectionMode peuvent être « Select » (sélectionner), « Start » (début) ou « End » (fin).
load(param: object)voidRemplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

Supprime l’image du document.

Syntaxe

jsinlinePictureObject.delete();

Paramètres

Aucun

Retourne

void

Obtient un objet dont la valeur est la représentation de chaîne encodée au format Base64 de l’image incluse.

Syntaxe

jsinlinePictureObject.getBase64ImageSrc();

Paramètres

Aucun

Retourne

string

Syntaxe

jsinlinePictureObject.insertBreak(breakType, insertLocation);

Paramètres

ParamètreTypeDescription
breakTypeBreakTypeObligatoire. Type de saut à ajouter au corps.
insertLocationInsertLocationObligatoire. La valeur peut être « Before » (avant) » ou « After » (après).

Retourne

void

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

Syntaxe

jsinlinePictureObject.insertContentControl();

Paramètres

Aucun

Retourne

ContentControl

Insère un document dans le corps à l’emplacement spécifié. La valeur insertLocation peut être « Before » (avant) ou « After » (après).

Syntaxe

jsinlinePictureObject.insertFileFromBase64(base64File, insertLocation);

Paramètres

ParamètreTypeDescription
base64FilestringObligatoire. Contenu d’un fichier docx encodé au format Base64.
insertLocationInsertLocationObligatoire. La valeur peut être « Before » (avant) » ou « After » (après).

Retourne

Range

Insère du code HTML à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).

Syntaxe

jsinlinePictureObject.insertHtml(html, insertLocation);

Paramètres

ParamètreTypeDescription
HtmlstringObligatoire. Code HTML à insérer dans le document.
insertLocationInsertLocationObligatoire. La valeur peut être « Before » (avant) » ou « After » (après).

Retourne

Range

Insère une image dans le corps à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).

Syntaxe

inlinePictureObject.insertInlinePictureFromBase64(image, insertLocation);

Paramètres

ParamètreTypeDescription
base64EncodedImagestringObligatoire. Image encodée au format Base64 à insérer dans le corps.
insertLocationInsertLocationObligatoire. La valeur peut être « Before » (avant) » ou « After » (après).

Renvoie

InlinePicture

Insère du code OOXML à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).

Syntaxe

jsinlinePictureObject.insertOoxml(ooxml, insertLocation);

Paramètres

ParamètreTypeDescription
ooxmlstringObligatoire. Code OOXML à insérer.
insertLocationInsertLocationObligatoire. La valeur peut être « Before » (avant) » ou « After » (après).

Retourne

Range

Insère un paragraphe à l’emplacement spécifié. La valeur insertLocation peut être définie sur « Before » (avant) ou « After » (après).

Syntaxe

jsinlinePictureObject.insertParagraph(paragraphText, insertLocation);

Paramètres

ParamètreTypeDescription
paragraphTextstringObligatoire. Texte de paragraphe à insérer.
insertLocationInsertLocationObligatoire. La valeur peut être « Before » (avant) » ou « After » (après).

Retourne

Paragraph

Insère du texte dans le corps à l’emplacement spécifié. La valeur insertLocation peut être « Before » (avant) ou « After » (après).

Syntaxe

jsinlinePictureObject.insertText(text, insertLocation);

Paramètres

ParamètreTypeDescription
textestringObligatoire. Texte à insérer.
insertLocationInsertLocationObligatoire. La valeur peut être « Before » (avant) » ou « After » (après).

Retourne

Range

Sélectionne l’image et y accède via l’interface utilisateur de Word. Les valeurs selectionMode peuvent être « Select » (sélectionner), « Start » (début) ou « End » (fin).

Syntaxe

jsinlinePictureObject.select(selectionMode);

Paramètres

ParamètreTypeDescription
selectionModeSelectionModeFacultatif. Le mode de sélection peut être « Select » (sélectionner), « Start » (début) ou « End » (fin). « Select » (sélectionner) est la valeur par défaut.

Retourne

void

Remplit l’objet proxy créé dans le calque JavaScript avec des valeurs de propriété et d’objet spécifiées dans le paramètre.

Syntaxe

jsobject.load(param);

Paramètres

ParamètreTypeDescription
paramobjectFacultatif. Accepte les noms de paramètre et de relation sous forme de chaîne délimitée ou de tableau. Sinon, indiquez l’objet loadOption.

Retourne

void

Utilisez l’ensemble de conditions requises dans les vérifications à l’exécution pour vous assurer que votre application est prise en charge par la version d’hôte de Word. Pour plus d’informations sur la configuration requise pour le serveur et l’application d’hôte Office, voir Configuration requise pour exécuter des compléments Office.

Afficher: