Excel.RangeFormat class

Paquet:

excel

Objet de format qui comprend les propriétés de police, de remplissage, de bordures, d’alignement et d’autres propriétés de la plage.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

borders	Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage.
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 globale.
font	Renvoie l’objet de police défini sur l’ensemble de la plage.
horizontalAlignment	Représente l’alignement horizontal de l’objet spécifié. Pour plus d’informations, consultez Excel.HorizontalAlignment .
verticalAlignment	Représente l’alignement vertical de l’objet spécifié. Pour plus d’informations, consultez Excel.VerticalAlignment .
wrapText	Spécifie si Excel encapsule le texte dans l’objet. Une null valeur indique que la plage entière n’a pas de paramètre d’habillage uniforme

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.RangeFormat d’origine est un objet API, la toJSON méthode retourne un objet JavaScript brut (tapé en tant Excel.Interfaces.RangeFormatDataque ) 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 à l’ensemble de la plage.

readonly borders: Excel.RangeBorderCollection;

Valeur de propriété

Excel.RangeBorderCollection

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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

fill

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

readonly fill: Excel.RangeFill;

Valeur de propriété

Excel.RangeFill

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

font

Renvoie l’objet de police défini sur l’ensemble de la plage.

readonly font: Excel.RangeFont;

Valeur de propriété

Excel.RangeFont

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

horizontalAlignment

Représente l’alignement horizontal de l’objet spécifié. Pour plus d’informations, consultez Excel.HorizontalAlignment .

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

Valeur de propriété

Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

verticalAlignment

Représente l’alignement vertical de l’objet spécifié. Pour plus d’informations, consultez Excel.VerticalAlignment .

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

Valeur de propriété

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

wrapText

Spécifie si Excel encapsule le texte dans l’objet. Une null valeur indique que la plage entière n’a pas de paramètre d’habillage uniforme

wrapText: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

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.RangeFormatLoadOptions): Excel.RangeFormat;

Paramètres

options

Excel.Interfaces.RangeFormatLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.RangeFormat

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

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.RangeFormat

Exemples

// Select all of the range's format properties.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load(["format/*", "format/fill", "format/borders", "format/font"]);
    await context.sync();
    
    console.log(range.format.wrapText);
    console.log(range.format.fill.color);
    console.log(range.format.font.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.RangeFormat;

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.RangeFormat

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

Paramètres

properties

Excel.Interfaces.RangeFormatUpdateData

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

Paramètres

properties

Excel.RangeFormat

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

toJSON(): Excel.Interfaces.RangeFormatData;

Retours

Excel.Interfaces.RangeFormatData