office package

Clases

Office.TableData

Representa los datos de una tabla o office.TableBinding.

OfficeExtension.ClientObject

Objeto proxy abstracto que representa un objeto en un documento de Office. Los objetos proxy se crean desde el contexto (o desde otros objetos proxy), se agregan comandos a una cola para actuar sobre el objeto y, a continuación, se sincroniza el estado del objeto proxy con el documento mediante una llamada a context.sync().

OfficeExtension.ClientRequestContext

Objeto RequestContext abstracto que facilita las solicitudes a la aplicación de Office. Los Excel.run métodos y Word.run proporcionan un contexto de solicitud.

OfficeExtension.ClientResult

Contiene el resultado de los métodos que devuelven tipos primitivos. La propiedad value del objeto se recupera del documento después context.sync() de invocarse.

OfficeExtension.EmbeddedSession

Representa una sesión de un diagrama de Visio incrustado en una página de SharePoint. Para obtener más información, consulte Información general sobre la API de JavaScript de Visio.

OfficeExtension.Error

Objeto de error devuelto por context.sync(), si se rechaza una promesa debido a un error al procesar la solicitud.

OfficeExtension.ErrorCodes

Representa el código de error que OfficeExtension.Error.code puede devolver.

Para obtener más información sobre los códigos de error, consulte Códigos de error de Api común de Office.

OfficeExtension.EventHandlerResult

Habilita la eliminación de un controlador de eventos. Devuelto por el EventHandlers.add método .

Nota: El mismo objeto RequestContext en el que se agregó el controlador debe usarse al quitar el controlador. Puede encontrar más información en Quitar un controlador de eventos.

OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects

Colección de objetos de seguimiento, contenidos en un contexto de solicitud. Consulte context.trackedObjects para obtener más información.

Interfaces

Office.Actions

Administra acciones y métodos abreviados de teclado.

Office.AddBindingFromNamedItemOptions

Proporciona opciones para configurar el enlace que se crea.

Office.AddBindingFromPromptOptions

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

Office.AddBindingFromSelectionOptions

Proporciona opciones para identificar el enlace que se crea.

Office.Addin

Representa la funcionalidad de nivel de complemento para operar o configurar varios aspectos del complemento.

Office.AddinCommands.Event

El Event objeto se pasa como parámetro a las funciones de complemento invocadas por los botones de comando de función. El objeto permite al complemento identificar qué botón se ha hecho clic y indicar a la aplicación de Office que ha completado su procesamiento.

Office.AddinCommands.EventCompletedOptions

Especifica el comportamiento de un complemento de envío en Outlook cuando finaliza el procesamiento de un ItemSend evento.

Office.AddinCommands.Source

Encapsula los datos de origen para eventos de complemento.

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.

Office.AsyncResult

Un objeto que encapsula el resultado de una solicitud asincrónica, incluida la información de estado y error si la solicitud falla.

Cuando se ejecuta la callback función que se pasa al parámetro de un método "Async", recibe un objeto AsyncResult al que puede acceder desde el único parámetro de la callback función.

Office.Auth

El espacio de nombres de Office Auth, Office.auth, proporciona un método que permite a la aplicación cliente de Office obtener un token de acceso a la aplicación web del complemento. Indirectamente, esto habilita el complemento para que tenga acceso a los datos del usuario que ha iniciado sesión en Microsoft Graph, sin que el usuario inicie sesión por segunda vez.

Office.AuthOptions

Proporciona opciones para la experiencia del usuario cuando Office obtiene un token de acceso al complemento desde AAD v. 2.0 con el getAccessToken método .

Office.BeforeDocumentCloseNotification

Representa un cuadro de diálogo de notificación modal que puede aparecer cuando el usuario intenta cerrar un documento. El documento no se cerrará hasta que el usuario responda. El cuadro de diálogo de notificación permitirá al usuario confirmar la solicitud para cerrar el documento o cancelar la solicitud para cerrar el documento. Esta API solo se admite en Excel.

Office.Binding

Representa un enlace a una sección del documento.

El objeto Binding expone la funcionalidad que poseen todos los enlaces, independientemente del tipo.

Nunca se llama directamente al objeto Binding. Es la clase primaria abstracta de los objetos que representan cada tipo de enlace: Office.MatrixBinding, Office.TableBinding o Office.TextBinding. Los tres objetos heredan los métodos getDataAsync y setDataAsync del objeto Binding que permiten interactuar con los datos del enlace. También heredan las propiedades id. y type para consultar esos valores de propiedad. Asimismo, los objetos MatrixBinding y TableBinding exponen métodos adicionales para las características específicas de matrices y tablas, como contar el número de filas y columnas.

Office.BindingDataChangedEventArgs

Proporciona información sobre el enlace que ha generado el evento DataChanged.

Office.Bindings

Representa los enlaces que tiene el complemento en el documento.

Office.BindingSelectionChangedEventArgs

Proporciona información sobre el enlace que ha generado el evento SelectionChanged.

Office.Context

Representa el entorno en tiempo de ejecución del complemento y proporciona acceso a los objetos clave de la API. El contexto actual existe como una propiedad de Office. Se accede a él mediante Office.context.

Office.ContextInformation

Proporciona información sobre el entorno en el que se ejecuta el complemento.

Office.Control

Representa un control o comando individuales y el estado que debe tener.

Office.CustomXmlNode

Representa un nodo XML en un árbol de un documento.

Office.CustomXmlPart

Representa un único objeto CustomXMLPart en una colección Office.CustomXmlParts .

Office.CustomXmlParts

Representa una colección de objetos CustomXmlPart.

Office.CustomXmlPrefixMappings

Representa una colección de objetos CustomXmlPart.

Office.Dialog

Objeto que se devuelve cuando UI.displayDialogAsync se llama a . Expone métodos para registrar controladores de eventos y cerrar el cuadro de diálogo.

Office.DialogMessageOptions

Proporciona opciones para enviar mensajes, en cualquier dirección, entre un cuadro de diálogo y su elemento primario.

Office.DialogOptions

Proporciona opciones para cómo se muestra un cuadro de diálogo.

Office.DialogParentMessageReceivedEventArgs

Proporciona información sobre el mensaje de la página primaria que generó el DialogParentMessageReceived evento.

Para agregar un controlador de eventos para el DialogParentMessageReceived evento, use el addHandlerAsync método del objeto Office.UI .

Office.Document

Una clase abstracta que representa el documento con el que interactúa el complemento.

Office.DocumentSelectionChangedEventArgs

Proporciona información sobre el documento que ha generado el evento SelectionChanged.

Office.Error

Proporciona información específica sobre un error que se produjo durante una operación de datos asincrónica.

Office.File

Representa el archivo de documento asociado a un complemento de Office.

Office.FileProperties
Office.GetBindingDataOptions

Proporciona opciones para obtener los datos de un enlace.

Office.GetFileOptions

Proporciona opciones para establecer el tamaño de los segmentos en los que se dividirá el documento.

Office.GetSelectedDataOptions

Proporciona opciones para personalizar qué datos se devuelven y cómo se les da formato.

Office.GoToByIdOptions

Proporciona opciones para seleccionar la ubicación a la que se navega.

Office.Group

Representa un grupo de controles en una pestaña de cinta de opciones.

Conjunto de requisitos: RibbonAPI 1.1

Office.IPromiseConstructor
Office.MatrixBinding

Representa un enlace en dos dimensiones de filas y columnas.

Office.NodeDeletedEventArgs

Proporciona información sobre el nodo eliminado que ha generado el evento nodeDeleted.

Office.NodeInsertedEventArgs

Proporciona información sobre el nodo que se insertó y generó el evento nodeInserted.

Office.NodeReplacedEventArgs

Proporciona información sobre el nodo reemplazado que ha generado el evento nodeReplaced.

Office.OfficeTheme

Proporciona acceso a las propiedades de los colores del tema de Office.

El uso de colores de tema de Office le permite coordinar la combinación de colores del complemento con el tema actual de Office seleccionado por el usuario con la interfaz de usuariodel tema de Officede la cuenta> de Office de archivo>, que se aplica en todas las aplicaciones de Office. El uso de colores del tema de Office es idóneo para los complementos de correo y panel de tareas.

Office.RangeCoordinates

Especifica una celda, fila o columna, por su número de fila o columna de base cero. Ejemplo: {row: 3, column: 4} especifica la celda de la 3ª fila (basada en cero) de la 4ª columna (basada en cero).

Office.RangeFormatConfiguration

Especifica un rango y su formato.

Office.RemoveHandlerOptions

Proporciona opciones para determinar qué controladores o controladores de eventos se quitan.

Office.RequirementSetSupport

Proporciona información sobre qué conjuntos de requisitos se admiten en el entorno actual.

Office.Ribbon

Interfaz que contiene toda la funcionalidad proporcionada para administrar el estado de la cinta de Opciones de Office.

Office.RibbonUpdaterData

Especifica los cambios en la cinta de opciones, como el estado habilitado o deshabilitado de un botón.

Office.SaveSettingsOptions

Proporciona opciones para guardar la configuración.

Office.SetBindingDataOptions

Proporciona opciones para establecer los datos en un enlace.

Office.SetSelectedDataOptions

Proporciona opciones para insertar datos en la selección.

Office.Settings

Representa la configuración personalizada de un complemento de panel de tareas o de contenido que se almacena en el documento host como pares de nombre y valor.

Office.SettingsChangedEventArgs

Proporciona información sobre la configuración que generó el evento settingsChanged.

Para agregar un controlador de eventos para el evento settingsChanged, use el método addHandlerAsync del objeto Office.Settings .

El evento settingsChanged se desencadena solo cuando el script del complemento llama al método Settings.saveAsync para conservar la copia en memoria de la configuración en el archivo de documento. El evento settingsChanged no se desencadena cuando se llama a los métodos Settings.set o Settings.remove.

El evento settingsChanged se diseñó para permitirle controlar posibles conflictos cuando dos o más usuarios intentan guardar la configuración al mismo tiempo cuando el complemento se usa en un documento compartido (coautor).

Importante: El código del complemento puede registrar un controlador para el evento settingsChanged cuando el complemento se ejecuta con cualquier cliente de Excel, pero el evento se desencadenará solo cuando el complemento se cargue con una hoja de cálculo que se abra en Excel en la Web y más de un usuario edite la hoja de cálculo (coautoría). Por lo tanto, de forma eficaz, el evento settingsChanged solo se admite en Excel en la Web en escenarios de coautoría.

Office.Slice

Representa un segmento de un archivo de documento. Se obtiene acceso al objeto Slice con el File.getSliceAsync método .

Office.Tab

Representa una pestaña individual y el estado que debe tener. Para obtener ejemplos de código, vea Habilitar y deshabilitar comandos de complemento yCreate pestañas contextuales personalizadas.

Office.TableBinding

Representa un enlace en dos dimensiones de filas y columnas, que puede llevar o no encabezados.

Office.TextBinding

Representa una selección de texto enlazado en el documento.

El objeto TextBinding hereda la id propiedad, la propiedad type, el método getDataAsync y el método setDataAsync del objeto Office.Binding . No implementa ninguna otra de sus propiedades ni métodos adicionales.

Office.UI

Proporciona objetos y métodos que puede usar para crear y manipular componentes de interfaz de usuario, como cuadros de diálogo, en los complementos de Office.

Visite "Use the Dialog API in your Office Add-ins" (Usar la API de diálogo en los complementos de Office) para obtener más información.

Office.VisibilityModeChangedMessage

Mensaje usado en la onVisibilityModeChanged invocación.

OfficeExtension.DebugInfo

Proporciona información sobre un error.

OfficeExtension.EmbeddedOptions

Especifica las opciones para una sesión de un diagrama de Visio insertado en una página de SharePoint. Llamado por el constructor de EmbeddedSession. Para obtener más información, consulte Información general sobre la API de JavaScript de Visio.

OfficeExtension.EventInfo

Lo usa Office para construir controladores de eventos. No llame a en el código.

OfficeExtension.LoadOption

Especifica qué propiedades de un objeto se deben cargar. Esta carga se produce cuando se ejecuta el método sync(). Esto sincroniza los estados entre los objetos de Office y los objetos de proxy de JavaScript correspondientes.

OfficeExtension.RequestContextDebugInfo

Contiene información de depuración sobre el contexto de la solicitud.

OfficeExtension.RequestUrlAndHeaderInfo

Dirección URL y encabezados de solicitud

OfficeExtension.RunOptions

Opciones adicionales que se pasan a {Host}.run(...).

OfficeExtension.UpdateOptions

Proporciona una opción para suprimir un error cuando el objeto que se usa para establecer varias propiedades intenta establecer propiedades de solo lectura.

Alias de tipos

OfficeExtension.IPromise

Enumeraciones

Office.ActiveView

Especifica el estado de la vista activa del documento (por ejemplo, si el usuario puede editar o no el documento).

Office.AsyncResultStatus

Especifica el resultado de una llamada asíncrona.

Office.BindingType

Especifica el tipo de objeto de enlace que se debería devolver.

Office.CoercionType

Especifica cómo convertir los datos que el método invocado ha devuelto o definido.

Office.CustomXMLNodeType

Especifica el tipo del nodo XML.

Office.DocumentMode

Especifica si el documento de la aplicación asociada es de solo lectura o de lectura y escritura.

Office.EventType

Especifica el tipo de evento que se ha generado. Devuelto por la type propiedad de un *EventArgs objeto .

Los complementos de Project admiten los Office.EventType.ResourceSelectionChangedtipos de eventos , Office.EventType.TaskSelectionChangedy Office.EventType.ViewSelectionChanged .

Solo los complementos de panel de tareas para Outlook admiten tipos de eventos de conjuntos de API de buzón.

Office.FileType

Especifica el formato en el que deben devolverse los documentos.

Office.FilterType

Especifica si se aplica el filtrado desde la aplicación de Office cuando se recuperan los datos.

Office.GoToType

Especifica el tipo de lugar u objeto hacia el que se debe navegar.

Office.HostType

Especifica la aplicación de Office en la que se ejecuta el complemento.

Office.Index

Especifica la diapositiva relativa de PowerPoint.

Office.InitializationReason

Especifica si el complemento se acaba de insertar o si se encontraba en el documento con anterioridad.

Office.PlatformType

Especifica el sistema operativo u otra plataforma en la que se ejecuta la aplicación de Office.

Office.ProjectProjectFields

Especifica los campos del proyecto que están disponibles como parámetro para el método Document.getProjectFieldAsync.

Office.ProjectResourceFields

Especifica los campos de recursos que están disponibles como parámetro para el método Document.getResourceFieldAsync.

Office.ProjectTaskFields

Especifica los campos de tarea que están disponibles como parámetro para el método Document.getTaskFieldAsync.

Office.ProjectViewTypes

Especifica los tipos de vistas que el método Document.getSelectedViewAsync puede reconocer.

Office.SelectionMode

Especifica si se debe seleccionar (resaltar) la ubicación a la que se va a navegar (cuando se usa el método Document.goToByIdAsync).

Office.StartupBehavior

Proporciona opciones para determinar el comportamiento de inicio del complemento en el siguiente inicio.

Office.Table

Especifica los valores enumerados para la cells propiedad en el parámetro cellFormat de los métodos de formato de tabla.

Office.ValueFormat

Especifica si se debe aplicar su formato correspondiente a los valores que devuelve el método que se ha invocado (por ejemplo, números y fechas).

Office.VisibilityMode

Modo de visibilidad del complemento.

Funciones

Office.initialize(reason)

Ocurre cuando se carga el entorno en tiempo de ejecución y el complemento está preparado para empezar a interactuar con la aplicación y el documento alojado.

El parámetro reason de la función initialize event listener devuelve un InitializationReason valor de enumeración que especifica cómo se produjo la inicialización. El complemento de contenido o panel de tareas puede inicializarse con dos procedimientos:

  • El usuario lo acaba de insertar en la sección Complementos usados recientemente de la lista desplegable Complemento de la pestaña Insertar de la cinta de opciones de la aplicación de Office o del cuadro de diálogo Insertar complemento.

  • El usuario abre un documento que contiene el complemento.

Nota: El parámetro reason de la función initialize event listener solo devuelve un InitializationReason valor de enumeración para el panel de tareas y los complementos de contenido. No devuelve un valor para los complementos de Outlook.

Office.isSetSupported(name, minVersion)

Comprueba si la aplicación de Office admite el conjunto de requisitos especificado.

Office.onReady(callback)

Garantiza que el complemento esté listo para llamar a las API de JavaScript de Office. Si el marco aún no se ha inicializado, la devolución de llamada o la promesa esperarán hasta que la aplicación de Office esté lista para aceptar llamadas API. Tenga en cuenta que, aunque esta API está pensada para usarse dentro de un complemento de Office, también se puede usar fuera del complemento. En ese caso, una vez que Office.js determine que se ejecuta fuera de una aplicación de Office, llamará a la devolución de llamada y resolverá la promesa con "null" tanto para la aplicación como para la plataforma.

Office.select(expression, callback)

Devuelve una promesa de un objeto descrito en la expresión . La devolución de llamada solo se invoca si se produce un error en la función.

Office.useShortNamespace(useShortNamespace)

Activa y desactiva el Office alias del espacio de nombres completo Microsoft.Office.WebExtension .

Detalles de la función

Office.initialize(reason)

Ocurre cuando se carga el entorno en tiempo de ejecución y el complemento está preparado para empezar a interactuar con la aplicación y el documento alojado.

El parámetro reason de la función initialize event listener devuelve un InitializationReason valor de enumeración que especifica cómo se produjo la inicialización. El complemento de contenido o panel de tareas puede inicializarse con dos procedimientos:

  • El usuario lo acaba de insertar en la sección Complementos usados recientemente de la lista desplegable Complemento de la pestaña Insertar de la cinta de opciones de la aplicación de Office o del cuadro de diálogo Insertar complemento.

  • El usuario abre un documento que contiene el complemento.

Nota: El parámetro reason de la función initialize event listener solo devuelve un InitializationReason valor de enumeración para el panel de tareas y los complementos de contenido. No devuelve un valor para los complementos de Outlook.

export function initialize(reason: InitializationReason): void;

Parámetros

reason
Office.InitializationReason

Indica cómo se inicializó la aplicación.

Devoluciones

void

Comentarios

Información sobre soporte técnico

Para obtener más información sobre los requisitos de servidor y aplicaciones de Office, vea Requisitos para ejecutar complementos de Office.

Aplicaciones admitidas, por plataforma

Office en la web Office en Windows Office en Mac Office en iPad Outlook en dispositivos móviles
Excel Compatible Compatible Compatible Compatible No aplicable
Outlook Compatible Compatible Compatible Compatible Compatible
Powerpoint Compatible Compatible Compatible Compatible No aplicable
Proyecto No se admite Compatible Compatible No se admite No aplicable
Word Compatible Compatible Compatible Compatible No aplicable

Ejemplos

// 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)

Comprueba si la aplicación de Office admite el conjunto de requisitos especificado.

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

Parámetros

name

string

Establecer nombre; Por ejemplo, "MatrixBindings".

minVersion

string

La versión mínima necesaria; por ejemplo, "1.4".

Devoluciones

boolean

Office.onReady(callback)

Garantiza que el complemento esté listo para llamar a las API de JavaScript de Office. Si el marco aún no se ha inicializado, la devolución de llamada o la promesa esperarán hasta que la aplicación de Office esté lista para aceptar llamadas API. Tenga en cuenta que, aunque esta API está pensada para usarse dentro de un complemento de Office, también se puede usar fuera del complemento. En ese caso, una vez que Office.js determine que se ejecuta fuera de una aplicación de Office, llamará a la devolución de llamada y resolverá la promesa con "null" tanto para la aplicación como para la 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

Una función de devolución de llamada opcional que recibirá la información de la aplicación y la plataforma. Como alternativa, en lugar de usar una devolución de llamada, un complemento puede simplemente esperar a que la promesa devuelta por la función se resuelva.

Devoluciones

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

Promesa que contiene la información de la aplicación y la plataforma, una vez completada la inicialización.

Office.select(expression, callback)

Devuelve una promesa de un objeto descrito en la expresión . La devolución de llamada solo se invoca si se produce un error en la función.

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

Parámetros

expression

string

Objeto que se va a recuperar. Ejemplo de "bindings#BindingName", recupera una promesa de enlace para un enlace denominado "BindingName"

callback

(result: Office.AsyncResult<any>) => 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

Comentarios

Información sobre soporte técnico

Para obtener más información sobre los requisitos de servidor y aplicaciones de Office, vea Requisitos para ejecutar complementos de Office.

Aplicaciones admitidas, por plataforma

Office en la web Office en Windows Office en iPad
Excel Compatible Compatible Compatible
Word No compatible Compatible Compatible

Ejemplos

// 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)

Activa y desactiva el Office alias del espacio de nombres completo Microsoft.Office.WebExtension .

export function useShortNamespace(useShortNamespace: boolean): void;

Parámetros

useShortNamespace

boolean

True para usar el alias de acceso directo; de lo contrario, false para deshabilitarlo. El valor predeterminado es true.

Devoluciones

void

Comentarios

Información sobre soporte técnico

Para obtener más información sobre los requisitos de servidor y aplicaciones de Office, vea Requisitos para ejecutar complementos de Office.

Aplicaciones admitidas, por plataforma

Office en la web Office en Windows Office en Mac Office en iPad Outlook en dispositivos móviles
Excel Compatible Compatible No se admite Compatible No aplicable
Outlook Compatible Compatible Compatible Compatible Compatible
Powerpoint Compatible Compatible No se admite Compatible No aplicable
Proyecto No compatible Compatible No se admite No compatible No aplicable
Word Compatible Compatible No se admite Compatible No aplicable

Ejemplos

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