Excel.HeaderFooterGroup class

Paket:

excel

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
defaultForAllPages	Die allgemeine Kopf-/Fußzeile, die für alle Seiten verwendet wird, sofern nicht gerade/ungerade oder erste Seite angegeben ist.
evenPages	Die für gerade Seiten zu verwendende Kopf-/Fußzeile, für ungerade Seiten muss die ungerade Kopf-/Fußzeile angegeben werden.
firstPage	Die Kopf-/Fußzeile der ersten Seite, für alle anderen Seiten werden die Einstellungen für die allgemeine oder gerade/ungerade Kopf-/Fußzeile verwendet.
oddPages	Die für ungerade Seiten zu verwendende Kopf-/Fußzeile, für gerade Seiten muss die gerade Kopf-/Fußzeile angegeben werden.
state	Der Zustand, in dem Kopf-/Fußzeilen festgelegt werden. Weitere Informationen finden Sie unter Excel.HeaderFooterState .
useSheetMargins	Gibt ein Flag an, das angibt, ob Kopf-/Fußzeilen an den Seitenrändern ausgerichtet sind, die in den Seitenlayoutoptionen für das Arbeitsblatt festgelegt sind.
useSheetScale	Gibt ein Flag an, das angibt, ob Kopf-/Fußzeilen um den Seitenprozentsatz skaliert werden sollen, der in den Seitenlayoutoptionen für das Arbeitsblatt festgelegt ist.

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

Details zur Eigenschaft

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

defaultForAllPages

Die allgemeine Kopf-/Fußzeile, die für alle Seiten verwendet wird, sofern nicht gerade/ungerade oder erste Seite angegeben ist.

readonly defaultForAllPages: Excel.HeaderFooter;

Eigenschaftswert

Excel.HeaderFooter

Hinweise

[ API-Satz: ExcelApi 1.9 ]

evenPages

Die für gerade Seiten zu verwendende Kopf-/Fußzeile, für ungerade Seiten muss die ungerade Kopf-/Fußzeile angegeben werden.

readonly evenPages: Excel.HeaderFooter;

Eigenschaftswert

Excel.HeaderFooter

Hinweise

[ API-Satz: ExcelApi 1.9 ]

firstPage

Die Kopf-/Fußzeile der ersten Seite, für alle anderen Seiten werden die Einstellungen für die allgemeine oder gerade/ungerade Kopf-/Fußzeile verwendet.

readonly firstPage: Excel.HeaderFooter;

Eigenschaftswert

Excel.HeaderFooter

Hinweise

[ API-Satz: ExcelApi 1.9 ]

oddPages

Die für ungerade Seiten zu verwendende Kopf-/Fußzeile, für gerade Seiten muss die gerade Kopf-/Fußzeile angegeben werden.

readonly oddPages: Excel.HeaderFooter;

Eigenschaftswert

Excel.HeaderFooter

Hinweise

[ API-Satz: ExcelApi 1.9 ]

state

Der Zustand, in dem Kopf-/Fußzeilen festgelegt werden. Weitere Informationen finden Sie unter Excel.HeaderFooterState .

state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";

Eigenschaftswert

Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

useSheetMargins

Gibt ein Flag an, das angibt, ob Kopf-/Fußzeilen an den Seitenrändern ausgerichtet sind, die in den Seitenlayoutoptionen für das Arbeitsblatt festgelegt sind.

useSheetMargins: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

useSheetScale

Gibt ein Flag an, das angibt, ob Kopf-/Fußzeilen um den Seitenprozentsatz skaliert werden sollen, der in den Seitenlayoutoptionen für das Arbeitsblatt festgelegt ist.

useSheetScale: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;

Parameter

options

Excel.Interfaces.HeaderFooterGroupLoadOptions

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

Gibt zurück

Excel.HeaderFooterGroup

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.HeaderFooterGroup

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

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

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

Parameter

properties

Excel.Interfaces.HeaderFooterGroupUpdateData

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

Parameter

properties

Excel.HeaderFooterGroup

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

toJSON(): Excel.Interfaces.HeaderFooterGroupData;

Gibt zurück

Excel.Interfaces.HeaderFooterGroupData