powerpoint package

Classes

PowerPoint.Application
PowerPoint.BulletFormat	Representa as propriedades de formatação de bala de um texto anexado ao PowerPoint.ParagraphFormat.
PowerPoint.ParagraphFormat	Representa as propriedades de formatação de parágrafo de um texto anexado ao PowerPoint.TextRange.
PowerPoint.Presentation
PowerPoint.RequestContext	O objeto RequestContext facilita solicitações para o aplicativo PowerPoint. Como o suplemento do Office e o aplicativo PowerPoint são executados em dois processos diferentes, o contexto de solicitação é necessário para obter acesso ao modelo de objeto do PowerPoint a partir do suplemento.
PowerPoint.Shape	Representa uma única forma no slide.
PowerPoint.ShapeCollection	Representa a coleção de formas.
PowerPoint.ShapeFill	Representa a formatação de preenchimento de um objeto de forma.
PowerPoint.ShapeFont	Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor, para o objeto TextRange de uma forma.
PowerPoint.ShapeLineFormat	Representa a formatação de linha para o objeto shape. Para imagens e formas geométricas, a formatação de linha representa a borda da forma.
PowerPoint.ShapeScopedCollection	Representa uma coleção de formas.
PowerPoint.Slide	Representa um único slide de uma apresentação.
PowerPoint.SlideCollection	Representa a coleção de slides na apresentação.
PowerPoint.SlideLayout	Representa o layout de um slide.
PowerPoint.SlideLayoutCollection	Representa a coleção de layouts fornecidos pelo Mestre de Slides para slides.
PowerPoint.SlideMaster	Representa o Mestre de Slides de um slide.
PowerPoint.SlideMasterCollection	Representa a coleção do Slide Masters na apresentação.
PowerPoint.SlideScopedCollection	Representa uma coleção de slides na apresentação.
PowerPoint.Tag	Representa uma única marca no slide.
PowerPoint.TagCollection	Representa a coleção de marcas.
PowerPoint.TextFrame	Representa o quadro de texto de um objeto shape.
PowerPoint.TextRange	Contém o texto que é anexado a uma forma, bem como propriedades e métodos para manipular o texto.

Interfaces

PowerPoint.AddSlideOptions	Representa as opções disponíveis ao adicionar um novo slide.
PowerPoint.InsertSlideOptions	Representa as opções disponíveis ao inserir slides.
PowerPoint.Interfaces.BulletFormatData	Uma interface que descreve os dados retornados chamando bulletFormat.toJSON().
PowerPoint.Interfaces.BulletFormatLoadOptions	Representa as propriedades de formatação de bala de um texto anexado ao PowerPoint.ParagraphFormat.
PowerPoint.Interfaces.BulletFormatUpdateData	Uma interface para atualizar dados no objeto BulletFormat, para uso em bulletFormat.set({ ... }).
PowerPoint.Interfaces.CollectionLoadOptions	Fornece maneiras de carregar propriedades de apenas um subconjunto de membros de uma coleção.
PowerPoint.Interfaces.ParagraphFormatData	Uma interface que descreve os dados retornados chamando paragraphFormat.toJSON().
PowerPoint.Interfaces.ParagraphFormatLoadOptions	Representa as propriedades de formatação de parágrafo de um texto anexado ao PowerPoint.TextRange.
PowerPoint.Interfaces.ParagraphFormatUpdateData	Uma interface para atualizar dados no objeto ParagraphFormat, para uso em paragraphFormat.set({ ... }).
PowerPoint.Interfaces.PresentationData	Uma interface que descreve os dados retornados chamando presentation.toJSON().
PowerPoint.Interfaces.PresentationLoadOptions
PowerPoint.Interfaces.ShapeCollectionData	Uma interface que descreve os dados retornados chamando shapeCollection.toJSON().
PowerPoint.Interfaces.ShapeCollectionLoadOptions	Representa a coleção de formas.
PowerPoint.Interfaces.ShapeCollectionUpdateData	Uma interface para atualizar dados no objeto ShapeCollection, para uso em shapeCollection.set({ ... }).
PowerPoint.Interfaces.ShapeData	Uma interface que descreve os dados retornados chamando shape.toJSON().
PowerPoint.Interfaces.ShapeFillData	Uma interface que descreve os dados retornados chamando shapeFill.toJSON().
PowerPoint.Interfaces.ShapeFillLoadOptions	Representa a formatação de preenchimento de um objeto de forma.
PowerPoint.Interfaces.ShapeFillUpdateData	Uma interface para atualizar dados no objeto ShapeFill, para uso em shapeFill.set({ ... }).
PowerPoint.Interfaces.ShapeFontData	Uma interface que descreve os dados retornados chamando shapeFont.toJSON().
PowerPoint.Interfaces.ShapeFontLoadOptions	Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor, para o objeto TextRange de uma forma.
PowerPoint.Interfaces.ShapeFontUpdateData	Uma interface para atualizar dados no objeto ShapeFont, para uso em shapeFont.set({ ... }).
PowerPoint.Interfaces.ShapeLineFormatData	Uma interface que descreve os dados retornados chamando shapeLineFormat.toJSON().
PowerPoint.Interfaces.ShapeLineFormatLoadOptions	Representa a formatação de linha para o objeto shape. Para imagens e formas geométricas, a formatação de linha representa a borda da forma.
PowerPoint.Interfaces.ShapeLineFormatUpdateData	Uma interface para atualizar dados no objeto ShapeLineFormat, para uso em shapeLineFormat.set({ ... }).
PowerPoint.Interfaces.ShapeLoadOptions	Representa uma única forma no slide.
PowerPoint.Interfaces.ShapeScopedCollectionData	Uma interface que descreve os dados retornados chamando shapeScopedCollection.toJSON().
PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions	Representa uma coleção de formas.
PowerPoint.Interfaces.ShapeScopedCollectionUpdateData	Uma interface para atualizar dados no objeto ShapeScopedCollection, para uso em shapeScopedCollection.set({ ... }).
PowerPoint.Interfaces.ShapeUpdateData	Uma interface para atualizar dados no objeto Shape, para uso em shape.set({ ... }).
PowerPoint.Interfaces.SlideCollectionData	Uma interface que descreve os dados retornados chamando slideCollection.toJSON().
PowerPoint.Interfaces.SlideCollectionLoadOptions	Representa a coleção de slides na apresentação.
PowerPoint.Interfaces.SlideCollectionUpdateData	Uma interface para atualizar dados no objeto SlideCollection, para uso em slideCollection.set({ ... }).
PowerPoint.Interfaces.SlideData	Uma interface que descreve os dados retornados chamando slide.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionData	Uma interface que descreve os dados retornados chamando slideLayoutCollection.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions	Representa a coleção de layouts fornecidos pelo Mestre de Slides para slides.
PowerPoint.Interfaces.SlideLayoutCollectionUpdateData	Uma interface para atualizar dados no objeto SlideLayoutCollection, para uso em slideLayoutCollection.set({ ... }).
PowerPoint.Interfaces.SlideLayoutData	Uma interface que descreve os dados retornados chamando slideLayout.toJSON().
PowerPoint.Interfaces.SlideLayoutLoadOptions	Representa o layout de um slide.
PowerPoint.Interfaces.SlideLoadOptions	Representa um único slide de uma apresentação.
PowerPoint.Interfaces.SlideMasterCollectionData	Uma interface que descreve os dados retornados chamando slideMasterCollection.toJSON().
PowerPoint.Interfaces.SlideMasterCollectionLoadOptions	Representa a coleção do Slide Masters na apresentação.
PowerPoint.Interfaces.SlideMasterCollectionUpdateData	Uma interface para atualizar dados no objeto SlideMasterCollection, para uso em slideMasterCollection.set({ ... }).
PowerPoint.Interfaces.SlideMasterData	Uma interface que descreve os dados retornados chamando slideMaster.toJSON().
PowerPoint.Interfaces.SlideMasterLoadOptions	Representa o Mestre de Slides de um slide.
PowerPoint.Interfaces.SlideScopedCollectionData	Uma interface que descreve os dados retornados chamando slideScopedCollection.toJSON().
PowerPoint.Interfaces.SlideScopedCollectionLoadOptions	Representa uma coleção de slides na apresentação.
PowerPoint.Interfaces.SlideScopedCollectionUpdateData	Uma interface para atualizar dados no objeto SlideScopedCollection, para uso em slideScopedCollection.set({ ... }).
PowerPoint.Interfaces.TagCollectionData	Uma interface que descreve os dados retornados chamando tagCollection.toJSON().
PowerPoint.Interfaces.TagCollectionLoadOptions	Representa a coleção de marcas.
PowerPoint.Interfaces.TagCollectionUpdateData	Uma interface para atualizar dados no objeto TagCollection, para uso em tagCollection.set({ ... }).
PowerPoint.Interfaces.TagData	Uma interface que descreve os dados retornados chamando tag.toJSON().
PowerPoint.Interfaces.TagLoadOptions	Representa uma única marca no slide.
PowerPoint.Interfaces.TagUpdateData	Uma interface para atualizar dados no objeto Tag, para uso em tag.set({ ... }).
PowerPoint.Interfaces.TextFrameData	Uma interface que descreve os dados retornados chamando textFrame.toJSON().
PowerPoint.Interfaces.TextFrameLoadOptions	Representa o quadro de texto de um objeto shape.
PowerPoint.Interfaces.TextFrameUpdateData	Uma interface para atualizar dados no objeto TextFrame, para uso em textFrame.set({ ... }).
PowerPoint.Interfaces.TextRangeData	Uma interface que descreve os dados retornados chamando textRange.toJSON().
PowerPoint.Interfaces.TextRangeLoadOptions	Contém o texto que é anexado a uma forma, bem como propriedades e métodos para manipular o texto.
PowerPoint.Interfaces.TextRangeUpdateData	Uma interface para atualizar dados no objeto TextRange, para uso em textRange.set({ ... }).
PowerPoint.ShapeAddOptions	Representa as opções disponíveis ao adicionar formas.
PowerPoint.SlideGetImageOptions	Representa as opções disponíveis ao obter uma imagem de um slide.

Enumerações

PowerPoint.ConnectorType	Especifica o tipo de conector para formas de linha.
PowerPoint.ErrorCodes
PowerPoint.GeometricShapeType	Especifica o tipo de forma de um GeometricShape objeto.
PowerPoint.InsertSlideFormatting	Especifica as opções de formatação para quando os slides são inseridos.
PowerPoint.ParagraphHorizontalAlignment	Representa o alinhamento horizontal do PowerPoint.TextFrame em um PowerPoint.Shape.
PowerPoint.ShapeAutoSize	Determina o tipo de dimensionamento automático permitido.
PowerPoint.ShapeFillType	Especifica o tipo de preenchimento de uma forma.
PowerPoint.ShapeFontUnderlineStyle	O tipo de sublinhado aplicado a uma fonte.
PowerPoint.ShapeLineDashStyle	Especifica o estilo do traço de uma linha.
PowerPoint.ShapeLineStyle	Especifica o estilo de uma linha.
PowerPoint.ShapeType	Especifica o tipo de forma.
PowerPoint.TextVerticalAlignment	Representa o alinhamento vertical de um PowerPoint.TextFrame em um PowerPoint.Shape. Se uma das opções centralizada for selecionada, o conteúdo do TextFrame será centralizado horizontalmente dentro do Shape como um grupo. Para alterar o alinhamento horizontal de um texto, consulte PowerPoint.ParagraphFormat e PowerPoint.ParagraphHorizontalAlignment.

Funções

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

[ Conjunto de API: PowerPointApi 1.1 ]

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

Parâmetros

base64File

string

Opcional. O arquivo de .pptx codificado em 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 em lote que executa ações no modelo de objeto do PowerPoint usando um novo RequestContext. Quando a promessa for resolvida, todos os objetos rastreados que foram alocados automaticamente durante a execução serão liberados.

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 retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita as solicitações para o aplicativo do PowerPoint. Como o suplemento do Office e o aplicativo PowerPoint são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto do PowerPoint do suplemento.

Retornos

OfficeExtension.IPromise<T>

PowerPoint.run(object, batch)

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

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 usará o mesmo RequestContext que o objeto passado, o que significa que todas as alterações aplicadas ao objeto serão captadas por "context.sync()".

batch

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

Uma função que recebe um RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita as solicitações para o aplicativo do PowerPoint. Como o suplemento do Office e o aplicativo PowerPoint são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto do PowerPoint do suplemento.

Retornos

OfficeExtension.IPromise<T>

PowerPoint.run(objects, batch)

Executa um script em lote que executa ações no modelo de objeto do PowerPoint, usando 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 compartilhem o mesmo contexto. O lote usará esse RequestContext compartilhado, o que significa que todas as alterações aplicadas a esses objetos serão captadas por "context.sync()".

batch

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

Uma função que recebe um RequestContext e retorna uma promessa (normalmente, apenas o resultado de "context.sync()"). O parâmetro de contexto facilita as solicitações para o aplicativo do PowerPoint. Como o suplemento do Office e o aplicativo PowerPoint são executados em dois processos diferentes, o RequestContext é necessário para obter acesso ao modelo de objeto do PowerPoint do suplemento.

Retornos

OfficeExtension.IPromise<T>