Excel.WorkbookRangeAreas class

Paquete:

excel

Representa una colección de uno o varios rangos rectangulares en varias hojas de cálculo.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

Propiedades

addresses	Devuelve una matriz de direcciones en estilo A1. Los valores de dirección contienen el nombre de la hoja de cálculo para cada bloque rectangular de celdas (por ejemplo, "Sheet1! A1:B4, Sheet1! D1:D4"). Solo lectura.
areas	Devuelve el RangeAreasCollection objeto . Cada uno RangeAreas de la colección representa uno o varios rangos de rectángulos en una hoja de cálculo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
ranges	Devuelve intervalos que componen este objeto en un RangeCollection objeto .

Métodos

getRangeAreasBySheet(key)	Devuelve el objeto según el RangeAreas identificador o el nombre de la hoja de cálculo de la colección.
getRangeAreasOrNullObjectBySheet(key)	Devuelve el objeto según el RangeAreas nombre o el identificador de la hoja de cálculo de la colección. Si la hoja de cálculo no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
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(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.WorkbookRangeAreas original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WorkbookRangeAreasData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()	Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.
untrack()	Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

addresses

Devuelve una matriz de direcciones en estilo A1. Los valores de dirección contienen el nombre de la hoja de cálculo para cada bloque rectangular de celdas (por ejemplo, "Sheet1! A1:B4, Sheet1! D1:D4"). Solo lectura.

readonly addresses: string[];

Valor de propiedad

string[]

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

areas

Devuelve el RangeAreasCollection objeto . Cada uno RangeAreas de la colección representa uno o varios rangos de rectángulos en una hoja de cálculo.

readonly areas: Excel.RangeAreasCollection;

Valor de propiedad

Excel.RangeAreasCollection

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/precedents.yaml

await Excel.run(async (context) => {
  // Precedents are cells referenced by the formula in a cell.
  // A "direct precedent" is a cell directly referenced by the selected formula.
  let range = context.workbook.getActiveCell();
  let directPrecedents = range.getDirectPrecedents();
  range.load("address");
  directPrecedents.areas.load("address");
  await context.sync();

  console.log(`Direct precedent cells of ${range.address}:`);

  // Use the direct precedents API to loop through precedents of the active cell.
  for (let i = 0; i < directPrecedents.areas.items.length; i++) {
    // Highlight and console the address of each precedent cell.
    directPrecedents.areas.items[i].format.fill.color = "Yellow";
    console.log(`  ${directPrecedents.areas.items[i].address}`);
  }
  await context.sync();
});

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

ranges

Devuelve intervalos que componen este objeto en un RangeCollection objeto .

readonly ranges: Excel.RangeCollection;

Valor de propiedad

Excel.RangeCollection

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

Detalles del método

getRangeAreasBySheet(key)

Devuelve el objeto según el RangeAreas identificador o el nombre de la hoja de cálculo de la colección.

getRangeAreasBySheet(key: string): Excel.RangeAreas;

Parámetros

key

string

Nombre o identificador de la hoja de cálculo.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

getRangeAreasOrNullObjectBySheet(key)

Devuelve el objeto según el RangeAreas nombre o el identificador de la hoja de cálculo de la colección. Si la hoja de cálculo no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getRangeAreasOrNullObjectBySheet(key: string): Excel.RangeAreas;

Parámetros

key

string

Nombre o identificador de la hoja de cálculo.

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.12 ]

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.WorkbookRangeAreasLoadOptions): Excel.WorkbookRangeAreas;

Parámetros

options

Excel.Interfaces.WorkbookRangeAreasLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.WorkbookRangeAreas

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.WorkbookRangeAreas;

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

Excel.WorkbookRangeAreas

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.WorkbookRangeAreas;

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

Excel.WorkbookRangeAreas

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.WorkbookRangeAreas original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WorkbookRangeAreasData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.WorkbookRangeAreasData;

Devoluciones

Excel.Interfaces.WorkbookRangeAreasData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez.

track(): Excel.WorkbookRangeAreas;

Devoluciones

Excel.WorkbookRangeAreas

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Excel.WorkbookRangeAreas;

Devoluciones

Excel.WorkbookRangeAreas