Excel.ShapeFont class

  • Référence
Paquet:
excel

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

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

bold

Représente le format de police Gras. Retourne null si inclut des TextRange fragments de texte en gras et non gras.
color

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

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
italic

Représente le format de police Italique. Retourne null si inclut des TextRange fragments de texte italique et non italique.
name

Représente le nom de la police (par exemple, « Calibri »). Si le texte est un script 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). Retourne null si inclut des TextRange fragments de texte avec des tailles de police différentes.
underline

Type de soulignement appliqué à la police. Retourne null si inclut des fragments de TextRange texte avec différents styles de soulignement. Pour plus d’informations, consultez Excel.ShapeFontUnderlineStyle .

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 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 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 Excel.ShapeFont d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ShapeFontDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

bold

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

bold: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

color

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

color: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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é

Excel.RequestContext

italic

Représente le format de police Italique. Retourne null si inclut des TextRange fragments de texte italique et non italique.

italic: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

name

Représente le nom de la police (par exemple, « Calibri »). Si le texte est un script 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

[ Ensemble d’API : ExcelApi 1.9 ]

size

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

size: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

underline

Type de soulignement appliqué à la police. Retourne null si inclut des fragments de TextRange texte avec différents styles de soulignement. Pour plus d’informations, consultez Excel.ShapeFontUnderlineStyle .

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

[ Ensemble 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

Excel.ShapeFont

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 qui spécifient les propriétés à charger.

Retours

Excel.ShapeFont

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

Excel.ShapeFont

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

Paramètres

properties
Excel.Interfaces.ShapeFontUpdateData

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.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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.ShapeFont d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.ShapeFontDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.ShapeFontData;

Retours

Excel.Interfaces.ShapeFontData