Document.Clean 方法 (Visio)

检查、报告和修复文档中的选定条件。

语法

表达式清理 (nTargetsnActionsnAlertsnFixesbStopOnErrorbLogFileNamenReserved)

表达 一个代表 Document 对象的变量。

参数

名称 必需/可选 数据类型 说明
nTargets 可选 Variant 指示要检查文档的哪些部分。 有关可能值,请参阅“说明”。
nActions 可选 Variant 指示要检测哪些条件。 有关可能值,请参阅“说明”。
nAlerts 可选 Variant 指示要报告哪些检测到的条件。 有关可能值,请参阅“说明”。
n 修复 可选 Variant 指示要修复哪些检测到的条件。 有关可能值,请参阅“说明”。
bStopOnError 可选 Variant 如果在试图修复检测到的条件时遇到错误,则非零值 (True) 会导致处理停止;零 (False) 会允许处理继续进行。
bLogFileName 可选 Variant 保留供以后使用。
nReserved 可选 Variant 保留供以后使用。

返回值

Nothing

注解

内部 Microsoft Visio 开发人员使用 Clean 方法验证和优化随 Visio 一起提供的文档;第三方开发人员可以对他们自己的文档使用此方法。

建议开发人员使用 nTargetsnActionsnAlertsnFixes 的默认值,并在清理文档之前创建文档的备份副本。

通过比较文档的已保存 VDX (XML) 版本(一个是在 Clean 方法执行之前保存的版本,另一个是在该方法执行之后保存的版本),可以标识 Clean 方法所做的文档更改。

nTargets 参数可以是 Visio 类型库中 VisDocCleanTargets 中定义的常量值的任意组合,如下表所述。

常量 说明
visDocCleanTargAll &HFF 检查 nTargets ) (默认值的所有对象。
visDocCleanTargFPages &H1 检查前景页。
visDocCleanTargBPages &H2 检查背景页。
visDocCleanTargMasters &H4 检查主控形状。
visDocCleanTargStyles &H8 检查样式。
visDocCleanTargDoc &H10 检查文档表。
visDocCleanTargPageSheet &H100 检查页表。

nActions、nAlerts 和 nFixes 参数可以是 Visio 类型库中 VisDocCleanActions 中定义的常量值的任意组合,如下表所述。

常量 说明
visDocCleanActLocalFormulas &H1 检测不必要的本地替换值。
visDocCleanActEmptyRowsAndSects &H2 检测空的本地行和内容。
visDocCleanActNonDefaultFonts &H4 检测非默认字体设置。
visDocCleanActStaleResults &H8 检测与公式不匹配的结果。
visDocCleanActMissingSubs &H10 检测缺失的订阅(单元格依赖关系)。
visDocCleanActConstantFormulas &H20 检测可以从结果生成的公式。
visDocCleanActNearZero &H40 检测近似为零的结果并将其更改为零。
visDocCleanActDuplicateSubs &H80 检测重复的订阅(单元格依赖关系)。
visDocCleanActBadDisplayLists &H100 检测无效的显示列表链接。
visDocCleanActDeletedFields &H400 检测已删除的域。
visDocCleanActBadFieldFormulas &H800 检测包含缺失公式或非标准公式的域。
visDocCleanActBadFieldMarks &H1000 检测包含非同步计数和标记值的域。 更改转义符的位置,以便与字符计数匹配。
visDocCleanActBadReferences &H2000 检测包含 #Ref() 错误的公式。
visDocCleanActAll &H3FFF 执行所有操作。
visDocCleanActDefault &H1FD8 用于检测 nActions ) 默认值 (默认条件。
visDocCleanAlertDefault &H0 要报告的默认条件 (默认值 nAlerts ) 。
visDocCleanFixDefault &H3D8 要修复的默认条件 (n 修复 ) 的默认值。

示例

以下过程演示 Clean 方法的某种用途。 在这种情况下,矩形的线型将由与其最初继承的值来替换,这将创建不必要的本地替换值。 然后将执行 Clean 方法,以检测条件并发布允许用户选择是否修复条件的通知。

  1. 创建新的空白绘图。

  2. 使用“矩形”工具在绘图页上绘制矩形。 如果在“ShapeSheet”窗口中查看形状,则可以看到 LinePattern 单元格中的值 ("1") 的颜色为黑色,指示将继承该值。

  3. 右键单击形状,指向“格式”,单击“线条”,然后在“线条”对话框中重新应用同一种线型。 此操作将在形状中创建本地值或本地替换值。 现在,如果在“ShapeSheet”窗口中查看形状,则可以看到 LinePattern 单元格中的值的颜色为蓝色,指示值为本地值。

  4. 将下面显示的 Clean_Example 过程插入到文档的 Microsoft Visual Basic for Applications 项目中:

  5. 运行 Clean_Example 过程(在“视图”选项卡上,单击“宏”;然后在“宏”对话框的宏的列表中,选择“ThisDocument.Clean_Example”,然后单击“运行”)。

 
    Public Sub Clean_Example() 
     
        ActiveDocument.Clean, visDocCleanActLocalFormulas, _  
           visDocCleanActLocalFormulas, visDocCleanActLocalFormulas 
     
End Sub

警告显示在绘图页上,询问您是否要删除不需要的本地替换值。 如果单击“是”,然后重新打开“ShapeSheet”窗口,则可以看到 LinePattern 单元格中的值的颜色再次显示为黑色,指示已恢复继承的值。

支持和反馈

有关于 Office VBA 或本文档的疑问或反馈? 请参阅 Office VBA 支持和反馈,获取有关如何接收支持和提供反馈的指南。