Office.Bindings interface

Obtém um objeto Office.Document que representa o documento associado a este conjunto de enlaces.

document: Document;

Valor da propriedade

Office.Document

Cria um enlace num objeto com nome no documento.

addFromNamedItemAsync(itemName: string, bindingType: BindingType, options?: AddBindingFromNamedItemOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

itemName: string

Nome do objeto vinculado no documento. Por exemplo, tabela "MyExpenses" no Excel."

bindingType: Office.BindingType

O Office.BindingType para os dados. O método devolve nulo se o objeto selecionado não puder ser coagido para o tipo especificado.

options: Office.AddBindingFromNamedItemOptions

Fornece opções para configurar o enlace que é criado.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto Binding que representa o item nomeado especificado.

Retornos

void

Comentários

Conjuntos de requisitos:

Para o Excel, o parâmetro itemName pode referir-se a um intervalo com nome ou a uma tabela.

Por padrão, a adição de uma tabela no Excel atribui o nome "Tabela1" à primeira tabela que você adicionar, "Tabela2" para a segunda tabela adicionada e assim por diante. Para atribuir um nome significativo a uma tabela na IU do Excel, utilize a propriedade Nome da Tabela nas Ferramentas de Tabela | Separador Estrutura do friso.

Nota: no Excel, ao especificar uma tabela como um item com nome, tem de qualificar totalmente o nome para incluir o nome da folha de cálculo no nome da tabela neste formato: "Folha1! Tabela1"

Para o Word, o parâmetro itemName refere-se à propriedade Título de um controlo de conteúdo rtf. (Não pode vincular a controlos de conteúdo que não o controlo de conteúdo RtF).

Por predefinição, um controlo de conteúdo não tem nenhum valor de Título atribuído. Para atribuir um nome significativo na interface do usuário do Word, depois de inserir um controle de conteúdo Rich Text do grupo Controles na guia Desenvolvedor da faixa de opções, use o comando Propriedades no grupo Controles para exibir a caixa de diálogo Propriedades de Controle de Conteúdo. Em seguida, defina a propriedade Title do controle de conteúdo para o nome ao qual você deseja fazer referência por meio do seu código.

Nota: no Word, se existirem vários controlos de conteúdo rtf.text com o mesmo valor de propriedade Título (nome) e tentar vincular a um destes controlos de conteúdo com este método (ao especificar o respetivo nome como o parâmetro itemName), a operação falhará.

Exemplos

// The following example adds a binding to the myRange named item in Excel as a "matrix" binding,
// and assigns the binding's id as myMatrix.
function bindNamedItem() {
    Office.context.document.bindings.addFromNamedItemAsync(
        "myRange", "matrix", {id:'myMatrix'}, function (result) {
        if (result.status == 'succeeded'){
            write('Added new binding with type: ' + result.value.type + ' and id: ' + result.value.id);
            }
        else
            write('Error: ' + result.error.message);
    });
}

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

// The following example adds a binding to the Table1 named item in Excel as a "table" binding,
// and assigns the binding's id as myTable.
function bindNamedItem() {
    Office.context.document.bindings.addFromNamedItemAsync(
        "Table1", "table", {id:'myTable'}, function (result) {
        if (result.status == 'succeeded'){
            write('Added new binding with type: ' + result.value.type + ' and id: ' + result.value.id);
            }
        else
            write('Error: ' + result.error.message);
    });
}

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

// The following example creates a text binding in Word to a rich text content control named "FirstName",
// assigns the id "firstName", and then displays that information.
function bindContentControl() {
    Office.context.document.bindings.addFromNamedItemAsync('FirstName', 
        Office.BindingType.Text, {id:'firstName'},
        function (result) {
            if (result.status === Office.AsyncResultStatus.Succeeded) {
                write('Control bound. Binding.id: '
                    + result.value.id + ' Binding.type: ' + result.value.type);
            } else {
                write('Error:', result.error.message);
            }
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Cria um enlace num objeto com nome no documento.

addFromNamedItemAsync(itemName: string, bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

itemName: string

Nome do objeto vinculado no documento. Por exemplo, tabela "MyExpenses" no Excel."

bindingType: Office.BindingType

O Office.BindingType para os dados. O método devolve nulo se o objeto selecionado não puder ser coagido para o tipo especificado.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto Binding que representa o item nomeado especificado.

Retornos

void

Comentários

MatrixBindings, TableBindings, TextBindings

Para o Excel, o parâmetro itemName pode referir-se a um intervalo com nome ou a uma tabela.

Por padrão, a adição de uma tabela no Excel atribui o nome "Tabela1" à primeira tabela que você adicionar, "Tabela2" para a segunda tabela adicionada e assim por diante. Para atribuir um nome significativo a uma tabela na IU do Excel, utilize a propriedade Nome da Tabela nas Ferramentas de Tabela | Separador Estrutura do friso.

Nota: no Excel, ao especificar uma tabela como um item com nome, tem de qualificar totalmente o nome para incluir o nome da folha de cálculo no nome da tabela neste formato: "Folha1! Tabela1"

Para o Word, o parâmetro itemName refere-se à propriedade Título de um controlo de conteúdo rtf. (Não pode vincular a controlos de conteúdo que não o controlo de conteúdo RtF).

Por predefinição, um controlo de conteúdo não tem nenhum valor de Título atribuído. Para atribuir um nome significativo na interface do usuário do Word, depois de inserir um controle de conteúdo Rich Text do grupo Controles na guia Desenvolvedor da faixa de opções, use o comando Propriedades no grupo Controles para exibir a caixa de diálogo Propriedades de Controle de Conteúdo. Em seguida, defina a propriedade Title do controle de conteúdo para o nome ao qual você deseja fazer referência por meio do seu código.

Nota: no Word, se existirem vários controlos de conteúdo rtf.text com o mesmo valor de propriedade Título (nome) e tentar vincular a um destes controlos de conteúdo com este método (ao especificar o respetivo nome como o parâmetro itemName), a operação falhará.

Crie um enlace ao pedir ao utilizador para fazer uma seleção no documento.

addFromPromptAsync(bindingType: BindingType, options?: AddBindingFromPromptOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

bindingType: Office.BindingType

Especifica o tipo do objeto de associação a ser criado. Obrigatório. Devolve nulo se o objeto selecionado não puder ser coagido para o tipo especificado.

options: Office.AddBindingFromPromptOptions

Fornece opções para configurar o pedido e identificar o enlace que é criado.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto Enlace que representa a seleção especificada pelo utilizador.

Retornos

void

Comentários

Conjunto de requisitos: não está num conjunto

Adiciona um objeto de enlace do tipo especificado à coleção Enlaces, que será identificado com o ID fornecido. O método falha se a seleção especificada não puder ser vinculada.

Exemplos

function addBindingFromPrompt() {
    Office.context.document.bindings.addFromPromptAsync(
        Office.BindingType.Text, 
        { id: 'MyBinding', promptText: 'Select text to bind to.' },
        function (asyncResult) {
            write('Added new binding with type: ' + asyncResult.value.type + ' and id: ' + asyncResult.value.id);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Crie um enlace ao pedir ao utilizador para fazer uma seleção no documento.

addFromPromptAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

bindingType: Office.BindingType

Especifica o tipo do objeto de associação a ser criado. Obrigatório. Devolve nulo se o objeto selecionado não puder ser coagido para o tipo especificado.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto Enlace que representa a seleção especificada pelo utilizador.

Retornos

void

Comentários

Conjunto de requisitos: não está num conjunto

Adiciona um objeto de enlace do tipo especificado à coleção Enlaces, que será identificado com o ID fornecido. O método falha se a seleção especificada não puder ser vinculada.

Crie um enlace com base na seleção atual do utilizador.

addFromSelectionAsync(bindingType: BindingType, options?: AddBindingFromSelectionOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

bindingType: Office.BindingType

Especifica o tipo do objeto de associação a ser criado. Obrigatório. Devolve nulo se o objeto selecionado não puder ser coagido para o tipo especificado.

options: Office.AddBindingFromSelectionOptions

Fornece opções para identificar o enlace que é criado.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto Enlace que representa a seleção especificada pelo utilizador.

Retornos

void

Comentários

Conjuntos de requisitos:

Adiciona o tipo especificado de objeto de enlace à coleção Enlaces, que será identificado com o ID fornecido.

Nota No Excel, se chamar o método addFromSelectionAsync ao transmitir o Binding.id de um enlace existente, é utilizado o binding.type desse enlace e o respetivo tipo não pode ser alterado ao especificar um valor diferente para o parâmetro bindingType. Se precisar de utilizar um ID existente e alterar o bindingType, chame primeiro o método Bindings.releaseByIdAsync para libertar o enlace e, em seguida, chame o método addFromSelectionAsync para restabelecer o enlace com um novo tipo.

Exemplos

function addBindingFromSelection() {
    Office.context.document.bindings.addFromSelectionAsync(Office.BindingType.Text, { id: 'MyBinding' }, 
        function (asyncResult) {
        write('Added new binding with type: ' + asyncResult.value.type + ' and id: ' + asyncResult.value.id);
        }
    );
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Crie um enlace com base na seleção atual do utilizador.

addFromSelectionAsync(bindingType: BindingType, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

bindingType: Office.BindingType

Especifica o tipo do objeto de associação a ser criado. Obrigatório. Devolve nulo se o objeto selecionado não puder ser coagido para o tipo especificado.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto Enlace que representa a seleção especificada pelo utilizador.

Retornos

void

Comentários

Conjuntos de requisitos:

Adiciona o tipo especificado de objeto de enlace à coleção Enlaces, que será identificado com o ID fornecido.

Nota No Excel, se chamar o método addFromSelectionAsync ao transmitir o Binding.id de um enlace existente, é utilizado o binding.type desse enlace e o respetivo tipo não pode ser alterado ao especificar um valor diferente para o parâmetro bindingType. Se precisar de utilizar um ID existente e alterar o bindingType, chame primeiro o método Bindings.releaseByIdAsync para libertar o enlace e, em seguida, chame o método addFromSelectionAsync para restabelecer o enlace com um novo tipo.

Obtém todas as associações criadas anteriormente.

getAllAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding[]>) => void): void;

Parâmetros

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

callback: (result: Office.AsyncResult<Office.Binding[]>) => void

Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma matriz que contém cada enlace criado para o objeto Enlaces referenciado.

Retornos

void

Comentários

Conjuntos de requisitos:

Obtém todas as associações criadas anteriormente.

getAllAsync(callback?: (result: AsyncResult<Binding[]>) => void): void;

Parâmetros

callback: (result: Office.AsyncResult<Office.Binding[]>) => void

Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma matriz que contém cada enlace criado para o objeto Enlaces referenciado.

Retornos

void

Comentários

Conjuntos de requisitos:

Exemplos

function displayAllBindingNames() {
    Office.context.document.bindings.getAllAsync(function (asyncResult) {
        let bindingString = '';
        for (let i in asyncResult.value) {
            bindingString += asyncResult.value[i].id + '\n';
        }
        write('Existing bindings: ' + bindingString);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Obtém um enlace com base no respetivo Nome

getByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

id: string

Especifica o nome exclusivo do objeto de enlace. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto De enlace especificado pelo ID na chamada.

Retornos

void

Comentários

Conjuntos de requisitos:

Falha se o ID especificado não existir.

Obtém um enlace com base no respetivo Nome

getByIdAsync(id: string, callback?: (result: AsyncResult<Binding>) => void): void;

Parâmetros

id: string

Especifica o nome exclusivo do objeto de enlace. Obrigatório.

callback: (result: Office.AsyncResult<Office.Binding>) => void

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é o objeto De enlace especificado pelo ID na chamada.

Retornos

void

Comentários

Conjuntos de requisitos:

Falha se o ID especificado não existir.

Exemplos

function displayBindingType() {
    Office.context.document.bindings.getByIdAsync('MyBinding', function (asyncResult) {
        write('Retrieved binding with type: ' + asyncResult.value.type + ' and id: ' + asyncResult.value.id);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Remove o enlace do documento

releaseByIdAsync(id: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

id: string

Especifica o nome exclusivo a ser usado para identificar o objeto de associação. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

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

Retornos

void

Comentários

Conjuntos de requisitos:

Falha se o ID especificado não existir.

Remove o enlace do documento

releaseByIdAsync(id: string, callback?: (result: AsyncResult<void>) => void): void;

Parâmetros

id: string

Especifica o nome exclusivo a ser usado para identificar o objeto de associação. Obrigatório.

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

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

Retornos

void

Comentários

Conjuntos de requisitos:

Falha se o ID especificado não existir.

Exemplos

Office.context.document.bindings.releaseByIdAsync("MyBinding", function (asyncResult) { 
    write("Released MyBinding!"); 
}); 
// Function that writes to a div with id='message' on the page. 
function write(message){ 
    document.getElementById('message').innerText += message;  
}

addFromNamedItemAsync(itemName, bindingType, options, callback)	Cria um enlace num objeto com nome no documento.
addFromNamedItemAsync(itemName, bindingType, callback)	Cria um enlace num objeto com nome no documento.
addFromPromptAsync(bindingType, options, callback)	Crie um enlace ao pedir ao utilizador para fazer uma seleção no documento.
addFromPromptAsync(bindingType, callback)	Crie um enlace ao pedir ao utilizador para fazer uma seleção no documento.
addFromSelectionAsync(bindingType, options, callback)	Crie um enlace com base na seleção atual do utilizador.
addFromSelectionAsync(bindingType, callback)	Crie um enlace com base na seleção atual do utilizador.
getAllAsync(options, callback)	Obtém todas as associações criadas anteriormente.
getAllAsync(callback)	Obtém todas as associações criadas anteriormente.
getByIdAsync(id, options, callback)	Obtém um enlace com base no respetivo Nome
getByIdAsync(id, callback)	Obtém um enlace com base no respetivo Nome
releaseByIdAsync(id, options, callback)	Remove o enlace do documento
releaseByIdAsync(id, callback)	Remove o enlace do documento

Compartilhar via

Propriedades

Métodos

Detalhes da propriedade

document

Valor da propriedade

Detalhes do método

addFromNamedItemAsync(itemName, bindingType, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addFromNamedItemAsync(itemName, bindingType, callback)

Parâmetros

Retornos

Comentários

addFromPromptAsync(bindingType, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addFromPromptAsync(bindingType, callback)

Parâmetros

Retornos

Comentários

addFromSelectionAsync(bindingType, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addFromSelectionAsync(bindingType, callback)

Parâmetros

Retornos

Comentários

getAllAsync(options, callback)

Parâmetros

Retornos

Comentários

getAllAsync(callback)

Parâmetros

Retornos

Comentários

Exemplos

getByIdAsync(id, options, callback)

Parâmetros

Retornos

Comentários

getByIdAsync(id, callback)

Parâmetros

Retornos

Comentários

Exemplos

releaseByIdAsync(id, options, callback)

Parâmetros

Retornos

Comentários

releaseByIdAsync(id, callback)

Parâmetros

Retornos

Comentários

Exemplos

Recursos adicionais