Excel.CustomProperty class

Пакет:

excel

Представляет пользовательское свойство.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
key	Ключ настраиваемого свойства. Клавиша ограничена 255 символами за пределами Excel в Интернете (более крупные клавиши автоматически обрезаются до 255 символов на других платформах).
type	Тип значения, используемого для настраиваемого свойства.
value	Значение настраиваемого свойства. Значение ограничено 255 символами за пределами Excel в Интернете (на других платформах значения большего размера автоматически обрезаются до 255 символов).

Методы

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

key

Ключ настраиваемого свойства. Клавиша ограничена 255 символами за пределами Excel в Интернете (более крупные клавиши автоматически обрезаются до 255 символов на других платформах).

readonly key: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

type

Тип значения, используемого для настраиваемого свойства.

readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float";

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

Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"

Комментарии

[ Набор API: ExcelApi 1.7 ]

value

Значение настраиваемого свойства. Значение ограничено 255 символами за пределами Excel в Интернете (на других платформах значения большего размера автоматически обрезаются до 255 символов).

value: any;

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

any

Комментарии

[ Набор API: ExcelApi 1.7 ]

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

delete()

Удаляет настраиваемое свойство.

delete(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

load(options)

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

load(options?: Excel.Interfaces.CustomPropertyLoadOptions): Excel.CustomProperty;

Параметры

options

Excel.Interfaces.CustomPropertyLoadOptions

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

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

Excel.CustomProperty

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.CustomProperty

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.CustomProperty

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.CustomPropertyUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.CustomProperty): void;

Параметры

properties

Excel.CustomProperty

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

void

toJSON()

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

toJSON(): Excel.Interfaces.CustomPropertyData;

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

Excel.Interfaces.CustomPropertyData