Excel.RangeBorderCollection class

  • Referencia
Paquete:
excel

Representa los objetos de borde que componen el borde del rango.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

context

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

Número de objetos de borde de la colección.
items

Obtiene los elementos secundarios cargados en esta colección.
tintAndShade

Especifica un doble que aclara u oscurece un color para los bordes de intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que toda la colección de bordes no tiene una configuración uniforme tintAndShade .

Métodos

getItem(index)

Obtiene un objeto de borde mediante su nombre.
getItem(indexString)

Obtiene un objeto de borde mediante su nombre.
getItemAt(index)

Obtiene un objeto de borde mediante su índice.
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 original Excel.RangeBorderCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeBorderCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Detalles de las propiedades

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

count

Número de objetos de borde de la colección.

readonly count: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.RangeBorder[];

Valor de propiedad

Excel.RangeBorder[]

tintAndShade

Especifica un doble que aclara u oscurece un color para los bordes de intervalo. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que toda la colección de bordes no tiene una configuración uniforme tintAndShade .

tintAndShade: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Detalles del método

getItem(index)

Obtiene un objeto de borde mediante su nombre.

getItem(index: Excel.BorderIndex): Excel.RangeBorder;

Parámetros

index
Excel.BorderIndex

Valor de índice del objeto de borde que va a recuperarse. Vea Excel.BorderIndex para más información.

Devoluciones

Excel.RangeBorder

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const border = range.format.borders.getItem(Excel.BorderIndex.edgeTop);
    border.load('style');
    await context.sync();

    console.log(border.style);
});

getItem(indexString)

Obtiene un objeto de borde mediante su nombre.

getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;

Parámetros

indexString

"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

Valor de índice del objeto de borde que va a recuperarse. Vea Excel.BorderIndex para más información.

Devoluciones

Excel.RangeBorder

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

getItemAt(index)

Obtiene un objeto de borde mediante su índice.

getItemAt(index: number): Excel.RangeBorder;

Parámetros

index

number

Valor de índice del objeto que se va a recuperar. Indizado con cero.

Devoluciones

Excel.RangeBorder

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const border = range.format.borders.getItemAt(0);
    border.load('sideIndex');
    await context.sync();
    
    console.log(border.sideIndex);
});

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.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection;

Parámetros

options

Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Devoluciones

Excel.RangeBorderCollection

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

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.RangeBorderCollection

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const borders = range.format.borders;
    borders.load('items');
    await context.sync();
    
    console.log(borders.count);
    for (let i = 0; i < borders.items.length; i++) {
        console.log(borders.items[i].sideIndex);
    }
});

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?: OfficeExtension.LoadOption): Excel.RangeBorderCollection;

Parámetros

propertyNamesAndPaths
OfficeExtension.LoadOption

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.RangeBorderCollection

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 original Excel.RangeBorderCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeBorderCollectionData) que contiene una matriz "items" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.RangeBorderCollectionData;

Devoluciones

Excel.Interfaces.RangeBorderCollectionData