Excel.CustomFunctionManager class

Пакет:

excel

Управляет параметрами пользовательских функций.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.20 ]

Свойства

context

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

Методы

load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
newObject(context)	Создайте новый экземпляр Excel.CustomFunctionManager объекта .
setVisibility(customFunctionVisibilityOptions)	Отображение или скрытие пользовательских функций в автозаполнения Excel.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.CustomFunctionManager объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.CustomFunctionManagerData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

context

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

context: RequestContext;

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

Excel.RequestContext

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

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.CustomFunctionManager

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.CustomFunctionManager

newObject(context)

Создайте новый экземпляр Excel.CustomFunctionManager объекта .

static newObject(context: OfficeExtension.ClientRequestContext): Excel.CustomFunctionManager;

Параметры

context

OfficeExtension.ClientRequestContext

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

Excel.CustomFunctionManager

Комментарии

[ Набор API: ExcelApi 1.20 ]

setVisibility(customFunctionVisibilityOptions)

Отображение или скрытие пользовательских функций в автозаполнения Excel.

static setVisibility(customFunctionVisibilityOptions: Excel.CustomFunctionVisibilityOptions): void;

Параметры

customFunctionVisibilityOptions

Excel.CustomFunctionVisibilityOptions

Указывает, какие пользовательские функции следует отображать или скрывать.

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

void

Комментарии

[ Набор API: ExcelApi 1.20 ]

toJSON()

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

toJSON(): Excel.Interfaces.CustomFunctionManagerData;

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

Excel.Interfaces.CustomFunctionManagerData