Excel.HeaderFooterPicture class
Представляет рисунок в верхнем или нижнем колонтитуле листа.
- Extends
Комментарии
Свойства
| brightness | Задает яркость рисунка. Значение для этого свойства должно быть числом от 0,0 (самый яркий) до 1,0 (самый яркий). |
| color |
Указывает тип преобразования цвета рисунка. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| contrast | Указывает контрастность рисунка. Значение этого свойства должно быть числом от 0,0 (наименьшая контрастность) до 1,0 (самая контрастность). |
| crop |
Указывает количество точек, обрезанных в нижней части рисунка. |
| crop |
Указывает количество точек, которые обрезаются от левой части рисунка. |
| crop |
Указывает количество точек, которые обрезаются от правой части рисунка. |
| crop |
Указывает количество точек, которые обрезаются в верхней части рисунка. |
| filename | Указывает URL-адрес (в интрасети или Интернете) или путь (локальный или сетевой) к расположению, в котором сохраняется исходный объект. |
| height | Задает высоту рисунка в точках. |
| lock |
Указывает значение, указывающее, сохраняет ли рисунок исходные пропорции при изменении размера.
|
| width | Задает ширину рисунка в точках. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
brightness
Задает яркость рисунка. Значение для этого свойства должно быть числом от 0,0 (самый яркий) до 1,0 (самый яркий).
brightness: number;Значение свойства
number
Комментарии
colorType
Указывает тип преобразования цвета рисунка.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";Значение свойства
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
contrast
Указывает контрастность рисунка. Значение этого свойства должно быть числом от 0,0 (наименьшая контрастность) до 1,0 (самая контрастность).
contrast: number;Значение свойства
number
Комментарии
cropBottom
Указывает количество точек, обрезанных в нижней части рисунка.
cropBottom: number;Значение свойства
number
Комментарии
cropLeft
Указывает количество точек, которые обрезаются от левой части рисунка.
cropLeft: number;Значение свойства
number
Комментарии
cropRight
Указывает количество точек, которые обрезаются от правой части рисунка.
cropRight: number;Значение свойства
number
Комментарии
cropTop
Указывает количество точек, которые обрезаются в верхней части рисунка.
cropTop: number;Значение свойства
number
Комментарии
filename
Указывает URL-адрес (в интрасети или Интернете) или путь (локальный или сетевой) к расположению, в котором сохраняется исходный объект.
filename: string;Значение свойства
string
Комментарии
height
Задает высоту рисунка в точках.
height: number;Значение свойства
number
Комментарии
lockAspectRatio
Указывает значение, указывающее, сохраняет ли рисунок исходные пропорции при изменении размера.
true если он сохраняет свои пропорции; В противном случае — falseзначение .
lockAspectRatio: boolean;Значение свойства
boolean
Комментарии
width
Задает ширину рисунка в точках.
width: number;Значение свойства
number
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.HeaderFooterPicture;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.HeaderFooterPicture;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Excel.HeaderFooterPicture): void;Параметры
- properties
- Excel.HeaderFooterPicture
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.HeaderFooterPicture объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.HeaderFooterPictureData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Excel.Interfaces.HeaderFooterPictureData;