powerpoint package

Classes

PowerPoint.Application
PowerPoint.BulletFormat

Représente les propriétés de mise en forme des puces d’un texte joint à PowerPoint.ParagraphFormat.

PowerPoint.CustomProperty

Représente une propriété personnalisée.

PowerPoint.CustomPropertyCollection

Collection de propriétés personnalisées.

PowerPoint.CustomXmlPart

Représente un objet de composant XML personnalisé.

PowerPoint.CustomXmlPartCollection

Collection de composants XML personnalisés.

PowerPoint.CustomXmlPartScopedCollection

Collection délimitée de parties XML personnalisées. Une collection délimitée est le résultat d’une opération (comme le filtrage par espace de noms). Une collection délimitée ne peut plus être étendue.

PowerPoint.DocumentProperties

Représente les propriétés de présentation.

PowerPoint.Hyperlink

Représente un lien hypertexte unique.

PowerPoint.HyperlinkCollection

Représente une collection de liens hypertexte.

PowerPoint.ParagraphFormat

Représente les propriétés de mise en forme de paragraphe d’un texte joint à PowerPoint.TextRange.

PowerPoint.Presentation
PowerPoint.RequestContext

L’objet RequestContext facilite les requêtes adressées à l’application PowerPoint. Étant donné que le complément Office et l’application PowerPoint s’exécutent dans deux processus différents, le contexte de demande est nécessaire pour accéder au modèle objet PowerPoint à partir du complément.

PowerPoint.Shape

Représente une forme unique dans la diapositive.

PowerPoint.ShapeCollection

Représente la collection de formes.

PowerPoint.ShapeFill

Représente la mise en forme de remplissage d’un objet shape.

PowerPoint.ShapeFont

Représente les attributs de police, tels que le nom de la police, la taille de police et la couleur, pour l’objet TextRange d’une forme.

PowerPoint.ShapeLineFormat

Représente la mise en forme de trait pour l’objet shape. Pour les images et les formes géométriques, la mise en forme de trait représente la bordure de la forme.

PowerPoint.ShapeScopedCollection

Représente une collection de formes.

PowerPoint.Slide

Représente une seule diapositive d’une présentation.

PowerPoint.SlideCollection

Représente la collection de diapositives dans la présentation.

PowerPoint.SlideLayout

Représente la disposition d’une diapositive.

PowerPoint.SlideLayoutCollection

Représente la collection de dispositions fournies par le masque des diapositives pour les diapositives.

PowerPoint.SlideMaster

Représente le masque des diapositives d’une diapositive.

PowerPoint.SlideMasterCollection

Représente la collection de masque des diapositives dans la présentation.

PowerPoint.SlideScopedCollection

Représente une collection de diapositives dans la présentation.

PowerPoint.Tag

Représente une seule balise dans la diapositive.

PowerPoint.TagCollection

Représente la collection de balises.

PowerPoint.TextFrame

Représente le cadre de texte d’un objet de forme.

PowerPoint.TextRange

Contient le texte lié à une forme, en plus des propriétés et méthodes de manipulation du texte.

Interfaces

PowerPoint.AddSlideOptions

Représente les options disponibles lors de l’ajout d’une nouvelle diapositive.

PowerPoint.InsertSlideOptions

Représente les options disponibles lors de l’insertion de diapositives.

PowerPoint.Interfaces.BulletFormatData

Interface décrivant les données retournées en appelant bulletFormat.toJSON().

PowerPoint.Interfaces.BulletFormatLoadOptions

Représente les propriétés de mise en forme des puces d’un texte joint à PowerPoint.ParagraphFormat.

PowerPoint.Interfaces.BulletFormatUpdateData

Interface permettant de mettre à jour les données sur l’objet BulletFormat , à utiliser dans bulletFormat.set({ ... }).

PowerPoint.Interfaces.CollectionLoadOptions

Fournit des moyens de charger les propriétés d’un sous-ensemble de membres d’une collection uniquement.

PowerPoint.Interfaces.CustomPropertyCollectionData

Interface décrivant les données retournées en appelant customPropertyCollection.toJSON().

PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions

Collection de propriétés personnalisées.

PowerPoint.Interfaces.CustomPropertyCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomPropertyCollection , à utiliser dans customPropertyCollection.set({ ... }).

PowerPoint.Interfaces.CustomPropertyData

Interface décrivant les données retournées en appelant customProperty.toJSON().

PowerPoint.Interfaces.CustomPropertyLoadOptions

Représente une propriété personnalisée.

PowerPoint.Interfaces.CustomPropertyUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomProperty , à utiliser dans customProperty.set({ ... }).

PowerPoint.Interfaces.CustomXmlPartCollectionData

Interface décrivant les données retournées en appelant customXmlPartCollection.toJSON().

PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions

Collection de composants XML personnalisés.

PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomXmlPartCollection , à utiliser dans customXmlPartCollection.set({ ... }).

PowerPoint.Interfaces.CustomXmlPartData

Interface décrivant les données retournées en appelant customXmlPart.toJSON().

PowerPoint.Interfaces.CustomXmlPartLoadOptions

Représente un objet de composant XML personnalisé.

PowerPoint.Interfaces.CustomXmlPartScopedCollectionData

Interface décrivant les données retournées en appelant customXmlPartScopedCollection.toJSON().

PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions

Collection délimitée de parties XML personnalisées. Une collection délimitée est le résultat d’une opération (comme le filtrage par espace de noms). Une collection délimitée ne peut plus être étendue.

PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet CustomXmlPartScopedCollection , à utiliser dans customXmlPartScopedCollection.set({ ... }).

PowerPoint.Interfaces.DocumentPropertiesData

Interface décrivant les données retournées en appelant documentProperties.toJSON().

PowerPoint.Interfaces.DocumentPropertiesLoadOptions

Représente les propriétés de présentation.

PowerPoint.Interfaces.DocumentPropertiesUpdateData

Interface permettant de mettre à jour les données sur l’objet DocumentProperties , à utiliser dans documentProperties.set({ ... }).

PowerPoint.Interfaces.HyperlinkCollectionData

Interface décrivant les données retournées en appelant hyperlinkCollection.toJSON().

PowerPoint.Interfaces.HyperlinkCollectionLoadOptions

Représente une collection de liens hypertexte.

PowerPoint.Interfaces.HyperlinkCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet HyperlinkCollection , à utiliser dans hyperlinkCollection.set({ ... }).

PowerPoint.Interfaces.HyperlinkData

Interface décrivant les données retournées en appelant hyperlink.toJSON().

PowerPoint.Interfaces.HyperlinkLoadOptions

Représente un lien hypertexte unique.

PowerPoint.Interfaces.HyperlinkUpdateData

Interface permettant de mettre à jour les données sur l’objet Hyperlink , à utiliser dans hyperlink.set({ ... }).

PowerPoint.Interfaces.ParagraphFormatData

Interface décrivant les données retournées en appelant paragraphFormat.toJSON().

PowerPoint.Interfaces.ParagraphFormatLoadOptions

Représente les propriétés de mise en forme de paragraphe d’un texte joint à PowerPoint.TextRange.

PowerPoint.Interfaces.ParagraphFormatUpdateData

Interface permettant de mettre à jour les données sur l’objet ParagraphFormat , à utiliser dans paragraphFormat.set({ ... }).

PowerPoint.Interfaces.PresentationData

Interface décrivant les données retournées en appelant presentation.toJSON().

PowerPoint.Interfaces.PresentationLoadOptions
PowerPoint.Interfaces.ShapeCollectionData

Interface décrivant les données retournées en appelant shapeCollection.toJSON().

PowerPoint.Interfaces.ShapeCollectionLoadOptions

Représente la collection de formes.

PowerPoint.Interfaces.ShapeCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet ShapeCollection , à utiliser dans shapeCollection.set({ ... }).

PowerPoint.Interfaces.ShapeData

Interface décrivant les données retournées en appelant shape.toJSON().

PowerPoint.Interfaces.ShapeFillData

Interface décrivant les données retournées en appelant shapeFill.toJSON().

PowerPoint.Interfaces.ShapeFillLoadOptions

Représente la mise en forme de remplissage d’un objet shape.

PowerPoint.Interfaces.ShapeFillUpdateData

Interface permettant de mettre à jour les données sur l’objet ShapeFill , à utiliser dans shapeFill.set({ ... }).

PowerPoint.Interfaces.ShapeFontData

Interface décrivant les données retournées en appelant shapeFont.toJSON().

PowerPoint.Interfaces.ShapeFontLoadOptions

Représente les attributs de police, tels que le nom de la police, la taille de police et la couleur, pour l’objet TextRange d’une forme.

PowerPoint.Interfaces.ShapeFontUpdateData

Interface permettant de mettre à jour les données sur l’objet ShapeFont , à utiliser dans shapeFont.set({ ... }).

PowerPoint.Interfaces.ShapeLineFormatData

Interface décrivant les données retournées en appelant shapeLineFormat.toJSON().

PowerPoint.Interfaces.ShapeLineFormatLoadOptions

Représente la mise en forme de trait pour l’objet shape. Pour les images et les formes géométriques, la mise en forme de trait représente la bordure de la forme.

PowerPoint.Interfaces.ShapeLineFormatUpdateData

Interface permettant de mettre à jour les données sur l’objet ShapeLineFormat , à utiliser dans shapeLineFormat.set({ ... }).

PowerPoint.Interfaces.ShapeLoadOptions

Représente une forme unique dans la diapositive.

PowerPoint.Interfaces.ShapeScopedCollectionData

Interface décrivant les données retournées en appelant shapeScopedCollection.toJSON().

PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions

Représente une collection de formes.

PowerPoint.Interfaces.ShapeScopedCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet ShapeScopedCollection , à utiliser dans shapeScopedCollection.set({ ... }).

PowerPoint.Interfaces.ShapeUpdateData

Interface permettant de mettre à jour les données sur l’objet Shape , à utiliser dans shape.set({ ... }).

PowerPoint.Interfaces.SlideCollectionData

Interface décrivant les données retournées en appelant slideCollection.toJSON().

PowerPoint.Interfaces.SlideCollectionLoadOptions

Représente la collection de diapositives dans la présentation.

PowerPoint.Interfaces.SlideCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet SlideCollection , à utiliser dans slideCollection.set({ ... }).

PowerPoint.Interfaces.SlideData

Interface décrivant les données retournées en appelant slide.toJSON().

PowerPoint.Interfaces.SlideLayoutCollectionData

Interface décrivant les données retournées en appelant slideLayoutCollection.toJSON().

PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions

Représente la collection de dispositions fournies par le masque des diapositives pour les diapositives.

PowerPoint.Interfaces.SlideLayoutCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet SlideLayoutCollection , à utiliser dans slideLayoutCollection.set({ ... }).

PowerPoint.Interfaces.SlideLayoutData

Interface décrivant les données retournées en appelant slideLayout.toJSON().

PowerPoint.Interfaces.SlideLayoutLoadOptions

Représente la disposition d’une diapositive.

PowerPoint.Interfaces.SlideLoadOptions

Représente une seule diapositive d’une présentation.

PowerPoint.Interfaces.SlideMasterCollectionData

Interface décrivant les données retournées en appelant slideMasterCollection.toJSON().

PowerPoint.Interfaces.SlideMasterCollectionLoadOptions

Représente la collection de masque des diapositives dans la présentation.

PowerPoint.Interfaces.SlideMasterCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet SlideMasterCollection , à utiliser dans slideMasterCollection.set({ ... }).

PowerPoint.Interfaces.SlideMasterData

Interface décrivant les données retournées en appelant slideMaster.toJSON().

PowerPoint.Interfaces.SlideMasterLoadOptions

Représente le masque des diapositives d’une diapositive.

PowerPoint.Interfaces.SlideScopedCollectionData

Interface décrivant les données retournées en appelant slideScopedCollection.toJSON().

PowerPoint.Interfaces.SlideScopedCollectionLoadOptions

Représente une collection de diapositives dans la présentation.

PowerPoint.Interfaces.SlideScopedCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet SlideScopedCollection , à utiliser dans slideScopedCollection.set({ ... }).

PowerPoint.Interfaces.TagCollectionData

Interface décrivant les données retournées en appelant tagCollection.toJSON().

PowerPoint.Interfaces.TagCollectionLoadOptions

Représente la collection de balises.

PowerPoint.Interfaces.TagCollectionUpdateData

Interface permettant de mettre à jour les données sur l’objet TagCollection , à utiliser dans tagCollection.set({ ... }).

PowerPoint.Interfaces.TagData

Interface décrivant les données retournées en appelant tag.toJSON().

PowerPoint.Interfaces.TagLoadOptions

Représente une seule balise dans la diapositive.

PowerPoint.Interfaces.TagUpdateData

Interface permettant de mettre à jour les données sur l’objet Tag , à utiliser dans tag.set({ ... }).

PowerPoint.Interfaces.TextFrameData

Interface décrivant les données retournées en appelant textFrame.toJSON().

PowerPoint.Interfaces.TextFrameLoadOptions

Représente le cadre de texte d’un objet de forme.

PowerPoint.Interfaces.TextFrameUpdateData

Interface permettant de mettre à jour les données sur l’objet TextFrame , à utiliser dans textFrame.set({ ... }).

PowerPoint.Interfaces.TextRangeData

Interface décrivant les données retournées en appelant textRange.toJSON().

PowerPoint.Interfaces.TextRangeLoadOptions

Contient le texte lié à une forme, en plus des propriétés et méthodes de manipulation du texte.

PowerPoint.Interfaces.TextRangeUpdateData

Interface permettant de mettre à jour les données sur l’objet TextRange , à utiliser dans textRange.set({ ... }).

PowerPoint.ShapeAddOptions

Représente les options disponibles lors de l’ajout de formes.

PowerPoint.SlideGetImageOptions

Représente les options disponibles lors de l’obtention d’une image d’une diapositive.

Énumérations

PowerPoint.ConnectorType

Spécifie le type de connecteur pour les formes de trait.

PowerPoint.DocumentPropertyType

Spécifie le type de propriété de document pour les propriétés personnalisées.

PowerPoint.ErrorCodes
PowerPoint.GeometricShapeType

Spécifie le type de forme d’un GeometricShape objet .

PowerPoint.InsertSlideFormatting

Spécifie les options de mise en forme pour l’insertion des diapositives.

PowerPoint.ParagraphHorizontalAlignment

Représente l’alignement horizontal de PowerPoint.TextFrame dans un Fichier PowerPoint.Shape.

PowerPoint.ShapeAutoSize

Détermine le type de dimensionnement automatique autorisé.

PowerPoint.ShapeFillType

Spécifie le type de remplissage d'une forme.

PowerPoint.ShapeFontUnderlineStyle

Type de soulignement appliqué à une police.

PowerPoint.ShapeLineDashStyle

Spécifie le style de tiret d'une ligne.

PowerPoint.ShapeLineStyle

Spécifie le style d'une ligne.

PowerPoint.ShapeType

Spécifie le type d’une forme.

PowerPoint.TextVerticalAlignment

Représente l’alignement vertical d’un Objet PowerPoint.TextFrame dans un fichier PowerPoint.Shape. Si l’une des options centrées est sélectionnée, le contenu du TextFrame est centré horizontalement dans le Shape en tant que groupe. Pour modifier l’alignement horizontal d’un texte, voir PowerPoint.ParagraphFormat et PowerPoint.ParagraphHorizontalAlignment.

Functions

PowerPoint.createPresentation(base64File)

Crée et ouvre une présentation. Si vous le souhaitez, la présentation peut être préremplie avec un fichier .pptx codé en Base64.

[ Ensemble d’API : PowerPointApi 1.1 ]

PowerPoint.run(batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet PowerPoint, à l’aide d’un nouveau RequestContext. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

PowerPoint.run(object, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet PowerPoint, à l’aide du RequestContext d’un objet API créé précédemment. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

PowerPoint.run(objects, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet PowerPoint, à l’aide du RequestContext d’objets API créés précédemment.

Informations relatives à la fonction

PowerPoint.createPresentation(base64File)

Crée et ouvre une présentation. Si vous le souhaitez, la présentation peut être préremplie avec un fichier .pptx codé en Base64.

[ Ensemble d’API : PowerPointApi 1.1 ]

export function createPresentation(base64File?: string): Promise<void>;

Paramètres

base64File

string

Optional. Fichier .pptx encodé en Base64. La valeur par défaut est null.

Retours

Promise<void>

Exemples

const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();

reader.onload = (event) => {
  // Remove the metadata before the base64-encoded string.
  const startIndex = reader.result.toString().indexOf("base64,");
  const copyBase64 = reader.result.toString().substr(startIndex + 7);

  PowerPoint.createPresentation(copyBase64);
};

// Read in the file as a data URL so we can parse the base64-encoded string.
reader.readAsDataURL(myFile.files[0]);

PowerPoint.run(batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet PowerPoint, à l’aide d’un nouveau RequestContext. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

export function run<T>(batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Paramètres

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

Fonction qui accepte un RequestContext et retourne une promesse (généralement, uniquement le résultat de « context.sync() »). Le paramètre de contexte facilite les requêtes adressées à l’application PowerPoint. Étant donné que le complément Office et l’application PowerPoint s’exécutent dans deux processus différents, requestContext est requis pour accéder au modèle objet PowerPoint à partir du complément.

Retours

PowerPoint.run(object, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet PowerPoint, à l’aide du RequestContext d’un objet API créé précédemment. Une fois la promesse résolue, tous les objets suivis qui ont été alloués automatiquement pendant l’exécution sont libérés.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Paramètres

object
OfficeExtension.ClientObject

Objet API créé précédemment. Le lot utilise le même RequestContext que l’objet passé, ce qui signifie que toutes les modifications appliquées à l’objet seront récupérées par « context.sync() ».

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

Fonction qui accepte un RequestContext et retourne une promesse (généralement, uniquement le résultat de « context.sync() »). Le paramètre de contexte facilite les requêtes adressées à l’application PowerPoint. Étant donné que le complément Office et l’application PowerPoint s’exécutent dans deux processus différents, requestContext est requis pour accéder au modèle objet PowerPoint à partir du complément.

Retours

PowerPoint.run(objects, batch)

Exécute un script de traitement par lots qui effectue des actions sur le modèle objet PowerPoint, à l’aide du RequestContext d’objets API créés précédemment.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Paramètres

objects

OfficeExtension.ClientObject[]

Tableau d’objets API créés précédemment. Le tableau est validé pour s’assurer que tous les objets partagent le même contexte. Le lot utilise ce RequestContext partagé, ce qui signifie que toutes les modifications appliquées à ces objets seront récupérées par « context.sync() ».

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

Fonction qui accepte un RequestContext et retourne une promesse (généralement, uniquement le résultat de « context.sync() »). Le paramètre de contexte facilite les requêtes adressées à l’application PowerPoint. Étant donné que le complément Office et l’application PowerPoint s’exécutent dans deux processus différents, requestContext est requis pour accéder au modèle objet PowerPoint à partir du complément.

Retours