Excel.RangeFont class
Cet objet représente les attributs de police (nom de la police, taille de police, couleur, etc.) d’un objet.
- Extends
Propriétés
| bold | Représente le status gras de la police. |
| color | Code couleur HTML : représentation de la couleur du texte (par exemple, #FF0000 représente le rouge). |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| italic | Spécifie le status italique de la police. |
| name | Nom de la police (par exemple, « Calibri »). La longueur du nom ne doit pas dépasser 31 caractères. |
| size | Taille de police |
| strikethrough | Spécifie le status barré de la police. Une |
| subscript | Spécifie le status de l’indice de la police. Renvoie |
| superscript | Spécifie le status en exposant de la police. Renvoie |
| tint |
Spécifie un double qui éclaircit ou assombrit une couleur pour la police 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 |
| underline | Type de soulignement appliqué à la police. 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é
bold
Représente le status gras de la police.
bold: boolean;Valeur de propriété
boolean
Remarques
color
Code couleur HTML : représentation de la couleur du texte (par exemple, #FF0000 représente le rouge).
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é
italic
Spécifie le status italique de la police.
italic: boolean;Valeur de propriété
boolean
Remarques
name
Nom de la police (par exemple, « Calibri »). La longueur du nom ne doit pas dépasser 31 caractères.
name: string;Valeur de propriété
string
Remarques
Exemples
// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
const selection = context.workbook.getSelectedRange();
selection.format.font.name = "Impact";
await context.sync();
});
size
strikethrough
Spécifie le status barré de la police. Une null valeur indique que toute la plage n’a pas de paramètre barré uniforme.
strikethrough: boolean;Valeur de propriété
boolean
Remarques
subscript
Spécifie le status de l’indice de la police. Renvoie true si toutes les polices de la plage sont des indices. Renvoie false si toutes les polices de la plage sont en exposant ou normales (ni exposant, ni indice). Retourne null dans le cas contraire.
subscript: boolean;Valeur de propriété
boolean
Remarques
superscript
Spécifie le status en exposant de la police. Renvoie true si toutes les polices de la plage sont en exposant. Renvoie false si toutes les polices de la plage sont en indice ou normales (ni exposant ni indice). Retourne null dans le cas contraire.
superscript: boolean;Valeur de propriété
boolean
Remarques
tintAndShade
Spécifie un double qui éclaircit ou assombrit une couleur pour la police 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 toute la plage n’a pas de paramètre de police tintAndShade uniforme.
tintAndShade: number;Valeur de propriété
number
Remarques
underline
Type de soulignement appliqué à la police. Pour Excel.RangeUnderlineStyle plus de détails.
underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";Valeur de propriété
Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"
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.RangeFontLoadOptions): Excel.RangeFont;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.RangeFont;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 = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const rangeFont = range.format.font;
rangeFont.load('name');
await context.sync();
console.log(rangeFont.name);
});
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.RangeFont;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.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.RangeFontUpdateData
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.RangeFont): void;Paramètres
- properties
- Excel.RangeFont
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.RangeFont est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RangeFontDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.RangeFontData;