Excel.HeaderFooterGroup class

Extends

Propriétés

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

defaultForAllPages

L’en-tête/pied de page, utilisé pour toutes les pages, sauf si la première page ou page impaire/paire est spécifiée.

evenPages

L’en-tête/le pied de page à utiliser pour les pages paires, en-tête/pied de page impaire doit être spécifié pour les pages impaires.

firstPage

La première en-tête/le premier pied de page, pour toutes les autres pages générales ou impair/pair est utilisé.

oddPages

L’en-tête/le pied de page à utiliser pour les pages paires, l’en-tête/pied de page paire doit être spécifié pour les pages paires.

state

État selon lequel les en-têtes/pieds de page sont définis. Pour Excel.HeaderFooterState plus de détails.

useSheetMargins

Spécifie un indicateur indiquant si les en-têtes/pieds de page sont alignés sur les marges de page définies dans les options de mise en page de la feuille de calcul.

useSheetScale

Spécifie un indicateur indiquant si les en-têtes/pieds de page doivent être mis à l’échelle selon le pourcentage d’échelle de page défini dans les options de mise en page de la feuille de calcul.

Méthodes

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.HeaderFooterGroup est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.HeaderFooterGroupDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

defaultForAllPages

L’en-tête/pied de page, utilisé pour toutes les pages, sauf si la première page ou page impaire/paire est spécifiée.

readonly defaultForAllPages: Excel.HeaderFooter;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

evenPages

L’en-tête/le pied de page à utiliser pour les pages paires, en-tête/pied de page impaire doit être spécifié pour les pages impaires.

readonly evenPages: Excel.HeaderFooter;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

firstPage

La première en-tête/le premier pied de page, pour toutes les autres pages générales ou impair/pair est utilisé.

readonly firstPage: Excel.HeaderFooter;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

oddPages

L’en-tête/le pied de page à utiliser pour les pages paires, l’en-tête/pied de page paire doit être spécifié pour les pages paires.

readonly oddPages: Excel.HeaderFooter;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

state

État selon lequel les en-têtes/pieds de page sont définis. Pour Excel.HeaderFooterState plus de détails.

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

Valeur de propriété

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

Remarques

Jeu d’API : ExcelApi 1.9

useSheetMargins

Spécifie un indicateur indiquant si les en-têtes/pieds de page sont alignés sur les marges de page définies dans les options de mise en page de la feuille de calcul.

useSheetMargins: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

useSheetScale

Spécifie un indicateur indiquant si les en-têtes/pieds de page doivent être mis à l’échelle selon le pourcentage d’échelle de page défini dans les options de mise en page de la feuille de calcul.

useSheetScale: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

Détails de la méthode

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;

Paramètres

options
Excel.Interfaces.HeaderFooterGroupLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.HeaderFooterGroup;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.HeaderFooterGroup;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.HeaderFooterGroupUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.HeaderFooterGroupUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.HeaderFooterGroup): void;

Paramètres

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.HeaderFooterGroup est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.HeaderFooterGroupDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.HeaderFooterGroupData;

Retours