powerpoint package

Clases

PowerPoint.Application
PowerPoint.BulletFormat	Representa las propiedades de formato de viñetas de un texto que está asociado a PowerPoint.ParagraphFormat.
PowerPoint.CustomProperty	Representa una propiedad personalizada.
PowerPoint.CustomPropertyCollection	Colección de propiedades personalizadas.
PowerPoint.CustomXmlPart	Representa un objeto de elemento XML personalizado.
PowerPoint.CustomXmlPartCollection	Colección de elementos XML personalizados.
PowerPoint.CustomXmlPartScopedCollection	Colección con ámbito de elementos XML personalizados. Una colección con ámbito es el resultado de alguna operación (como filtrar por espacio de nombres). Una colección con ámbito no se puede limitar aún más.
PowerPoint.DocumentProperties	Representa las propiedades de la presentación.
PowerPoint.Hyperlink	Representa un solo hipervínculo.
PowerPoint.HyperlinkCollection	Representa una colección de hipervínculos.
PowerPoint.ParagraphFormat	Representa las propiedades de formato de párrafo de un texto asociado a PowerPoint.TextRange.
PowerPoint.Presentation
PowerPoint.RequestContext	El objeto RequestContext facilita las solicitudes a la aplicación de PowerPoint. Dado que el complemento de Office y la aplicación de PowerPoint se ejecutan en dos procesos diferentes, el contexto de solicitud es necesario para obtener acceso al modelo de objetos de PowerPoint desde el complemento.
PowerPoint.Shape	Representa una sola forma en la diapositiva.
PowerPoint.ShapeCollection	Representa la colección de formas.
PowerPoint.ShapeFill	Representa el formato de relleno de un objeto de forma.
PowerPoint.ShapeFont	Representa los atributos de fuente, como el nombre de fuente, el tamaño de fuente y el color, para el objeto TextRange de una forma.
PowerPoint.ShapeLineFormat	Representa el formato de línea del objeto shape. Para imágenes y formas geométricas, el formato de línea representa el borde de la forma.
PowerPoint.ShapeScopedCollection	Representa una colección de formas.
PowerPoint.Slide	Representa una sola diapositiva de una presentación.
PowerPoint.SlideCollection	Representa la colección de diapositivas de la presentación.
PowerPoint.SlideLayout	Representa el diseño de una diapositiva.
PowerPoint.SlideLayoutCollection	Representa la colección de diseños que proporciona el patrón de diapositivas para las diapositivas.
PowerPoint.SlideMaster	Representa el patrón de diapositivas de una diapositiva.
PowerPoint.SlideMasterCollection	Representa la colección de patrones de diapositivas de la presentación.
PowerPoint.SlideScopedCollection	Representa una colección de diapositivas de la presentación.
PowerPoint.Tag	Representa una sola etiqueta en la diapositiva.
PowerPoint.TagCollection	Representa la colección de etiquetas.
PowerPoint.TextFrame	Representa el marco de texto de un objeto de forma.
PowerPoint.TextRange	Contiene el texto que hay unido a una forma, además de las propiedades y los métodos de manipulación del texto.

Interfaces

PowerPoint.AddSlideOptions	Representa las opciones disponibles al agregar una nueva diapositiva.
PowerPoint.InsertSlideOptions	Representa las opciones disponibles al insertar diapositivas.
PowerPoint.Interfaces.BulletFormatData	Interfaz que describe los datos devueltos mediante una llamada a bulletFormat.toJSON().
PowerPoint.Interfaces.BulletFormatLoadOptions	Representa las propiedades de formato de viñetas de un texto que está asociado a PowerPoint.ParagraphFormat.
PowerPoint.Interfaces.BulletFormatUpdateData	Interfaz para actualizar datos en el BulletFormat objeto , para su uso en bulletFormat.set({ ... }).
PowerPoint.Interfaces.CollectionLoadOptions	Proporciona formas de cargar las propiedades de solo un subconjunto de miembros de una colección.
PowerPoint.Interfaces.CustomPropertyCollectionData	Interfaz que describe los datos devueltos mediante una llamada a customPropertyCollection.toJSON().
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions	Colección de propiedades personalizadas.
PowerPoint.Interfaces.CustomPropertyCollectionUpdateData	Interfaz para actualizar datos en el CustomPropertyCollection objeto , para su uso en customPropertyCollection.set({ ... }).
PowerPoint.Interfaces.CustomPropertyData	Interfaz que describe los datos devueltos mediante una llamada a customProperty.toJSON().
PowerPoint.Interfaces.CustomPropertyLoadOptions	Representa una propiedad personalizada.
PowerPoint.Interfaces.CustomPropertyUpdateData	Interfaz para actualizar datos en el CustomProperty objeto , para su uso en customProperty.set({ ... }).
PowerPoint.Interfaces.CustomXmlPartCollectionData	Interfaz que describe los datos devueltos mediante una llamada a customXmlPartCollection.toJSON().
PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions	Colección de elementos XML personalizados.
PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData	Interfaz para actualizar datos en el CustomXmlPartCollection objeto , para su uso en customXmlPartCollection.set({ ... }).
PowerPoint.Interfaces.CustomXmlPartData	Interfaz que describe los datos devueltos mediante una llamada a customXmlPart.toJSON().
PowerPoint.Interfaces.CustomXmlPartLoadOptions	Representa un objeto de elemento XML personalizado.
PowerPoint.Interfaces.CustomXmlPartScopedCollectionData	Interfaz que describe los datos devueltos mediante una llamada a customXmlPartScopedCollection.toJSON().
PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions	Colección con ámbito de elementos XML personalizados. Una colección con ámbito es el resultado de alguna operación (como filtrar por espacio de nombres). Una colección con ámbito no se puede limitar aún más.
PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData	Interfaz para actualizar datos en el CustomXmlPartScopedCollection objeto , para su uso en customXmlPartScopedCollection.set({ ... }).
PowerPoint.Interfaces.DocumentPropertiesData	Interfaz que describe los datos devueltos mediante una llamada a documentProperties.toJSON().
PowerPoint.Interfaces.DocumentPropertiesLoadOptions	Representa las propiedades de la presentación.
PowerPoint.Interfaces.DocumentPropertiesUpdateData	Interfaz para actualizar datos en el DocumentProperties objeto , para su uso en documentProperties.set({ ... }).
PowerPoint.Interfaces.HyperlinkCollectionData	Interfaz que describe los datos devueltos mediante una llamada a hyperlinkCollection.toJSON().
PowerPoint.Interfaces.HyperlinkCollectionLoadOptions	Representa una colección de hipervínculos.
PowerPoint.Interfaces.HyperlinkCollectionUpdateData	Interfaz para actualizar datos en el HyperlinkCollection objeto , para su uso en hyperlinkCollection.set({ ... }).
PowerPoint.Interfaces.HyperlinkData	Interfaz que describe los datos devueltos mediante una llamada a hyperlink.toJSON().
PowerPoint.Interfaces.HyperlinkLoadOptions	Representa un solo hipervínculo.
PowerPoint.Interfaces.HyperlinkUpdateData	Interfaz para actualizar datos en el Hyperlink objeto , para su uso en hyperlink.set({ ... }).
PowerPoint.Interfaces.ParagraphFormatData	Interfaz que describe los datos devueltos mediante una llamada a paragraphFormat.toJSON().
PowerPoint.Interfaces.ParagraphFormatLoadOptions	Representa las propiedades de formato de párrafo de un texto asociado a PowerPoint.TextRange.
PowerPoint.Interfaces.ParagraphFormatUpdateData	Interfaz para actualizar datos en el ParagraphFormat objeto , para su uso en paragraphFormat.set({ ... }).
PowerPoint.Interfaces.PresentationData	Interfaz que describe los datos devueltos mediante una llamada a presentation.toJSON().
PowerPoint.Interfaces.PresentationLoadOptions
PowerPoint.Interfaces.ShapeCollectionData	Interfaz que describe los datos devueltos mediante una llamada a shapeCollection.toJSON().
PowerPoint.Interfaces.ShapeCollectionLoadOptions	Representa la colección de formas.
PowerPoint.Interfaces.ShapeCollectionUpdateData	Interfaz para actualizar datos en el ShapeCollection objeto , para su uso en shapeCollection.set({ ... }).
PowerPoint.Interfaces.ShapeData	Interfaz que describe los datos devueltos mediante una llamada a shape.toJSON().
PowerPoint.Interfaces.ShapeFillData	Interfaz que describe los datos devueltos mediante una llamada a shapeFill.toJSON().
PowerPoint.Interfaces.ShapeFillLoadOptions	Representa el formato de relleno de un objeto de forma.
PowerPoint.Interfaces.ShapeFillUpdateData	Interfaz para actualizar datos en el ShapeFill objeto , para su uso en shapeFill.set({ ... }).
PowerPoint.Interfaces.ShapeFontData	Interfaz que describe los datos devueltos mediante una llamada a shapeFont.toJSON().
PowerPoint.Interfaces.ShapeFontLoadOptions	Representa los atributos de fuente, como el nombre de fuente, el tamaño de fuente y el color, para el objeto TextRange de una forma.
PowerPoint.Interfaces.ShapeFontUpdateData	Interfaz para actualizar datos en el ShapeFont objeto , para su uso en shapeFont.set({ ... }).
PowerPoint.Interfaces.ShapeLineFormatData	Interfaz que describe los datos devueltos mediante una llamada a shapeLineFormat.toJSON().
PowerPoint.Interfaces.ShapeLineFormatLoadOptions	Representa el formato de línea del objeto shape. Para imágenes y formas geométricas, el formato de línea representa el borde de la forma.
PowerPoint.Interfaces.ShapeLineFormatUpdateData	Interfaz para actualizar datos en el ShapeLineFormat objeto , para su uso en shapeLineFormat.set({ ... }).
PowerPoint.Interfaces.ShapeLoadOptions	Representa una sola forma en la diapositiva.
PowerPoint.Interfaces.ShapeScopedCollectionData	Interfaz que describe los datos devueltos mediante una llamada a shapeScopedCollection.toJSON().
PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions	Representa una colección de formas.
PowerPoint.Interfaces.ShapeScopedCollectionUpdateData	Interfaz para actualizar datos en el ShapeScopedCollection objeto , para su uso en shapeScopedCollection.set({ ... }).
PowerPoint.Interfaces.ShapeUpdateData	Interfaz para actualizar datos en el Shape objeto , para su uso en shape.set({ ... }).
PowerPoint.Interfaces.SlideCollectionData	Interfaz que describe los datos devueltos mediante una llamada a slideCollection.toJSON().
PowerPoint.Interfaces.SlideCollectionLoadOptions	Representa la colección de diapositivas de la presentación.
PowerPoint.Interfaces.SlideCollectionUpdateData	Interfaz para actualizar datos en el SlideCollection objeto , para su uso en slideCollection.set({ ... }).
PowerPoint.Interfaces.SlideData	Interfaz que describe los datos devueltos mediante una llamada a slide.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionData	Interfaz que describe los datos devueltos mediante una llamada a slideLayoutCollection.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions	Representa la colección de diseños que proporciona el patrón de diapositivas para las diapositivas.
PowerPoint.Interfaces.SlideLayoutCollectionUpdateData	Interfaz para actualizar datos en el SlideLayoutCollection objeto , para su uso en slideLayoutCollection.set({ ... }).
PowerPoint.Interfaces.SlideLayoutData	Interfaz que describe los datos devueltos mediante una llamada a slideLayout.toJSON().
PowerPoint.Interfaces.SlideLayoutLoadOptions	Representa el diseño de una diapositiva.
PowerPoint.Interfaces.SlideLoadOptions	Representa una sola diapositiva de una presentación.
PowerPoint.Interfaces.SlideMasterCollectionData	Interfaz que describe los datos devueltos mediante una llamada a slideMasterCollection.toJSON().
PowerPoint.Interfaces.SlideMasterCollectionLoadOptions	Representa la colección de patrones de diapositivas de la presentación.
PowerPoint.Interfaces.SlideMasterCollectionUpdateData	Interfaz para actualizar datos en el SlideMasterCollection objeto , para su uso en slideMasterCollection.set({ ... }).
PowerPoint.Interfaces.SlideMasterData	Interfaz que describe los datos devueltos mediante una llamada a slideMaster.toJSON().
PowerPoint.Interfaces.SlideMasterLoadOptions	Representa el patrón de diapositivas de una diapositiva.
PowerPoint.Interfaces.SlideScopedCollectionData	Interfaz que describe los datos devueltos mediante una llamada a slideScopedCollection.toJSON().
PowerPoint.Interfaces.SlideScopedCollectionLoadOptions	Representa una colección de diapositivas de la presentación.
PowerPoint.Interfaces.SlideScopedCollectionUpdateData	Interfaz para actualizar datos en el SlideScopedCollection objeto , para su uso en slideScopedCollection.set({ ... }).
PowerPoint.Interfaces.TagCollectionData	Interfaz que describe los datos devueltos mediante una llamada a tagCollection.toJSON().
PowerPoint.Interfaces.TagCollectionLoadOptions	Representa la colección de etiquetas.
PowerPoint.Interfaces.TagCollectionUpdateData	Interfaz para actualizar datos en el TagCollection objeto , para su uso en tagCollection.set({ ... }).
PowerPoint.Interfaces.TagData	Interfaz que describe los datos devueltos mediante una llamada a tag.toJSON().
PowerPoint.Interfaces.TagLoadOptions	Representa una sola etiqueta en la diapositiva.
PowerPoint.Interfaces.TagUpdateData	Interfaz para actualizar datos en el Tag objeto , para su uso en tag.set({ ... }).
PowerPoint.Interfaces.TextFrameData	Interfaz que describe los datos devueltos mediante una llamada a textFrame.toJSON().
PowerPoint.Interfaces.TextFrameLoadOptions	Representa el marco de texto de un objeto de forma.
PowerPoint.Interfaces.TextFrameUpdateData	Interfaz para actualizar datos en el TextFrame objeto , para su uso en textFrame.set({ ... }).
PowerPoint.Interfaces.TextRangeData	Interfaz que describe los datos devueltos mediante una llamada a textRange.toJSON().
PowerPoint.Interfaces.TextRangeLoadOptions	Contiene el texto que hay unido a una forma, además de las propiedades y los métodos de manipulación del texto.
PowerPoint.Interfaces.TextRangeUpdateData	Interfaz para actualizar datos en el TextRange objeto , para su uso en textRange.set({ ... }).
PowerPoint.ShapeAddOptions	Representa las opciones disponibles al agregar formas.
PowerPoint.SlideGetImageOptions	Representa las opciones disponibles al obtener una imagen de una diapositiva.

Enumeraciones

PowerPoint.ConnectorType	Especifica el tipo de conector para las formas de línea.
PowerPoint.DocumentPropertyType	Especifica el tipo de propiedad del documento para las propiedades personalizadas.
PowerPoint.ErrorCodes
PowerPoint.GeometricShapeType	Especifica el tipo de forma de un GeometricShape objeto.
PowerPoint.InsertSlideFormatting	Especifica las opciones de formato para cuando se insertan diapositivas.
PowerPoint.ParagraphHorizontalAlignment	Representa la alineación horizontal del PowerPoint.TextFrame en una powerpoint.shape.
PowerPoint.ShapeAutoSize	Determina el tipo de ajuste automático de tamaño permitido.
PowerPoint.ShapeFillType	Especifica el tipo de relleno de una forma.
PowerPoint.ShapeFontUnderlineStyle	Tipo de subrayado aplicado a una fuente.
PowerPoint.ShapeLineDashStyle	Especifica el estilo de guión de una línea.
PowerPoint.ShapeLineStyle	Especifica el estilo de una línea.
PowerPoint.ShapeType	Especifica el tipo de una forma.
PowerPoint.TextVerticalAlignment	Representa la alineación vertical de un PowerPoint.TextFrame en un PowerPoint.Shape. Si se selecciona una de las opciones centradas, el contenido de TextFrame se centrará horizontalmente dentro de Shape como un grupo. Para cambiar la alineación horizontal de un texto, vea PowerPoint.ParagraphFormat y PowerPoint.ParagraphHorizontalAlignment.

Funciones

PowerPoint.createPresentation(base64File)	Crea y abre una nueva presentación. Opcionalmente, la presentación se puede rellenar previamente con un archivo de .pptx codificado en Base64. [ Conjunto de API: PowerPointApi 1.1 ]
PowerPoint.run(batch)	Ejecuta un script por lotes que realiza acciones en el modelo de objetos de PowerPoint mediante un nuevo RequestContext. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.
PowerPoint.run(object, batch)	Ejecuta un script por lotes que realiza acciones en el modelo de objetos de PowerPoint mediante RequestContext de un objeto de API creado anteriormente. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.
PowerPoint.run(objects, batch)	Ejecuta un script por lotes que realiza acciones en el modelo de objetos de PowerPoint mediante RequestContext de objetos de API creados anteriormente.

Detalles de la función

PowerPoint.createPresentation(base64File)

Crea y abre una nueva presentación. Opcionalmente, la presentación se puede rellenar previamente con un archivo de .pptx codificado en Base64.

[ Conjunto de API: PowerPointApi 1.1 ]

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

Parámetros

base64File

string

Opcional. El archivo .pptx codificado en Base64. El valor predeterminado es null.

Devoluciones

Promise<void>

Ejemplos

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)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de PowerPoint mediante un nuevo RequestContext. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

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

Parámetros

batch

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

Función que toma un RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). El parámetro de contexto facilita las solicitudes a la aplicación de PowerPoint. Dado que el complemento de Office y la aplicación de PowerPoint se ejecutan en dos procesos diferentes, RequestContext es necesario para obtener acceso al modelo de objetos de PowerPoint desde el complemento.

Devoluciones

OfficeExtension.IPromise<T>

PowerPoint.run(object, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de PowerPoint mediante RequestContext de un objeto de API creado anteriormente. Cuando se resuelve la promesa, se liberarán los objetos de seguimiento que se asignaron automáticamente durante la ejecución.

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

Parámetros

object

OfficeExtension.ClientObject

Objeto de API creado anteriormente. El lote usará el mismo RequestContext que el objeto pasado, lo que significa que cualquier cambio aplicado al objeto será recogido por "context.sync()".

batch

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

Función que toma un RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). El parámetro de contexto facilita las solicitudes a la aplicación de PowerPoint. Dado que el complemento de Office y la aplicación de PowerPoint se ejecutan en dos procesos diferentes, RequestContext es necesario para obtener acceso al modelo de objetos de PowerPoint desde el complemento.

Devoluciones

OfficeExtension.IPromise<T>

PowerPoint.run(objects, batch)

Ejecuta un script por lotes que realiza acciones en el modelo de objetos de PowerPoint mediante RequestContext de objetos de API creados anteriormente.

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

Parámetros

objects

OfficeExtension.ClientObject[]

Matriz de objetos de API creados anteriormente. La matriz se validará para asegurarse de que todos los objetos comparten el mismo contexto. El lote usará este RequestContext compartido, lo que significa que cualquier cambio aplicado a estos objetos será recogido por "context.sync()".

batch

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

Función que toma un RequestContext y devuelve una promesa (normalmente, solo el resultado de "context.sync()"). El parámetro de contexto facilita las solicitudes a la aplicación de PowerPoint. Dado que el complemento de Office y la aplicación de PowerPoint se ejecutan en dos procesos diferentes, RequestContext es necesario para obtener acceso al modelo de objetos de PowerPoint desde el complemento.

Devoluciones

OfficeExtension.IPromise<T>