ExcelScript.PageLayout interface

Paket:

ExcelScript

Stellt Layout- und Druckeinstellungen dar, die nicht von einer druckerspezifischen Implementierung abhängig sind. Diese Einstellungen umfassen Ränder, Ausrichtung, Seitennummerierung, Titelzeilen und Druckbereich.

Hinweise

Beispiele

/**
 * 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);
  });
}

Methoden

getBlackAndWhite()	Die Schwarzweißdruckoption des Arbeitsblatts.
getBottomMargin()	Der untere Seitenrand des Arbeitsblatts, der zum Drucken in Punkt verwendet werden soll.
getCenterHorizontally()	Die mitte des Arbeitsblatts ist horizontal gekennzeichnet. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck horizontal zentriert wird.
getCenterVertically()	Die vertikale Kennzeichnung mit der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck vertikal zentriert wird.
getDraftMode()	Die Entwurfsmodusoption des Arbeitsblatts. Gibt truean, dass das Blatt ohne Grafiken gedruckt wird.
getFirstPageNumber()	Die erste zu druckde Seitenzahl des Arbeitsblatts. Ein null -Wert stellt die "automatische" Seitennummerierung dar.
getFooterMargin()	Der Fußzeilenrand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
getHeaderMargin()	Der Kopfzeilenrand des Arbeitsblatts in Punkt zur Verwendung beim Drucken.
getHeadersFooters()	Kopf- und Fußzeilenkonfiguration für das Arbeitsblatt.
getLeftMargin()	Der linke Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
getOrientation()	Die Ausrichtung des Arbeitsblatts der Seite.
getPaperSize()	Das Papierformat des Arbeitsblatts der Seite.
getPrintArea()	Ruft das RangeAreas -Objekt ab, das einen oder mehrere rechteckige Bereiche enthält, das den Druckbereich für das Arbeitsblatt darstellt. Wenn kein Druckbereich vorhanden ist, gibt diese Methode zurück undefined.
getPrintComments()	Gibt an, ob die Kommentare des Arbeitsblatts beim Drucken angezeigt werden sollen.
getPrintErrors()	Die Druckfehleroption des Arbeitsblatts.
getPrintGridlines()	Gibt an, ob die Gitternetzlinien des Arbeitsblatts gedruckt werden.
getPrintHeadings()	Gibt an, ob die Überschriften des Arbeitsblatts gedruckt werden.
getPrintOrder()	Die Druckreihenfolgeoption der Seite des Arbeitsblatts. Dies gibt die Reihenfolge für die Verarbeitung der gedruckten Seitenzahl an.
getPrintTitleColumns()	Ruft das Bereichsobjekt ab, das die Titelspalten darstellt. Wenn nicht festgelegt, gibt diese Methode zurück undefined.
getPrintTitleRows()	Ruft das Bereichsobjekt ab, das die Titelzeilen darstellt. Wenn nicht festgelegt, gibt diese Methode zurück undefined.
getRightMargin()	Der rechte Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
getTopMargin()	Der obere Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
getZoom()	Die Druckzoomoptionen des Arbeitsblatts. Das PageLayoutZoomOptions -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.zoom = {...} anstelle von x.zoom.scale = ...).
setBlackAndWhite(blackAndWhite)	Die Schwarzweißdruckoption des Arbeitsblatts.
setBottomMargin(bottomMargin)	Der untere Seitenrand des Arbeitsblatts, der zum Drucken in Punkt verwendet werden soll.
setCenterHorizontally(centerHorizontally)	Die mitte des Arbeitsblatts ist horizontal gekennzeichnet. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck horizontal zentriert wird.
setCenterVertically(centerVertically)	Die vertikale Kennzeichnung mit der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck vertikal zentriert wird.
setDraftMode(draftMode)	Die Entwurfsmodusoption des Arbeitsblatts. Gibt truean, dass das Blatt ohne Grafiken gedruckt wird.
setFirstPageNumber(firstPageNumber)	Die erste zu druckde Seitenzahl des Arbeitsblatts. Ein null -Wert stellt die "automatische" Seitennummerierung dar.
setFooterMargin(footerMargin)	Der Fußzeilenrand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
setHeaderMargin(headerMargin)	Der Kopfzeilenrand des Arbeitsblatts in Punkt zur Verwendung beim Drucken.
setLeftMargin(leftMargin)	Der linke Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
setOrientation(orientation)	Die Ausrichtung des Arbeitsblatts der Seite.
setPaperSize(paperSize)	Das Papierformat des Arbeitsblatts der Seite.
setPrintArea(printArea)	Legt den Druckbereich des Arbeitsblatts fest.
setPrintComments(printComments)	Gibt an, ob die Kommentare des Arbeitsblatts beim Drucken angezeigt werden sollen.
setPrintErrors(printErrors)	Die Druckfehleroption des Arbeitsblatts.
setPrintGridlines(printGridlines)	Gibt an, ob die Gitternetzlinien des Arbeitsblatts gedruckt werden.
setPrintHeadings(printHeadings)	Gibt an, ob die Überschriften des Arbeitsblatts gedruckt werden.
setPrintMargins(unit, marginOptions)	Legt die Seitenränder des Arbeitsblatts mit Einheiten fest.
setPrintOrder(printOrder)	Die Druckreihenfolgeoption der Seite des Arbeitsblatts. Dies gibt die Reihenfolge für die Verarbeitung der gedruckten Seitenzahl an.
setPrintTitleColumns(printTitleColumns)	Legt die Spalten fest, die die links auf jeder Seite des Arbeitsblatts im Druck zu wiederholenden Zellen enthalten.
setPrintTitleRows(printTitleRows)	Legt die Zeilen fest, die die oben auf jeder Seite des Arbeitsblatts im Druck zu wiederholenden Zellen enthalten.
setRightMargin(rightMargin)	Der rechte Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
setTopMargin(topMargin)	Der obere Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
setZoom(zoom)	Die Druckzoomoptionen des Arbeitsblatts. Das PageLayoutZoomOptions -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.zoom = {...} anstelle von x.zoom.scale = ...).

Details zur Methode

getBlackAndWhite()

Die Schwarzweißdruckoption des Arbeitsblatts.

getBlackAndWhite(): boolean;

Gibt zurück

boolean

getBottomMargin()

Der untere Seitenrand des Arbeitsblatts, der zum Drucken in Punkt verwendet werden soll.

getBottomMargin(): number;

Gibt zurück

number

getCenterHorizontally()

Die mitte des Arbeitsblatts ist horizontal gekennzeichnet. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck horizontal zentriert wird.

getCenterHorizontally(): boolean;

Gibt zurück

boolean

getCenterVertically()

Die vertikale Kennzeichnung mit der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck vertikal zentriert wird.

getCenterVertically(): boolean;

Gibt zurück

boolean

getDraftMode()

Die Entwurfsmodusoption des Arbeitsblatts. Gibt truean, dass das Blatt ohne Grafiken gedruckt wird.

getDraftMode(): boolean;

Gibt zurück

boolean

getFirstPageNumber()

Die erste zu druckde Seitenzahl des Arbeitsblatts. Ein null -Wert stellt die "automatische" Seitennummerierung dar.

getFirstPageNumber(): number | "";

Gibt zurück

number | ""

getFooterMargin()

Der Fußzeilenrand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

getFooterMargin(): number;

Gibt zurück

number

getHeaderMargin()

Der Kopfzeilenrand des Arbeitsblatts in Punkt zur Verwendung beim Drucken.

getHeaderMargin(): number;

Gibt zurück

number

getHeadersFooters()

Kopf- und Fußzeilenkonfiguration für das Arbeitsblatt.

getHeadersFooters(): HeaderFooterGroup;

Gibt zurück

ExcelScript.HeaderFooterGroup

getLeftMargin()

Der linke Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

getLeftMargin(): number;

Gibt zurück

number

getOrientation()

Die Ausrichtung des Arbeitsblatts der Seite.

getOrientation(): PageOrientation;

Gibt zurück

ExcelScript.PageOrientation

getPaperSize()

Das Papierformat des Arbeitsblatts der Seite.

getPaperSize(): PaperType;

Gibt zurück

ExcelScript.PaperType

getPrintArea()

Ruft das RangeAreas -Objekt ab, das einen oder mehrere rechteckige Bereiche enthält, das den Druckbereich für das Arbeitsblatt darstellt. Wenn kein Druckbereich vorhanden ist, gibt diese Methode zurück undefined.

getPrintArea(): RangeAreas;

Gibt zurück

ExcelScript.RangeAreas

getPrintComments()

Gibt an, ob die Kommentare des Arbeitsblatts beim Drucken angezeigt werden sollen.

getPrintComments(): PrintComments;

Gibt zurück

ExcelScript.PrintComments

getPrintErrors()

Die Druckfehleroption des Arbeitsblatts.

getPrintErrors(): PrintErrorType;

Gibt zurück

ExcelScript.PrintErrorType

getPrintGridlines()

Gibt an, ob die Gitternetzlinien des Arbeitsblatts gedruckt werden.

getPrintGridlines(): boolean;

Gibt zurück

boolean

getPrintHeadings()

Gibt an, ob die Überschriften des Arbeitsblatts gedruckt werden.

getPrintHeadings(): boolean;

Gibt zurück

boolean

getPrintOrder()

Die Druckreihenfolgeoption der Seite des Arbeitsblatts. Dies gibt die Reihenfolge für die Verarbeitung der gedruckten Seitenzahl an.

getPrintOrder(): PrintOrder;

Gibt zurück

ExcelScript.PrintOrder

getPrintTitleColumns()

Ruft das Bereichsobjekt ab, das die Titelspalten darstellt. Wenn nicht festgelegt, gibt diese Methode zurück undefined.

getPrintTitleColumns(): Range;

Gibt zurück

ExcelScript.Range

getPrintTitleRows()

Ruft das Bereichsobjekt ab, das die Titelzeilen darstellt. Wenn nicht festgelegt, gibt diese Methode zurück undefined.

getPrintTitleRows(): Range;

Gibt zurück

ExcelScript.Range

getRightMargin()

Der rechte Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

getRightMargin(): number;

Gibt zurück

number

getTopMargin()

Der obere Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

getTopMargin(): number;

Gibt zurück

number

getZoom()

Die Druckzoomoptionen des Arbeitsblatts. Das PageLayoutZoomOptions -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.zoom = {...} anstelle von x.zoom.scale = ...).

getZoom(): PageLayoutZoomOptions;

Gibt zurück

ExcelScript.PageLayoutZoomOptions

setBlackAndWhite(blackAndWhite)

Die Schwarzweißdruckoption des Arbeitsblatts.

setBlackAndWhite(blackAndWhite: boolean): void;

Parameter

blackAndWhite

boolean

Gibt zurück

void

setBottomMargin(bottomMargin)

Der untere Seitenrand des Arbeitsblatts, der zum Drucken in Punkt verwendet werden soll.

setBottomMargin(bottomMargin: number): void;

Parameter

bottomMargin

number

Gibt zurück

void

setCenterHorizontally(centerHorizontally)

Die mitte des Arbeitsblatts ist horizontal gekennzeichnet. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck horizontal zentriert wird.

setCenterHorizontally(centerHorizontally: boolean): void;

Parameter

centerHorizontally

boolean

Gibt zurück

void

setCenterVertically(centerVertically)

Die vertikale Kennzeichnung mit der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck vertikal zentriert wird.

setCenterVertically(centerVertically: boolean): void;

Parameter

centerVertically

boolean

Gibt zurück

void

setDraftMode(draftMode)

Die Entwurfsmodusoption des Arbeitsblatts. Gibt truean, dass das Blatt ohne Grafiken gedruckt wird.

setDraftMode(draftMode: boolean): void;

Parameter

draftMode

boolean

Gibt zurück

void

Beispiele

/**
 * 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)

Die erste zu druckde Seitenzahl des Arbeitsblatts. Ein null -Wert stellt die "automatische" Seitennummerierung dar.

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

Parameter

firstPageNumber

number | ""

Gibt zurück

void

setFooterMargin(footerMargin)

Der Fußzeilenrand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

setFooterMargin(footerMargin: number): void;

Parameter

footerMargin

number

Gibt zurück

void

setHeaderMargin(headerMargin)

Der Kopfzeilenrand des Arbeitsblatts in Punkt zur Verwendung beim Drucken.

setHeaderMargin(headerMargin: number): void;

Parameter

headerMargin

number

Gibt zurück

void

setLeftMargin(leftMargin)

Der linke Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

setLeftMargin(leftMargin: number): void;

Parameter

leftMargin

number

Gibt zurück

void

setOrientation(orientation)

Die Ausrichtung des Arbeitsblatts der Seite.

setOrientation(orientation: PageOrientation): void;

Parameter

orientation

ExcelScript.PageOrientation

Gibt zurück

void

Beispiele

/**
 * 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)

Das Papierformat des Arbeitsblatts der Seite.

setPaperSize(paperSize: PaperType): void;

Parameter

paperSize

ExcelScript.PaperType

Gibt zurück

void

Beispiele

/**
 * 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)

Legt den Druckbereich des Arbeitsblatts fest.

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

Parameter

printArea

ExcelScript.Range | ExcelScript.RangeAreas | string

Der bzw. die Bereiche des zu druckden Inhalts.

Gibt zurück

void

setPrintComments(printComments)

Gibt an, ob die Kommentare des Arbeitsblatts beim Drucken angezeigt werden sollen.

setPrintComments(printComments: PrintComments): void;

Parameter

printComments

ExcelScript.PrintComments

Gibt zurück

void

Beispiele

/**
 * 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)

Die Druckfehleroption des Arbeitsblatts.

setPrintErrors(printErrors: PrintErrorType): void;

Parameter

printErrors

ExcelScript.PrintErrorType

Gibt zurück

void

setPrintGridlines(printGridlines)

Gibt an, ob die Gitternetzlinien des Arbeitsblatts gedruckt werden.

setPrintGridlines(printGridlines: boolean): void;

Parameter

printGridlines

boolean

Gibt zurück

void

setPrintHeadings(printHeadings)

Gibt an, ob die Überschriften des Arbeitsblatts gedruckt werden.

setPrintHeadings(printHeadings: boolean): void;

Parameter

printHeadings

boolean

Gibt zurück

void

setPrintMargins(unit, marginOptions)

Legt die Seitenränder des Arbeitsblatts mit Einheiten fest.

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

Parameter

unit

ExcelScript.PrintMarginUnit

Maßeinheit für die bereitgestellten Ränder.

marginOptions

ExcelScript.PageLayoutMarginOptions

Festzulegende Randwerte. Nicht bereitgestellte Ränder bleiben unverändert.

Gibt zurück

void

setPrintOrder(printOrder)

Die Druckreihenfolgeoption der Seite des Arbeitsblatts. Dies gibt die Reihenfolge für die Verarbeitung der gedruckten Seitenzahl an.

setPrintOrder(printOrder: PrintOrder): void;

Parameter

printOrder

ExcelScript.PrintOrder

Gibt zurück

void

Beispiele

/**
 * 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)

Legt die Spalten fest, die die links auf jeder Seite des Arbeitsblatts im Druck zu wiederholenden Zellen enthalten.

setPrintTitleColumns(printTitleColumns: Range | string): void;

Parameter

printTitleColumns

ExcelScript.Range | string

Die Spalten, die links von jeder Seite wiederholt werden sollen. Der Bereich muss sich über die gesamte Spalte erstrecken, um gültig zu sein.

Gibt zurück

void

setPrintTitleRows(printTitleRows)

Legt die Zeilen fest, die die oben auf jeder Seite des Arbeitsblatts im Druck zu wiederholenden Zellen enthalten.

setPrintTitleRows(printTitleRows: Range | string): void;

Parameter

printTitleRows

ExcelScript.Range | string

Die Zeilen, die oben auf jeder Seite wiederholt werden sollen. Der Bereich muss die gesamte Zeile umfassen, um gültig zu sein.

Gibt zurück

void

setRightMargin(rightMargin)

Der rechte Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

setRightMargin(rightMargin: number): void;

Parameter

rightMargin

number

Gibt zurück

void

setTopMargin(topMargin)

Der obere Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.

setTopMargin(topMargin: number): void;

Parameter

topMargin

number

Gibt zurück

void

setZoom(zoom)

Die Druckzoomoptionen des Arbeitsblatts. Das PageLayoutZoomOptions -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.zoom = {...} anstelle von x.zoom.scale = ...).

setZoom(zoom: PageLayoutZoomOptions): void;

Parameter

zoom

ExcelScript.PageLayoutZoomOptions

Gibt zurück

void

Beispiele

/**
 * 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)
}