Excel.HeaderFooter class

Paket:

excel

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

centerFooter	Die mittlere Fußzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.
centerFooterPicture	Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den mittleren Abschnitt der Fußzeile darstellt.
centerHeader	Die mittlere Kopfzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.
centerHeaderPicture	Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den mittleren Abschnitt der Kopfzeile darstellt.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
leftFooter	Die linke Fußzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.
leftFooterPicture	Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den linken Abschnitt der Fußzeile darstellt.
leftHeader	Die linke Kopfzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.
leftHeaderPicture	Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den linken Abschnitt der Kopfzeile darstellt.
rightFooter	Die rechte Fußzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.
rightFooterPicture	Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den rechten Abschnitt der Fußzeile darstellt.
rightHeader	Die rechte Kopfzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.
rightHeaderPicture	Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den rechten Abschnitt der Kopfzeile darstellt.

Methoden

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.HeaderFooter Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.HeaderFooterData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

centerFooter

Die mittlere Fußzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.

centerFooter: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

centerFooterPicture

Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den mittleren Abschnitt der Fußzeile darstellt.

readonly centerFooterPicture: Excel.HeaderFooterPicture;

Eigenschaftswert

Excel.HeaderFooterPicture

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

centerHeader

Die mittlere Kopfzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.

centerHeader: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

centerHeaderPicture

Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den mittleren Abschnitt der Kopfzeile darstellt.

readonly centerHeaderPicture: Excel.HeaderFooterPicture;

Eigenschaftswert

Excel.HeaderFooterPicture

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

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

leftFooter

Die linke Fußzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.

leftFooter: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

leftFooterPicture

Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den linken Abschnitt der Fußzeile darstellt.

readonly leftFooterPicture: Excel.HeaderFooterPicture;

Eigenschaftswert

Excel.HeaderFooterPicture

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

leftHeader

Die linke Kopfzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.

leftHeader: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

leftHeaderPicture

Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den linken Abschnitt der Kopfzeile darstellt.

readonly leftHeaderPicture: Excel.HeaderFooterPicture;

Eigenschaftswert

Excel.HeaderFooterPicture

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

rightFooter

Die rechte Fußzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.

rightFooter: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

rightFooterPicture

Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den rechten Abschnitt der Fußzeile darstellt.

readonly rightFooterPicture: Excel.HeaderFooterPicture;

Eigenschaftswert

Excel.HeaderFooterPicture

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

rightHeader

Die rechte Kopfzeile des Arbeitsblatts. Verwenden Sie die hier angegebenen Formatcodes, um die Schriftartformatierung anzuwenden oder einen Variablenwert einzufügen: https://msdn.microsoft.com/library/bb225426.aspx.

rightHeader: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.9 ]

rightHeaderPicture

Ruft ein HeaderFooterPicture -Objekt ab, das das Bild für den rechten Abschnitt der Kopfzeile darstellt.

readonly rightHeaderPicture: Excel.HeaderFooterPicture;

Eigenschaftswert

Excel.HeaderFooterPicture

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

Details zur Methode

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.HeaderFooterLoadOptions): Excel.HeaderFooter;

Parameter

options

Excel.Interfaces.HeaderFooterLoadOptions

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

Gibt zurück

Excel.HeaderFooter

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.HeaderFooter

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

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

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

Parameter

properties

Excel.Interfaces.HeaderFooterUpdateData

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.HeaderFooter): void;

Parameter

properties

Excel.HeaderFooter

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.HeaderFooter Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.HeaderFooterData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.HeaderFooterData;

Gibt zurück

Excel.Interfaces.HeaderFooterData