Partager via

Excel.RangeBorder class

  • Référence
Paquet:
excel

Cet objet représente la bordure d'un objet.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

color

Code de couleur HTML représentant la couleur de la ligne de bordure, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
sideIndex

Valeur constante qui indique un côté spécifique de la bordure. Pour plus d’informations, consultez Excel.BorderIndex .
style

L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour plus d’informations, consultez Excel.BorderLineStyle .
weight

Spécifie l'épaisseur de la bordure autour d'une plage. Pour plus d’informations, consultez Excel.BorderWeight .

Méthodes

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.RangeBorder est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.RangeBorderDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

color

Code de couleur HTML représentant la couleur de la ligne de bordure, sous la forme #RRGGBB (par exemple, « FFA500 ») ou sous la forme d’une couleur HTML nommée (par exemple, « orange »).

color: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

sideIndex

Valeur constante qui indique un côté spécifique de la bordure. Pour plus d’informations, consultez Excel.BorderIndex .

readonly sideIndex: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp";

Valeur de propriété

Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

style

L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour plus d’informations, consultez Excel.BorderLineStyle .

style: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot";

Valeur de propriété

Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

// Add grid borders around the range.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.borders.getItem('InsideHorizontal').style = 'Continuous';
    range.format.borders.getItem('InsideVertical').style = 'Continuous';
    range.format.borders.getItem('EdgeBottom').style = 'Continuous';
    range.format.borders.getItem('EdgeLeft').style = 'Continuous';
    range.format.borders.getItem('EdgeRight').style = 'Continuous';
    range.format.borders.getItem('EdgeTop').style = 'Continuous';
    await context.sync(); 
});

weight

Spécifie l'épaisseur de la bordure autour d'une plage. Pour plus d’informations, consultez Excel.BorderWeight .

weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";

Valeur de propriété

Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Détails de la méthode

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder;

Paramètres

options
Excel.Interfaces.RangeBorderLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.RangeBorder

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.RangeBorder;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.RangeBorder

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeBorder;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.RangeBorder

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.RangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.RangeBorderUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.RangeBorder): void;

Paramètres

properties
Excel.RangeBorder

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.RangeBorder est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.RangeBorderDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.RangeBorderData;

Retours

Excel.Interfaces.RangeBorderData