Excel.ShapeFont class

Représente les attributs de police, tels que le nom, la taille de police et la couleur, de l’objet d’une TextRange forme.

Extends

Propriétés

bold

Représente le format de police Gras. Renvoie null si le inclut des fragments de TextRange texte en gras et sans gras.

color

Code couleur HTML : représentation de la couleur du texte (par exemple, « #FF0000 » représente le rouge). Retourne null si le inclut des fragments de TextRange texte de différentes couleurs.

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

Représente le format de police Italique. Renvoie null si le comprend des fragments de TextRange texte en italique et non en italique.

name

Représente le nom de la police (par exemple, « Calibri »). Si le texte est une écriture complexe ou une langue d’Asie de l’Est, il s’agit du nom de police correspondant ; sinon, il s’agit du nom de la police latine.

size

Représente la taille de police en points (par exemple, 11). Renvoie null si le inclut des fragments de texte avec différentes tailles de TextRange police.

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.

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.

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.

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.

underline

Type de soulignement appliqué à la police. Renvoie null si le inclut des fragments de texte avec différents styles de TextRange soulignement. Pour Excel.ShapeFontUnderlineStyle plus de détails.

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 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 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.ShapeFont est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ShapeFontDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

bold

Représente le format de police Gras. Renvoie null si le inclut des fragments de TextRange texte en gras et sans gras.

bold: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

color

Code couleur HTML : représentation de la couleur du texte (par exemple, « #FF0000 » représente le rouge). Retourne null si le inclut des fragments de TextRange texte de différentes couleurs.

color: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

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

Représente le format de police Italique. Renvoie null si le comprend des fragments de TextRange texte en italique et non en italique.

italic: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

name

Représente le nom de la police (par exemple, « Calibri »). Si le texte est une écriture complexe ou une langue d’Asie de l’Est, il s’agit du nom de police correspondant ; sinon, il s’agit du nom de la police latine.

name: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

size

Représente la taille de police en points (par exemple, 11). Renvoie null si le inclut des fragments de texte avec différentes tailles de TextRange police.

size: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.9

strikethrough

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

subscript

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

superscript

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

tintAndShade

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

underline

Type de soulignement appliqué à la police. Renvoie null si le inclut des fragments de texte avec différents styles de TextRange soulignement. Pour Excel.ShapeFontUnderlineStyle plus de détails.

underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";

Valeur de propriété

Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"

Remarques

Jeu d’API : ExcelApi 1.9

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.ShapeFontLoadOptions): Excel.ShapeFont;

Paramètres

options
Excel.Interfaces.ShapeFontLoadOptions

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.ShapeFont;

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.ShapeFont;

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.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.ShapeFontUpdateData

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.ShapeFont): void;

Paramètres

properties
Excel.ShapeFont

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.ShapeFont est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.ShapeFontDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.ShapeFontData;

Retours