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
Hinweise
Eigenschaften
| black |
Die Schwarzweißdruckoption des Arbeitsblatts. |
| bottom |
Der untere Seitenrand des Arbeitsblatts, der zum Drucken in Punkt verwendet werden soll. |
| center |
Die mitte des Arbeitsblatts ist horizontal gekennzeichnet. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck horizontal zentriert wird. |
| center |
Die vertikale Kennzeichnung mit der Mitte des Arbeitsblatts. Diese Kennzeichnung bestimmt, ob das Arbeitsblatt beim Druck vertikal zentriert wird. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| draft |
Die Entwurfsmodusoption des Arbeitsblatts. Gibt |
| first |
Die erste zu druckde Seitenzahl des Arbeitsblatts. Ein |
| footer |
Der Fußzeilenrand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann. |
| 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, der beim Drucken verwendet werden kann. |
| orientation | Die Ausrichtung des Arbeitsblatts der Seite. |
| paper |
Das Papierformat des Arbeitsblatts der Seite. |
| print |
Gibt an, ob die Kommentare des Arbeitsblatts beim Drucken angezeigt werden sollen. |
| print |
Die Druckfehleroption des Arbeitsblatts. |
| print |
Gibt an, ob die Gitternetzlinien des Arbeitsblatts gedruckt werden. |
| print |
Gibt an, ob die Überschriften des Arbeitsblatts gedruckt werden. |
| print |
Die Druckreihenfolgeoption der Seite des Arbeitsblatts. Dies gibt die Reihenfolge für die Verarbeitung der gedruckten Seitenzahl an. |
| right |
Der rechte Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann. |
| top |
Der obere Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann. |
| zoom | Die Druckzoomoptionen des Arbeitsblatts. 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 festgelegt, 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 festgelegt, 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
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
Die mitte des Arbeitsblatts ist horizontal gekennzeichnet. 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
Die vertikale Kennzeichnung mit 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 Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
draftMode
Die Entwurfsmodusoption des Arbeitsblatts. Gibt truean, dass das Blatt ohne Grafiken gedruckt wird.
draftMode: boolean;Eigenschaftswert
boolean
Hinweise
firstPageNumber
Die erste zu druckde Seitenzahl des Arbeitsblatts. Ein null -Wert stellt die "automatische" Seitennummerierung dar.
firstPageNumber: number | "";Eigenschaftswert
number | ""
Hinweise
footerMargin
Der Fußzeilenrand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
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, der beim Drucken verwendet werden kann.
leftMargin: number;Eigenschaftswert
number
Hinweise
orientation
Die Ausrichtung des Arbeitsblatts 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 des Arbeitsblatts der Seite.
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 Druckfehleroption 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 Druckreihenfolgeoption der Seite 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
rightMargin
Der rechte Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
rightMargin: number;Eigenschaftswert
number
Hinweise
topMargin
Der obere Rand des Arbeitsblatts in Punkt, der beim Drucken verwendet werden kann.
topMargin: number;Eigenschaftswert
number
Hinweise
zoom
Die Druckzoomoptionen des Arbeitsblatts. Das PageLayoutZoomOptions -Objekt muss als JSON-Objekt festgelegt werden (verwenden Sie x.zoom = {...} 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 einen oder mehrere rechteckige Bereiche enthält, das 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 einen oder mehrere rechteckige Bereiche enthält, das den Druckbereich für das Arbeitsblatt darstellt. Wenn kein Druckbereich vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. 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 festgelegt, 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 festgelegt, 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 dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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 Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen 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
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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 bzw. die Bereiche des zu druckden 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 bereitgestellten Ränder.
- marginOptions
- Excel.PageLayoutMarginOptions
Festzulegende Randwerte. Nicht bereitgestellte Ränder bleiben unverändert.
Gibt zurück
void
Hinweise
setPrintMargins(unitString, marginOptions)
Legt die Seitenränder des Arbeitsblatts mit Einheiten fest.
setPrintMargins(unitString: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;Parameter
- unitString
-
"Points" | "Inches" | "Centimeters"
Maßeinheit für die bereitgestellten Ränder.
- marginOptions
- Excel.PageLayoutMarginOptions
Festzulegende Randwerte. Nicht bereitgestellte Ränder 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 von 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 die gesamte Zeile umfassen, 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 das Objekt übergeben wird.) Während das ursprüngliche Excel.PageLayout Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.PageLayoutData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.PageLayoutData;Gibt zurück
Office Add-ins