office package

Classes

Office.TableData	Representa os dados em uma tabela ou em um Office.TableBinding.
OfficeExtension.ClientObject	Um objeto proxy abstrato que representa um objeto em um documento do Office. Você cria objetos proxy do contexto (ou de outros objetos proxy), adiciona comandos a uma fila para agir no objeto e sincroniza o estado do objeto proxy com o documento chamando context.sync().
OfficeExtension.ClientRequestContext	Um objeto RequestContext abstrato que facilita solicitações para o aplicativo do Office. Os Excel.run métodos e Word.run fornecem um contexto de solicitação.
OfficeExtension.ClientResult	Contém o resultado para métodos que retornam tipos primitivos. A propriedade value do objeto é recuperada do documento após context.sync() ser invocada.
OfficeExtension.EmbeddedSession	Representa uma sessão de um diagrama do Visio inserido em uma página do SharePoint. Para obter mais informações, confira Visão geral da API JavaScript do Visio.
OfficeExtension.Error	O objeto de erro retornado por context.sync(), se uma promessa for rejeitada devido a um erro durante o processamento da solicitação.
OfficeExtension.ErrorCodes	Representa o código de erro que pode ser retornado por OfficeExtension.Error.code. Para saber mais sobre os códigos de erro, consulte Códigos de erro da API Comum do Office.
OfficeExtension.EventHandlerResult	Habilita a remoção de um manipulador de eventos. Retornado pelo EventHandlers.add método. Observação: o mesmo objeto RequestContext no qual o manipulador foi adicionado deve ser usado ao remover o manipulador. Mais informações podem ser encontradas em Remover um manipulador de eventos.
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects	Coleção de objetos rastreados, contidos em um contexto de solicitação. Consulte context.trackedObjects para obter mais informações.

Interfaces

Office.Actions	Gerencia ações e atalhos de teclado.
Office.AddBindingFromNamedItemOptions	Fornece opções para configurar a associação criada.
Office.AddBindingFromPromptOptions	Fornece opções para configurar o prompt e identificar a associação criada.
Office.AddBindingFromSelectionOptions	Fornece opções para identificar a associação criada.
Office.Addin	Representa a funcionalidade de nível de suplemento para operar ou configurar vários aspectos do suplemento.
Office.AddinCommands.Event	O Event objeto é passado como um parâmetro para funções de suplemento invocadas por botões de comando de função. O objeto permite que o suplemento identifique qual botão foi clicado e sinalize ao aplicativo do Office que ele concluiu seu processamento.
Office.AddinCommands.EventCompletedOptions	Especifica o comportamento de um suplemento em envio no Outlook quando ele conclui o processamento de um ItemSend evento.
Office.AddinCommands.Source	Encapsula dados de origem para eventos de suplemento.
Office.AsyncContextOptions	Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.
Office.AsyncResult	Um objeto que encapsula o resultado de uma solicitação assíncrona, incluindo informações de status e de erro caso a solicitação tenha falhado. Quando a função que você passa para o callback parâmetro de um método "Async" é executada, ela recebe um objeto AsyncResult que você pode acessar do callback único parâmetro da função.
Office.Auth	O namespace do Office Auth, Office.auth, fornece um método que permite que o aplicativo cliente do Office obtenha um token de acesso ao aplicativo Web do suplemento. Indiretamente, isso também habilita o suplemento para acessar os dados do Microsoft Graph do usuário sem exigir que o usuário se conecte uma segunda vez.
Office.AuthOptions	Fornece opções para a experiência do usuário quando o Office obtém um token de acesso ao suplemento do AAD v. 2.0 com o getAccessToken método.
Office.BeforeDocumentCloseNotification	Representa uma caixa de diálogo de notificação modal que pode ser exibida quando o usuário tenta fechar um documento. O documento não será fechado até que o usuário responda. A caixa de diálogo de notificação permitirá que o usuário confirme a solicitação para fechar o documento ou cancelar a solicitação para fechar o documento. Essa API só tem suporte no Excel.
Office.Binding	Representa uma associação a uma seção do documento. O objeto Binding expõe a funcionalidade possuída por todas as associações, independentemente do tipo. O objeto Binding nunca é chamado diretamente. É a classe pai abstrata dos objetos que representam cada tipo de associação: Office.MatrixBinding, Office.TableBinding ou Office.TextBinding. Todos esses três objetos herdam os métodos getDataAsync e setDataAsync do objeto Binding que permitem interagir com os dados na associação. Eles também herdam a ID e digitam propriedades para consultar esses valores de propriedade. Além disso, os objetos MatrixBinding e TableBinding expõem métodos adicionais para recursos específicos de matriz e tabela, como contar o número de linhas e colunas.
Office.BindingDataChangedEventArgs	Fornece informações sobre a associação que gerou o evento DataChanged.
Office.Bindings	Representa as associações que o suplemento tem no documento.
Office.BindingSelectionChangedEventArgs	Fornece informações sobre a associação que gerou o evento SelectionChanged.
Office.Context	Representa o ambiente de tempo de execução do suplemento e fornece acesso a objetos de chave da API. O contexto atual existe como uma propriedade do Office. Ele é acessado usando Office.context.
Office.ContextInformation	Fornece informações sobre o ambiente em que o suplemento está em execução.
Office.Control	Representa um controle ou comando individual e o estado que ele deve ter.
Office.CustomXmlNode	Representa um nó XML em uma árvore em um documento.
Office.CustomXmlPart	Representa um único CustomXMLPart em uma coleção Office.CustomXmlParts .
Office.CustomXmlParts	Representa uma coleção de objetos CustomXmlPart.
Office.CustomXmlPrefixMappings	Representa uma coleção de objetos CustomXmlPart.
Office.Dialog	O objeto que é retornado quando UI.displayDialogAsync é chamado. Ele expõe métodos para registrar manipuladores de eventos e fechar a caixa de diálogo.
Office.DialogMessageOptions	Fornece opções de como enviar mensagens, em qualquer direção, entre uma caixa de diálogo e seu pai.
Office.DialogOptions	Fornece opções de como uma caixa de diálogo é exibida.
Office.DialogParentMessageReceivedEventArgs	Fornece informações sobre a mensagem da página pai que gerou o DialogParentMessageReceived evento. Para adicionar um manipulador de eventos para o DialogParentMessageReceived evento, use o addHandlerAsync método do objeto Office.UI .
Office.Document	Uma classe abstrata que representa o documento com o qual o suplemento está interagindo.
Office.DocumentSelectionChangedEventArgs	Fornece informações sobre o documento que gerou o evento SelectionChanged.
Office.Error	Fornece informações específicas sobre um erro que ocorreu durante uma operação de dados assíncrona.
Office.File	Representa o arquivo de documento associado a um Suplemento do Office.
Office.FileProperties
Office.GetBindingDataOptions	Fornece opções de como obter os dados em uma associação.
Office.GetFileOptions	Fornece opções para definir o tamanho das fatias em que o documento será dividido.
Office.GetSelectedDataOptions	Fornece opções para personalizar quais dados são retornados e como eles são formatados.
Office.GoToByIdOptions	Fornece opções para selecionar o local para o qual é navegado.
Office.Group	Representa um grupo de controles em uma guia de faixa de opções. Conjunto de requisitos: RibbonAPI 1.1
Office.IPromiseConstructor
Office.MatrixBinding	Representa uma associação em duas dimensões de linhas e colunas.
Office.NodeDeletedEventArgs	Fornece informações sobre o nó excluído que levantou o evento nodeDeleted.
Office.NodeInsertedEventArgs	Fornece informações sobre o nó inserido que levantou o evento nodeInserted.
Office.NodeReplacedEventArgs	Fornece informações sobre o nó substituído que levantou o evento nodeReplaced.
Office.OfficeTheme	Fornece acesso às propriedades de cores de temas do Office. O uso das cores do tema do Office permite coordenar o esquema de cores do suplemento com o tema atual do Office selecionado pelo usuário com ainterface do usuário do Tema do Office daConta> do Office de Arquivos>, que é aplicada em todos os aplicativos do Office. Usar cores de temas do Office é apropriado suplementos de email e painéis de tarefas.
Office.RangeCoordinates	Especifica uma célula, ou linha ou coluna, por sua linha baseada em zero e/ou número de coluna. Exemplo: {row: 3, column: 4} especifica a célula na 3ª linha (baseada em zero) na 4ª coluna (baseada em zero).
Office.RangeFormatConfiguration	Especifica um intervalo e sua formatação.
Office.RemoveHandlerOptions	Fornece opções para determinar quais manipuladores ou manipuladores de eventos são removidos.
Office.RequirementSetSupport	Fornece informações sobre quais Conjuntos de Requisitos têm suporte no ambiente atual.
Office.Ribbon	Uma interface que contém toda a funcionalidade fornecida para gerenciar o estado da faixa de opções do Office.
Office.RibbonUpdaterData	Especifica alterações na faixa de opções, como o status habilitado ou desabilitado de um botão.
Office.SaveSettingsOptions	Fornece opções para salvar configurações.
Office.SetBindingDataOptions	Fornece opções de como definir os dados em uma associação.
Office.SetSelectedDataOptions	Fornece opções de como inserir dados na seleção.
Office.Settings	Representa configurações personalizadas para um suplemento de painel de tarefas ou conteúdo que são armazenadas no documento host como pares nome/valor.
Office.SettingsChangedEventArgs	Fornece informações sobre as configurações que geraram o evento settingsChanged. Para adicionar um manipulador de eventos para o evento settingsChanged, use o método addHandlerAsync do objeto Office.Settings . O evento settingsChanged é acionado somente quando o script do suplemento chama o método Settings.saveAsync para persistir a cópia na memória das configurações no arquivo do documento. O evento settingsChanged não é disparado quando os métodos Settings.set ou Settings.remove são chamados. O evento settingsChanged foi projetado para permitir que você lide com possíveis conflitos quando dois ou mais usuários estão tentando salvar configurações ao mesmo tempo em que seu suplemento é usado em um documento compartilhado (coautoriado). Importante: o código do suplemento pode registrar um manipulador para o evento settingsChanged quando o suplemento estiver em execução com qualquer cliente do Excel, mas o evento será disparado somente quando o suplemento for carregado com uma planilha aberta no Excel na Web e mais de um usuário estiver editando a planilha (coautoria). Portanto, efetivamente, o evento settingsChanged só tem suporte em Excel na Web em cenários de coautoria.
Office.Slice	Representa uma fatia de um arquivo de documento. O objeto Slice é acessado com o File.getSliceAsync método.
Office.Tab	Representa uma guia individual e o estado que ela deve ter. Para obter exemplos de código, consulte Habilitar e desabilitar comandos de suplemento e Create guias contextuais personalizadas.
Office.TableBinding	Representa uma associação em duas dimensões de linhas e colunas, opcionalmente com cabeçalhos.
Office.TextBinding	Representa uma seleção de texto associada no documento. O objeto TextBinding herda a propriedade, a propriedade type, o id método getDataAsync e o método setDataAsync do objeto Office.Binding . Ele não implementa quaisquer propriedades ou métodos adicionais próprios.
Office.UI	Fornece objetos e métodos que você pode usar para criar e manipular componentes da interface do usuário, como caixas de diálogo, em seus Suplementos do Office. Visite "Usar a API de Caixa de Diálogo em seus Suplementos do Office" para obter mais informações.
Office.VisibilityModeChangedMessage	Mensagem usada na onVisibilityModeChanged invocação.
OfficeExtension.DebugInfo	Fornece informações sobre um erro.
OfficeExtension.EmbeddedOptions	Especifica opções para uma sessão de um diagrama do Visio inserido em uma página do SharePoint. Chamado pelo construtor de EmbeddedSession. Para obter mais informações, confira Visão geral da API JavaScript do Visio.
OfficeExtension.EventInfo	Usado pelo Office para construir manipuladores de eventos. Não chame seu código.
OfficeExtension.LoadOption	Especifica quais propriedades de um objeto devem ser carregadas. Essa carga acontece quando o método sync() é executado. Isso sincroniza os estados entre objetos do Office e objetos proxy JavaScript correspondentes.
OfficeExtension.RequestContextDebugInfo	Contém informações de depuração sobre o contexto da solicitação.
OfficeExtension.RequestUrlAndHeaderInfo	Solicitar URL e cabeçalhos
OfficeExtension.RunOptions	Opções adicionais passadas para {Host}.run(...).
OfficeExtension.UpdateOptions	Fornece uma opção para suprimir um erro quando o objeto usado para definir várias propriedades tenta definir propriedades somente leitura.

Aliases de tipo

OfficeExtension.IPromise

Enumerações

Office.ActiveView	Especifica o estado do modo de exibição ativo do documento, por exemplo, se o usuário pode editar o documento.
Office.AsyncResultStatus	Especifica o resultado de uma chamada assíncrona.
Office.BindingType	Especifica o tipo do objeto de associação que deve ser retornado.
Office.CoercionType	Especifica como forçar dados retornados ou definidos pelo método invocado.
Office.CustomXMLNodeType	Especifica o tipo do nó XML.
Office.DocumentMode	Especifica se o documento no aplicativo associado é somente leitura ou leitura e gravação.
Office.EventType	Especifica o tipo de evento que foi gerado. Retornado pela type propriedade de um *EventArgs objeto. Os suplementos para Project dão suporte aos Office.EventType.ResourceSelectionChangedtipos de evento , Office.EventType.TaskSelectionChangede Office.EventType.ViewSelectionChanged . Somente os suplementos do painel de tarefas para o Outlook dão suporte a tipos de evento de conjunto de API da Caixa de Correio.
Office.FileType	Especifica o formato no qual o documento deve ser retornado.
Office.FilterType	Especifica se a filtragem do aplicativo do Office é aplicada quando os dados são recuperados.
Office.GoToType	Especifica o tipo de local ou objeto até o qual navegar.
Office.HostType	Especifica o aplicativo do Office no qual o suplemento está em execução.
Office.Index	Especifica o slide relativo do PowerPoint.
Office.InitializationReason	Especifica se o suplemento acabou de ser inserido ou se já estava contido no documento.
Office.PlatformType	Especifica o sistema operacional ou outra plataforma na qual o aplicativo do Office está em execução.
Office.ProjectProjectFields	Especifica os campos de projeto que estão disponíveis como um parâmetro para o método Document.getProjectFieldAsync.
Office.ProjectResourceFields	Especifica os campos de recurso que estão disponíveis como um parâmetro para o método Document.getResourceFieldAsync.
Office.ProjectTaskFields	Especifica os campos de tarefa que estão disponíveis como um parâmetro para o método Document.getTaskFieldAsync.
Office.ProjectViewTypes	Especifica os tipos de exibições que o método Document.getSelectedViewAsync pode reconhecer.
Office.SelectionMode	Especifica se deve selecionar (realçar) o local para o qual navegar (ao usar o método Document.goToByIdAsync).
Office.StartupBehavior	Fornece opções para determinar o comportamento de inicialização do suplemento na próxima inicialização.
Office.Table	Especifica valores enumerados para a cells propriedade no parâmetro cellFormat dos métodos de formatação de tabela.
Office.ValueFormat	Especifica se valores, como números e datas, retornados pelo método invocado são retornados com sua formatação aplicada.
Office.VisibilityMode	Modo de visibilidade do suplemento.

Funções

Office.initialize(reason)	Ocorre quando o ambiente de tempo de execução é carregado e o suplemento está pronto para começar a interagir com o aplicativo e o documento hospedado. O parâmetro de razão da função de ouvinte de evento inicializar retorna um InitializationReason valor de enumeração que especifica como a inicialização ocorreu. Um suplemento de painel de tarefas ou conteúdo pode ser inicializado de duas maneiras: O usuário acabou de inseri-lo na seção Suplementos Usados Recentemente da lista suspensa Suplemento na guia Inserir da faixa de opções no aplicativo do Office ou na caixa de diálogo Inserir suplemento. O usuário abriu um documento que já contém o suplemento. Observação: o parâmetro motivo da função de ouvinte de evento inicializar retorna apenas um InitializationReason valor de enumeração para suplementos de conteúdo e painel de tarefas. Ele não retorna um valor para suplementos do Outlook.
Office.isSetSupported(name, minVersion)	Verifica se o conjunto de requisitos especificado tem suporte pelo aplicativo do Office.
Office.onReady(callback)	Garante que as APIs JavaScript do Office estejam prontas para serem chamadas pelo suplemento. Se a estrutura ainda não tiver sido inicializada, o retorno de chamada ou promessa aguardará até que o aplicativo do Office esteja pronto para aceitar chamadas de API. Observe que, embora essa API se destine a ser usada dentro de um suplemento do Office, ela também pode ser usada fora do suplemento. Nesse caso, depois que Office.js determinar que ele está em execução fora de um aplicativo do Office, ele chamará o retorno de chamada e resolve a promessa com "nulo" para o aplicativo e a plataforma.
Office.select(expression, callback)	Retorna uma promessa de um objeto descrito na expressão. O retorno de chamada será invocado somente se a função falhar.
Office.useShortNamespace(useShortNamespace)	Alterna e desativa o alias Office para o namespace completo Microsoft.Office.WebExtension .

Detalhes da função

Office.initialize(reason)

Ocorre quando o ambiente de tempo de execução é carregado e o suplemento está pronto para começar a interagir com o aplicativo e o documento hospedado.

O parâmetro de razão da função de ouvinte de evento inicializar retorna um InitializationReason valor de enumeração que especifica como a inicialização ocorreu. Um suplemento de painel de tarefas ou conteúdo pode ser inicializado de duas maneiras:

• O usuário acabou de inseri-lo na seção Suplementos Usados Recentemente da lista suspensa Suplemento na guia Inserir da faixa de opções no aplicativo do Office ou na caixa de diálogo Inserir suplemento.

• O usuário abriu um documento que já contém o suplemento.

Observação: o parâmetro motivo da função de ouvinte de evento inicializar retorna apenas um InitializationReason valor de enumeração para suplementos de conteúdo e painel de tarefas. Ele não retorna um valor para suplementos do Outlook.

export function initialize(reason: InitializationReason): void;

Parâmetros

reason

Office.InitializationReason

Indica como o aplicativo foi inicializado.

Retornos

void

Comentários

Detalhes do suporte

Para obter mais informações sobre os requisitos de aplicativo e servidor do Office, consulte Requisitos para executar suplementos do Office.

Aplicativos com suporte, por plataforma

	Office na Web	Office no Windows	Office no Mac	Office no iPad	Outlook em dispositivos móveis
Excel	Com suporte	Com suporte	Com suporte	Com suporte	Não aplicável
Outlook	Com suporte	Com suporte	Com suporte	Com suporte	Com suporte
Powerpoint	Com suporte	Com suporte	Com suporte	Com suporte	Não aplicável
Projeto	Sem suporte	Com suporte	Com suporte	Sem suporte	Não aplicável
Word	Com suporte	Com suporte	Com suporte	Com suporte	Não aplicável

Exemplos

// You can use the value of the InitializationEnumeration to implement different logic for
// when the add-in is first inserted versus when it is already part of the document.
// The following example shows some simple logic that uses the value of the reason parameter
// to display how the task pane or content add-in was initialized.
Office.initialize = function (reason) {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
    // After the DOM is loaded, code specific to the add-in can run.
    // Display initialization reason.
    if (reason == "inserted")
    write("The add-in was just inserted.");

    if (reason == "documentOpened")
    write("The add-in is already part of the document.");
    });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Office.isSetSupported(name, minVersion)

Verifica se o conjunto de requisitos especificado tem suporte pelo aplicativo do Office.

export function isSetSupported(name: string, minVersion?: string): boolean;

Parâmetros

name

string

Definir nome; por exemplo, "MatrixBindings".

minVersion

string

A versão mínima necessária; por exemplo, "1.4".

Retornos

boolean

Office.onReady(callback)

Garante que as APIs JavaScript do Office estejam prontas para serem chamadas pelo suplemento. Se a estrutura ainda não tiver sido inicializada, o retorno de chamada ou promessa aguardará até que o aplicativo do Office esteja pronto para aceitar chamadas de API. Observe que, embora essa API se destine a ser usada dentro de um suplemento do Office, ela também pode ser usada fora do suplemento. Nesse caso, depois que Office.js determinar que ele está em execução fora de um aplicativo do Office, ele chamará o retorno de chamada e resolve a promessa com "nulo" para o aplicativo e a plataforma.

export function onReady(callback?: (info: { host: HostType, platform: PlatformType }) => any): Promise<{ host: HostType, platform: PlatformType }>;

Parâmetros

callback

(info: { host: Office.HostType, platform: Office.PlatformType }) => any

Uma função opcional de retorno de chamada, que receberá as informações do aplicativo e da plataforma. Como alternativa, em vez de usar um retorno de chamada, um suplemento pode simplesmente aguardar a promessa retornada pela função para resolve.

Retornos

Promise<{ host: Office.HostType, platform: Office.PlatformType }>

Uma Promessa que contém as informações do aplicativo e da plataforma, depois que a inicialização for concluída.

Office.select(expression, callback)

Retorna uma promessa de um objeto descrito na expressão. O retorno de chamada será invocado somente se a função falhar.

export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;

Parâmetros

expression

string

O objeto a ser recuperado. O exemplo "bindings#BindingName", recupera uma promessa de associação para uma associação chamada 'BindingName'

callback

(result: Office.AsyncResult<any>) => void

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

Office.Binding

Comentários

Detalhes do suporte

Para obter mais informações sobre os requisitos de aplicativo e servidor do Office, consulte Requisitos para executar suplementos do Office.

Aplicativos com suporte, por plataforma

	Office na Web	Office no Windows	Office no iPad
Excel	Com suporte	Com suporte	Com suporte
Word	Sem suporte	Com suporte	Com suporte

Exemplos

// The following code example uses the select function to retrieve a binding with the id "cities" from
// the Bindings collection, and then calls the addHandlerAsync method to add an event handler for the
// dataChanged event of the binding.
function addBindingDataChangedEventHandler() {
    Office.select("bindings#cities", function onError(){}).addHandlerAsync(Office.EventType.BindingDataChanged,
    function (eventArgs) {
        doSomethingWithBinding(eventArgs.binding);
    });
}

Office.useShortNamespace(useShortNamespace)

Alterna e desativa o alias Office para o namespace completo Microsoft.Office.WebExtension .

export function useShortNamespace(useShortNamespace: boolean): void;

Parâmetros

useShortNamespace

boolean

True para usar o alias de atalho; caso contrário, false para desabilitar. O padrão é verdadeiro.

Retornos

void

Comentários

Detalhes do suporte

Para obter mais informações sobre os requisitos de aplicativo e servidor do Office, consulte Requisitos para executar suplementos do Office.

Aplicativos com suporte, por plataforma

	Office na Web	Office no Windows	Office no Mac	Office no iPad	Outlook em dispositivos móveis
Excel	Com suporte	Com suporte	Sem suporte	Com suporte	Não aplicável
Outlook	Com suporte	Com suporte	Com suporte	Com suporte	Com suporte
Powerpoint	Com suporte	Com suporte	Sem suporte	Com suporte	Não aplicável
Projeto	Sem suporte	Com suporte	Sem suporte	Sem suporte	Não aplicável
Word	Com suporte	Com suporte	Sem suporte	Com suporte	Não aplicável

Exemplos

function startUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(true);
    }
    else {
        Office.useShortNamespace(true);
    }
    write('Office alias is now ' + typeof Office);
}

function stopUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(false);
    }
    else {
        Office.useShortNamespace(false);
    }
    write('Office alias is now ' + typeof Office);
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}