Excel.Binding class
Representa un enlace de Office.js que se define en el libro.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.1]
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| id | Representa el identificador de enlace. |
| type | Devuelve el tipo de enlace. Vea |
Métodos
| delete() | Elimina el enlace. |
| get |
Devuelve el intervalo representado por el enlace. Arrojará un error si el enlace no es del tipo correcto. |
| get |
Devuelve la tabla representada por el enlace. Arrojará un error si el enlace no es del tipo correcto. |
| get |
Devuelve el texto representado por el enlace. Arrojará un error si el enlace no es del tipo correcto. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| toJSON() | Reemplaza el método JavaScript |
Eventos
| on |
Se produce al cambiar los datos del enlace o al darles formato. |
| on |
Se produce cuando se cambia el contenido seleccionado en el enlace.
Nota: Si se seleccionan varias celdas discontinuas, |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
id
Representa el identificador de enlace.
readonly id: string;
Valor de propiedad
string
Comentarios
[Conjunto de API: ExcelApi 1.1]
type
Devuelve el tipo de enlace. Vea Excel.BindingType para más información.
readonly type: Excel.BindingType | "Range" | "Table" | "Text";
Valor de propiedad
Excel.BindingType | "Range" | "Table" | "Text"
Comentarios
[Conjunto de API: ExcelApi 1.1]
Detalles del método
delete()
Elimina el enlace.
delete(): void;
Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.3]
getRange()
Devuelve el intervalo representado por el enlace. Arrojará un error si el enlace no es del tipo correcto.
getRange(): Excel.Range;
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.1]
getTable()
Devuelve la tabla representada por el enlace. Arrojará un error si el enlace no es del tipo correcto.
getTable(): Excel.Table;
Devoluciones
Comentarios
[Conjunto de API: ExcelApi 1.1]
getText()
Devuelve el texto representado por el enlace. Arrojará un error si el enlace no es del tipo correcto.
getText(): OfficeExtension.ClientResult<string>;
Devoluciones
OfficeExtension.ClientResult<string>
Comentarios
[Conjunto de API: ExcelApi 1.1]
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.BindingLoadOptions): Excel.Binding;
Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.Binding;
Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Binding;
Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Binding es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.BindingData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.BindingData;
Devoluciones
Detalles del evento
onDataChanged
Se produce al cambiar los datos del enlace o al darles formato.
readonly onDataChanged: OfficeExtension.EventHandlers<Excel.BindingDataChangedEventArgs>;
Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.2]
onSelectionChanged
Se produce cuando se cambia el contenido seleccionado en el enlace.
Nota: Si se seleccionan varias celdas discontinuas, Binding.onSelectionChanged solo se notifica la información de fila y columna de una selección. Se usa Worksheet.onSelectionChanged para varios rangos seleccionados.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.BindingSelectionChangedEventArgs>;
Tipo de evento
Comentarios
[Conjunto de API: ExcelApi 1.2]