Excel.PageLayout class
Представляет параметры макета и печати, которые не зависят от реализации принтера. Эти параметры включают поля, ориентацию, нумерацию страницы, строки заголовков и область печати.
- Extends
Комментарии
Свойства
| black |
Параметр черно-белой печати листа. |
| bottom |
Нижнее поле страницы листа, используемое для печати в точках. |
| center |
Центр листа по горизонтали. Эта отметка определяет, выравнивается ли лист по горизонтали относительно центра при печати. |
| center |
По центру листа по вертикали. Эта отметка определяет, выравнивается ли лист по вертикали относительно центра при печати. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| draft |
Параметр режима черновика листа. Если |
| first |
Номер первой страницы листа для печати. Значение |
| footer |
Поле нижнего колонтитула листа (в пунктах) для использования при печати. |
| header |
Поле заголовка листа (в пунктах) для использования при печати. |
| headers |
Настройка колонтитулов для листа. |
| left |
Левое поле листа (в пунктах) для использования при печати. |
| orientation | Ориентация листа страницы. |
| paper |
Размер бумаги листа страницы. |
| print |
Указывает, должны ли примечания листа отображаться при печати. |
| print |
Параметр ошибок печати листа. |
| print |
Указывает, будут ли печататься линии сетки листа. |
| print |
Указывает, будут ли печататься заголовки листа. |
| print |
Параметр порядка печати страницы листа. Определяет порядок, использующийся при обработке распечатываемых номеров страниц. |
| right |
Правое поле листа (в пунктах) для использования при печати. |
| top |
Верхнее поле листа (в пунктах) для использования при печати. |
| zoom | Параметры масштабирования листа. Объект |
Методы
| get |
Возвращает объект , состоящий |
| get |
Возвращает объект , состоящий |
| get |
Получает объект range, представляющий столбцы заголовков. |
| get |
Получает объект range, представляющий столбцы заголовков. Если значение не задано, то этот метод возвращает объект со свойством , для его |
| get |
Получает объект range, представляющий строки заголовков. |
| get |
Получает объект range, представляющий строки заголовков. Если значение не задано, то этот метод возвращает объект со свойством , для его |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| set |
Задает область печати листа. |
| set |
Задает поля страницы с единицами измерения для листа. |
| set |
Задает поля страницы с единицами измерения для листа. |
| set |
Задает столбцы, содержащие ячейки, которые должны повторяться слева на каждой странице при печати листа. |
| set |
Задает строки, содержащие ячейки, которые должны повторяться сверху каждой страницы при печати листа. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
blackAndWhite
Параметр черно-белой печати листа.
blackAndWhite: boolean;Значение свойства
boolean
Комментарии
bottomMargin
Нижнее поле страницы листа, используемое для печати в точках.
bottomMargin: number;Значение свойства
number
Комментарии
centerHorizontally
Центр листа по горизонтали. Эта отметка определяет, выравнивается ли лист по горизонтали относительно центра при печати.
centerHorizontally: boolean;Значение свойства
boolean
Комментарии
Примеры
// 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
По центру листа по вертикали. Эта отметка определяет, выравнивается ли лист по вертикали относительно центра при печати.
centerVertically: boolean;Значение свойства
boolean
Комментарии
Примеры
// 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
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
draftMode
Параметр режима черновика листа. Если trueзначение , лист будет напечатан без графики.
draftMode: boolean;Значение свойства
boolean
Комментарии
firstPageNumber
Номер первой страницы листа для печати. Значение null представляет "автоматическую" нумеровку страниц.
firstPageNumber: number | "";Значение свойства
number | ""
Комментарии
footerMargin
Поле нижнего колонтитула листа (в пунктах) для использования при печати.
footerMargin: number;Значение свойства
number
Комментарии
headerMargin
Поле заголовка листа (в пунктах) для использования при печати.
headerMargin: number;Значение свойства
number
Комментарии
headersFooters
Настройка колонтитулов для листа.
readonly headersFooters: Excel.HeaderFooterGroup;Значение свойства
Комментарии
leftMargin
Левое поле листа (в пунктах) для использования при печати.
leftMargin: number;Значение свойства
number
Комментарии
orientation
Ориентация листа страницы.
orientation: Excel.PageOrientation | "Portrait" | "Landscape";Значение свойства
Excel.PageOrientation | "Portrait" | "Landscape"
Комментарии
Примеры
// 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
Размер бумаги листа страницы.
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";Значение свойства
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"
Комментарии
printComments
Указывает, должны ли примечания листа отображаться при печати.
printComments: Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace";Значение свойства
Excel.PrintComments | "NoComments" | "EndSheet" | "InPlace"
Комментарии
printErrors
Параметр ошибок печати листа.
printErrors: Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable";Значение свойства
Excel.PrintErrorType | "AsDisplayed" | "Blank" | "Dash" | "NotAvailable"
Комментарии
printGridlines
Указывает, будут ли печататься линии сетки листа.
printGridlines: boolean;Значение свойства
boolean
Комментарии
printHeadings
Указывает, будут ли печататься заголовки листа.
printHeadings: boolean;Значение свойства
boolean
Комментарии
printOrder
Параметр порядка печати страницы листа. Определяет порядок, использующийся при обработке распечатываемых номеров страниц.
printOrder: Excel.PrintOrder | "DownThenOver" | "OverThenDown";Значение свойства
Excel.PrintOrder | "DownThenOver" | "OverThenDown"
Комментарии
rightMargin
Правое поле листа (в пунктах) для использования при печати.
rightMargin: number;Значение свойства
number
Комментарии
topMargin
Верхнее поле листа (в пунктах) для использования при печати.
topMargin: number;Значение свойства
number
Комментарии
zoom
Параметры масштабирования листа. Объект PageLayoutZoomOptions должен быть задан как объект JSON (используйте x.zoom = {...} вместо x.zoom.scale = ...).
zoom: Excel.PageLayoutZoomOptions;Значение свойства
Комментарии
Примеры
// 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();
});
Сведения о методе
getPrintArea()
Возвращает объект , состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, который представляет область печати для листа. Если области печати нет, будет выдана ItemNotFound ошибка.
getPrintArea(): Excel.RangeAreas;Возвращаемое значение
Комментарии
getPrintAreaOrNullObject()
Возвращает объект , состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, который представляет область печати для листа. Если области печати нет, то этот метод возвращает объект со свойством isNullObject .true Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getPrintAreaOrNullObject(): Excel.RangeAreas;Возвращаемое значение
Комментарии
getPrintTitleColumns()
Получает объект range, представляющий столбцы заголовков.
getPrintTitleColumns(): Excel.Range;Возвращаемое значение
Комментарии
getPrintTitleColumnsOrNullObject()
Получает объект range, представляющий столбцы заголовков. Если значение не задано, то этот метод возвращает объект со свойством , для его isNullObject свойства задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getPrintTitleColumnsOrNullObject(): Excel.Range;Возвращаемое значение
Комментарии
getPrintTitleRows()
Получает объект range, представляющий строки заголовков.
getPrintTitleRows(): Excel.Range;Возвращаемое значение
Комментарии
getPrintTitleRowsOrNullObject()
Получает объект range, представляющий строки заголовков. Если значение не задано, то этот метод возвращает объект со свойством , для его isNullObject свойства задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getPrintTitleRowsOrNullObject(): Excel.Range;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.PageLayoutLoadOptions): Excel.PageLayout;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.PageLayout;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PageLayout;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.PageLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.PageLayoutUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.PageLayout): void;Параметры
- properties
- Excel.PageLayout
Возвращаемое значение
void
setPrintArea(printArea)
Задает область печати листа.
setPrintArea(printArea: Range | RangeAreas | string): void;Параметры
- printArea
-
Excel.Range | Excel.RangeAreas | string
Диапазон или диапазоны содержимого для печати.
Возвращаемое значение
void
Комментарии
Примеры
// 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)
Задает поля страницы с единицами измерения для листа.
setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions): void;Параметры
Единица измерения для предоставленных полей.
- marginOptions
- Excel.PageLayoutMarginOptions
Значения полей для задания. Поля, не предоставленные, остаются без изменений.
Возвращаемое значение
void
Комментарии
setPrintMargins(unitString, marginOptions)
Задает поля страницы с единицами измерения для листа.
setPrintMargins(unitString: "Points" | "Inches" | "Centimeters", marginOptions: Excel.PageLayoutMarginOptions): void;Параметры
- unitString
-
"Points" | "Inches" | "Centimeters"
Единица измерения для предоставленных полей.
- marginOptions
- Excel.PageLayoutMarginOptions
Значения полей для задания. Поля, не предоставленные, остаются без изменений.
Возвращаемое значение
void
Комментарии
setPrintTitleColumns(printTitleColumns)
Задает столбцы, содержащие ячейки, которые должны повторяться слева на каждой странице при печати листа.
setPrintTitleColumns(printTitleColumns: Range | string): void;Параметры
- printTitleColumns
-
Excel.Range | string
Столбцы, повторяемые слева от каждой страницы. Диапазон должен охватывать весь столбец, чтобы быть допустимым.
Возвращаемое значение
void
Комментарии
setPrintTitleRows(printTitleRows)
Задает строки, содержащие ячейки, которые должны повторяться сверху каждой страницы при печати листа.
setPrintTitleRows(printTitleRows: Range | string): void;Параметры
- printTitleRows
-
Excel.Range | string
Повторяющиеся строки в верхней части каждой страницы. Диапазон должен охватывать всю строку, чтобы быть допустимым.
Возвращаемое значение
void
Комментарии
Примеры
// 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()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.PageLayout является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PageLayoutData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.PageLayoutData;Возвращаемое значение
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по