文档函数参考 (iLogic)

使用文档函数可以访问 Inventor 零件、部件或工程图文档。

文档函数允许您执行获取文件名和更新模型等任务。

在文档函数中,ThisDoc 表示在其中编写规则的 Inventor 文档。它通常是激活的文档,但也可能是部件中的零件。无论何时存储规则时,都可以使用 ThisDoc 访问该文档。

若要访问文档函数,请展开 iLogic“编辑规则”对话框“代码段”区域中“系统”选项卡下的“文档”节点。

Path

以文本字符串形式返回文档路径(文件夹名称)。

语法

ThisDoc.Path

FileName

返回文档的文件名。

语法

ThisDoc.FileName(False)

当参数为 False 时,不包含文件扩展名。如果您想包含文件扩展名,请将参数替换为 True

PathAndFileName

返回文档的路径和文件名。

语法

ThisDoc.PathAndFileName(False)

当参数为 False 时,不包含文件扩展名。若要包含文件扩展名,请将括号内的值替换为 True

ChangeExtension

使用文档的文件名和更改的扩展名创建一个文件名。

语法

changedName = ThisDoc.ChangeExtension(“.new”)

WorkspacePath

返回激活的 Inventor 项目工作空间的路径(文件夹名称)。如果未定义任何工作空间,该函数将返回一个空字符串(不包含任何字符的字符串,长度为零)。

语法

ThisDoc.WorkspacePath()

Launch

根据提供的路径和文件名(包括扩展名)启动文件。如果指定数据文件,则它会使用文件的原生应用程序打开文件。如果指定可执行文件 (.exe),它会运行相关程序。如果不指定完整路径,iLogic 会查找 Inventor 文档所在的文件夹中的文件。您还可以指定相对该文档文件夹的文件名和路径。

语法

ThisDoc.Launch(“path\file.ext”)

Save

保存当前激活的文档。该函数不能用于由参数更改事件触发的规则。

语法

ThisDoc.Save

UpdateWhenDone

在该规则(以及它触发的任何规则)运行完毕后,更新该规则所在的文档。该更新与在用户界面上单击“更新”按钮作用一样。

语法

iLogicVb.UpdateWhenDone = True

RuleParametersOutput

如果规则更改了任意参数值,该函数会对 Inventor 模型应用新规则值。如果不使用该函数,则需要等到规则运行完毕后才应用更新的值。如果必须使用 DocumentUpdate 执行更新,请使用该函数。如果正在使用 iLogicVb.RunRule 函数,也请使用该函数,以便其他规则可以获得参数的新值。

语法

RuleParametersOutput()

DocumentUpdate

在当前文档(该规则所在的文档)中执行即时更新并更新显示。如果您需要重建几何图元(例如您正在使用 iProperties.Mass 计算质量),请使用该函数。如果该规则触发其他规则(通过更改参数),请在“编辑规则”对话框中为该规则启用“立即触发从属规则”选项。该选项可确保在您执行更新前已运行完其他规则。

语法

InventorVb.DocumentUpdate()

DocumentUpdate(False)

在当前文档(该规则所在的文档)中执行即时更新,但不更新文档显示。InventorVb.DocumentUpdate 函数将更新显示以及模型。如果您不想更新显示,请使用该函数。

语法

InventorVb.DocumentUpdate(False)

只显示更新

该 Inventor API 函数只更新显示而不更新模型。

语法

ThisApplication.ActiveView.Update()

CheckParameters

检验参数值,但不更改任何值。

可在诸如以下情况下使用该函数:

假设参数关联至基础零件,并且在基础零件中它们关联至外部电子表格。您可能想更改电子表格中的参数值,并保存该电子表格,但是不想让这些更改显示在主零件中。使用 GoExcel 更改电子表格中的值之前,可以在主零件内的规则中使用该函数。该函数可确保加载基础零件(在后台)并将更改传递给部件的主零件。

语法

InventorVb.CheckParameters(“”)

File Save As

使用新文件名保存文档,并且还可以使用新的扩展名。

语法

ThisDoc.Document.SaveAs(NewFileNameAndExtension , True)

True

设置为 True 以执行“保存副本为”操作,或者设置为 False 以执行“另存为”操作。