Partager via


ExcelScript.PageLayout interface

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.

Remarques

Exemples

/**
 * This script sets some basic page layout settings for printing.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout : ExcelScript.PageLayout = sheet.getPageLayout();

    // Turn off draft mode so images are printed.
    pageLayout.setDraftMode(false);
    
    // Print on 8.5"x11" paper.
    pageLayout.setPaperSize(ExcelScript.PaperType.letter);

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

Méthodes

getBlackAndWhite()

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

getBottomMargin()

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

getCenterHorizontally()

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.

getCenterVertically()

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.

getDraftMode()

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

getFirstPageNumber()

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

getFooterMargin()

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

getHeaderMargin()

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

getHeadersFooters()

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

getLeftMargin()

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

getOrientation()

Orientation de la feuille de calcul de la page.

getPaperSize()

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

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, cette méthode retourne undefined.

getPrintComments()

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

getPrintErrors()

Option erreurs d’impression de la feuille de calcul.

getPrintGridlines()

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

getPrintHeadings()

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

getPrintOrder()

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é.

getPrintTitleColumns()

Obtient l’objet plage représentant les colonnes de titre. Si elle n’est pas définie, cette méthode retourne undefined.

getPrintTitleRows()

Obtient l’objet plage représentant les rangées de titre. Si elle n’est pas définie, cette méthode retourne undefined.

getRightMargin()

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

getTopMargin()

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

getZoom()

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 = ...).

setBlackAndWhite(blackAndWhite)

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

setBottomMargin(bottomMargin)

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

setCenterHorizontally(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.

setCenterVertically(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.

setDraftMode(draftMode)

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

setFirstPageNumber(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.

setFooterMargin(footerMargin)

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

setHeaderMargin(headerMargin)

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

setLeftMargin(leftMargin)

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

setOrientation(orientation)

Orientation de la feuille de calcul de la page.

setPaperSize(paperSize)

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

setPrintArea(printArea)

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

setPrintComments(printComments)

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

setPrintErrors(printErrors)

Option erreurs d’impression de la feuille de calcul.

setPrintGridlines(printGridlines)

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

setPrintHeadings(printHeadings)

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

setPrintMargins(unit, marginOptions)

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

setPrintOrder(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é.

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.

setRightMargin(rightMargin)

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

setTopMargin(topMargin)

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

setZoom(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 = ...).

Détails de la méthode

getBlackAndWhite()

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

getBlackAndWhite(): boolean;

Retours

boolean

getBottomMargin()

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

getBottomMargin(): number;

Retours

number

getCenterHorizontally()

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.

getCenterHorizontally(): boolean;

Retours

boolean

getCenterVertically()

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.

getCenterVertically(): boolean;

Retours

boolean

getDraftMode()

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

getDraftMode(): boolean;

Retours

boolean

getFirstPageNumber()

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

getFirstPageNumber(): number | "";

Retours

number | ""

getFooterMargin()

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

getFooterMargin(): number;

Retours

number

getHeaderMargin()

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

getHeaderMargin(): number;

Retours

number

getHeadersFooters()

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

getHeadersFooters(): HeaderFooterGroup;

Retours

getLeftMargin()

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

getLeftMargin(): number;

Retours

number

getOrientation()

Orientation de la feuille de calcul de la page.

getOrientation(): PageOrientation;

Retours

getPaperSize()

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

getPaperSize(): PaperType;

Retours

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, cette méthode retourne undefined.

getPrintArea(): RangeAreas;

Retours

getPrintComments()

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

getPrintComments(): PrintComments;

Retours

getPrintErrors()

Option erreurs d’impression de la feuille de calcul.

getPrintErrors(): PrintErrorType;

Retours

getPrintGridlines()

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

getPrintGridlines(): boolean;

Retours

boolean

getPrintHeadings()

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

getPrintHeadings(): boolean;

Retours

boolean

getPrintOrder()

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é.

getPrintOrder(): PrintOrder;

Retours

getPrintTitleColumns()

Obtient l’objet plage représentant les colonnes de titre. Si elle n’est pas définie, cette méthode retourne undefined.

getPrintTitleColumns(): Range;

Retours

getPrintTitleRows()

Obtient l’objet plage représentant les rangées de titre. Si elle n’est pas définie, cette méthode retourne undefined.

getPrintTitleRows(): Range;

Retours

getRightMargin()

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

getRightMargin(): number;

Retours

number

getTopMargin()

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

getTopMargin(): number;

Retours

number

getZoom()

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 = ...).

getZoom(): PageLayoutZoomOptions;

Retours

setBlackAndWhite(blackAndWhite)

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

setBlackAndWhite(blackAndWhite: boolean): void;

Paramètres

blackAndWhite

boolean

Retours

void

setBottomMargin(bottomMargin)

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

setBottomMargin(bottomMargin: number): void;

Paramètres

bottomMargin

number

Retours

void

setCenterHorizontally(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.

setCenterHorizontally(centerHorizontally: boolean): void;

Paramètres

centerHorizontally

boolean

Retours

void

setCenterVertically(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.

setCenterVertically(centerVertically: boolean): void;

Paramètres

centerVertically

boolean

Retours

void

setDraftMode(draftMode)

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

setDraftMode(draftMode: boolean): void;

Paramètres

draftMode

boolean

Retours

void

Exemples

/**
 * This script turns off the print setting for draft mode.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Turn off draft mode so images are printed.
    pageLayout.setDraftMode(false);
  });
}

setFirstPageNumber(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.

setFirstPageNumber(firstPageNumber: number | ""): void;

Paramètres

firstPageNumber

number | ""

Retours

void

setFooterMargin(footerMargin)

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

setFooterMargin(footerMargin: number): void;

Paramètres

footerMargin

number

Retours

void

setHeaderMargin(headerMargin)

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

setHeaderMargin(headerMargin: number): void;

Paramètres

headerMargin

number

Retours

void

setLeftMargin(leftMargin)

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

setLeftMargin(leftMargin: number): void;

Paramètres

leftMargin

number

Retours

void

setOrientation(orientation)

Orientation de la feuille de calcul de la page.

setOrientation(orientation: PageOrientation): void;

Paramètres

Retours

void

Exemples

/**
 * This script sets the printing orientation for the entire workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

setPaperSize(paperSize)

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

setPaperSize(paperSize: PaperType): void;

Paramètres

Retours

void

Exemples

/**
 * This script sets the page size for printing.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();
    // Print on 8.5"x11" paper.
    pageLayout.setPaperSize(ExcelScript.PaperType.letter);
  });
}

setPrintArea(printArea)

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

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

Paramètres

printArea

ExcelScript.Range | ExcelScript.RangeAreas | string

Plage(s) du contenu à imprimer.

Retours

void

setPrintComments(printComments)

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

setPrintComments(printComments: PrintComments): void;

Paramètres

Retours

void

Exemples

/**
 * This script makes the comments print at the end of the worksheet
 * when the workbook is printed.
 */
function main(workbook: ExcelScript.Workbook) {
  // Access every worksheet in the workbook.
  workbook.getWorksheets().forEach(worksheet => {
    // Get the page layout for each sheet.
    const layout = worksheet.getPageLayout();

    // Change the comment printing settings to print them at the end of the sheet.
    layout.setPrintComments(ExcelScript.PrintComments.endSheet);
  });
}

setPrintErrors(printErrors)

Option erreurs d’impression de la feuille de calcul.

setPrintErrors(printErrors: PrintErrorType): void;

Paramètres

Retours

void

setPrintGridlines(printGridlines)

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

setPrintGridlines(printGridlines: boolean): void;

Paramètres

printGridlines

boolean

Retours

void

setPrintHeadings(printHeadings)

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

setPrintHeadings(printHeadings: boolean): void;

Paramètres

printHeadings

boolean

Retours

void

setPrintMargins(unit, marginOptions)

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

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

Paramètres

unit
ExcelScript.PrintMarginUnit

Unité de mesure pour les marges fournies.

marginOptions
ExcelScript.PageLayoutMarginOptions

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

Retours

void

setPrintOrder(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é.

setPrintOrder(printOrder: PrintOrder): void;

Paramètres

Retours

void

Exemples

/**
 * This script sets the print order for every worksheet in the workbook.
 * The order of printed content will go over (e.g., left-to-right) 
 * then down (i.e., top-to-bottom).
 */
function main(workbook: ExcelScript.Workbook) {
  // Access every worksheet in the workbook.
  workbook.getWorksheets().forEach(worksheet => {
    // Get the page layout for each sheet.
    const layout: ExcelScript.PageLayout = worksheet.getPageLayout();

    // Set the print order to over-then-down.
    layout.setPrintOrder(ExcelScript.PrintOrder.overThenDown);
  });
}

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

ExcelScript.Range | string

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

Retours

void

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

ExcelScript.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

setRightMargin(rightMargin)

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

setRightMargin(rightMargin: number): void;

Paramètres

rightMargin

number

Retours

void

setTopMargin(topMargin)

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

setTopMargin(topMargin: number): void;

Paramètres

topMargin

number

Retours

void

setZoom(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 = ...).

setZoom(zoom: PageLayoutZoomOptions): void;

Paramètres

Retours

void

Exemples

/**
 * This script changes the scale-to-fit of the page layout.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the current worksheet.
    const sheet = workbook.getActiveWorksheet();

    // Scale the layout to half size for printing.
    const layout = sheet.getPageLayout();
    const zoomOptions: ExcelScript.PageLayoutZoomOptions = {
        scale: 50
    }
    layout.setZoom(zoomOptions)
}