Excel.RangeBorder class
Cet objet représente la bordure d'un objet.
- Extends
Remarques
Utilisateur
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 comme une couleur HTML nommée (par exemple, « orange »). |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| side |
Valeur constante qui indique un côté spécifique de la bordure. Pour |
| style | L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour |
| tint |
Spécifie un double qui éclaircit ou assombrit une couleur pour la bordure de la plage, la valeur est comprise entre -1 (le plus foncé) et 1 (le plus clair), avec 0 pour la couleur d’origine. Une |
| weight | Spécifie l'épaisseur de la bordure autour d'une plage. Pour |
Méthodes
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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 |
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 comme une couleur HTML nommée (par exemple, « orange »).
color: string;Valeur de propriété
string
Remarques
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
sideIndex
Valeur constante qui indique un côté spécifique de la bordure. Pour Excel.BorderIndex plus de détails.
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
style
L’une des constantes de style de ligne déterminant le style de ligne de la bordure. Pour Excel.BorderLineStyle plus de détails.
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
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();
});
tintAndShade
Spécifie un double qui éclaircit ou assombrit une couleur pour la bordure de la plage, la valeur est comprise entre -1 (le plus foncé) et 1 (le plus clair), avec 0 pour la couleur d’origine. Une null valeur indique que la bordure n’a pas un paramètre uniforme tintAndShade .
tintAndShade: number;Valeur de propriété
number
Remarques
weight
Spécifie l'épaisseur de la bordure autour d'une plage. Pour Excel.BorderWeight plus de détails.
weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";Valeur de propriété
Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"
Remarques
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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 spécifiant les propriétés à charger.
Retours
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
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties: Interfaces.RangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.RangeBorderUpdateData
Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.RangeBorderDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.RangeBorderData;