Freigeben über


Excel.HeaderFooterPicture class

Stellt ein Bild in der Kopf- oder Fußzeile eines Arbeitsblatts dar.

Extends

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

Eigenschaften

brightness

Gibt die Helligkeit des Bilds an. Der Wert für diese Eigenschaft muss im Bereich von 0,0 (stark abgetönt) bis 1,0 (sehr hell) liegen. Lese-/Schreibzugriff.

colorType

Gibt den Typ der Farbtransformation des Bilds an.

context

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

contrast

Gibt den Kontrast des Bilds an. Der Wert für diese Eigenschaft muss eine Zahl von 0,0 (geringster Kontrast) bis 1,0 (der größte Kontrast) sein.

cropBottom

Gibt die Anzahl der Punkte an, die am unteren Rand des Bilds zugeschnitten werden.

cropLeft

Gibt die Anzahl der Punkte an, die von der linken Seite des Bilds abgeschnitten werden.

cropRight

Gibt die Anzahl der Punkte an, die von der rechten Seite des Bilds abgeschnitten werden.

cropTop

Gibt die Anzahl der Punkte an, die am oberen Rand des Bilds zugeschnitten werden.

filename

Gibt die URL (im Intranet oder im Web) oder den Pfad (lokal oder netzwerk) zu dem Speicherort an, an dem das Quellobjekt gespeichert ist.

height

Gibt die Höhe des Bilds in Punkt an.

lockAspectRatio

Gibt einen Wert an, der angibt, ob das Bild seine ursprünglichen Proportionen beibehält, wenn die Größe geändert wird. true , wenn sie ihre Proportionen behält; falseandernfalls .

width

Gibt die Breite des Bilds in Punkt an.

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

Details zur Eigenschaft

brightness

Gibt die Helligkeit des Bilds an. Der Wert für diese Eigenschaft muss im Bereich von 0,0 (stark abgetönt) bis 1,0 (sehr hell) liegen. Lese-/Schreibzugriff.

brightness: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

colorType

Gibt den Typ der Farbtransformation des Bilds an.

colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";

Eigenschaftswert

Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"

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

contrast

Gibt den Kontrast des Bilds an. Der Wert für diese Eigenschaft muss eine Zahl von 0,0 (geringster Kontrast) bis 1,0 (der größte Kontrast) sein.

contrast: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

cropBottom

Gibt die Anzahl der Punkte an, die am unteren Rand des Bilds zugeschnitten werden.

cropBottom: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

cropLeft

Gibt die Anzahl der Punkte an, die von der linken Seite des Bilds abgeschnitten werden.

cropLeft: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

cropRight

Gibt die Anzahl der Punkte an, die von der rechten Seite des Bilds abgeschnitten werden.

cropRight: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

cropTop

Gibt die Anzahl der Punkte an, die am oberen Rand des Bilds zugeschnitten werden.

cropTop: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

filename

Gibt die URL (im Intranet oder im Web) oder den Pfad (lokal oder netzwerk) zu dem Speicherort an, an dem das Quellobjekt gespeichert ist.

filename: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

height

Gibt die Höhe des Bilds in Punkt an.

height: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

lockAspectRatio

Gibt einen Wert an, der angibt, ob das Bild seine ursprünglichen Proportionen beibehält, wenn die Größe geändert wird. true , wenn sie ihre Proportionen behält; falseandernfalls .

lockAspectRatio: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApiDesktop 1.1 ]

width

Gibt die Breite des Bilds in Punkt an.

width: number;

Eigenschaftswert

number

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.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;

Parameter

options
Excel.Interfaces.HeaderFooterPictureLoadOptions

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

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

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

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

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

Parameter

properties
Excel.Interfaces.HeaderFooterPictureUpdateData

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

Parameter

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

toJSON(): Excel.Interfaces.HeaderFooterPictureData;

Gibt zurück