Excel.HeaderFooterGroup class
- Extends
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| default |
Die allgemeine Kopf-/Fußzeile, die für alle Seiten verwendet wird, sofern nicht gerade/ungerade oder erste Seite angegeben ist. |
| even |
Die für gerade Seiten zu verwendende Kopf-/Fußzeile, für ungerade Seiten muss die ungerade Kopf-/Fußzeile angegeben werden. |
| first |
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. |
| odd |
Die für ungerade Seiten zu verwendende Kopf-/Fußzeile, für gerade Seiten muss die gerade Kopf-/Fußzeile angegeben werden. |
| state | Der Status, mit dem Kopf- und Fußzeilen festgelegt werden. Weitere Informationen findest du hier |
| use |
Gibt ein Kennzeichen an, das angibt, ob Kopf-/Fußzeilen an den Seitenrändern ausgerichtet sind, die in den Seitenlayoutoptionen für das Arbeitsblatt festgelegt wurden. |
| use |
Gibt ein Flag an, das angibt, ob Kopf-/Fußzeilen mit der in den Seitenlayoutoptionen für das Arbeitsblatt festgelegten prozentualen Seitenskalierung skaliert werden sollen. |
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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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 |
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
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
Hinweise
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
Hinweise
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
Hinweise
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
Hinweise
state
Der Status, mit dem Kopf- und Fußzeilen festgelegt werden. Weitere Informationen findest du hier Excel.HeaderFooterState .
state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";
Eigenschaftswert
Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"
Hinweise
useSheetMargins
Gibt ein Kennzeichen an, das angibt, ob Kopf-/Fußzeilen an den Seitenrändern ausgerichtet sind, die in den Seitenlayoutoptionen für das Arbeitsblatt festgelegt wurden.
useSheetMargins: boolean;
Eigenschaftswert
boolean
Hinweise
useSheetScale
Gibt ein Flag an, das angibt, ob Kopf-/Fußzeilen mit der in den Seitenlayoutoptionen für das Arbeitsblatt festgelegten prozentualen Seitenskalierung skaliert werden sollen.
useSheetScale: boolean;
Eigenschaftswert
boolean
Hinweise
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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.HeaderFooterGroup;
Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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 sie übergeben wird.) Während das ursprüngliche Excel.HeaderFooterGroup Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.HeaderFooterGroupData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.HeaderFooterGroupData;