Excel.PageLayout class
Représente les paramètres de mise en page 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
Propriétés
| align |
Indique si Excel aligne l’en-tête et le pied de page sur les marges définies dans les options de mise en page. |
| black |
Option d’impression en noir et blanc de la feuille de calcul. |
| bottom |
Marge de la page inférieure de la feuille de calcul à utiliser pour l’impression en points. |
| center |
Indicateur horizontal au centre de la feuille de calcul. Cet indicateur détermine si la feuille de calcul est centrée horizontalement lorsqu’elle est imprimée. |
| center |
Indicateur vertical du centre 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. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| draft |
Option mode brouillon de la feuille de calcul. Si |
| first |
Premier numéro de page de la feuille de calcul à imprimer. Une |
| footer |
Marge de pied de page de la feuille de calcul, en points, à utiliser lors de l’impression. |
| header |
Marge d’en-tête de la feuille de calcul, en points, à utiliser lors de l’impression. |
| headers |
Configuration de l’en-tête et pied de page de la feuille de calcul. |
| left |
Marge gauche de la feuille de calcul, en points, à utiliser lors de l’impression. |
| orientation | Orientation de la feuille de calcul de la page. |
| paper |
Format de papier de la feuille de calcul de la page. |
| print |
Spécifie si les commentaires de la feuille de calcul doivent être affichés lors de l’impression. |
| print |
Option Erreurs d’impression de la feuille de calcul. |
| print |
Spécifie si le quadrillage de la feuille de calcul sera imprimé. |
| print |
Spécifie si les titres de la feuille de calcul sont imprimés. |
| print |
Option d’ordre d’impression des pages de la feuille de calcul. Cela indique l’ordre à utiliser pour traiter le numéro de page imprimé. |
| print |
Spécifie un tableau à deux éléments qui contient des valeurs de qualité d’impression horizontales et verticales. Le premier élément est la qualité d’impression horizontale et le deuxième élément est la qualité d’impression verticale. Certaines imprimantes peuvent ne pas prendre en charge la qualité d’impression verticale et les valeurs prises en charge peuvent varier selon l’imprimante. |
| right |
Marge droite de la feuille de calcul, en points, à utiliser lors de l’impression. |
| top |
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 |
Méthodes
| get |
Obtient l’objet |
| get |
Obtient l’objet |
| get |
Obtient l’objet plage représentant les colonnes de titre. |
| get |
Obtient l’objet plage représentant les colonnes de titre. Si elle n’est pas définie, cette méthode renvoie un objet dont la |
| get |
Obtient l’objet plage représentant les rangées de titre. |
| get |
Obtient l’objet plage représentant les rangées de titre. Si elle n’est pas définie, cette méthode renvoie un objet dont la |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| 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. |
| set |
Définit la zone d’impression de la feuille de calcul. |
| set |
Définit les marges de page de la feuille de calcul avec des unités. |
| set |
Définit les marges de page de la feuille de calcul avec des unités. |
| set |
Définit les colonnes qui contiennent des cellules répétées à gauche de chaque page de la feuille de calcul pour l’impression. |
| set |
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 |
Détails de la propriété
alignMarginsHeaderFooter
Indique si Excel aligne l’en-tête et le pied de page sur les marges définies dans les options de mise en page.
alignMarginsHeaderFooter: boolean;Valeur de propriété
boolean
Remarques
blackAndWhite
Option d’impression en noir et blanc de la feuille de calcul.
blackAndWhite: boolean;Valeur de propriété
boolean
Remarques
bottomMargin
Marge de la page inférieure de la feuille de calcul à utiliser pour l’impression en points.
bottomMargin: number;Valeur de propriété
number
Remarques
centerHorizontally
Indicateur horizontal au centre de la feuille de calcul. 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
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 du centre 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
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. Cette opération connecte le processus du complément à celui de l’application hôte Office.
context: RequestContext;Valeur de propriété
draftMode
Option mode brouillon de la feuille de calcul. Si true, la feuille sera imprimée sans graphiques.
draftMode: boolean;Valeur de propriété
boolean
Remarques
firstPageNumber
Premier numéro de page de la feuille de calcul à imprimer. Une null valeur représente une numérotation de page « automatique ».
firstPageNumber: number | "";Valeur de propriété
number | ""
Remarques
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
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
headersFooters
Configuration de l’en-tête et pied de page de la feuille de calcul.
readonly headersFooters: Excel.HeaderFooterGroup;Valeur de propriété
Remarques
leftMargin
Marge gauche de la feuille de calcul, en points, à utiliser lors de l’impression.
leftMargin: number;Valeur de propriété
number
Remarques
orientation
Orientation de la feuille de calcul de la page.
orientation: Excel.PageOrientation | "Portrait" | "Landscape";Valeur de propriété
Excel.PageOrientation | "Portrait" | "Landscape"
Remarques
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
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
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
printGridlines
Spécifie si le quadrillage de la feuille de calcul sera imprimé.
printGridlines: boolean;Valeur de propriété
boolean
Remarques
printHeadings
Spécifie si les titres de la feuille de calcul sont imprimés.
printHeadings: boolean;Valeur de propriété
boolean
Remarques
printOrder
Option d’ordre d’impression des pages 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
printQuality
Spécifie un tableau à deux éléments qui contient des valeurs de qualité d’impression horizontales et verticales. Le premier élément est la qualité d’impression horizontale et le deuxième élément est la qualité d’impression verticale. Certaines imprimantes peuvent ne pas prendre en charge la qualité d’impression verticale et les valeurs prises en charge peuvent varier selon l’imprimante.
printQuality: number[];Valeur de propriété
number[]
Remarques
rightMargin
Marge droite de la feuille de calcul, en points, à utiliser lors de l’impression.
rightMargin: number;Valeur de propriété
number
Remarques
topMargin
Marge supérieure de la feuille de calcul, en points, à utiliser lors de l’impression.
topMargin: number;Valeur de propriété
number
Remarques
zoom
Options de zoom d’impression de la feuille de calcul. L’objet PageLayoutZoomOptions doit être défini en tant qu’objet JSON (utiliser x.zoom = {...} à la place de x.zoom.scale = ...).
zoom: Excel.PageLayoutZoomOptions;Valeur de propriété
Remarques
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 , composé d’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
Remarques
getPrintAreaOrNullObject()
Obtient l’objet RangeAreas , composé d’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 renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getPrintAreaOrNullObject(): Excel.RangeAreas;Retours
Remarques
getPrintTitleColumns()
Obtient l’objet plage représentant les colonnes de titre.
getPrintTitleColumns(): Excel.Range;Retours
Remarques
getPrintTitleColumnsOrNullObject()
Obtient l’objet plage représentant les colonnes de titre. Si elle n’est pas définie, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getPrintTitleColumnsOrNullObject(): Excel.Range;Retours
Remarques
getPrintTitleRows()
Obtient l’objet plage représentant les rangées de titre.
getPrintTitleRows(): Excel.Range;Retours
Remarques
getPrintTitleRowsOrNullObject()
Obtient l’objet plage représentant les rangées de titre. Si elle n’est pas définie, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getPrintTitleRowsOrNullObject(): Excel.Range;Retours
Remarques
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
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.PageLayout;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.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
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.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.PageLayoutUpdateData
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.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 ou plages de contenu à imprimer.
Retours
void
Remarques
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é de mesure des marges fournies.
- marginOptions
- Excel.PageLayoutMarginOptions
Valeurs de marge à définir. Les marges non fournies restent inchangées.
Retours
void
Remarques
setPrintMargins(unit, marginOptions)
Définit les marges de page de la feuille de calcul avec des unités.
setPrintMargins(unit: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;Paramètres
- unit
-
"Points" | "Inches" | "Centimeters"
Unité de mesure des marges fournies.
- marginOptions
- Excel.PageLayoutMarginOptions
Valeurs de marge à définir. Les marges non fournies restent inchangées.
Retours
void
Remarques
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. Pour être valide, la plage doit couvrir toute la colonne.
Retours
void
Remarques
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. Pour être valide, la plage doit couvrir toute la ligne.
Retours
void
Remarques
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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.PageLayout est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.PageLayoutDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.PageLayoutData;