Excel.CustomPropertyCollection class
Содержит коллекцию настраиваемых свойств.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(key, value) | Создает или задает настраиваемое свойство. |
| delete |
Удаляет все настраиваемые свойства в коллекции. |
| get |
Получает количество настраиваемых свойств. |
| get |
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Выдает ошибку, если настраиваемое свойство не существует. |
| get |
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательского свойства не существует, этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Excel.CustomProperty[];Значение свойства
Сведения о методе
add(key, value)
Создает или задает настраиваемое свойство.
add(key: string, value: any): Excel.CustomProperty;Параметры
- key
-
string
Обязательно. Ключ настраиваемого свойства без учета регистра. Длина ключа ограничена 255 символами вне Excel в Интернете (на других платформах длина больших клавиш автоматически сокращается до 255 символов).
- value
-
any
Обязательно. Значение настраиваемого свойства. Длина значения вне Excel в Интернете ограничена 255 символами (на других платформах длина больших значений автоматически сокращается до 255).
Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Get the key/value pair from the task pane.
const userKey = document.getElementById("key").textContent;
const userValue = document.getElementById("value").textContent;
// Add the custom property.
const customDocProperties = context.workbook.properties.custom;
customDocProperties.add(userKey, userValue);
await context.sync();
console.log(`Successfully set custom document property ${userKey}: ${userValue}.`);
});
deleteAll()
Удаляет все настраиваемые свойства в коллекции.
deleteAll(): void;Возвращаемое значение
void
Комментарии
getCount()
Получает количество настраиваемых свойств.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/properties.yaml
await Excel.run(async (context) => {
let customDocProperties = context.workbook.properties.custom;
let count = customDocProperties.getCount();
await context.sync();
console.log("Count of custom document properties :" + count.value);
});
getItem(key)
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Выдает ошибку, если настраиваемое свойство не существует.
getItem(key: string): Excel.CustomProperty;Параметры
- key
-
string
Ключ, определяющий объект настраиваемого свойства.
Возвращаемое значение
Комментарии
getItemOrNullObject(key)
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательского свойства не существует, этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): Excel.CustomProperty;Параметры
- key
-
string
Обязательно. Ключ, определяющий объект настраиваемого свойства.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomPropertyCollection;Параметры
- options
-
Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.CustomPropertyCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.CustomPropertyCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.CustomPropertyCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Excel.Interfaces.CustomPropertyCollectionData;