Partager via

Excel.PageLayout class

  • Référence
Paquet:
excel

Représente les paramètres de disposition et d’impression qui ne dépendent d’aucune implémentation spécifique à l’imprimante. Ces paramètres incluent marges, orientation, numérotation, lignes de titre et zone d’impression.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

blackAndWhite

Option d’impression en noir et blanc de la feuille de calcul.
bottomMargin

Marge de page inférieure de la feuille de calcul à utiliser pour l’impression en points.
centerHorizontally

Indicateur du centre de la feuille de calcul horizontalement. Cet indicateur détermine si la feuille de calcul est centrée horizontalement lorsqu’elle est imprimée.
centerVertically

Indicateur vertical central de la feuille de calcul. Cet indicateur détermine si la feuille de calcul est centrée verticalement lorsqu’elle est imprimée.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
draftMode

Option de mode brouillon de la feuille de calcul. Si truela valeur est , la feuille est imprimée sans graphique.
firstPageNumber

Numéro de la première page de la feuille de calcul à imprimer. Une null valeur représente la numérotation « automatique » des pages.
footerMargin

Marge de pied de page de la feuille de calcul, en points, à utiliser lors de l’impression.
headerMargin

Marge d’en-tête de la feuille de calcul, en points, à utiliser lors de l’impression.
headersFooters

Configuration de l’en-tête et pied de page de la feuille de calcul.
leftMargin

Marge gauche de la feuille de calcul, en points, à utiliser lors de l’impression.
orientation

Orientation de la feuille de calcul de la page.
paperSize

Format de papier de la feuille de calcul de la page.
printComments

Spécifie si les commentaires de la feuille de calcul doivent être affichés lors de l’impression.
printErrors

Option erreurs d’impression de la feuille de calcul.
printGridlines

Spécifie si le quadrillage de la feuille de calcul sera imprimé.
printHeadings

Spécifie si les en-têtes de la feuille de calcul seront imprimés.
printOrder

Option d’ordre d’impression de page de la feuille de calcul. Cela indique l’ordre à utiliser pour traiter le numéro de page imprimé.
rightMargin

Marge droite de la feuille de calcul, en points, à utiliser lors de l’impression.
topMargin

Marge supérieure de la feuille de calcul, en points, à utiliser lors de l’impression.
zoom

Options de zoom d’impression de la feuille de calcul. L’objet PageLayoutZoomOptions doit être défini en tant qu’objet JSON (utilisez x.zoom = {...} au lieu de x.zoom.scale = ...).

Méthodes

getPrintArea()

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente la zone d’impression de la feuille de calcul. S’il n’y a pas de zone d’impression, une ItemNotFound erreur est générée.
getPrintAreaOrNullObject()

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente la zone d’impression de la feuille de calcul. S’il n’y a pas de zone d’impression, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getPrintTitleColumns()

Obtient l’objet plage représentant les colonnes de titre.
getPrintTitleColumnsOrNullObject()

Obtient l’objet plage représentant les colonnes de titre. Si elle n’est pas définie, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getPrintTitleRows()

Obtient l’objet plage représentant les rangées de titre.
getPrintTitleRowsOrNullObject()

Obtient l’objet plage représentant les rangées de titre. Si elle n’est pas définie, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
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 passer un objet brut avec les propriétés appropriées ou 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.
setPrintArea(printArea)

Définit la zone d’impression de la feuille de calcul.
setPrintMargins(unit, marginOptions)

Définit les marges de page de la feuille de calcul avec des unités.
setPrintMargins(unitString, marginOptions)

Définit les marges de page de la feuille de calcul avec des unités.
setPrintTitleColumns(printTitleColumns)

Définit les colonnes qui contiennent des cellules répétées à gauche de chaque page de la feuille de calcul pour l’impression.
setPrintTitleRows(printTitleRows)

Définit les rangées qui contiennent des cellules répétées en haut de chaque page de la feuille de calcul pour l’impression.
toJSON()

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

Détails de la propriété

blackAndWhite

Option d’impression en noir et blanc de la feuille de calcul.

blackAndWhite: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

bottomMargin

Marge de page inférieure de la feuille de calcul à utiliser pour l’impression en points.

bottomMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

centerHorizontally

Indicateur du centre de la feuille de calcul horizontalement. Cet indicateur détermine si la feuille de calcul est centrée horizontalement lorsqu’elle est imprimée.

centerHorizontally: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.centerHorizontally = true;
    farmSheet.pageLayout.centerVertically = true;
    await context.sync();
});

centerVertically

Indicateur vertical central de la feuille de calcul. Cet indicateur détermine si la feuille de calcul est centrée verticalement lorsqu’elle est imprimée.

centerVertically: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.centerHorizontally = true;
    farmSheet.pageLayout.centerVertically = true;
    await context.sync();
});

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

draftMode

Option de mode brouillon de la feuille de calcul. Si truela valeur est , la feuille est imprimée sans graphique.

draftMode: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

firstPageNumber

Numéro de la première page de la feuille de calcul à imprimer. Une null valeur représente la numérotation « automatique » des pages.

firstPageNumber: number | "";

Valeur de propriété

number | ""

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

footerMargin

Marge de pied de page de la feuille de calcul, en points, à utiliser lors de l’impression.

footerMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

headerMargin

Marge d’en-tête de la feuille de calcul, en points, à utiliser lors de l’impression.

headerMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

headersFooters

Configuration de l’en-tête et pied de page de la feuille de calcul.

readonly headersFooters: Excel.HeaderFooterGroup;

Valeur de propriété

Excel.HeaderFooterGroup

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

leftMargin

Marge gauche de la feuille de calcul, en points, à utiliser lors de l’impression.

leftMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

orientation

Orientation de la feuille de calcul de la page.

orientation: Excel.PageOrientation | "Portrait" | "Landscape";

Valeur de propriété

Excel.PageOrientation | "Portrait" | "Landscape"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.orientation = Excel.PageOrientation.landscape;
    await context.sync();
});

paperSize

Format de papier de la feuille de calcul de la page.

paperSize: Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman";

Valeur de propriété

Excel.PaperType | "Letter" | "LetterSmall" | "Tabloid" | "Ledger" | "Legal" | "Statement" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "Folio" | "Quatro" | "Paper10x14" | "Paper11x17" | "Note" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "Csheet" | "Dsheet" | "Esheet" | "EnvelopeDL" | "EnvelopeC5" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "FanfoldUS" | "FanfoldStdGerman" | "FanfoldLegalGerman"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

printComments

Spécifie si les commentaires de la feuille de calcul doivent être affichés lors de l’impression.

printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";

Valeur de propriété

Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

printErrors

Option erreurs d’impression de la feuille de calcul.

printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";

Valeur de propriété

Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

printGridlines

Spécifie si le quadrillage de la feuille de calcul sera imprimé.

printGridlines: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

printHeadings

Spécifie si les en-têtes de la feuille de calcul seront imprimés.

printHeadings: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

printOrder

Option d’ordre d’impression de page de la feuille de calcul. Cela indique l’ordre à utiliser pour traiter le numéro de page imprimé.

printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";

Valeur de propriété

Excel.PrintOrder | "DownThenOver" | "OverThenDown"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

rightMargin

Marge droite de la feuille de calcul, en points, à utiliser lors de l’impression.

rightMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

topMargin

Marge supérieure de la feuille de calcul, en points, à utiliser lors de l’impression.

topMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

zoom

Options de zoom d’impression de la feuille de calcul. L’objet PageLayoutZoomOptions doit être défini en tant qu’objet JSON (utilisez x.zoom = {...} au lieu de x.zoom.scale = ...).

zoom: Excel.PageLayoutZoomOptions;

Valeur de propriété

Excel.PageLayoutZoomOptions

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.zoom = { scale: 200 };
    await context.sync();
});

Détails de la méthode

getPrintArea()

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente la zone d’impression de la feuille de calcul. S’il n’y a pas de zone d’impression, une ItemNotFound erreur est générée.

getPrintArea(): Excel.RangeAreas;

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getPrintAreaOrNullObject()

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente la zone d’impression de la feuille de calcul. S’il n’y a pas de zone d’impression, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getPrintAreaOrNullObject(): Excel.RangeAreas;

Retours

Excel.RangeAreas

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getPrintTitleColumns()

Obtient l’objet plage représentant les colonnes de titre.

getPrintTitleColumns(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getPrintTitleColumnsOrNullObject()

Obtient l’objet plage représentant les colonnes de titre. Si elle n’est pas définie, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getPrintTitleColumnsOrNullObject(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getPrintTitleRows()

Obtient l’objet plage représentant les rangées de titre.

getPrintTitleRows(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

getPrintTitleRowsOrNullObject()

Obtient l’objet plage représentant les rangées de titre. Si elle n’est pas définie, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getPrintTitleRowsOrNullObject(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

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.PageLayoutLoadOptions): Excel.PageLayout;

Paramètres

options
Excel.Interfaces.PageLayoutLoadOptions

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

Retours

Excel.PageLayout

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

Paramètres

propertyNames

string | string[]

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

Retours

Excel.PageLayout

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

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

Excel.PageLayout

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties
Excel.Interfaces.PageLayoutUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.PageLayout): void;

Paramètres

properties
Excel.PageLayout

Retours

void

setPrintArea(printArea)

Définit la zone d’impression de la feuille de calcul.

setPrintArea(printArea: Range | RangeAreas | string): void;

Paramètres

printArea

Excel.Range | Excel.RangeAreas | string

Plage(s) du contenu à imprimer.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.setPrintArea("A1:D41");
    await context.sync();
});

setPrintMargins(unit, marginOptions)

Définit les marges de page de la feuille de calcul avec des unités.

setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions): void;

Paramètres

unit
Excel.PrintMarginUnit

Unité de mesure pour les marges fournies.

marginOptions
Excel.PageLayoutMarginOptions

Valeurs de marge à définir. Les marges non fournies restent inchangées.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

setPrintMargins(unitString, marginOptions)

Définit les marges de page de la feuille de calcul avec des unités.

setPrintMargins(unitString: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;

Paramètres

unitString

"Points" | "Inches" | "Centimeters"

Unité de mesure pour les marges fournies.

marginOptions
Excel.PageLayoutMarginOptions

Valeurs de marge à définir. Les marges non fournies restent inchangées.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

setPrintTitleColumns(printTitleColumns)

Définit les colonnes qui contiennent des cellules répétées à gauche de chaque page de la feuille de calcul pour l’impression.

setPrintTitleColumns(printTitleColumns: Range | string): void;

Paramètres

printTitleColumns

Excel.Range | string

Colonnes à répéter à gauche de chaque page. La plage doit s’étendre sur toute la colonne pour être valide.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

setPrintTitleRows(printTitleRows)

Définit les rangées qui contiennent des cellules répétées en haut de chaque page de la feuille de calcul pour l’impression.

setPrintTitleRows(printTitleRows: Range | string): void;

Paramètres

printTitleRows

Excel.Range | string

Lignes à répéter en haut de chaque page. La plage doit s’étendre sur toute la ligne pour être valide.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-page-layout.yaml

await Excel.run(async (context) => {
    const farmSheet = context.workbook.worksheets.getItem("Print");
    farmSheet.pageLayout.setPrintTitleRows("$1:$1");
    await context.sync();
});

toJSON()

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

toJSON(): Excel.Interfaces.PageLayoutData;

Retours

Excel.Interfaces.PageLayoutData