Filter

Filter 对象允许您创建 文本过滤器,其类型与 查找 工具以及 复制 等命令中使用的类型相同,以控制递归操作。

使用 dopusfactory.Filter 方法创建新的过滤器对象。拥有 Filter 对象后,您可以:

  • 使用 item.MatchFilter 方法查看文件或文件夹是否与过滤器匹配。

  • 使用 command.SetFilter 方法将过滤器应用于命令。

属性名称
返回类型
说明

lasterror

如果 valid 返回 False,则可以使用此属性发现有关错误的信息。

valid

bool

如果过滤器创建成功(即解析过滤器文本时未遇到错误),则返回 True

方法名称

参数

返回类型

说明

Add

<string:clause> 或 <object:Filter> [<string:conjunction>]

bool

将子句添加到过滤器。如果以字符串形式提供,则将解析该子句,如果解析成功,则该方法返回 True。如果解析失败,请使用 lasterror 属性找出原因。或者,您可以添加另一个 Filter 对象。

clause 字符串必须是完全形成的 文本过滤器 子句。例如,size match > 2 mb

可选的 conjunction 字符串允许您选择是通过 and 还是 or 连接子句。如果未指定,则默认为 and

Clear

none

none

清除过滤的内容。

Set

<string:clause> 或 <object:Filter>

bool

使用字符串或现有 Filter 对象的内容初始化过滤器。如果以字符串形式提供,则将解析该子句,如果解析成功,则该方法返回 True。如果解析失败,请使用 lasterror 属性找出原因。

最后更新于