Excel.CustomXmlPartScopedCollection class

包:: excel

自定义 XML 部分的作用域集合。作用域集合是一些操作的结果 (例如，按命名空间) 筛选。无法进一步限定范围的集合。

扩展: OfficeExtension.ClientObject

注解

使用方

Excel.CustomXmlPartCollection： getByNamespace

属性

context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

getCount()	获取此集合中 CustomXML 部件的数量。
getItem(id)	获取基于其 ID 的自定义 XML 部件。
getItemOrNullObject(id)	获取基于其 ID 的自定义 XML 部件。如果不 `CustomXmlPart` 存在，则此方法返回其 `isNullObject` 属性设置为 `true`的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。
getOnlyItem()	如果集合仅包含一个项，则此方法返回该项。否则，此方法将生成错误。
getOnlyItemOrNullObject()	如果集合仅包含一个项，则此方法返回该项。否则，此方法将返回 `null`。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `Excel.CustomXmlPartScopedCollection` 对象是 API 对象，但该 `toJSON` 方法返回一个纯 JavaScript 对象， (类型为 `Excel.Interfaces.CustomXmlPartScopedCollectionData`) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

属性详细信息

context

与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

items

获取此集合中已加载的子项。

readonly items: Excel.CustomXmlPart[];

属性值

Excel.CustomXmlPart[]

方法详细信息

getCount()

获取此集合中 CustomXML 部件的数量。

getCount(): OfficeExtension.ClientResult<number>;

OfficeExtension.ClientResult<number>

注解

API 集：ExcelApi 1.5

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml

await Excel.run(async (context) => {
    document.getElementById("display-xml").textContent = "";
    const contosoNamespace = "http://schemas.contoso.com/review/1.0";
    const customXmlParts = context.workbook.customXmlParts;
    const filteredXmlParts = customXmlParts.getByNamespace(contosoNamespace);
    const numberOfPartsInNamespace = filteredXmlParts.getCount();

    await context.sync();

    if (numberOfPartsInNamespace.value == 1) {
        const onlyXmlPartInNamespace = filteredXmlParts.getOnlyItem();
        const xmlBlob = onlyXmlPartInNamespace.getXml();

        await context.sync();

        // Make it a bit more readable.
        const readableXml = xmlBlob.value.replace(/></g, ">\n<");

        document.getElementById("display-xml").textContent = `The only XML part in the namespace ${contosoNamespace} is:
            ${readableXml}`;

    } else {
        console.log(`There are ${numberOfPartsInNamespace.value} XML parts with namespace ${contosoNamespace}. There should be exactly 1.`);
    }        

    await context.sync();
});

getItem(id)

获取基于其 ID 的自定义 XML 部件。

getItem(id: string): Excel.CustomXmlPart;

参数

id: string

要检索的对象的 ID。

Excel.CustomXmlPart

注解

API 集：ExcelApi 1.5

getItemOrNullObject(id)

获取基于其 ID 的自定义 XML 部件。如果不 CustomXmlPart 存在，则此方法返回其 isNullObject 属性设置为 true的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(id: string): Excel.CustomXmlPart;

参数

id: string

要检索的对象的 ID。

Excel.CustomXmlPart

注解

API 集：ExcelApi 1.5

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml

await Excel.run(async (context) => {
    const settings = context.workbook.settings;
    const xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value");
    await context.sync();

    if (xmlPartIDSetting.value) {   
        let customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value);
        const xmlBlob = customXmlPart.getXml();
        customXmlPart.delete();
        customXmlPart = context.workbook.customXmlParts.getItemOrNullObject(xmlPartIDSetting.value);

        await context.sync();

        if (customXmlPart.isNullObject) {
            document.getElementById("display-xml").textContent = `The XML part with the id ${xmlPartIDSetting.value} has been deleted.`;

            // Delete the unneeded setting too.
            xmlPartIDSetting.delete();            
        } else {
            const readableXml = addLineBreaksToXML(xmlBlob.value);
            const strangeMessage = `This is strange. The XML part with the id ${xmlPartIDSetting.value} has not been deleted:\n${readableXml}`
            document.getElementById("display-xml").textContent = strangeMessage;
        }

        await context.sync();
    }
});

getOnlyItem()

如果集合仅包含一个项，则此方法返回该项。否则，此方法将生成错误。

getOnlyItem(): Excel.CustomXmlPart;

Excel.CustomXmlPart

注解

API 集：ExcelApi 1.5

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml

await Excel.run(async (context) => {
    document.getElementById("display-xml").textContent = "";
    const contosoNamespace = "http://schemas.contoso.com/review/1.0";
    const customXmlParts = context.workbook.customXmlParts;
    const filteredXmlParts = customXmlParts.getByNamespace(contosoNamespace);
    const numberOfPartsInNamespace = filteredXmlParts.getCount();

    await context.sync();

    if (numberOfPartsInNamespace.value == 1) {
        const onlyXmlPartInNamespace = filteredXmlParts.getOnlyItem();
        const xmlBlob = onlyXmlPartInNamespace.getXml();

        await context.sync();

        // Make it a bit more readable.
        const readableXml = xmlBlob.value.replace(/></g, ">\n<");

        document.getElementById("display-xml").textContent = `The only XML part in the namespace ${contosoNamespace} is:
            ${readableXml}`;

    } else {
        console.log(`There are ${numberOfPartsInNamespace.value} XML parts with namespace ${contosoNamespace}. There should be exactly 1.`);
    }        

    await context.sync();
});

getOnlyItemOrNullObject()

如果集合仅包含一个项，则此方法返回该项。否则，此方法将返回 null。

getOnlyItemOrNullObject(): Excel.CustomXmlPart;

Excel.CustomXmlPart

注解

API 集：ExcelApi 1.5

load(options)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CustomXmlPartScopedCollection;

参数

options: Excel.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

为要加载的对象属性提供选项。

Excel.CustomXmlPartScopedCollection

load(propertyNames)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.CustomXmlPartScopedCollection;

参数

propertyNames: string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

Excel.CustomXmlPartScopedCollection

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CustomXmlPartScopedCollection;

参数

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

Excel.CustomXmlPartScopedCollection

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.CustomXmlPartScopedCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.CustomXmlPartScopedCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

toJSON(): Excel.Interfaces.CustomXmlPartScopedCollectionData;

Excel.Interfaces.CustomXmlPartScopedCollectionData

反馈

此页面是否有帮助？