PowerPoint.CustomXmlPart class

Пакет:

powerpoint

Представляет пользовательский объект части XML.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: PowerPointApi 1.7

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

• PowerPoint.CustomXmlPartCollection: add, getItem, getItemAt, getItemOrNullObject, items
• PowerPoint.CustomXmlPartScopedCollection: getItem, getItemAt, getItemOrNullObject, getOnlyItem, getOnlyItemOrNullObject, items

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
id	Идентификатор пользовательской части XML.
namespaceUri	Универсальный код ресурса (URI) пространства имен пользовательской части XML.

Методы

delete()	Удаляет пользовательскую XML-часть.
getXml()	Получает содержимое XML пользовательской части XML.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
setXml(xml)	Задает содержимое XML для пользовательской части XML.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.CustomXmlPart объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.CustomXmlPartData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

id

Идентификатор пользовательской части XML.

readonly id: string;

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

string

Комментарии

Набор API: PowerPointApi 1.7

namespaceUri

Универсальный код ресурса (URI) пространства имен пользовательской части XML.

readonly namespaceUri: string;

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

string

Комментарии

Набор API: PowerPointApi 1.7

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

delete()

Удаляет пользовательскую XML-часть.

delete(): void;

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

void

Комментарии

Набор API: PowerPointApi 1.7

getXml()

Получает содержимое XML пользовательской части XML.

getXml(): OfficeExtension.ClientResult<string>;

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

OfficeExtension.ClientResult<string>

Комментарии

Набор API: PowerPointApi 1.7

load(options)

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

load(options?: PowerPoint.Interfaces.CustomXmlPartLoadOptions): PowerPoint.CustomXmlPart;

Параметры

options

PowerPoint.Interfaces.CustomXmlPartLoadOptions

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

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

PowerPoint.CustomXmlPart

load(propertyNames)

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

load(propertyNames?: string | string[]): PowerPoint.CustomXmlPart;

Параметры

propertyNames

string | string[]

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

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

PowerPoint.CustomXmlPart

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.CustomXmlPart;

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.CustomXmlPart

setXml(xml)

Задает содержимое XML для пользовательской части XML.

setXml(xml: string): void;

Параметры

xml

string

XML-содержимое для детали.

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

void

Комментарии

Набор API: PowerPointApi 1.7

toJSON()

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

toJSON(): PowerPoint.Interfaces.CustomXmlPartData;

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

PowerPoint.Interfaces.CustomXmlPartData