Word.CustomPropertyCollection class
Содержит коллекцию Word. Объекты CustomProperty.
- Extends
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml
await Word.run(async (context) => {
const properties: Word.CustomPropertyCollection = context.document.properties.customProperties;
properties.load("key,type,value");
await context.sync();
for (let i = 0; i < properties.items.length; i++)
console.log("Property Name:" + properties.items[i].key + "; Type=" + properties.items[i].type + "; Property Value=" + properties.items[i].value);
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(key, value) | Создает или задает настраиваемое свойство. |
| delete |
Удаляет все настраиваемые свойства в коллекции. |
| get |
Получает количество настраиваемых свойств. |
| get |
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Выдает ошибку |
| get |
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательское свойство не существует, этот метод возвращает объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Word.CustomProperty[];Значение свойства
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml
await Word.run(async (context) => {
const properties: Word.CustomPropertyCollection = context.document.properties.customProperties;
properties.load("key,type,value");
await context.sync();
for (let i = 0; i < properties.items.length; i++)
console.log("Property Name:" + properties.items[i].key + "; Type=" + properties.items[i].type + "; Property Value=" + properties.items[i].value);
});
Сведения о методе
add(key, value)
Создает или задает настраиваемое свойство.
add(key: string, value: any): Word.CustomProperty;Параметры
- key
-
string
Обязательно. Ключ настраиваемого свойства, который не учитывает регистр.
- value
-
any
Обязательно. Значение настраиваемого свойства.
Возвращаемое значение
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml
await Word.run(async (context) => {
context.document.properties.customProperties.add("Numeric Property", 1234);
await context.sync();
console.log("Property added");
});
...
await Word.run(async (context) => {
context.document.properties.customProperties.add("String Property", "Hello World!");
await context.sync();
console.log("Property added");
});
deleteAll()
Удаляет все настраиваемые свойства в коллекции.
deleteAll(): void;Возвращаемое значение
void
Комментарии
getCount()
Получает количество настраиваемых свойств.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(key)
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Выдает ошибку ItemNotFound , если пользовательское свойство не существует.
getItem(key: string): Word.CustomProperty;Параметры
- key
-
string
Ключ, идентифицирующий объект пользовательского свойства.
Возвращаемое значение
Комментарии
getItemOrNullObject(key)
Возвращает объект настраиваемого свойства по ключу, указываемому без учета регистра. Если пользовательское свойство не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): Word.CustomProperty;Параметры
- key
-
string
Обязательно. Ключ, идентифицирующий объект пользовательского свойства.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.CustomPropertyCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomPropertyCollection;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.CustomPropertyCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomPropertyCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CustomPropertyCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CustomPropertyCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): Word.Interfaces.CustomPropertyCollectionData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.CustomPropertyCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.CustomPropertyCollection;Возвращаемое значение
Office Add-ins