powerpoint package

Classes

PowerPoint.Application

Representa o aplicativo do PowerPoint que gerencia a apresentação.

PowerPoint.Presentation

O Presentation objeto é o objeto de nível superior com um ou mais slides que contêm o conteúdo da apresentação. Para saber mais sobre o modelo de objeto do PowerPoint, consulte Modelo de objeto JavaScript do PowerPoint.

PowerPoint.RequestContext

O objeto RequestContext facilita as 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 do suplemento.

Interfaces

PowerPoint.Interfaces.AdjustmentsData

Uma interface que descreve os dados retornados chamando adjustments.toJSON().

PowerPoint.Interfaces.BindingCollectionData

Uma interface que descreve os dados retornados chamando bindingCollection.toJSON().

PowerPoint.Interfaces.BindingCollectionUpdateData

Uma interface para atualizar dados sobre o BindingCollection objeto, para uso no bindingCollection.set({ ... }).

PowerPoint.Interfaces.BindingData

Uma interface que descreve os dados retornados chamando binding.toJSON().

PowerPoint.Interfaces.BorderData

Uma interface que descreve os dados retornados chamando border.toJSON().

PowerPoint.Interfaces.BordersData

Uma interface que descreve os dados retornados chamando borders.toJSON().

PowerPoint.Interfaces.BorderUpdateData

Uma interface para atualizar dados sobre o Border objeto, para uso no border.set({ ... }).

PowerPoint.Interfaces.BulletFormatData

Uma interface que descreve os dados retornados chamando bulletFormat.toJSON().

PowerPoint.Interfaces.BulletFormatUpdateData

Uma interface para atualizar dados sobre o BulletFormat objeto, para uso no bulletFormat.set({ ... }).

PowerPoint.Interfaces.CollectionLoadOptions

Fornece maneiras de carregar propriedades de apenas um subconjunto de membros de uma coleção.

PowerPoint.Interfaces.CustomPropertyCollectionData

Uma interface que descreve os dados retornados chamando customPropertyCollection.toJSON().

PowerPoint.Interfaces.CustomPropertyCollectionUpdateData

Uma interface para atualizar dados sobre o CustomPropertyCollection objeto, para uso no customPropertyCollection.set({ ... }).

PowerPoint.Interfaces.CustomPropertyData

Uma interface que descreve os dados retornados chamando customProperty.toJSON().

PowerPoint.Interfaces.CustomPropertyUpdateData

Uma interface para atualizar dados sobre o CustomProperty objeto, para uso no customProperty.set({ ... }).

PowerPoint.Interfaces.CustomXmlPartCollectionData

Uma interface que descreve os dados retornados chamando customXmlPartCollection.toJSON().

PowerPoint.Interfaces.CustomXmlPartCollectionUpdateData

Uma interface para atualizar dados sobre o CustomXmlPartCollection objeto, para uso no customXmlPartCollection.set({ ... }).

PowerPoint.Interfaces.CustomXmlPartData

Uma interface que descreve os dados retornados chamando customXmlPart.toJSON().

PowerPoint.Interfaces.CustomXmlPartScopedCollectionData

Uma interface que descreve os dados retornados chamando customXmlPartScopedCollection.toJSON().

PowerPoint.Interfaces.CustomXmlPartScopedCollectionUpdateData

Uma interface para atualizar dados sobre o CustomXmlPartScopedCollection objeto, para uso no customXmlPartScopedCollection.set({ ... }).

PowerPoint.Interfaces.DocumentPropertiesData

Uma interface que descreve os dados retornados chamando documentProperties.toJSON().

PowerPoint.Interfaces.DocumentPropertiesUpdateData

Uma interface para atualizar dados sobre o DocumentProperties objeto, para uso no documentProperties.set({ ... }).

PowerPoint.Interfaces.HyperlinkCollectionData

Uma interface que descreve os dados retornados chamando hyperlinkCollection.toJSON().

PowerPoint.Interfaces.HyperlinkCollectionUpdateData

Uma interface para atualizar dados sobre o HyperlinkCollection objeto, para uso no hyperlinkCollection.set({ ... }).

PowerPoint.Interfaces.HyperlinkData

Uma interface que descreve os dados retornados chamando hyperlink.toJSON().

PowerPoint.Interfaces.HyperlinkScopedCollectionData

Uma interface que descreve os dados retornados chamando hyperlinkScopedCollection.toJSON().

PowerPoint.Interfaces.HyperlinkScopedCollectionUpdateData

Uma interface para atualizar dados sobre o HyperlinkScopedCollection objeto, para uso no hyperlinkScopedCollection.set({ ... }).

PowerPoint.Interfaces.HyperlinkUpdateData

Uma interface para atualizar dados sobre o Hyperlink objeto, para uso no hyperlink.set({ ... }).

PowerPoint.Interfaces.MarginsData

Uma interface que descreve os dados retornados chamando margins.toJSON().

PowerPoint.Interfaces.MarginsUpdateData

Uma interface para atualizar dados sobre o Margins objeto, para uso no margins.set({ ... }).

PowerPoint.Interfaces.PageSetupData

Uma interface que descreve os dados retornados chamando pageSetup.toJSON().

PowerPoint.Interfaces.PageSetupUpdateData

Uma interface para atualizar dados sobre o PageSetup objeto, para uso no pageSetup.set({ ... }).

PowerPoint.Interfaces.ParagraphFormatData

Uma interface que descreve os dados retornados chamando paragraphFormat.toJSON().

PowerPoint.Interfaces.ParagraphFormatUpdateData

Uma interface para atualizar dados sobre o ParagraphFormat objeto, para uso no paragraphFormat.set({ ... }).

PowerPoint.Interfaces.PlaceholderFormatData

Uma interface que descreve os dados retornados chamando placeholderFormat.toJSON().

PowerPoint.Interfaces.PresentationData

Uma interface que descreve os dados retornados chamando presentation.toJSON().

PowerPoint.Interfaces.PresentationLoadOptions

O Presentation objeto é o objeto de nível superior com um ou mais slides que contêm o conteúdo da apresentação. Para saber mais sobre o modelo de objeto do PowerPoint, consulte Modelo de objeto JavaScript do PowerPoint.

PowerPoint.Interfaces.ShapeCollectionData

Uma interface que descreve os dados retornados chamando shapeCollection.toJSON().

PowerPoint.Interfaces.ShapeCollectionUpdateData

Uma interface para atualizar dados sobre o ShapeCollection objeto, para uso no 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.ShapeFillUpdateData

Uma interface para atualizar dados sobre o ShapeFill objeto, para uso no shapeFill.set({ ... }).

PowerPoint.Interfaces.ShapeFontData

Uma interface que descreve os dados retornados chamando shapeFont.toJSON().

PowerPoint.Interfaces.ShapeFontUpdateData

Uma interface para atualizar dados sobre o ShapeFont objeto, para uso no shapeFont.set({ ... }).

PowerPoint.Interfaces.ShapeGroupData

Uma interface que descreve os dados retornados chamando shapeGroup.toJSON().

PowerPoint.Interfaces.ShapeLineFormatData

Uma interface que descreve os dados retornados chamando shapeLineFormat.toJSON().

PowerPoint.Interfaces.ShapeLineFormatUpdateData

Uma interface para atualizar dados sobre o ShapeLineFormat objeto, para uso no shapeLineFormat.set({ ... }).

PowerPoint.Interfaces.ShapeScopedCollectionData

Uma interface que descreve os dados retornados chamando shapeScopedCollection.toJSON().

PowerPoint.Interfaces.ShapeScopedCollectionUpdateData

Uma interface para atualizar dados sobre o ShapeScopedCollection objeto, para uso no shapeScopedCollection.set({ ... }).

PowerPoint.Interfaces.ShapeUpdateData

Uma interface para atualizar dados sobre o Shape objeto, para uso no shape.set({ ... }).

PowerPoint.Interfaces.SlideBackgroundData

Uma interface que descreve os dados retornados chamando slideBackground.toJSON().

PowerPoint.Interfaces.SlideBackgroundFillData

Uma interface que descreve os dados retornados chamando slideBackgroundFill.toJSON().

PowerPoint.Interfaces.SlideBackgroundGradientFillData

Uma interface que descreve os dados retornados chamando slideBackgroundGradientFill.toJSON().

PowerPoint.Interfaces.SlideBackgroundGradientFillUpdateData

Uma interface para atualizar dados sobre o SlideBackgroundGradientFill objeto, para uso no slideBackgroundGradientFill.set({ ... }).

PowerPoint.Interfaces.SlideBackgroundPatternFillData

Uma interface que descreve os dados retornados chamando slideBackgroundPatternFill.toJSON().

PowerPoint.Interfaces.SlideBackgroundPatternFillUpdateData

Uma interface para atualizar dados sobre o SlideBackgroundPatternFill objeto, para uso no slideBackgroundPatternFill.set({ ... }).

PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData

Uma interface que descreve os dados retornados chamando slideBackgroundPictureOrTextureFill.toJSON().

PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillUpdateData

Uma interface para atualizar dados sobre o SlideBackgroundPictureOrTextureFill objeto, para uso no slideBackgroundPictureOrTextureFill.set({ ... }).

PowerPoint.Interfaces.SlideBackgroundSolidFillData

Uma interface que descreve os dados retornados chamando slideBackgroundSolidFill.toJSON().

PowerPoint.Interfaces.SlideBackgroundSolidFillUpdateData

Uma interface para atualizar dados sobre o SlideBackgroundSolidFill objeto, para uso no slideBackgroundSolidFill.set({ ... }).

PowerPoint.Interfaces.SlideBackgroundUpdateData

Uma interface para atualizar dados sobre o SlideBackground objeto, para uso no slideBackground.set({ ... }).

PowerPoint.Interfaces.SlideCollectionData

Uma interface que descreve os dados retornados chamando slideCollection.toJSON().

PowerPoint.Interfaces.SlideCollectionUpdateData

Uma interface para atualizar dados sobre o SlideCollection objeto, para uso no slideCollection.set({ ... }).

PowerPoint.Interfaces.SlideData

Uma interface que descreve os dados retornados chamando slide.toJSON().

PowerPoint.Interfaces.SlideLayoutBackgroundData

Uma interface que descreve os dados retornados chamando slideLayoutBackground.toJSON().

PowerPoint.Interfaces.SlideLayoutBackgroundUpdateData

Uma interface para atualizar dados sobre o SlideLayoutBackground objeto, para uso no slideLayoutBackground.set({ ... }).

PowerPoint.Interfaces.SlideLayoutCollectionData

Uma interface que descreve os dados retornados chamando slideLayoutCollection.toJSON().

PowerPoint.Interfaces.SlideLayoutCollectionUpdateData

Uma interface para atualizar dados sobre o SlideLayoutCollection objeto, para uso no slideLayoutCollection.set({ ... }).

PowerPoint.Interfaces.SlideLayoutData

Uma interface que descreve os dados retornados chamando slideLayout.toJSON().

PowerPoint.Interfaces.SlideMasterBackgroundData

Uma interface que descreve os dados retornados chamando slideMasterBackground.toJSON().

PowerPoint.Interfaces.SlideMasterCollectionData

Uma interface que descreve os dados retornados chamando slideMasterCollection.toJSON().

PowerPoint.Interfaces.SlideMasterCollectionUpdateData

Uma interface para atualizar dados sobre o SlideMasterCollection objeto, para uso no slideMasterCollection.set({ ... }).

PowerPoint.Interfaces.SlideMasterData

Uma interface que descreve os dados retornados chamando slideMaster.toJSON().

PowerPoint.Interfaces.SlideScopedCollectionData

Uma interface que descreve os dados retornados chamando slideScopedCollection.toJSON().

PowerPoint.Interfaces.SlideScopedCollectionUpdateData

Uma interface para atualizar dados sobre o SlideScopedCollection objeto, para uso no slideScopedCollection.set({ ... }).

PowerPoint.Interfaces.TableCellCollectionData

Uma interface que descreve os dados retornados chamando tableCellCollection.toJSON().

PowerPoint.Interfaces.TableCellCollectionUpdateData

Uma interface para atualizar dados sobre o TableCellCollection objeto, para uso no tableCellCollection.set({ ... }).

PowerPoint.Interfaces.TableCellData

Uma interface que descreve os dados retornados chamando tableCell.toJSON().

PowerPoint.Interfaces.TableCellUpdateData

Uma interface para atualizar dados sobre o TableCell objeto, para uso no tableCell.set({ ... }).

PowerPoint.Interfaces.TableColumnCollectionData

Uma interface que descreve os dados retornados chamando tableColumnCollection.toJSON().

PowerPoint.Interfaces.TableColumnCollectionUpdateData

Uma interface para atualizar dados sobre o TableColumnCollection objeto, para uso no tableColumnCollection.set({ ... }).

PowerPoint.Interfaces.TableColumnData

Uma interface que descreve os dados retornados chamando tableColumn.toJSON().

PowerPoint.Interfaces.TableColumnUpdateData

Uma interface para atualizar dados sobre o TableColumn objeto, para uso no tableColumn.set({ ... }).

PowerPoint.Interfaces.TableData

Uma interface que descreve os dados retornados chamando table.toJSON().

PowerPoint.Interfaces.TableRowCollectionData

Uma interface que descreve os dados retornados chamando tableRowCollection.toJSON().

PowerPoint.Interfaces.TableRowCollectionUpdateData

Uma interface para atualizar dados sobre o TableRowCollection objeto, para uso no tableRowCollection.set({ ... }).

PowerPoint.Interfaces.TableRowData

Uma interface que descreve os dados retornados chamando tableRow.toJSON().

PowerPoint.Interfaces.TableRowUpdateData

Uma interface para atualizar dados sobre o TableRow objeto, para uso no tableRow.set({ ... }).

PowerPoint.Interfaces.TableStyleSettingsData

Uma interface que descreve os dados retornados chamando tableStyleSettings.toJSON().

PowerPoint.Interfaces.TableStyleSettingsUpdateData

Uma interface para atualizar dados sobre o TableStyleSettings objeto, para uso no tableStyleSettings.set({ ... }).

PowerPoint.Interfaces.TagCollectionData

Uma interface que descreve os dados retornados chamando tagCollection.toJSON().

PowerPoint.Interfaces.TagCollectionUpdateData

Uma interface para atualizar dados sobre o TagCollection objeto, para uso no tagCollection.set({ ... }).

PowerPoint.Interfaces.TagData

Uma interface que descreve os dados retornados chamando tag.toJSON().

PowerPoint.Interfaces.TagUpdateData

Uma interface para atualizar dados sobre o Tag objeto, para uso no tag.set({ ... }).

PowerPoint.Interfaces.TextFrameData

Uma interface que descreve os dados retornados chamando textFrame.toJSON().

PowerPoint.Interfaces.TextFrameUpdateData

Uma interface para atualizar dados sobre o TextFrame objeto, para uso no textFrame.set({ ... }).

PowerPoint.Interfaces.TextRangeData

Uma interface que descreve os dados retornados chamando textRange.toJSON().

PowerPoint.Interfaces.TextRangeUpdateData

Uma interface para atualizar dados sobre o TextRange objeto, para uso no textRange.set({ ... }).

Enumerações

PowerPoint.ErrorCodes

Funções

PowerPoint.createPresentation(base64File)

Cria e abre uma nova apresentação. Opcionalmente, a apresentação pode ser preenchida previamente com um arquivo .pptx codificado em Base64.

Conjunto de APIs: PowerPointApi 1.1

PowerPoint.run(batch)

Executa um script em lotes 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 lotes 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 preenchida previamente com um arquivo .pptx codificado em Base64.

Conjunto de APIs: PowerPointApi 1.1

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

Parâmetros

base64File

string

Opcional. O arquivo .pptx codificado em Base64. O valor padrão é nulo. O campo permite um máximo de 71.680.000 caracteres.

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 lotes 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 context facilita as solicitações para o aplicativo 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

Exemplos

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await PowerPoint.run(async (context) => {
  const presentation = context.presentation;
  // Interact with the PowerPoint presentation...
});

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 escolhidas 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 context facilita as solicitações para o aplicativo 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

PowerPoint.run(objects, batch)

Executa um script em lotes 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 escolhidas 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 context facilita as solicitações para o aplicativo 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