Excel.RangeFormat class

Auflistung von Border-Objekten, die für den gesamten ausgewählten Bereich gelten.

readonly borders: Excel.RangeBorderCollection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Gibt die Breite aller Spalten innerhalb des Bereichs an. Wenn die Spaltenbreiten nicht einheitlich sind, null wird zurückgegeben.

columnWidth: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt das Fill-Objekt an, das für den gesamten Bereich definiert ist.

readonly fill: Excel.RangeFill;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Gibt das Font-Objekt an, das für den gesamten Bereich definiert ist.

readonly font: Excel.RangeFont;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Stellt die horizontale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter Excel.HorizontalAlignment .

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Gibt das Formatschutz-Objekt für einen Bereich zurück.

readonly protection: Excel.FormatProtection;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Die Höhe aller Zeilen im Bereich. Wenn die Zeilenhöhen nicht einheitlich sind, null wird zurückgegeben.

rowHeight: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Stellt die vertikale Ausrichtung für das angegebene Objekt dar. Weitere Informationen finden Sie unter Excel.VerticalAlignment .

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Gibt an, ob Excel den Text im -Objekt umschließt. Ein null -Wert gibt an, dass der gesamte Bereich keine einheitliche Umbrucheinstellung aufweist.

wrapText: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Ändert die Breite der Spalten des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Spalten die optimale Breite zu erzielen.

autofitColumns(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Ändert die Höhe der Zeilen des aktuellen Bereichs, um basierend auf den aktuellen Daten in den Zeilen die optimale Höhe zu erzielen.

autofitRows(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.RangeFormatLoadOptions): Excel.RangeFormat;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.RangeFormat;

Parameter

Gibt zurück

Beispiele

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

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeFormat;

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.RangeFormat): void;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.RangeFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.RangeFormatData;

Gibt zurück