slreq.callback.MSExcelImportOptions 类

命名空间: slreq.callback

Microsoft Excel 导入选项

自 R2022a 起

描述

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

slreq.callback.MSExcelImportOptions 类是 handle 类。

创建对象

如果您从 Microsoft Excel 文件导入需求，则 options = slreq.getCurrentImportOptions 返回 slreq.callback.MSExcelImportOptions 对象。

属性

全部展开

`Worksheet` — 工作表名称
字符串标量 | 字符向量

Microsoft Excel 工作表的名称，指定为字符串标量或字符向量。

属性：

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

`SubDocPrefix` — 在自定义 ID 中附加工作表名称的选项
`0` (默认) | `1`

选择在导入需求的 CustomId属性中添加工作表名称，指定为数据类型为 logical 的 1 或 0。

提示

如果来自多个工作表的需求使用相同的自定义 ID 导入，则将此属性设置为 1 以生成唯一的自定义 ID。

属性：

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

`Rows` — 行的范围
`double` 数组

要从 Microsoft Excel 电子表格导入的行范围，指定为 double数组。

示例: myImportOptions.Rows = [3 35];

属性：

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

`Columns` — 列的范围
`double` 数组

要从 Microsoft Excel 电子表格导入的列范围，指定为 double数组。

示例: myImportOptions.Columns = [1 6];

属性：

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

`Attributes` — 要导入的外部属性
元胞数组

作为自定义属性导入的外部属性，指定为 cell数组。

此元胞数组的长度必须与 AttributeColumn属性指定的列数相匹配。

示例: myImportOptions.Attributes = {'Test Status','Test Procedure'};

属性：

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

`IdColumn` — 要映射到 `Id`属性的列
`double`

Microsoft Excel 电子表格中的列映射到需求集需求的 Id属性，指定为 double。

示例: myImportOptions.IdColumn = 1;

属性：

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

`SummaryColumn` — 要映射到 `Summary`属性的列
`double`

Microsoft Excel 电子表格中的列映射到需求集需求的 Summary属性，指定为 double。

示例: myImportOptions.SummaryColumn = 2;

属性：

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

`DescriptionColumn` — 要映射到 `Description`属性的列
`double`

Microsoft Excel 电子表格中的列映射到需求集需求的 Description属性，指定为 double。

示例: myImportOptions.DescriptionColumn = 3;

属性：

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

`RationaleColumn` — 要映射到 `Rationale`属性的列
`double`

Microsoft Excel 电子表格中的列映射到需求集需求的 Rationale属性，指定为 double。

示例: myImportOptions.RationaleColumn = 4;

属性：

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

`KeywordsColumn` — 要映射到 `Keywords`属性的列
`double`

Microsoft Excel 电子表格中的列映射到需求集需求的 Keywords属性，指定为 double。

示例: myImportOptions.KeywordsColumn = 5;

属性：

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

`AttributeColumn` — 要映射到自定义属性的列
`double` 数组

Microsoft Excel 电子表格中的列映射为需求集需求的自定义属性，指定为 double数组。

示例: myImportOptions.AttributeColumn = [4 6];

属性：

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

`USDM` — USDM 格式
字符串标量 | 字符向量

从通用规范描述方式 (USDM) 标准格式指定的 Microsoft Excel 电子表格导入。将值指定为字符串标量或字符向量，其中 ID 前缀后面可以跟分隔符。

示例: myImportOptions.USDM = "RQ -" 将与 ID 类似于 RQ01、RQ01-2、RQ01-2-1 等的条目匹配。

属性：

`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`

示例

全部折叠

自定义 Excel 导入选项

打开实时脚本

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

使用slreq.import将 Excel 文件 ExampleRequirements.xlsx 导入 Requirements Toolbox™。将导入的需求集myReqSet，并将脚本excelPreImport注册为PreImportFcn回调。返回需求集的句柄。

[~,~,rs] = slreq.import("ExampleRequirements.xlsx", ...
    ReqSet="myReqSet",preImportFcn="excelPreImport");

脚本 excelPreImport 使用 slreq.getCurrentImportOptions 获取导入选项，然后将第 2、4 和 5 列映射到内置的 slreq.Reference属性ID、Summary 和 Description。该脚本还将第 3、6 和 7 列映射到自定义属性orig_Type、Remark 和 Status。

type excelPreImport.m

importOptions = slreq.getCurrentImportOptions;
importOptions.IdColumn = 2;
importOptions.SummaryColumn = 4;
importOptions.DescriptionColumn = 5;
importOptions.Attributes = {'orig_type','Remark','Status'};
importOptions.AttributeColumn = [3 6 7];

返回 importOptions 对象。

importOptions

importOptions = 
  MSExcelImportOptions with properties:

            Worksheet: []
         SubDocPrefix: 0
                 Rows: []
              Columns: ''
           Attributes: {'orig_type'  'Remark'  'Status'}
             IdColumn: 2
        SummaryColumn: 4
    DescriptionColumn: 5
      RationaleColumn: []
       KeywordsColumn: []
      AttributeColumn: [3 6 7]
      CreatedByColumn: []
     ModifiedByColumn: []
                 USDM: ''
            Bookmarks: 0
                Match: []
          AsReference: 1
             RichText: 0
               DocUri: 'C:\Users\jdoe\MATLAB\Examples\slrequirements-ex00521778\ExampleRequirements.xlsx'
              DocType: 'linktype_rmi_excel'
               ReqSet: 'myReqSet'
         PreImportFcn: 'excelPreImport'
        PostImportFcn: ''

版本历史记录

在 R2022a 中推出

另请参阅

slreq.getCurrentImportOptions | setPreImportFcn | getPreImportFcn

主题

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

slreq.callback.MSExcelImportOptions 类

描述

创建对象

属性

Worksheet — 工作表名称 字符串标量 | 字符向量

属性：

SubDocPrefix — 在自定义 ID 中附加工作表名称的选项 0 (默认) | 1

属性：

Rows — 行的范围 double 数组

属性：

Columns — 列的范围 double 数组

属性：

Attributes — 要导入的外部属性 元胞数组

属性：

IdColumn — 要映射到 Id属性的列 double

属性：

SummaryColumn — 要映射到 Summary属性的列 double

属性：

DescriptionColumn — 要映射到 Description属性的列 double

属性：

RationaleColumn — 要映射到 Rationale属性的列 double

属性：

KeywordsColumn — 要映射到 Keywords属性的列 double

属性：

AttributeColumn — 要映射到自定义属性的列 double 数组

属性：

USDM — USDM 格式 字符串标量 | 字符向量

属性：

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

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

属性：

ReqSet — 需求集名称 字符向量

属性：

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

属性：

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

属性：

示例