Freigeben über

Excel.RangeFormat class

  • Referenz
Paket:
excel

Gibt ein Formatobjekt zurück, das die Schriftart des Bereichs, Füllung, Rahmen, die Ausrichtung und andere Eigenschaften verschachtelt.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

autoIndent

Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist.
borders

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

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

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

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

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

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

Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt.
protection

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

Die Leserichtung für den Bereich.
rowHeight

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

Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.
textOrientation

Die Textausrichtung aller Zellen innerhalb des Bereichs. Die Textausrichtung sollte eine ganze Zahl zwischen -90 und 90 oder 180 für vertikal ausgerichteten Text sein. Wenn die Ausrichtung innerhalb eines Bereichs nicht einheitlich ist, null wird zurückgegeben.
useStandardHeight

Bestimmt, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt zurück true , wenn die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt zurück null , wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück false . Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.
useStandardWidth

Gibt an, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt zurück true , wenn die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt zurück null , wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück false . Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.
verticalAlignment

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

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

Methoden

adjustIndent(amount)

Passt den Einzug der Bereichsformatierung an. Der Einzugswert reicht von 0 bis 250 und wird in Zeichen gemessen.
autofitColumns()

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

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

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)

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)

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.
set(properties, options)

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)

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

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

Details zur Eigenschaft

autoIndent

Gibt an, ob Text automatisch eingezogen wird, wenn die Textausrichtung auf die gleiche Verteilung festgelegt ist.

autoIndent: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

borders

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

readonly borders: Excel.RangeBorderCollection;

Eigenschaftswert

Excel.RangeBorderCollection

Hinweise

[ API-Satz: ExcelApi 1.1 ]

columnWidth

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

columnWidth: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.2 ]

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

fill

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

readonly fill: Excel.RangeFill;

Eigenschaftswert

Excel.RangeFill

Hinweise

[ API-Satz: ExcelApi 1.1 ]

font

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

readonly font: Excel.RangeFont;

Eigenschaftswert

Excel.RangeFont

Hinweise

[ API-Satz: ExcelApi 1.1 ]

horizontalAlignment

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

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

Hinweise

[ API-Satz: ExcelApi 1.1 ]

indentLevel

Eine ganze Zahl zwischen 0 und 250, die die Einzugsebene angibt.

indentLevel: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

protection

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

readonly protection: Excel.FormatProtection;

Eigenschaftswert

Excel.FormatProtection

Hinweise

[ API-Satz: ExcelApi 1.2 ]

readingOrder

Die Leserichtung für den Bereich.

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

rowHeight

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

rowHeight: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.2 ]

shrinkToFit

Gibt an, ob der Text automatisch verkleinert wird, um in die verfügbare Spaltenbreite einzupassen.

shrinkToFit: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

textOrientation

Die Textausrichtung aller Zellen innerhalb des Bereichs. Die Textausrichtung sollte eine ganze Zahl zwischen -90 und 90 oder 180 für vertikal ausgerichteten Text sein. Wenn die Ausrichtung innerhalb eines Bereichs nicht einheitlich ist, null wird zurückgegeben.

textOrientation: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Beispiele

// 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

Bestimmt, ob die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt zurück true , wenn die Zeilenhöhe des Range Objekts der Standardhöhe des Blatts entspricht. Gibt zurück null , wenn der Bereich mehr als eine Zeile enthält und die Zeilen nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück false . Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.

useStandardHeight: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

useStandardWidth

Gibt an, ob die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt zurück true , wenn die Spaltenbreite des Range Objekts der Standardbreite des Blatts entspricht. Gibt zurück null , wenn der Bereich mehr als eine Spalte enthält und die Spalten nicht alle dieselbe Höhe aufweisen. Gibt andernfalls zurück false . Hinweis: Diese Eigenschaft soll nur auf truefestgelegt werden. Das Festlegen auf hat false keine Auswirkungen.

useStandardWidth: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

verticalAlignment

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

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

Hinweise

[ API-Satz: ExcelApi 1.1 ]

wrapText

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

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Details zur Methode

adjustIndent(amount)

Passt den Einzug der Bereichsformatierung an. Der Einzugswert reicht von 0 bis 250 und wird in Zeichen gemessen.

adjustIndent(amount: number): void;

Parameter

amount

number

Die Anzahl der Zeichenräume, um die der aktuelle Einzug angepasst wird. Dieser Wert sollte zwischen -250 und 250 sein. Hinweis: Wenn der Betrag die Einzugsebene über 250 erhöhen würde, bleibt die Einzugsebene bei 250. Wenn der Betrag die Einzugsebene unter 0 senken würde, bleibt die Einzugsebene 0.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.11 ]

autofitColumns()

Ä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

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

autofitRows()

Ä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

void

Hinweise

[ API-Satz: ExcelApi 1.2 ]

load(options)

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

options
Excel.Interfaces.RangeFormatLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.RangeFormat

load(propertyNames)

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

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.RangeFormat

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.RangeFormat

set(properties, options)

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

properties
Excel.Interfaces.RangeFormatUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

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

set(properties: Excel.RangeFormat): void;

Parameter

properties
Excel.RangeFormat

Gibt zurück

void

toJSON()

Ü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

Excel.Interfaces.RangeFormatData