Excel.CustomProperty class

Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.7

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

Свойства

context

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

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

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

Значение настраиваемого свойства. Длина значения вне Excel в Интернете ограничена 255 символами (на других платформах длина больших значений автоматически сокращается до 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

Значение настраиваемого свойства. Длина значения вне Excel в Интернете ограничена 255 символами (на других платформах длина больших значений автоматически сокращается до 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

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

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

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