PowerPoint.Adjustments class

Пакет:

powerpoint

Представляет значения корректировки для фигуры.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: PowerPointApi 1.10

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

• PowerPoint.Shape: корректировки

Свойства

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

Методы

get(index)	Получает значение корректировки по заданному индексу, отсчитывающемуся от нуля. Создает InvalidArgument исключение, когда индекс выходит за пределы допустимого диапазона.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(index, value)	Устанавливает значение корректировки на основе заданного индекса, отсчитываемого от нуля. Создает InvalidArgument исключение, когда индекс выходит за пределы допустимого диапазона.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.Adjustments объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.AdjustmentsData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

count

Число точек корректировки.

readonly count: number;

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

number

Комментарии

Набор API: PowerPointApi 1.10

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

get(index)

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

get(index: number): OfficeExtension.ClientResult<number>;

Параметры

index

number

Индекс корректировки для получения.

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

OfficeExtension.ClientResult<number>

Значение корректировки по заданному индексу.

Комментарии

Набор API: PowerPointApi 1.10

load(options)

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

load(options?: PowerPoint.Interfaces.AdjustmentsLoadOptions): PowerPoint.Adjustments;

Параметры

options

PowerPoint.Interfaces.AdjustmentsLoadOptions

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

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

PowerPoint.Adjustments

load(propertyNames)

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

load(propertyNames?: string | string[]): PowerPoint.Adjustments;

Параметры

propertyNames

string | string[]

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

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

PowerPoint.Adjustments

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Adjustments;

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.Adjustments

set(index, value)

Устанавливает значение корректировки на основе заданного индекса, отсчитываемого от нуля. Создает InvalidArgument исключение, когда индекс выходит за пределы допустимого диапазона.

set(index: number, value: number): void;

Параметры

index

number

Индекс корректировки, который нужно задать.

value

number

Задаваемое значение корректировки.

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

void

Комментарии

Набор API: PowerPointApi 1.10

toJSON()

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

toJSON(): PowerPoint.Interfaces.AdjustmentsData;

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

PowerPoint.Interfaces.AdjustmentsData