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

autoIndent	Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale.
borders	Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage.
columnWidth	Spécifie la largeur de toutes les colonnes de la plage. Si les largeurs de colonne ne sont pas uniformes, null est retourné.
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 .
indentLevel	Entier compris entre 0 à 250 qui indique le niveau de retrait du style.
protection	Renvoie l’objet de protection du format pour une plage.
readingOrder	L’ordre de lecture de la plage.
rowHeight	Hauteur de toutes les lignes de la plage. Si les hauteurs de ligne ne sont pas uniformes, null est retourné.
shrinkToFit	Spécifie si le texte se réduit automatiquement pour s’adapter à la largeur de colonne disponible.
textOrientation	Orientation du texte de toutes les cellules de la plage. L’orientation du texte doit être un entier compris entre -90 et 90, ou 180 pour le texte orienté verticalement. Si l’orientation au sein d’une plage n’est pas uniforme, null elle est retournée.
useStandardHeight	Détermine si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Retourne true si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Retourne null si la plage contient plusieurs lignes et que les lignes n’ont pas toutes la même hauteur. Retourne false dans le cas contraire. Remarque : cette propriété est uniquement destinée à être définie sur true. La définition de la valeur false sur n’a aucun effet.
useStandardWidth	Spécifie si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Retourne true si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Retourne null si la plage contient plusieurs colonnes et que les colonnes ne sont pas toutes de la même hauteur. Retourne false dans le cas contraire. Remarque : cette propriété est uniquement destinée à être définie sur true. La définition de la valeur false sur n’a aucun effet.
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

adjustIndent(amount)	Ajuste la mise en retrait de la mise en forme de la plage. La valeur de retrait est comprise entre 0 et 250 et est mesurée en caractères.
autofitColumns()	Modifie la largeur des colonnes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.
autofitRows()	Modifie la hauteur des lignes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.
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.RangeFormat est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé 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é

autoIndent

Spécifie si le texte est automatiquement mis en retrait lorsque l’alignement du texte est défini sur une distribution égale.

autoIndent: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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 ]

columnWidth

Spécifie la largeur de toutes les colonnes de la plage. Si les largeurs de colonne ne sont pas uniformes, null est retourné.

columnWidth: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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 ]

indentLevel

Entier compris entre 0 à 250 qui indique le niveau de retrait du style.

indentLevel: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

protection

Renvoie l’objet de protection du format pour une plage.

readonly protection: Excel.FormatProtection;

Valeur de propriété

Excel.FormatProtection

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

readingOrder

L’ordre de lecture de la plage.

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Valeur de propriété

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

rowHeight

Hauteur de toutes les lignes de la plage. Si les hauteurs de ligne ne sont pas uniformes, null est retourné.

rowHeight: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

shrinkToFit

Spécifie si le texte se réduit automatiquement pour s’adapter à la largeur de colonne disponible.

shrinkToFit: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

textOrientation

Orientation du texte de toutes les cellules de la plage. L’orientation du texte doit être un entier compris entre -90 et 90, ou 180 pour le texte orienté verticalement. Si l’orientation au sein d’une plage n’est pas uniforme, null elle est retournée.

textOrientation: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-text-orientation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:E2");

    // Set textOrientation to either an integer between -90 and 90
    // or to 180 for vertically-oriented text.
    range.format.textOrientation = 90;

    await context.sync();
});

useStandardHeight

Détermine si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Retourne true si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Retourne null si la plage contient plusieurs lignes et que les lignes n’ont pas toutes la même hauteur. Retourne false dans le cas contraire. Remarque : cette propriété est uniquement destinée à être définie sur true. La définition de la valeur false sur n’a aucun effet.

useStandardHeight: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

useStandardWidth

Spécifie si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Retourne true si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Retourne null si la plage contient plusieurs colonnes et que les colonnes ne sont pas toutes de la même hauteur. Retourne false dans le cas contraire. Remarque : cette propriété est uniquement destinée à être définie sur true. La définition de la valeur false sur n’a aucun effet.

useStandardWidth: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

adjustIndent(amount)

Ajuste la mise en retrait de la mise en forme de la plage. La valeur de retrait est comprise entre 0 et 250 et est mesurée en caractères.

adjustIndent(amount: number): void;

Paramètres

amount

number

Nombre d’espaces de caractères par lesquels le retrait actuel est ajusté. Cette valeur doit être comprise entre -250 et 250. Remarque : Si le montant augmente le niveau de retrait au-dessus de 250, le niveau de retrait reste avec 250. De même, si le montant abaisse le niveau de retrait en dessous de 0, le niveau de retrait reste 0.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

autofitColumns()

Modifie la largeur des colonnes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.

autofitColumns(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

autofitRows()

Modifie la hauteur des lignes de la plage active pour obtenir le meilleur ajustement, en fonction des données présentes dans les colonnes.

autofitRows(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

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