Office.Bindings interface

Obtiene un objeto Office.Document que representa el documento asociado a este conjunto de enlaces.

document: Document;

Valor de propiedad

Office.Document

Crea un enlace con un objeto con nombre en el documento.

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

Parámetros

itemName: string

Nombre del objeto enlazable en el documento. Por ejemplo, tabla "MyExpenses" en Excel".

bindingType: Office.BindingType

Office.BindingType para los datos. El método devuelve null si el objeto seleccionado no se puede convertir en el tipo especificado.

options: Office.AddBindingFromNamedItemOptions

Proporciona opciones para configurar el enlace que se crea.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding que representa el elemento con nombre especificado.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Para Excel, el parámetro itemName puede hacer referencia a un rango con nombre o a una tabla.

De forma predeterminada, al agregar una tabla en Excel se asigna el nombre "Tabla1" para la primera tabla que agregue, "Tabla2" para la segunda y así sucesivamente. Para asignar un nombre significativo para una tabla en la interfaz de usuario de Excel, use la propiedad Nombre de tabla en herramientas de tabla | Pestaña Diseño de la cinta de opciones.

Nota: En Excel, al especificar una tabla como un elemento con nombre, debe calificar completamente el nombre para incluir el nombre de la hoja de cálculo en el nombre de la tabla en este formato: "Sheet1! Table1"

Para Word, el parámetro itemName hace referencia a la propiedad Title de un control de contenido texto enriquecido. (No se puede enlazar a controles de contenido que no sean el control de contenido texto enriquecido).

De forma predeterminada, un control de contenido no tiene asignado ningún valor title. Para asignar un nombre significativo en la interfaz de usuario de Word, después de insertar un control de contenido Texto enriquecido desde el grupo Controles de la pestaña Desarrollador de la cinta, use el comando Propiedades del grupo Controles para mostrar el cuadro de diálogo Propiedades del control de contenido. A continuación, establezca la propiedad Title del control de contenido con el nombre al que desee hacer referencia desde su código.

Nota: En Word, si hay varios controles de contenido de texto enriquecido con el mismo valor de propiedad Title (nombre) e intenta enlazar a uno estos controles de contenido con este método (especificando su nombre como el parámetro itemName), se producirá un error en la operación.

Ejemplos

// 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; 
}

Crea un enlace con un objeto con nombre en el documento.

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

Parámetros

itemName: string

Nombre del objeto enlazable en el documento. Por ejemplo, tabla "MyExpenses" en Excel".

bindingType: Office.BindingType

Office.BindingType para los datos. El método devuelve null si el objeto seleccionado no se puede convertir en el tipo especificado.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding que representa el elemento con nombre especificado.

Devoluciones

void

Comentarios

MatrixBindings, TableBindings, TextBindings

Para Excel, el parámetro itemName puede hacer referencia a un rango con nombre o a una tabla.

De forma predeterminada, al agregar una tabla en Excel se asigna el nombre "Tabla1" para la primera tabla que agregue, "Tabla2" para la segunda y así sucesivamente. Para asignar un nombre significativo para una tabla en la interfaz de usuario de Excel, use la propiedad Nombre de tabla en herramientas de tabla | Pestaña Diseño de la cinta de opciones.

Nota: En Excel, al especificar una tabla como un elemento con nombre, debe calificar completamente el nombre para incluir el nombre de la hoja de cálculo en el nombre de la tabla en este formato: "Sheet1! Table1"

Para Word, el parámetro itemName hace referencia a la propiedad Title de un control de contenido texto enriquecido. (No se puede enlazar a controles de contenido que no sean el control de contenido texto enriquecido).

De forma predeterminada, un control de contenido no tiene asignado ningún valor title. Para asignar un nombre significativo en la interfaz de usuario de Word, después de insertar un control de contenido Texto enriquecido desde el grupo Controles de la pestaña Desarrollador de la cinta, use el comando Propiedades del grupo Controles para mostrar el cuadro de diálogo Propiedades del control de contenido. A continuación, establezca la propiedad Title del control de contenido con el nombre al que desee hacer referencia desde su código.

Nota: En Word, si hay varios controles de contenido de texto enriquecido con el mismo valor de propiedad Title (nombre) e intenta enlazar a uno estos controles de contenido con este método (especificando su nombre como el parámetro itemName), se producirá un error en la operación.

Cree un enlace solicitando al usuario que realice una selección en el documento.

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

Parámetros

bindingType: Office.BindingType

Especifica el tipo de objeto de enlace que se debe crear. Necesario. Devuelve null si el objeto seleccionado no se puede convertir en el tipo especificado.

options: Office.AddBindingFromPromptOptions

Proporciona opciones para configurar el símbolo del sistema e identificar el enlace que se crea.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding que representa la selección especificada por el usuario.

Devoluciones

void

Comentarios

Conjunto de requisitos: no en un conjunto

Agrega un objeto de enlace del tipo especificado a la colección Bindings, que se identificará con el identificador proporcionado. Si no se puede enlazar la selección especificada, el método falla.

Ejemplos

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; 
}

Cree un enlace solicitando al usuario que realice una selección en el documento.

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

Parámetros

bindingType: Office.BindingType

Especifica el tipo de objeto de enlace que se debe crear. Necesario. Devuelve null si el objeto seleccionado no se puede convertir en el tipo especificado.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding que representa la selección especificada por el usuario.

Devoluciones

void

Comentarios

Conjunto de requisitos: no en un conjunto

Agrega un objeto de enlace del tipo especificado a la colección Bindings, que se identificará con el identificador proporcionado. Si no se puede enlazar la selección especificada, el método falla.

Cree un enlace basado en la selección actual del usuario.

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

Parámetros

bindingType: Office.BindingType

Especifica el tipo de objeto de enlace que se debe crear. Necesario. Devuelve null si el objeto seleccionado no se puede convertir en el tipo especificado.

options: Office.AddBindingFromSelectionOptions

Proporciona opciones para identificar el enlace que se crea.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding que representa la selección especificada por el usuario.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Agrega el tipo especificado de objeto de enlace a la colección Bindings, que se identificará con el identificador proporcionado.

Nota En Excel, si llama al método addFromSelectionAsync pasando el Binding.id de un enlace existente, se usa binding.type de ese enlace y su tipo no se puede cambiar especificando un valor diferente para el parámetro bindingType. Si necesita usar un identificador existente y cambiar el bindingType, llame primero al método Bindings.releaseByIdAsync para liberar el enlace y, a continuación, llame al método addFromSelectionAsync para restablecer el enlace con un nuevo tipo.

Ejemplos

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; 
}

Cree un enlace basado en la selección actual del usuario.

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

Parámetros

bindingType: Office.BindingType

Especifica el tipo de objeto de enlace que se debe crear. Necesario. Devuelve null si el objeto seleccionado no se puede convertir en el tipo especificado.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding que representa la selección especificada por el usuario.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Agrega el tipo especificado de objeto de enlace a la colección Bindings, que se identificará con el identificador proporcionado.

Nota En Excel, si llama al método addFromSelectionAsync pasando el Binding.id de un enlace existente, se usa binding.type de ese enlace y su tipo no se puede cambiar especificando un valor diferente para el parámetro bindingType. Si necesita usar un identificador existente y cambiar el bindingType, llame primero al método Bindings.releaseByIdAsync para liberar el enlace y, a continuación, llame al método addFromSelectionAsync para restablecer el enlace con un nuevo tipo.

Obtiene todos los enlaces que se crearon previamente.

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

Parámetros

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una matriz que contiene cada enlace creado para el objeto Bindings al que se hace referencia.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Obtiene todos los enlaces que se crearon previamente.

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

Parámetros

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

Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una matriz que contiene cada enlace creado para el objeto Bindings al que se hace referencia.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Ejemplos

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; 
}

Recupera un enlace basado en su nombre

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

Parámetros

id: string

Especifica el nombre único del objeto de enlace. Necesario.

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding especificado por el identificador en la llamada.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Se produce un error si el identificador especificado no existe.

Recupera un enlace basado en su nombre

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

Parámetros

id: string

Especifica el nombre único del objeto de enlace. Necesario.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es el objeto Binding especificado por el identificador en la llamada.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Se produce un error si el identificador especificado no existe.

Ejemplos

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; 
}

Quita el enlace del documento

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

Parámetros

id: string

Especifica el nombre único que se debe usar para identificar el objeto de enlace. Necesario.

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Se produce un error si el identificador especificado no existe.

Quita el enlace del documento

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

Parámetros

id: string

Especifica el nombre único que se debe usar para identificar el objeto de enlace. Necesario.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjuntos de requisitos:

Se produce un error si el identificador especificado no existe.

Ejemplos

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)	Crea un enlace con un objeto con nombre en el documento.
addFromNamedItemAsync(itemName, bindingType, callback)	Crea un enlace con un objeto con nombre en el documento.
addFromPromptAsync(bindingType, options, callback)	Cree un enlace solicitando al usuario que realice una selección en el documento.
addFromPromptAsync(bindingType, callback)	Cree un enlace solicitando al usuario que realice una selección en el documento.
addFromSelectionAsync(bindingType, options, callback)	Cree un enlace basado en la selección actual del usuario.
addFromSelectionAsync(bindingType, callback)	Cree un enlace basado en la selección actual del usuario.
getAllAsync(options, callback)	Obtiene todos los enlaces que se crearon previamente.
getAllAsync(callback)	Obtiene todos los enlaces que se crearon previamente.
getByIdAsync(id, options, callback)	Recupera un enlace basado en su nombre
getByIdAsync(id, callback)	Recupera un enlace basado en su nombre
releaseByIdAsync(id, options, callback)	Quita el enlace del documento
releaseByIdAsync(id, callback)	Quita el enlace del documento

Share via

Propiedades

Métodos

Detalles de las propiedades

document

Valor de propiedad

Detalles del método

addFromNamedItemAsync(itemName, bindingType, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addFromNamedItemAsync(itemName, bindingType, callback)

Parámetros

Devoluciones

Comentarios

addFromPromptAsync(bindingType, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addFromPromptAsync(bindingType, callback)

Parámetros

Devoluciones

Comentarios

addFromSelectionAsync(bindingType, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

addFromSelectionAsync(bindingType, callback)

Parámetros

Devoluciones

Comentarios

getAllAsync(options, callback)

Parámetros

Devoluciones

Comentarios

getAllAsync(callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

getByIdAsync(id, options, callback)

Parámetros

Devoluciones

Comentarios

getByIdAsync(id, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

releaseByIdAsync(id, options, callback)

Parámetros

Devoluciones

Comentarios

releaseByIdAsync(id, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

Comentarios

Recursos adicionales