office package
Classes
Office.TableData |
Representa os dados numa tabela ou num Office.TableBinding. |
OfficeExtension.ClientObject |
Um objeto proxy abstrato que representa um objeto num documento do Office. Pode criar objetos proxy a partir do contexto (ou de outros objetos proxy), adicionar comandos a uma fila para agir no objeto e, em seguida, sincronizar o estado do objeto proxy com o documento ao chamar |
OfficeExtension.ClientRequestContext |
Um objeto RequestContext abstrato que facilita os pedidos para a aplicação do Office. Os |
OfficeExtension.ClientResult |
Contém o resultado para métodos que devolvem tipos primitivos. A propriedade de valor do objeto é obtida do documento após ser |
OfficeExtension.EmbeddedSession |
Representa uma sessão de um diagrama do Visio incorporado numa página do SharePoint. Para obter mais informações, veja Visio JavaScript API overview (Descrição geral da API JavaScript do Visio). |
OfficeExtension.Error |
O objeto de erro devolvido por |
OfficeExtension.ErrorCodes |
Representa o código de erro que pode ser devolvido 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 |
Permite a remoção de um processador de eventos. Devolvido pelo Nota: o mesmo objeto RequestContext no qual o processador foi adicionado tem de ser utilizado ao remover o processador. Pode encontrar mais informações em Remover um processador de eventos. |
OfficeExtension.EventHandlers | |
OfficeExtension.TrackedObjects |
Coleção de objetos controlados, contida num contexto de pedido. Veja context.trackedObjects para obter mais informações. |
Interfaces
Office.Actions |
Gere ações e atalhos de teclado. |
Office.AddBindingFromNamedItemOptions |
Fornece opções para configurar o enlace que é criado. |
Office.AddBindingFromPromptOptions |
Fornece opções para configurar o pedido e identificar o enlace que é criado. |
Office.AddBindingFromSelectionOptions |
Fornece opções para identificar o enlace que é criado. |
Office.Addin |
Representa a funcionalidade de nível de suplemento para operar ou configurar vários aspetos do suplemento. |
Office.AddinCommands.Event |
O |
Office.AddinCommands.EventCompletedOptions |
Especifica o comportamento de um suplemento no Outlook quando este conclui o processamento de um |
Office.AddinCommands.Source |
Encapsula os dados de origem para eventos de suplementos. |
Office.AsyncContextOptions |
Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno. |
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 transmite ao |
Office.Auth |
O espaço de nomes da Autenticação do Office, |
Office.AuthContext |
Representa as informações de utilizador que podem ser transmitidas ao msal.js. |
Office.AuthOptions |
Fornece opções para a experiência de utilizador quando o Office obtém um token de acesso para o suplemento a partir do AAD v. 2.0 com o |
Office.BeforeDocumentCloseNotification |
Representa uma caixa de diálogo de notificação modal que pode ser apresentada quando o utilizador tenta fechar um documento. O documento não será fechado até que o utilizador responda. A caixa de diálogo de notificação permitirá ao utilizador confirmar o pedido para fechar o documento ou cancelar o pedido para fechar o documento. Esta API só é suportada no Excel. |
Office.Binding |
Representa um enlace a uma secção do documento. O objeto Enlace expõe a funcionalidade que todos os enlaces possuem, independentemente do tipo. O objeto Enlace nunca é chamado diretamente. É a classe principal abstrata dos objetos que representam cada tipo de enlace: Office.MatrixBinding, Office.TableBinding ou Office.TextBinding. Todos estes três objetos herdam os métodos getDataAsync e setDataAsync do objeto Binding que lhe permite interagir com os dados no enlace. Também herdam o ID e as propriedades do tipo 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. É acedido através |
Office.ContextInformation |
Fornece informações sobre o ambiente em que o suplemento está em execução. |
Office.Control |
Representa um controlo ou comando individual e o estado que deveria ter. |
Office.CustomXmlNode |
Representa um nó XML em uma árvore em um documento. |
Office.CustomXmlPart |
Representa uma única CustomXMLPart numa coleção Office.CustomXmlParts . |
Office.CustomXmlParts |
Representa uma coleção de objetos CustomXmlPart. |
Office.CustomXmlPrefixMappings |
Representa uma coleção de objetos CustomXmlPart. |
Office.DevicePermission |
Fornece métodos para um suplemento pedir permissão a um utilizador para aceder às respetivas capacidades de dispositivo. As capacidades de dispositivo de um utilizador incluem a câmara, a geolocalização e o microfone. |
Office.Dialog |
O objeto que é devolvido quando |
Office.DialogMessageOptions |
Fornece opções para como enviar mensagens, em qualquer direção, entre uma caixa de diálogo e o respetivo principal. |
Office.DialogOptions |
Fornece opções para a forma como uma caixa de diálogo é apresentada. |
Office.DialogParentMessageReceivedEventArgs |
Fornece informações sobre a mensagem da página principal que elevou o Para adicionar um processador de eventos para o |
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 para obter os dados num enlace. |
Office.GetFileOptions |
Fornece opções para definir o tamanho dos setores em que o documento será dividido. |
Office.GetSelectedDataOptions |
Fornece opções para personalizar que dados são devolvidos e como são formatados. |
Office.GoToByIdOptions |
Fornece opções para selecionar a localização para onde é navegada. |
Office.Group |
Representa um grupo de controlos num separador do friso. 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ó eliminado que levantou o evento nodeDeleted. |
Office.NodeInsertedEventArgs |
Fornece informações sobre o nó inserido que elevou 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. Utilizar as cores do tema do Office permite-lhe coordenar o esquema de cores do seu suplemento com o tema atual do Office selecionado pelo utilizador. O utilizador define um tema numa aplicação do Office através daContade Ficheiro> oudo Tema do Officeda Conta> do Office. Em seguida, o tema selecionado é aplicado em todas as aplicações do Office. Usar cores de temas do Office é apropriado suplementos de email e painéis de tarefas. Para obter mais informações sobre temas do Office, consulte Alterar o aspeto e funcionalidade do Microsoft 365. |
Office.RangeCoordinates |
Especifica uma célula, linha ou coluna pelo respetivo número de linha e/ou coluna baseado em zero. Exemplo: |
Office.RangeFormatConfiguration |
Especifica um intervalo e a respetiva formatação. |
Office.RemoveHandlerOptions |
Fornece opções para determinar que processadores ou processadores de eventos são removidos. |
Office.RequirementSetSupport |
Fornece informações sobre que Conjuntos de Requisitos são suportados no ambiente atual. |
Office.Ribbon |
Uma interface que contém todas as funcionalidades fornecidas para gerir o estado do friso do Office. |
Office.RibbonUpdaterData |
Especifica as alterações ao friso, como o estado ativado ou desativado de um botão. |
Office.SaveSettingsOptions |
Fornece opções para guardar definições. |
Office.SetBindingDataOptions |
Fornece opções para definir os dados num enlace. |
Office.SetSelectedDataOptions |
Fornece opções para 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 processador de eventos para o evento settingsChanged, utilize o método addHandlerAsync do objeto Office.Settings . O evento settingsChanged é acionado apenas quando o script do suplemento chama o método Settings.saveAsync para manter a cópia dentro da memória das definições no ficheiro de documento. O evento settingsChanged não é disparado quando os métodos Settings.set ou Settings.remove são chamados. O evento settingsChanged foi concebido para lhe permitir lidar com potenciais conflitos quando dois ou mais utilizadores estão a tentar guardar as definições ao mesmo tempo que o suplemento é utilizado num documento partilhado (cocriado). Importante: o código do suplemento pode registar um processador para o evento SettingsChanged quando o suplemento está em execução com qualquer cliente do Excel, mas o evento só será acionado quando o suplemento for carregado com uma folha de cálculo aberta no Excel na Web e mais do que um utilizador estiver a editar a folha de cálculo (cocriação). Por conseguinte, efetivamente, o evento settingsChanged só é suportado no Excel na Web em cenários de cocriação. |
Office.Slice |
Representa uma fatia de um arquivo de documento. O objeto Setor é acedido com o |
Office.Tab |
Representa um separador individual e o estado que deveria ter. Para obter exemplos de código, veja Ativar e Desativar Comandos de Suplemento eCriar separadores contextuais personalizados. |
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 |
Office.UI |
Fornece objetos e métodos que pode utilizar para criar e manipular componentes da IU, como caixas de diálogo, nos seus Suplementos do Office. Visite "Utilizar a API de Caixa de Diálogo nos seus Suplementos do Office" para obter mais informações. |
Office.Urls |
Fornece os URLs dos ambientes de runtime utilizados por um suplemento. |
Office.VisibilityModeChangedMessage |
Mensagem utilizada na |
OfficeExtension.DebugInfo |
Fornece informações sobre um erro. |
OfficeExtension.EmbeddedOptions |
Especifica opções para uma sessão de um diagrama do Visio incorporado numa página do SharePoint. Chamado por construtor de |
OfficeExtension.EventInfo |
Utilizado pelo Office para construir processadores de eventos. Não chame o seu código. |
OfficeExtension.LoadOption |
Especifica as propriedades de um objeto que devem ser carregadas. Esta carga ocorre quando o método sync() é executado. Esta ação sincroniza os estados entre objetos do Office e objetos proxy JavaScript correspondentes. |
OfficeExtension.RequestContextDebugInfo |
Contém informações de depuração sobre o contexto do pedido. |
OfficeExtension.RequestUrlAndHeaderInfo |
URL e cabeçalhos do pedido |
OfficeExtension.RunOptions |
Opções adicionais transmitidas para |
OfficeExtension.UpdateOptions |
Fornece uma opção para suprimir um erro quando o objeto utilizado para definir várias propriedades tenta definir propriedades só de 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.DevicePermissionType |
Especifica a capacidade do dispositivo à qual um suplemento está a pedir acesso. |
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. Devolvido pela Os suplementos para o Project suportam os Apenas os suplementos do painel de tarefas do Outlook suportam tipos de eventos de conjuntos de API da Caixa de Correio. |
Office.FileType |
Especifica o formato no qual o documento deve ser retornado. |
Office.FilterType |
Especifica se a filtragem da aplicação do Office é aplicada quando os dados são obtidos. |
Office.GoToType |
Especifica o tipo de local ou objeto até o qual navegar. |
Office.HostType |
Especifica a aplicação do Office na qual o suplemento está em execução. |
Office.Index |
Especifica o diapositivo relativo do PowerPoint. |
Office.InitializationReason |
Especifica se o suplemento acabou de ser inserido ou se já estava contido no documento. |
Office.PlatformType |
Especifica o SO ou outra plataforma na qual a aplicação do Office está em execução. |
Office.ProjectProjectFields |
Especifica os campos do projeto que estão disponíveis como um parâmetro para o método Document.getProjectFieldAsync. |
Office.ProjectResourceFields |
Especifica os campos de recursos que estão disponíveis como um parâmetro para o método Document.getResourceFieldAsync. |
Office.ProjectTaskFields |
Especifica os campos de tarefas que estão disponíveis como um parâmetro para o método Document.getTaskFieldAsync. |
Office.ProjectViewTypes |
Especifica os tipos de vistas que o método Document.getSelectedViewAsync consegue reconhecer. |
Office.SelectionMode |
Especifica se pretende selecionar (realçar) a localização para onde navegar (ao utilizar o método Document.goToByIdAsync). |
Office.StartupBehavior |
Fornece opções para determinar o comportamento de arranque do suplemento no próximo arranque. |
Office.Table |
Especifica valores enumerados para a |
Office.ThemeId |
Especifica o tema do Office que está atualmente selecionado. Para obter informações sobre temas do Office, consulte Alterar o aspeto e funcionalidade do Microsoft 365. |
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. |
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 inicializar o serviço de escuta de eventos devolve um
Nota: o parâmetro de razão da função inicializar o serviço de escuta de eventos só devolve um |
Office. |
Verifica se o conjunto de requisitos especificado é suportado pela aplicação do Office. |
Office. |
Garante que as APIs javaScript do Office estão prontas para serem chamadas pelo suplemento. Se a arquitetura ainda não tiver sido inicializada, a chamada de retorno ou promessa aguardará até que a aplicação do Office esteja pronta para aceitar chamadas à API. Tenha em atenção que, embora esta API se destine a ser utilizada dentro de um suplemento do Office, também pode ser utilizada fora do suplemento. Nesse caso, assim que Office.js determinar que está em execução fora de uma aplicação do Office, chamará a chamada de retorno e resolverá a promessa com "nulo" tanto para a aplicação como para a plataforma. |
Office. |
Devolve uma promessa de um objeto descrito na expressão. A chamada de retorno só é invocada se a função falhar. |
Office. |
Ativa e desativa o alias |
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 inicializar o serviço de escuta de eventos devolve 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 utilizador acabou de inseri-lo na secção Suplementos Utilizados Recentemente da lista pendente Suplemento no separador Inserir do friso na aplicação do Office ou na caixa de diálogo Inserir suplemento.
O usuário abriu um documento que já contém o suplemento.
Nota: o parâmetro de razão da função inicializar o serviço de escuta de eventos só devolve um InitializationReason
valor de enumeração para o painel de tarefas e os suplementos de conteúdo. Não devolve um valor para suplementos do Outlook.
export function initialize(reason: InitializationReason): void;
Parâmetros
- reason
- Office.InitializationReason
Indica como a aplicação foi inicializada.
Retornos
void
Comentários
Detalhes do suporte
Para obter mais informações sobre os requisitos de aplicações e servidores do Office, consulte Requisitos para executar Suplementos do Office.
Aplicações suportadas, 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 é suportado pela aplicação 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 estão prontas para serem chamadas pelo suplemento. Se a arquitetura ainda não tiver sido inicializada, a chamada de retorno ou promessa aguardará até que a aplicação do Office esteja pronta para aceitar chamadas à API. Tenha em atenção que, embora esta API se destine a ser utilizada dentro de um suplemento do Office, também pode ser utilizada fora do suplemento. Nesse caso, assim que Office.js determinar que está em execução fora de uma aplicação do Office, chamará a chamada de retorno e resolverá a promessa com "nulo" tanto para a aplicação como para 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 de chamada de retorno opcional, que irá receber as informações da aplicação e da plataforma. Em alternativa, em vez de utilizar uma chamada de retorno, um suplemento pode simplesmente esperar que a Promessa devolvida pela função seja resolvida.
Retornos
Promise<{ host: Office.HostType, platform: Office.PlatformType }>
Uma Promessa que contém as informações da aplicação e da plataforma, uma vez concluída a inicialização.
Office.select(expression, callback)
Devolve uma promessa de um objeto descrito na expressão. A chamada de retorno só é invocada se a função falhar.
export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;
Parâmetros
- expression
-
string
O objeto a obter. Exemplo de "bindings#BindingName", obtém uma promessa de enlace para um enlace denominado "BindingName"
- callback
-
(result: Office.AsyncResult<any>) => void
Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult.
Retornos
Comentários
Detalhes do suporte
Para obter mais informações sobre os requisitos de aplicações e servidores do Office, consulte Requisitos para executar Suplementos do Office.
Aplicações suportadas, 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)
Ativa e desativa o alias Office
para o espaço de nomes completo Microsoft.Office.WebExtension
.
export function useShortNamespace(useShortNamespace: boolean): void;
Parâmetros
- useShortNamespace
-
boolean
Verdadeiro para utilizar o alias de atalho; caso contrário, falso para desativá-lo. O padrão é verdadeiro.
Retornos
void
Comentários
Detalhes do suporte
Para obter mais informações sobre os requisitos de aplicações e servidores do Office, consulte Requisitos para executar Suplementos do Office.
Aplicações suportadas, 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;
}