Requirements 元素

此元素的含义取决于它是在基础清单中使用作为 VersionOverrides> 元素的<子元素,还是作为 Override 元素的子元素使用

提示

使用此元素之前,请熟悉 指定 Office 主机和 API 要求

在基本清单中

在基本清单 ((也就是说,作为 OfficeApp) 的直接子级)中使用时, <“要求> ”元素指定 Office 加载项需要由 Office 激活的 Office JavaScript API 要求) (要求集 和/或方法的最小集合。 在 Office 版本和平台 ((如 Windows、Mac、Web、iOS 或 iPad) )不支持指定方法和要求集的任何组合上都不会激活该加载项。

加载项类型: 任务窗格,“邮件”

作为 VersionOverrides 元素的子元素

当用作 VersionOverrides 的子级时,指定 Office 版本和平台 ((如 Windows、Mac、Web、iOS 或 iPad) )必须支持的 Office JavaScript API 要求 (要求和/或方法) 的最小集合,以便 VersionOverrides> 元素中<覆盖基本清单设置的设置生效。

请考虑这样一个加载项,它在基本清单中指定要求 A,并在 VersionOverrides> 内<指定要求 B。

  • 如果平台和 Office 版本不支持 A,则不会激活加载项,并且 Office 不会分析 <清单的 VersionOverrides> 部分。
  • 如果 A 和 B 都受支持,则加载项将被激活,并且 VersionOverrides> 中的所有<标记将生效。
  • 如果 A 受支持,但 B 不受支持,则加载项将被激活,并且 VersionOverrides> 中<的一些标记将生效。 具体而言,不替代基本清单元素的 VersionOverrides> 子<元素将生效。 例如, <WebApplicationInfo> 元素或 <EquivalentAddins> 生效。 但是,替代基本清单元素(如 <Hosts>)的 VersionOverrides> 的所有<子元素不会生效。 相反,Office 使用基本清单标记的值,否则该标记将被覆盖。

加载项类型: 任务窗格,“邮件”

仅在以下 VersionOverrides 架构中有效

  • 任务窗格 1.0
  • 邮件 1.0
  • 邮件 1.1

有关详细信息,请参阅仅加载 项清单中的版本替代

与以下要求集关联

  • 当父 <VersionOverrides> 类型为 Taskpane 1.0 时,为 AddinCommands 1.1
  • 邮箱 1.3(如果父 <VersionOverrides> 类型为 Mail 1.0)。
  • 邮箱 1.5(如果父 <VersionOverrides> 类型为 Mail 1.1)。

备注

如果 Requirements> 元素未指定基本清单中的 Requirements 中未指定的其他要求,则该<元素在 VersionOverrides> 中<没有任何用途。<> 如果 Office 版本和平台不支持基本清单中的要求,则不会激活加载项, <并且不会分析 VersionOverrides> 元素。 因此,只有在满足这两个条件时,才应在 VersionOverrides> 中使用<Requirements> 元素:<

  • 加载项具有通过 VersionOverrides> (中的配置<实现的附加功能(如加载项命令) ),以及需要未在基本清单的 Requirements> 元素中<指定的方法或要求集。
  • 加载项非常有用,应该 (激活,但不带) 额外功能,即使在平台和 Office 版本的组合中不支持额外功能所需的要求时也是如此。

提示

不要在 VersionOverrides> 内<重复基本清单中的 Requirement 元素。 这样做不会起作用,并且可能会误导 VersionOverrides> 内<Requirements> 元素的<用途。

警告

VersionOverrides> 中使用<<Requirements> 元素之前要非常小心,因为在不支持该要求的平台和版本组合上,将不安装任何加载项命令,即使是那些调用不需要该要求的功能的加载项命令。 例如,考虑具有两个自定义功能区按钮的加载项。 其中一个调用要求集 ExcelApi 1.4 (及更高版本) 中可用的 Office JavaScript API。 其他调用仅在 ExcelApi 1.9 (及更高版本中可用的 API) 。 如果你在 VersionOverrides> 中<设置了对 ExcelApi 1.9 的要求,那么当不支持 1.9 时,功能区上两个按钮都不会显示。 在此方案中,更好的策略是使用 运行时检查方法和需求集支持中所述的技术。 第二个按钮调用的代码首先用于isSetSupported检查对 ExcelApi 1.9 的支持。 如果不支持此功能,则代码会向用户提供消息,指出该加载项的此功能在其 Office 版本上不可用。

注意

在邮件加载项中,<VersionOverrides> 1.1 可以嵌套在 VersionOverrides> 1.0 中<。 Office 将始终使用平台和 Office 版本支持的最高版本 <VersionOverrides>

作为 Override 元素的子元素

<Requirements> 元素可以是上级 ExtendedOverrides 元素上下文中 Override 元素的子元素。 替代>元素表示<条件,可以理解为“如果......那么......”语句。 如果 Override> 元素的<类型为 RequirementTokenOverride (意味着xsi:type其父 Token 元素RequirementsToken为) ,则子 <Requirements> 元素表示条件,Value属性是结果。 例如, <下面第一个替代> 是“如果当前平台支持 FeatureOne 版本 1.7,请使用字符串'oldAddinVersion'来代替 ${token.requirements} 祖父母 <ExtendedOverrides> (的 URL 中的令牌,而不是默认字符串'upgrade') 。”有关详细信息,请参阅 ExtendedOverrides

<ExtendedOverrides Url="http://contoso.com/addinmetadata/${token.requirements}/extended-manifest-overrides.json">
    <Tokens>
        <Token Name="requirements" DefaultValue="upgrade" xsi:type="RequirementsToken">
            <Override Value="oldAddinVersion">
                <Requirements>
                    <Sets>
                        <Set Name="FeatureOne" MinVersion="1.7" />
                    </Sets>
                </Requirements>
            </Override>
            <Override Value="currentAddinVersion">
                <Requirements>
                    <Sets>
                        <Set Name="FeatureOne" MinVersion="1.8" />
                    </Sets>
                    <Methods>
                        <Method Name="MethodThree" />
                    </Methods>
                </Requirements>
            </Override>
        </Token>
    </Tokens>
</ExtendedOverrides>

外接程序类型:任务窗格

语法

<Requirements>
   ...
</Requirements>

包含于

可以包含

根据加载项类型,Requirements> 元素可以包含以下子元素。<

元素 内容 邮件 任务窗格
Sets
方法 可访问

另请参阅

有关要求集的详细信息,请参阅 Office 版本和要求集