powerpoint package

Classes

PowerPoint.Application
PowerPoint.Presentation
PowerPoint.RequestContext	O objeto RequestContext facilita os pedidos para a aplicação PowerPoint. Uma vez que o suplemento do Office e a aplicação PowerPoint são executados em dois processos diferentes, o contexto do pedido é necessário para obter acesso ao modelo de objetos do PowerPoint a partir do suplemento.
PowerPoint.Shape	Representa uma única forma no diapositivo.
PowerPoint.ShapeCollection	Representa a coleção de formas.
PowerPoint.Slide	Representa um único diapositivo de uma apresentação.
PowerPoint.SlideCollection	Representa a coleção de diapositivos na apresentação.
PowerPoint.SlideLayout	Representa o esquema de um diapositivo.
PowerPoint.SlideLayoutCollection	Representa a coleção de esquemas fornecida pelo Modelo Global de Diapositivos para diapositivos.
PowerPoint.SlideMaster	Representa o Modelo Global de Diapositivos de um diapositivo.
PowerPoint.SlideMasterCollection	Representa a coleção de Modelos Globais de Diapositivos na apresentação.
PowerPoint.Tag	Representa uma única etiqueta no diapositivo.
PowerPoint.TagCollection	Representa a coleção de etiquetas.

Interfaces

PowerPoint.AddSlideOptions	Representa as opções disponíveis ao adicionar um novo diapositivo.
PowerPoint.InsertSlideOptions	Representa as opções disponíveis ao inserir diapositivos.
PowerPoint.Interfaces.BulletFormatData	Uma interface que descreve os dados devolvidos ao chamar bulletFormat.toJSON().
PowerPoint.Interfaces.BulletFormatUpdateData	Uma interface para atualizar dados no BulletFormat objeto, para utilização no bulletFormat.set({ ... }).
PowerPoint.Interfaces.CollectionLoadOptions	Fornece formas de carregar propriedades de apenas um subconjunto de membros de uma coleção.
PowerPoint.Interfaces.CustomPropertyCollectionData	Uma interface que descreve os dados devolvidos ao chamar customPropertyCollection.toJSON().
PowerPoint.Interfaces.CustomPropertyCollectionUpdateData	Uma interface para atualizar dados no CustomPropertyCollection objeto, para utilização no customPropertyCollection.set({ ... }).
PowerPoint.Interfaces.CustomPropertyData	Uma interface que descreve os dados devolvidos ao chamar customProperty.toJSON().
PowerPoint.Interfaces.CustomPropertyUpdateData	Uma interface para atualizar dados no CustomProperty objeto, para utilização no customProperty.set({ ... }).
PowerPoint.Interfaces.CustomXmlPartCollectionData	Uma interface que descreve os dados devolvidos ao chamar customXmlPartCollection.toJSON().
PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData	Uma interface para atualizar dados no CustomXmlPartCollection objeto, para utilização no customXmlPartCollection.set({ ... }).
PowerPoint.Interfaces.CustomXmlPartData	Uma interface que descreve os dados devolvidos ao chamar customXmlPart.toJSON().
PowerPoint.Interfaces.CustomXmlPartScopedCollectionData	Uma interface que descreve os dados devolvidos ao chamar customXmlPartScopedCollection.toJSON().
PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData	Uma interface para atualizar dados no CustomXmlPartScopedCollection objeto, para utilização no customXmlPartScopedCollection.set({ ... }).
PowerPoint.Interfaces.DocumentPropertiesData	Uma interface que descreve os dados devolvidos ao chamar documentProperties.toJSON().
PowerPoint.Interfaces.DocumentPropertiesUpdateData	Uma interface para atualizar dados no DocumentProperties objeto, para utilização no documentProperties.set({ ... }).
PowerPoint.Interfaces.HyperlinkCollectionData	Uma interface que descreve os dados devolvidos ao chamar hyperlinkCollection.toJSON().
PowerPoint.Interfaces.HyperlinkCollectionUpdateData	Uma interface para atualizar dados no HyperlinkCollection objeto, para utilização no hyperlinkCollection.set({ ... }).
PowerPoint.Interfaces.HyperlinkData	Uma interface que descreve os dados devolvidos ao chamar hyperlink.toJSON().
PowerPoint.Interfaces.HyperlinkUpdateData	Uma interface para atualizar dados no Hyperlink objeto, para utilização no hyperlink.set({ ... }).
PowerPoint.Interfaces.ParagraphFormatData	Uma interface que descreve os dados devolvidos ao chamar paragraphFormat.toJSON().
PowerPoint.Interfaces.ParagraphFormatUpdateData	Uma interface para atualizar dados no ParagraphFormat objeto, para utilização no paragraphFormat.set({ ... }).
PowerPoint.Interfaces.PresentationData	Uma interface que descreve os dados devolvidos ao chamar presentation.toJSON().
PowerPoint.Interfaces.PresentationLoadOptions
PowerPoint.Interfaces.ShapeCollectionData	Uma interface que descreve os dados devolvidos ao chamar shapeCollection.toJSON().
PowerPoint.Interfaces.ShapeCollectionLoadOptions	Representa a coleção de formas.
PowerPoint.Interfaces.ShapeCollectionUpdateData	Uma interface para atualizar dados no ShapeCollection objeto, para utilização no shapeCollection.set({ ... }).
PowerPoint.Interfaces.ShapeData	Uma interface que descreve os dados devolvidos ao chamar shape.toJSON().
PowerPoint.Interfaces.ShapeFillData	Uma interface que descreve os dados devolvidos ao chamar shapeFill.toJSON().
PowerPoint.Interfaces.ShapeFillUpdateData	Uma interface para atualizar dados no ShapeFill objeto, para utilização no shapeFill.set({ ... }).
PowerPoint.Interfaces.ShapeFontData	Uma interface que descreve os dados devolvidos ao chamar shapeFont.toJSON().
PowerPoint.Interfaces.ShapeFontUpdateData	Uma interface para atualizar dados no ShapeFont objeto, para utilização no shapeFont.set({ ... }).
PowerPoint.Interfaces.ShapeLineFormatData	Uma interface que descreve os dados devolvidos ao chamar shapeLineFormat.toJSON().
PowerPoint.Interfaces.ShapeLineFormatUpdateData	Uma interface para atualizar dados no ShapeLineFormat objeto, para utilização no shapeLineFormat.set({ ... }).
PowerPoint.Interfaces.ShapeLoadOptions	Representa uma única forma no diapositivo.
PowerPoint.Interfaces.ShapeScopedCollectionData	Uma interface que descreve os dados devolvidos ao chamar shapeScopedCollection.toJSON().
PowerPoint.Interfaces.ShapeScopedCollectionUpdateData	Uma interface para atualizar dados no ShapeScopedCollection objeto, para utilização no shapeScopedCollection.set({ ... }).
PowerPoint.Interfaces.ShapeUpdateData	Uma interface para atualizar dados no Shape objeto, para utilização no shape.set({ ... }).
PowerPoint.Interfaces.SlideCollectionData	Uma interface que descreve os dados devolvidos ao chamar slideCollection.toJSON().
PowerPoint.Interfaces.SlideCollectionLoadOptions	Representa a coleção de diapositivos na apresentação.
PowerPoint.Interfaces.SlideCollectionUpdateData	Uma interface para atualizar dados no SlideCollection objeto, para utilização no slideCollection.set({ ... }).
PowerPoint.Interfaces.SlideData	Uma interface que descreve os dados devolvidos ao chamar slide.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionData	Uma interface que descreve os dados devolvidos ao chamar slideLayoutCollection.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions	Representa a coleção de esquemas fornecida pelo Modelo Global de Diapositivos para diapositivos.
PowerPoint.Interfaces.SlideLayoutCollectionUpdateData	Uma interface para atualizar dados no SlideLayoutCollection objeto, para utilização no slideLayoutCollection.set({ ... }).
PowerPoint.Interfaces.SlideLayoutData	Uma interface que descreve os dados devolvidos ao chamar slideLayout.toJSON().
PowerPoint.Interfaces.SlideLayoutLoadOptions	Representa o esquema de um diapositivo.
PowerPoint.Interfaces.SlideLoadOptions	Representa um único diapositivo de uma apresentação.
PowerPoint.Interfaces.SlideMasterCollectionData	Uma interface que descreve os dados devolvidos ao chamar slideMasterCollection.toJSON().
PowerPoint.Interfaces.SlideMasterCollectionLoadOptions	Representa a coleção de Modelos Globais de Diapositivos na apresentação.
PowerPoint.Interfaces.SlideMasterCollectionUpdateData	Uma interface para atualizar dados no SlideMasterCollection objeto, para utilização no slideMasterCollection.set({ ... }).
PowerPoint.Interfaces.SlideMasterData	Uma interface que descreve os dados devolvidos ao chamar slideMaster.toJSON().
PowerPoint.Interfaces.SlideMasterLoadOptions	Representa o Modelo Global de Diapositivos de um diapositivo.
PowerPoint.Interfaces.SlideScopedCollectionData	Uma interface que descreve os dados devolvidos ao chamar slideScopedCollection.toJSON().
PowerPoint.Interfaces.SlideScopedCollectionUpdateData	Uma interface para atualizar dados no SlideScopedCollection objeto, para utilização no slideScopedCollection.set({ ... }).
PowerPoint.Interfaces.TagCollectionData	Uma interface que descreve os dados devolvidos ao chamar tagCollection.toJSON().
PowerPoint.Interfaces.TagCollectionLoadOptions	Representa a coleção de etiquetas.
PowerPoint.Interfaces.TagCollectionUpdateData	Uma interface para atualizar dados no TagCollection objeto, para utilização no tagCollection.set({ ... }).
PowerPoint.Interfaces.TagData	Uma interface que descreve os dados devolvidos ao chamar tag.toJSON().
PowerPoint.Interfaces.TagLoadOptions	Representa uma única etiqueta no diapositivo.
PowerPoint.Interfaces.TagUpdateData	Uma interface para atualizar dados no Tag objeto, para utilização no tag.set({ ... }).
PowerPoint.Interfaces.TextFrameData	Uma interface que descreve os dados devolvidos ao chamar textFrame.toJSON().
PowerPoint.Interfaces.TextFrameUpdateData	Uma interface para atualizar dados no TextFrame objeto, para utilização no textFrame.set({ ... }).
PowerPoint.Interfaces.TextRangeData	Uma interface que descreve os dados devolvidos ao chamar textRange.toJSON().
PowerPoint.Interfaces.TextRangeUpdateData	Uma interface para atualizar dados no TextRange objeto, para utilização no textRange.set({ ... }).

Enumerações

PowerPoint.ErrorCodes
PowerPoint.InsertSlideFormatting	Especifica as opções de formatação para quando os diapositivos são inseridos.

Funções

PowerPoint.createPresentation(base64File)	Cria e abre uma nova apresentação. Opcionalmente, a apresentação pode ser pré-preenchida com um ficheiro de .pptx codificado em Base64. [ Conjunto de API: PowerPointApi 1.1 ]
PowerPoint.run(batch)	Executa um script de lote que executa ações no modelo de objetos do PowerPoint com um novo RequestContext. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.
PowerPoint.run(object, batch)	Executa um script de lote que executa ações no modelo de objetos do PowerPoint com o RequestContext de um objeto de API criado anteriormente. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.
PowerPoint.run(objects, batch)	Executa um script de lote que executa ações no modelo de objetos do PowerPoint com o RequestContext de objetos de API criados anteriormente.

Detalhes da função

PowerPoint.createPresentation(base64File)

Cria e abre uma nova apresentação. Opcionalmente, a apresentação pode ser pré-preenchida com um ficheiro de .pptx codificado em Base64.

[ Conjunto de API: PowerPointApi 1.1 ]

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

Parâmetros

base64File

string

Opcional. O ficheiro de .pptx codificado com Base64. O valor padrão é nulo.

Retornos

Promise<void>

Exemplos

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)

Executa um script de lote que executa ações no modelo de objetos do PowerPoint com um novo RequestContext. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

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

Parâmetros

batch

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

Uma função que recebe um RequestContext e devolve uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita os pedidos para a aplicação PowerPoint. Uma vez que o suplemento do Office e a aplicação PowerPoint são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objetos do PowerPoint a partir do suplemento.

Retornos

OfficeExtension.IPromise<T>

PowerPoint.run(object, batch)

Executa um script de lote que executa ações no modelo de objetos do PowerPoint com o RequestContext de um objeto de API criado anteriormente. Quando a promessa for resolvida, todos os objetos controlados que foram alocados automaticamente durante a execução serão libertados.

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

Parâmetros

object

OfficeExtension.ClientObject

Um objeto de API criado anteriormente. O lote utilizará o mesmo RequestContext que o objeto transmitido, o que significa que todas as alterações aplicadas ao objeto serão recolhidas por "context.sync()".

batch

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

Uma função que recebe um RequestContext e devolve uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita os pedidos para a aplicação PowerPoint. Uma vez que o suplemento do Office e a aplicação PowerPoint são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objetos do PowerPoint a partir do suplemento.

Retornos

OfficeExtension.IPromise<T>

PowerPoint.run(objects, batch)

Executa um script de lote que executa ações no modelo de objetos do PowerPoint com o RequestContext de objetos de API criados anteriormente.

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

Parâmetros

objects

OfficeExtension.ClientObject[]

Uma matriz de objetos de API criados anteriormente. A matriz será validada para garantir que todos os objetos partilham o mesmo contexto. O lote utilizará este RequestContext partilhado, o que significa que todas as alterações aplicadas a estes objetos serão recolhidas por "context.sync()".

batch

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

Uma função que recebe um RequestContext e devolve uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita os pedidos para a aplicação PowerPoint. Uma vez que o suplemento do Office e a aplicação PowerPoint são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objetos do PowerPoint a partir do suplemento.

Retornos

OfficeExtension.IPromise<T>