Excel.RangeBorderCollection class

Stellt die Rahmenobjekte dar, aus denen der Bereichsrahmen besteht.

Extends

Hinweise

[API-Satz: ExcelApi 1.1 ]

Eigenschaften

context

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

count

Die Anzahl der Rahmen-Objekte in der Auflistung.

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

tintAndShade

Gibt einen Double-Wert an, der eine Farbe für Bereichsrahmen aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellster), mit 0 für die Originalfarbe. Ein null Wert gibt an, dass die gesamte Rahmensammlung keine einheitliche tintAndShade Einstellung aufweist.

Methoden

getItem(index)

Ruft ein Rahmen-Objekt ab, das den Namen verwendet

getItem(indexString)

Ruft ein Rahmen-Objekt ab, das den Namen verwendet

getItemAt(index)

Ruft ein Rahmen-Objekt ab, das den Namen verwendet

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.

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeBorderCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Excel.Interfaces.RangeBorderCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

count

Die Anzahl der Rahmen-Objekte in der Auflistung.

readonly count: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.1 ]

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.RangeBorder[];

Eigenschaftswert

tintAndShade

Gibt einen Double-Wert an, der eine Farbe für Bereichsrahmen aufhellt oder abdunkelt. Der Wert liegt zwischen -1 (dunkelster) und 1 (hellster), mit 0 für die Originalfarbe. Ein null Wert gibt an, dass die gesamte Rahmensammlung keine einheitliche tintAndShade Einstellung aufweist.

tintAndShade: number;

Eigenschaftswert

number

Hinweise

[API-Satz: ExcelApi 1.9 ]

Details zur Methode

getItem(index)

Ruft ein Rahmen-Objekt ab, das den Namen verwendet

getItem(index: Excel.BorderIndex): Excel.RangeBorder;

Parameter

index
Excel.BorderIndex

Index-Wert des abzurufenden Rahmen-Objekts. Weitere Informationen finden Sie Excel.BorderIndex unter.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1 ]

Beispiele

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var borderName = 'EdgeTop';
    var border = range.format.borders.getItem(borderName);
    border.load('style');
    return ctx.sync().then(function() {
            console.log(border.style);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getItem(indexString)

Ruft ein Rahmen-Objekt ab, das den Namen verwendet

getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;

Parameter

indexString

"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

Index-Wert des abzurufenden Rahmen-Objekts. Weitere Informationen finden Sie Excel.BorderIndex unter.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1 ]

getItemAt(index)

Ruft ein Rahmen-Objekt ab, das den Namen verwendet

getItemAt(index: number): Excel.RangeBorder;

Parameter

index

number

Index-Wert des abzurufenden Objekts. Nullindiziert.

Gibt zurück

Hinweise

[API-Satz: ExcelApi 1.1 ]

Beispiele

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var border = range.format.borders.getItemAt(0);
    border.load('sideIndex');
    return ctx.sync().then(function() {
        console.log(border.sideIndex);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection;

Parameter

options

Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Stellt Optionen bereit, für welche Eigenschaften des Objekts geladen werden soll.

Gibt zurück

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Beispiele

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var borders = range.format.borders;
    border.load('items');
    return ctx.sync().then(function() {
        console.log(borders.count);
        for (var i = 0; i < borders.items.length; i++) {
            console.log(borders.items[i].sideIndex);
        }
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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?: OfficeExtension.LoadOption): Excel.RangeBorderCollection;

Parameter

propertyNamesAndPaths
OfficeExtension.LoadOption

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

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während das ursprüngliche Excel.RangeBorderCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Excel.Interfaces.RangeBorderCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.RangeBorderCollectionData;

Gibt zurück