Excel.RangeFormat class

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é

Remarques

Jeu d’API : ExcelApi 1.9

Collection d’objets de bordure qui s’appliquent à l’ensemble de la plage.

readonly borders: Excel.RangeBorderCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Spécifie la largeur de toutes les colonnes dans la plage. Si la largeur des colonnes n’est pas uniforme, null est renvoyée.

columnWidth: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

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é

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

readonly fill: Excel.RangeFill;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

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

readonly font: Excel.RangeFont;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

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

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

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

indentLevel: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

readonly protection: Excel.FormatProtection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

L’ordre de lecture de la plage.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

rowHeight: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

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

shrinkToFit: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Orientation du texte de toutes les cellules dans 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 à l’intérieur d’une plage n’est pas uniforme, elle null est renvoyée.

textOrientation: number;

Valeur de propriété

Remarques

Jeu 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();
});

Détermine si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Renvoie true cette valeur si la hauteur de ligne de l’objet Range est égale à la hauteur standard de la feuille. Renvoie 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. Le définir sur n’a false aucun effet.

useStandardHeight: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Indique si la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Affiche true une valeur indique que la largeur de colonne de l’objet Range est égale à la largeur standard de la feuille. Renvoie des données null si la plage contient plusieurs colonnes et que les colonnes 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. Le définir sur n’a false aucun effet.

useStandardWidth: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Indique si Excel encapsule le texte dans l’objet. Une null valeur indique que toute la plage n’a pas de paramètre d’habillage uniforme

wrapText: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

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

adjustIndent(amount: number): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.11

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

Remarques

Jeu d’API : ExcelApi 1.2

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

Remarques

Jeu d’API : ExcelApi 1.2

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

Retours

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

Retours

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);
});

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

Retours

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

Paramètres

Retours

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

Retours

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

toJSON(): Excel.Interfaces.RangeFormatData;

Retours