Excel.RangeBorderCollection class
Représente les objets de bordure qui composent la bordure de la plage.
- Extends
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| count | Nombre d’objets de bordure de la collection. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
| tint |
Spécifie un double qui éclaircit ou assombrit une couleur pour les bordures de plage. La valeur est comprise entre -1 (le plus foncé) et 1 (le plus clair), avec 0 pour la couleur d’origine. Une |
Méthodes
| get |
Obtient un objet de bordure à l’aide de son nom. |
| get |
Obtient un objet de bordure à l’aide de son nom. |
| get |
Obtient un objet de bordure à l’aide de son indice. |
| 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 |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
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é
count
Nombre d’objets de bordure de la collection.
readonly count: number;Valeur de propriété
number
Remarques
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.RangeBorder[];Valeur de propriété
tintAndShade
Spécifie un double qui éclaircit ou assombrit une couleur pour les bordures de 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 l’ensemble de la collection de bordures n’a pas de paramètre uniforme tintAndShade .
tintAndShade: number;Valeur de propriété
number
Remarques
Détails de la méthode
getItem(index)
Obtient un objet de bordure à l’aide de son nom.
getItem(index: Excel.BorderIndex): Excel.RangeBorder;Paramètres
- index
- Excel.BorderIndex
Valeur d’indice de l’objet de bordure à récupérer. Pour Excel.BorderIndex plus de détails.
Retours
Remarques
Exemples
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(index)
Obtient un objet de bordure à l’aide de son nom.
getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;Paramètres
- index
-
"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"
Valeur d’indice de l’objet de bordure à récupérer. Pour Excel.BorderIndex plus de détails.
Retours
Remarques
getItemAt(index)
Obtient un objet de bordure à l’aide de son indice.
getItemAt(index: number): Excel.RangeBorder;Paramètres
- index
-
number
Valeur d’indice de l’objet à récupérer. Avec indice zéro.
Retours
Remarques
Exemples
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)
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.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection;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.RangeBorderCollection;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
Exemples
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)
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?: OfficeExtension.LoadOption): Excel.RangeBorderCollection;Paramètres
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.RangeBorderCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RangeBorderCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.RangeBorderCollectionData;