Excel.HeaderFooterPicture class

Пакет:
excel

Представляет рисунок в верхнем или нижнем колонтитуле листа.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApiDesktop 1.1

Используется

Свойства

brightness

Определяет яркость рисунка. Значение этого свойства должно быть числом от 0,0 (самая яркая) до 1,0 (самая яркая).
colorType

Определяет тип цветового преобразования рисунка.
context

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

Определяет контрастность рисунка. Значение этого свойства должно быть числом от 0,0 (наименьший контраст) до 1,0 (наибольший контраст).
cropBottom

Количество точек, обрезаемых в нижней части рисунка.
cropLeft

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

Количество точек, обрезаемых в правой части рисунка.
cropTop

Указывает количество точек, обрезаемых в верхней части рисунка.
filename

Указывает URL-адрес (в интрасети или в Интернете) или путь (локальный или сетевый) к расположению, в котором сохранен исходный объект.
height

Указывает высоту рисунка в точках.
lockAspectRatio

Указывает, сохраняет ли рисунок исходные пропорции при изменении размера. true если он сохраняет свои пропорции; в противном случае, false.
width

Ширина рисунка в точках.

Методы

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

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

brightness

Определяет яркость рисунка. Значение этого свойства должно быть числом от 0,0 (самая яркая) до 1,0 (самая яркая).

brightness: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

colorType

Определяет тип цветового преобразования рисунка.

colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";

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

Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"

Комментарии

Набор API: ExcelApiDesktop 1.1

context

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

context: RequestContext;

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

Excel.RequestContext

contrast

Определяет контрастность рисунка. Значение этого свойства должно быть числом от 0,0 (наименьший контраст) до 1,0 (наибольший контраст).

contrast: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

cropBottom

Количество точек, обрезаемых в нижней части рисунка.

cropBottom: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

cropLeft

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

cropLeft: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

cropRight

Количество точек, обрезаемых в правой части рисунка.

cropRight: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

cropTop

Указывает количество точек, обрезаемых в верхней части рисунка.

cropTop: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

filename

Указывает URL-адрес (в интрасети или в Интернете) или путь (локальный или сетевый) к расположению, в котором сохранен исходный объект.

filename: string;

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

string

Комментарии

Набор API: ExcelApiDesktop 1.1

height

Указывает высоту рисунка в точках.

height: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

lockAspectRatio

Указывает, сохраняет ли рисунок исходные пропорции при изменении размера. true если он сохраняет свои пропорции; в противном случае, false.

lockAspectRatio: boolean;

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

boolean

Комментарии

Набор API: ExcelApiDesktop 1.1

width

Ширина рисунка в точках.

width: number;

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

number

Комментарии

Набор API: ExcelApiDesktop 1.1

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

load(options)

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

load(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;

Параметры

options
Excel.Interfaces.HeaderFooterPictureLoadOptions

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

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

Excel.HeaderFooterPicture

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.HeaderFooterPicture

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.HeaderFooterPicture

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.HeaderFooterPictureUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

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;

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

Excel.Interfaces.HeaderFooterPictureData