Excel.HeaderFooterGroup class
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| default |
Общий колонтитул, используемый для всех страниц, если не указан колонтитул четных и нечетных страниц или первой страницы. |
| even |
Колонтитул для четных страниц, для нечетных страниц нужно указывать отдельный колонтитул. |
| first |
Колонтитул первой страницы, для остальных страниц используется общий или четный и нечетный колонтитулы. |
| odd |
Колонтитул для нечетных страниц, для четных страниц нужно указывать отдельный колонтитул. |
| state | Состояние, в котором задаются верхние и нижние колонтитулы. См. |
| use |
Флаг, обозначающий, выравниваются ли верхние или нижние колонтитулы относительно полей страницы, заданных в параметрах разметки страницы листа. |
| use |
Указывает флаг, указывающий, следует ли изменять масштаб верхних и нижних колонтитулов в процентах страницы, заданный в параметрах разметки страницы листа. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
defaultForAllPages
Общий колонтитул, используемый для всех страниц, если не указан колонтитул четных и нечетных страниц или первой страницы.
readonly defaultForAllPages: Excel.HeaderFooter;Значение свойства
Комментарии
evenPages
Колонтитул для четных страниц, для нечетных страниц нужно указывать отдельный колонтитул.
readonly evenPages: Excel.HeaderFooter;Значение свойства
Комментарии
firstPage
Колонтитул первой страницы, для остальных страниц используется общий или четный и нечетный колонтитулы.
readonly firstPage: Excel.HeaderFooter;Значение свойства
Комментарии
oddPages
Колонтитул для нечетных страниц, для четных страниц нужно указывать отдельный колонтитул.
readonly oddPages: Excel.HeaderFooter;Значение свойства
Комментарии
state
Состояние, в котором задаются верхние и нижние колонтитулы. См. Excel.HeaderFooterState дополнительные сведения.
state: Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven";Значение свойства
Excel.HeaderFooterState | "Default" | "FirstAndDefault" | "OddAndEven" | "FirstOddAndEven"
Комментарии
useSheetMargins
Флаг, обозначающий, выравниваются ли верхние или нижние колонтитулы относительно полей страницы, заданных в параметрах разметки страницы листа.
useSheetMargins: boolean;Значение свойства
boolean
Комментарии
useSheetScale
Указывает флаг, указывающий, следует ли изменять масштаб верхних и нижних колонтитулов в процентах страницы, заданный в параметрах разметки страницы листа.
useSheetScale: boolean;Значение свойства
boolean
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.HeaderFooterGroupLoadOptions): Excel.HeaderFooterGroup;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.HeaderFooterGroup;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.HeaderFooterGroup;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.HeaderFooterGroupUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.HeaderFooterGroupUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;