Excel.PageBreak class

Пакет:

excel

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

columnIndex	Задает индекс столбца для разрыва страницы.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
rowIndex	Задает индекс строки для разрыва страницы.

Методы

delete()	Удаляет объект разрыва страницы.
getCellAfterBreak()	Получает первую ячейку после разрыва страницы.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.PageBreak является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PageBreakData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

columnIndex

Задает индекс столбца для разрыва страницы.

readonly columnIndex: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

rowIndex

Задает индекс строки для разрыва страницы.

readonly rowIndex: number;

Значение свойства

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

Сведения о методе

delete()

Удаляет объект разрыва страницы.

delete(): void;

Возвращаемое значение

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

getCellAfterBreak()

Получает первую ячейку после разрыва страницы.

getCellAfterBreak(): Excel.Range;

Возвращаемое значение

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.9 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.PageBreakLoadOptions): Excel.PageBreak;

Параметры

options

Excel.Interfaces.PageBreakLoadOptions

Предоставляет параметры свойств загружаемого объекта.

Возвращаемое значение

Excel.PageBreak

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.PageBreak;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.PageBreak

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.PageBreak;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.PageBreak

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.PageBreak является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.PageBreakData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.PageBreakData;

Возвращаемое значение

Excel.Interfaces.PageBreakData