Excel.PageLayout class
Stellt Layout- und Druckeinstellungen dar, die nicht von einer druckerspezifischen Implementierung abhängig sind. Diese Einstellungen umfassen Ränder, Ausrichtung, Seitennummerierung, Titelzeilen und Druckbereich.
- Extends
Eigenschaften
| align |
Gibt an, ob Excel die Kopf- und Fußzeile an den Rändern ausrichtet, die in den Seiteneinrichtungsoptionen festgelegt sind. |
| black |
Die Schwarzweiß-Druckoption des Arbeitsblatts. |
| bottom |
Der untere Seitenrand des Arbeitsblatts, der zum Drucken in Punkt verwendet werden soll. |
| center |
Horizontales Flag in der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck horizontal zentriert wird. |
| center |
Vertikales Flag in der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck vertikal zentriert wird. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| draft |
Die Entwurfsmodusoption des Arbeitsblatts. Wenn |
| first |
Die erste Seitenzahl des Arbeitsblatts, die gedruckt werden soll. Ein |
| footer |
Der Fußzeilenrand (in Punkt) des Arbeitsblatts zur Verwendung beim Drucken. |
| header |
Der Kopfzeilenrand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken. |
| headers |
Kopf- und Fußzeilenkonfiguration für das Arbeitsblatt. |
| left |
Der linke Rand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken |
| orientation | Die Ausrichtung des Arbeitsblatts auf der Seite. |
| paper |
Das Papierformat der Seite auf dem Arbeitsblatt. |
| print |
Gibt an, ob die Kommentare des Arbeitsblatts beim Drucken angezeigt werden sollen. |
| print |
Die Option "Druckfehler" des Arbeitsblatts. |
| print |
Gibt an, ob die Gitternetzlinien des Arbeitsblatts gedruckt werden. |
| print |
Gibt an, ob die Überschriften des Arbeitsblatts gedruckt werden. |
| print |
Die Seitendruckreihenfolge des Arbeitsblatts. Dies gibt die Reihenfolge für die Verarbeitung der gedruckten Seitenzahl an. |
| print |
Gibt ein Array mit zwei Elementen an, das sowohl horizontale als auch vertikale Druckqualitätswerte enthält. Das erste Element ist die horizontale Druckqualität, und das zweite Element ist die vertikale Druckqualität. Einige Drucker unterstützen möglicherweise keine vertikale Druckqualität, und die unterstützten Werte können je nach Drucker variieren. |
| right |
Der rechte Rand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken |
| top |
Der obere Rand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken. |
| zoom | Die Zoomoptionen des Arbeitsblatts zum Drucken. Das |
Methoden
| get |
Ruft das |
| get |
Ruft das |
| get |
Ruft das Bereichsobjekt ab, das die Titelspalten darstellt. |
| get |
Ruft das Bereichsobjekt ab, das die Titelspalten darstellt. Wenn nicht gesetzt, dann gibt diese Methode ein Objekt zurück, dessen |
| get |
Ruft das Bereichsobjekt ab, das die Titelzeilen darstellt. |
| get |
Ruft das Bereichsobjekt ab, das die Titelzeilen darstellt. Wenn nicht gesetzt, dann gibt diese Methode ein Objekt zurück, dessen |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben. |
| set(properties) | Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| set |
Legt den Druckbereich des Arbeitsblatts fest. |
| set |
Legt die Seitenränder des Arbeitsblatts mit Einheiten fest. |
| set |
Legt die Seitenränder des Arbeitsblatts mit Einheiten fest. |
| set |
Legt die Spalten fest, die die links auf jeder Seite des Arbeitsblatts im Druck zu wiederholenden Zellen enthalten. |
| set |
Legt die Zeilen fest, die die oben auf jeder Seite des Arbeitsblatts im Druck zu wiederholenden Zellen enthalten. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
alignMarginsHeaderFooter
Gibt an, ob Excel die Kopf- und Fußzeile an den Rändern ausrichtet, die in den Seiteneinrichtungsoptionen festgelegt sind.
alignMarginsHeaderFooter: boolean;Eigenschaftswert
boolean
Hinweise
blackAndWhite
Die Schwarzweiß-Druckoption des Arbeitsblatts.
blackAndWhite: boolean;Eigenschaftswert
boolean
Hinweise
bottomMargin
Der untere Seitenrand des Arbeitsblatts, der zum Drucken in Punkt verwendet werden soll.
bottomMargin: number;Eigenschaftswert
number
Hinweise
centerHorizontally
Horizontales Flag in der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck horizontal zentriert wird.
centerHorizontally: boolean;Eigenschaftswert
boolean
Hinweise
Beispiele
// 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
Vertikales Flag in der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck vertikal zentriert wird.
centerVertically: boolean;Eigenschaftswert
boolean
Hinweise
Beispiele
// 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
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
draftMode
Die Entwurfsmodusoption des Arbeitsblatts. Wenn true, wird das Blatt ohne Grafiken gedruckt.
draftMode: boolean;Eigenschaftswert
boolean
Hinweise
firstPageNumber
Die erste Seitenzahl des Arbeitsblatts, die gedruckt werden soll. Ein null Wert steht für die "automatische" Seitennummerierung.
firstPageNumber: number | "";Eigenschaftswert
number | ""
Hinweise
footerMargin
Der Fußzeilenrand (in Punkt) des Arbeitsblatts zur Verwendung beim Drucken.
footerMargin: number;Eigenschaftswert
number
Hinweise
headerMargin
Der Kopfzeilenrand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken.
headerMargin: number;Eigenschaftswert
number
Hinweise
headersFooters
Kopf- und Fußzeilenkonfiguration für das Arbeitsblatt.
readonly headersFooters: Excel.HeaderFooterGroup;Eigenschaftswert
Hinweise
leftMargin
Der linke Rand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken
leftMargin: number;Eigenschaftswert
number
Hinweise
orientation
Die Ausrichtung des Arbeitsblatts auf der Seite.
orientation: Excel.PageOrientation | "Portrait" | "Landscape";Eigenschaftswert
Excel.PageOrientation | "Portrait" | "Landscape"
Hinweise
Beispiele
// 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
Das Papierformat der Seite auf dem Arbeitsblatt.
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";Eigenschaftswert
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"
Hinweise
printComments
Gibt an, ob die Kommentare des Arbeitsblatts beim Drucken angezeigt werden sollen.
printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";Eigenschaftswert
Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"
Hinweise
printErrors
Die Option "Druckfehler" des Arbeitsblatts.
printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";Eigenschaftswert
Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"
Hinweise
printGridlines
Gibt an, ob die Gitternetzlinien des Arbeitsblatts gedruckt werden.
printGridlines: boolean;Eigenschaftswert
boolean
Hinweise
printHeadings
Gibt an, ob die Überschriften des Arbeitsblatts gedruckt werden.
printHeadings: boolean;Eigenschaftswert
boolean
Hinweise
printOrder
Die Seitendruckreihenfolge des Arbeitsblatts. Dies gibt die Reihenfolge für die Verarbeitung der gedruckten Seitenzahl an.
printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";Eigenschaftswert
Excel.PrintOrder | "DownThenOver" | "OverThenDown"
Hinweise
printQuality
Gibt ein Array mit zwei Elementen an, das sowohl horizontale als auch vertikale Druckqualitätswerte enthält. Das erste Element ist die horizontale Druckqualität, und das zweite Element ist die vertikale Druckqualität. Einige Drucker unterstützen möglicherweise keine vertikale Druckqualität, und die unterstützten Werte können je nach Drucker variieren.
printQuality: number[];Eigenschaftswert
number[]
Hinweise
rightMargin
Der rechte Rand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken
rightMargin: number;Eigenschaftswert
number
Hinweise
topMargin
Der obere Rand des Arbeitsblatts (in Punkt) zur Verwendung beim Drucken.
topMargin: number;Eigenschaftswert
number
Hinweise
zoom
Die Zoomoptionen des Arbeitsblatts zum Drucken. Das PageLayoutZoomOptions Objekt muss als JSON-Objekt festgelegt werden (verwenden x.zoom = {...} Sie anstelle von x.zoom.scale = ...).
zoom: Excel.PageLayoutZoomOptions;Eigenschaftswert
Hinweise
Beispiele
// 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();
});
Details zur Methode
getPrintArea()
Ruft das RangeAreas Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und den Druckbereich für das Arbeitsblatt darstellt. Wenn kein Druckbereich vorhanden ist, wird ein ItemNotFound Fehler ausgelöst.
getPrintArea(): Excel.RangeAreas;Gibt zurück
Hinweise
getPrintAreaOrNullObject()
Ruft das RangeAreas Objekt ab, das aus einem oder mehreren rechteckigen Bereichen besteht und den Druckbereich für das Arbeitsblatt darstellt. Wenn kein Druckbereich vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getPrintAreaOrNullObject(): Excel.RangeAreas;Gibt zurück
Hinweise
getPrintTitleColumns()
Ruft das Bereichsobjekt ab, das die Titelspalten darstellt.
getPrintTitleColumns(): Excel.Range;Gibt zurück
Hinweise
getPrintTitleColumnsOrNullObject()
Ruft das Bereichsobjekt ab, das die Titelspalten darstellt. Wenn nicht gesetzt, dann gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getPrintTitleColumnsOrNullObject(): Excel.Range;Gibt zurück
Hinweise
getPrintTitleRows()
Ruft das Bereichsobjekt ab, das die Titelzeilen darstellt.
getPrintTitleRows(): Excel.Range;Gibt zurück
Hinweise
getPrintTitleRowsOrNullObject()
Ruft das Bereichsobjekt ab, das die Titelzeilen darstellt. Wenn nicht gesetzt, dann gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getPrintTitleRowsOrNullObject(): Excel.Range;Gibt zurück
Hinweise
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): Excel.PageLayout;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PageLayout;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties: Interfaces.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.PageLayoutUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.PageLayout): void;Parameter
- properties
- Excel.PageLayout
Gibt zurück
void
setPrintArea(printArea)
Legt den Druckbereich des Arbeitsblatts fest.
setPrintArea(printArea: Range | RangeAreas | string): void;Parameter
- printArea
-
Excel.Range | Excel.RangeAreas | string
Der Bereich oder die Bereiche des zu druckenden Inhalts.
Gibt zurück
void
Hinweise
Beispiele
// 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)
Legt die Seitenränder des Arbeitsblatts mit Einheiten fest.
setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions): void;Parameter
Maßeinheit für die angegebenen Ränder.
- marginOptions
- Excel.PageLayoutMarginOptions
Festzulegende Randwerte. Nicht angegebene Margen bleiben unverändert.
Gibt zurück
void
Hinweise
setPrintMargins(unit, marginOptions)
Legt die Seitenränder des Arbeitsblatts mit Einheiten fest.
setPrintMargins(unit: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;Parameter
- unit
-
"Points" | "Inches" | "Centimeters"
Maßeinheit für die angegebenen Ränder.
- marginOptions
- Excel.PageLayoutMarginOptions
Festzulegende Randwerte. Nicht angegebene Margen bleiben unverändert.
Gibt zurück
void
Hinweise
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
-
Excel.Range | string
Die Spalten, die links neben jeder Seite wiederholt werden sollen. Der Bereich muss sich über die gesamte Spalte erstrecken, um gültig zu sein.
Gibt zurück
void
Hinweise
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
-
Excel.Range | string
Die Zeilen, die oben auf jeder Seite wiederholt werden sollen. Der Bereich muss sich über die gesamte Zeile erstrecken, um gültig zu sein.
Gibt zurück
void
Hinweise
Beispiele
// 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()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche Excel.PageLayout Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.PageLayoutData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.PageLayoutData;