slreq.callback.MSWordImportOptions 类

命名空间: slreq.callback

Microsoft Word 导入选项

自 R2022a 起

描述

使用 slreq.callback.MSWordImportOptions 类的对象来调整导入需求时要使用的选项。当您从 Microsoft^® Word 文件导入需求时，slreq.getCurrentImportOptions 会生成一个 slreq.callback.MSWordImportOptions 对象，您可以使用该对象来调整导入需求时要使用的选项。您只能在 PreImportFcn 回调中访问该对象。

slreq.callback.MSWordImportOptions 类是 handle 类。

创建对象

如果您从 Microsoft Word 文件导入需求，options = slreq.getCurrentImportOptions 将返回 slreq.callback.MSWordImportOptions 对象。

属性

全部展开

`IgnoreOutlineNumbers` — 忽略大纲数字的选项
`0` (默认) | `1`

用于忽略节标题中的大纲数字的选项，指定为数据类型 logical 的 1 或 0。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`Bookmarks` — 使用书签导入需求的选项
`0` (默认) | `1`

使用用户定义的书签导入需求内容的选项，指定为数据类型为 logical 的 1 或 0。

默认情况下，Requirements Toolbox™ 将 Microsoft Word 文档的值设置为 1，将 Microsoft Excel^® 电子表格的值设置为 0。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`Match` — 正则表达式模式
字符串标量 | 字符向量

正则表达式模式，指定为字符串标量或字符向量。使用此表达式在 Microsoft Office 文档中搜索匹配项。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`AsReference` — 导入为参考的选项
`1` (默认) | `0`

选择导入为 slreq.Reference 对象，指定为数据类型为 logical 的 1 或 0。如果是 0，需求导入为 slreq.Requirement 对象。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`RichText` — 可选择使用富文本格式导入
`0` (默认) | `1`

使用富文本导入需求的选项，指定为数据类型为 logical 的 1 或 0。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`DocUri` — 需求文档的资源标识符
字符串标量 | 字符向量

外部需求文档的资源标识符，指定为字符串标量或字符向量。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`DocType` — 需求文档自定义链接类型
字符串标量 | 字符向量

需求文档自定义链接类型，以字符串标量或字符向量形式返回。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`ReqSet` — 需求集名称
字符向量

需求集名称，以字符向量形式返回。

属性：

`GetAccess`	`public`
`SetAccess`	`private`

`PreImportFcn` — `PreImportFcn` 回调的内容
字符串标量 | 字符向量

当前导入节点的 PreImportFcn 回调的内容，指定为字符串标量或字符向量。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`PostImportFcn` — `PostImportFcn` 回调的内容
字符串标量 | 字符向量

当前导入节点的 PostImportFcn 回调的内容，指定为字符串标量或字符向量。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

示例

全部折叠

自定义 Word 导入选项

打开实时脚本

此示例显示如何使用 PreImportFcn 回调自定义 Microsoft® Word 导入选项。

使用 slreq.import 将 Word 文档 Reject_Double_Button_Press_Model_Requirements.docx 导入 Requirements Toolbox™。将导入的需求集 myReqSet，并将脚本 wordPreImport 注册为导入时使用的 PreImportFcn 回调。返回需求集的句柄。

[~,~,rs] = slreq.import("Reject_Double_Button_Press_Model_Requirements.docx", ...
    ReqSet="myReqSet",preImportFcn="wordPreImport");

脚本 wordPreImport 使用 slreq.getCurrentImportOptions 获取导入选项，然后将 Bookmark 属性设置为 1 以使用书签来识别项并用作自定义 ID。

type wordPreImport.m

importOptions = slreq.getCurrentImportOptions;
importOptions.Bookmarks = 1;

返回 importOptions 对象。

importOptions

importOptions = 
  MSWordImportOptions with properties:

    IgnoreOutlineNumbers: 0
               Bookmarks: 1
                   Match: []
             AsReference: 1
                RichText: 1
                  DocUri: 'C:\Users\jdoe\MATLAB\Examples\slrequirements-ex48179482\Reject_Double_Button_Press_Model_Requirements.docx'
                 DocType: 'linktype_rmi_word'
                  ReqSet: 'myReqSet'
            PreImportFcn: 'wordPreImport'
           PostImportFcn: ''

版本历史记录

在 R2022a 中推出

另请参阅

slreq.getCurrentImportOptions | setPreImportFcn | getPreImportFcn

主题

使用回调自定义需求导入行为

slreq.callback.MSWordImportOptions 类

描述

创建对象

属性

IgnoreOutlineNumbers — 忽略大纲数字的选项 0 (默认) | 1

属性：

Bookmarks — 使用书签导入需求的选项 0 (默认) | 1

属性：

Match — 正则表达式模式 字符串标量 | 字符向量

属性：

AsReference — 导入为参考的选项 1 (默认) | 0

属性：

RichText — 可选择使用富文本格式导入 0 (默认) | 1

属性：

DocUri — 需求文档的资源标识符 字符串标量 | 字符向量

属性：

DocType — 需求文档自定义链接类型 字符串标量 | 字符向量

属性：

ReqSet — 需求集名称 字符向量

属性：

PreImportFcn — PreImportFcn 回调的内容 字符串标量 | 字符向量

属性：

PostImportFcn — PostImportFcn 回调的内容 字符串标量 | 字符向量

属性：

示例