Excel.IterativeCalculation class

Пакет:

excel

Представляет параметры итеративного вычисления.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
enabled	Значение true, если в Excel используется итерация для разрешения циклических ссылок.
maxChange	Указывает максимальный объем изменений между каждой итерацией, так как Excel разрешает циклические ссылки.
maxIteration	Указывает максимальное количество итераций, которые Excel может использовать для разрешения циклической ссылки.

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

enabled

Значение true, если в Excel используется итерация для разрешения циклических ссылок.

enabled: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

maxChange

Указывает максимальный объем изменений между каждой итерацией, так как Excel разрешает циклические ссылки.

maxChange: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

maxIteration

Указывает максимальное количество итераций, которые Excel может использовать для разрешения циклической ссылки.

maxIteration: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

load(options)

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

load(options?: Excel.Interfaces.IterativeCalculationLoadOptions): Excel.IterativeCalculation;

Параметры

options

Excel.Interfaces.IterativeCalculationLoadOptions

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

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

Excel.IterativeCalculation

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.IterativeCalculation

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.IterativeCalculation

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.IterativeCalculationUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.IterativeCalculation): void;

Параметры

properties

Excel.IterativeCalculation

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

void

toJSON()

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

toJSON(): Excel.Interfaces.IterativeCalculationData;

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

Excel.Interfaces.IterativeCalculationData