Partager via


Excel.ConditionalRangeFormat class

Objet de format qui encapsule la police, le remplissage, les bordures et d’autres propriétés de la plage de formats conditionnels.

Extends

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

Propriétés

borders

Collection d’objets de bordure qui s’appliquent à la plage de format conditionnel globale.

context

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

fill

Renvoie l’objet de remplissage défini sur la plage de format conditionnel globale.

font

Retourne l’objet de police défini sur la plage de format conditionnel globale.

numberFormat

Représente le code de format numérique d’Excel pour la plage donnée. Pour plus d’informations sur la mise en forme des nombres Excel, consultez Codes de format de nombre. Effacé si null est transmis.

Méthodes

clearFormat()

Supprimez les propriétés de format d’une règle de mise en forme conditionnelle. Cela crée une règle sans paramètres de format.

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 d’origine Excel.ConditionalRangeFormat est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.ConditionalRangeFormatDataque ) 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é

borders

Collection d’objets de bordure qui s’appliquent à la plage de format conditionnel globale.

readonly borders: Excel.ConditionalRangeBorderCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

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é

fill

Renvoie l’objet de remplissage défini sur la plage de format conditionnel globale.

readonly fill: Excel.ConditionalRangeFill;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

font

Retourne l’objet de police défini sur la plage de format conditionnel globale.

readonly font: Excel.ConditionalRangeFont;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

numberFormat

Représente le code de format numérique d’Excel pour la plage donnée. Pour plus d’informations sur la mise en forme des nombres Excel, consultez Codes de format de nombre. Effacé si null est transmis.

numberFormat: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.6 ]

Détails de la méthode

clearFormat()

Supprimez les propriétés de format d’une règle de mise en forme conditionnelle. Cela crée une règle sans paramètres de format.

clearFormat(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.17 ]

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.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;

Paramètres

options
Excel.Interfaces.ConditionalRangeFormatLoadOptions

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

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

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

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

Paramètres

properties
Excel.Interfaces.ConditionalRangeFormatUpdateData

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

Paramètres

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

toJSON(): Excel.Interfaces.ConditionalRangeFormatData;

Retours