Excel.RangeFont class
Cet objet représente les attributs de police (nom de la police, taille de police, couleur, etc.) d’un objet.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
Propriétés
| bold | Représente la status en gras de la police. |
| color | Représentation par code de couleur HTML de la couleur du texte (par exemple, #FF0000 représente le rouge). |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| italic | Spécifie la status italique de la police. |
| name | Nom de la police (par exemple, « Calibri »). La longueur du nom ne doit pas être supérieure à 31 caractères. |
| size | Taille de police |
| strikethrough | Spécifie le status barré de la police. Une |
| subscript | Spécifie l’indice status de police. Retourne |
| superscript | Spécifie l’exposant status de police. Retourne |
| tint |
Spécifie un double qui éclaircit ou assombrit une couleur pour la police de plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une |
| underline | Type de soulignement appliqué à la police. Pour plus d’informations, consultez |
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 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 |
Détails de la propriété
bold
Représente la status en gras de la police.
bold: boolean;Valeur de propriété
boolean
Remarques
color
Représentation par code de couleur HTML 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 . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
italic
Spécifie la 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 être supérieure à 31 caractères.
name: string;Valeur de propriété
string
Remarques
[ Ensemble d’API : ExcelApi 1.1 ]
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
Taille de police
size: number;Valeur de propriété
number
Remarques
strikethrough
Spécifie le status barré de la police. Une null valeur indique que la plage entière n’a pas de paramètre barré uniforme.
strikethrough: boolean;Valeur de propriété
boolean
Remarques
subscript
Spécifie l’indice status de police. Retourne true si toutes les polices de la plage sont en indice. Retourne 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 l’exposant status de police. Retourne true si toutes les polices de la plage sont en exposant. Retourne 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 plage. La valeur est comprise entre -1 (la plus foncée) et 1 (la plus brillante), avec 0 pour la couleur d’origine. Une null valeur indique que la plage entière 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 plus d’informations, consultez Excel.RangeUnderlineStyle .
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 qui spécifient 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 passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.RangeFontUpdateData
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.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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.RangeFontDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.RangeFontData;