Word.CustomXmlSchemaCollection class
Представляет коллекцию Word. Объекты CustomXmlSchema, прикрепленные к потоку данных.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(options) | Добавляет одну или несколько схем в коллекцию схем, которые затем можно добавить в поток в хранилище данных и в библиотеку схем. |
| add |
Добавляет существующую коллекцию схем в текущую. |
| get |
Возвращает число элементов в коллекции. |
| get |
Возвращает объект, |
| get |
Возвращает число элементов в коллекции. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
| validate() | Указывает, являются ли допустимыми схемы в коллекции схем (соответствует синтаксическим правилам XML и правилам для заданного словаря). |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: Word.CustomXmlSchema[];Значение свойства
Сведения о методе
add(options)
Добавляет одну или несколько схем в коллекцию схем, которые затем можно добавить в поток в хранилище данных и в библиотеку схем.
add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema;Параметры
- options
- Word.CustomXmlAddSchemaOptions
Необязательный параметр. Параметры, определяющие схему для добавления.
Возвращаемое значение
Комментарии
addCollection(schemaCollection)
Добавляет существующую коллекцию схем в текущую.
addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection;Параметры
- schemaCollection
- Word.CustomXmlSchemaCollection
Добавляемая коллекция схем.
Возвращаемое значение
Комментарии
getCount()
Возвращает число элементов в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
getItem(index)
Возвращает объект, CustomXmlSchema представляющий указанный элемент семейства.
getItem(index: number): Word.CustomXmlSchema;Параметры
- index
-
number
Расположение CustomXmlSchema объекта.
Возвращаемое значение
Комментарии
getNamespaceUri()
Возвращает число элементов в коллекции.
getNamespaceUri(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection;Параметры
- options
-
Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.CustomXmlSchemaCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlSchemaCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CustomXmlSchemaCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.CustomXmlSchemaCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.CustomXmlSchemaCollection;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.CustomXmlSchemaCollection;Возвращаемое значение
validate()
Указывает, являются ли допустимыми схемы в коллекции схем (соответствует синтаксическим правилам XML и правилам для заданного словаря).
validate(): OfficeExtension.ClientResult<boolean>;Возвращаемое значение
OfficeExtension.ClientResult<boolean>