Share via

Excel.HeaderFooterGroup class

  • Ссылка
Пакет:
excel
Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

context

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

Общий колонтитул, используемый для всех страниц, если не указан колонтитул четных и нечетных страниц или первой страницы.
evenPages

Колонтитул для четных страниц, для нечетных страниц нужно указывать отдельный колонтитул.
firstPage

Колонтитул первой страницы, для остальных страниц используется общий или четный и нечетный колонтитулы.
oddPages

Колонтитул для нечетных страниц, для четных страниц нужно указывать отдельный колонтитул.
state

Состояние, по которому задаются колонтитулы. Дополнительные сведения см. в этой Excel.HeaderFooterState статье.
useSheetMargins

Получает или задает отметку, которая указывает, выровнены ли колонтитулы относительно полей страницы, установленных в параметрах макета страницы для листа.
useSheetScale

Получает или задает отметку, которая указывает, нужно ли масштабировать колонтитулы с помощью процентных значений, установленных в параметрах макета страницы для листа.

Методы

load(options)

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

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

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

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

defaultForAllPages

Общий колонтитул, используемый для всех страниц, если не указан колонтитул четных и нечетных страниц или первой страницы.

readonly defaultForAllPages: Excel.HeaderFooter;

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

Excel.HeaderFooter

Комментарии

[ Набор API: ExcelApi 1.9 ]

evenPages

Колонтитул для четных страниц, для нечетных страниц нужно указывать отдельный колонтитул.

readonly evenPages: Excel.HeaderFooter;

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

Excel.HeaderFooter

Комментарии

[ Набор API: ExcelApi 1.9 ]

firstPage

Колонтитул первой страницы, для остальных страниц используется общий или четный и нечетный колонтитулы.

readonly firstPage: Excel.HeaderFooter;

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

Excel.HeaderFooter

Комментарии

[ Набор API: ExcelApi 1.9 ]

oddPages

Колонтитул для нечетных страниц, для четных страниц нужно указывать отдельный колонтитул.

readonly oddPages: Excel.HeaderFooter;

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

Excel.HeaderFooter

Комментарии

[ Набор API: ExcelApi 1.9 ]

state

Состояние, по которому задаются колонтитулы. Дополнительные сведения см. в этой Excel.HeaderFooterState статье.

state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";

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

Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"

Комментарии

[ Набор API: ExcelApi 1.9 ]

useSheetMargins

Получает или задает отметку, которая указывает, выровнены ли колонтитулы относительно полей страницы, установленных в параметрах макета страницы для листа.

useSheetMargins: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

useSheetScale

Получает или задает отметку, которая указывает, нужно ли масштабировать колонтитулы с помощью процентных значений, установленных в параметрах макета страницы для листа.

useSheetScale: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

load(options)

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

load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;

Параметры

options
Excel.Interfaces.HeaderFooterGroupLoadOptions

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

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

Excel.HeaderFooterGroup

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.HeaderFooterGroup

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.HeaderFooterGroup

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.HeaderFooterGroupUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.HeaderFooterGroupUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.HeaderFooterGroup): void;

Параметры

properties
Excel.HeaderFooterGroup

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

void

toJSON()

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

toJSON(): Excel.Interfaces.HeaderFooterGroupData;

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

Excel.Interfaces.HeaderFooterGroupData