Поделиться через


Excel.HeaderFooter class

Extends

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

centerFooter

Центральный нижний колонтитул листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

centerHeader

Центральный заголовок листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

context

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

leftFooter

Левый нижний колонтитул листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

leftHeader

Левый заголовок листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

rightFooter

Правый нижний колонтитул листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

rightHeader

Правый заголовок листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

Методы

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.HeaderFooter является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.HeaderFooterData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

centerFooter

Центральный нижний колонтитул листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

centerFooter: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

centerHeader

Центральный заголовок листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

centerHeader: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

context

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

context: RequestContext;

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

leftFooter

Левый нижний колонтитул листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

leftFooter: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

leftHeader

Левый заголовок листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

leftHeader: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

rightFooter

Правый нижний колонтитул листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

rightFooter: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

rightHeader

Правый заголовок листа. Чтобы применить форматирование шрифта или вставить значение переменной, используйте коды форматирования, указанные здесь: https://msdn.microsoft.com/library/bb225426.aspx.

rightHeader: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

load(options)

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

load(options?: Excel.Interfaces.HeaderFooterLoadOptions): Excel.HeaderFooter;

Параметры

options
Excel.Interfaces.HeaderFooterLoadOptions

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

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.HeaderFooterUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.HeaderFooter): void;

Параметры

properties
Excel.HeaderFooter

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

void

toJSON()

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

toJSON(): Excel.Interfaces.HeaderFooterData;

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