适用于 Data Standard 的 PowerShell 函数

PowerShell 函数用于以编程方式自定义业务逻辑、行为、默认值和用户界面。

Data Standard 附带了使用标准对话框和选项卡所需的多个函数。一些函数被从 Data Standard 附加模块内部调用。

这些函数是必需的,不应移除。

这些函数可被视为事件驱动函数,并且可以进行修改以更改其行为。其他函数被直接从 XAML 文件调用。例如,为了从 Vault 数据库检索信息(例如,可用的编号方案、类别)。

所有位于“addinVault”(Vault) 或“addins”(CAD) 文件夹中的 *.ps1 和 *.psm1(PowerShell 模块)中的文件都被自动导入和使用。

注: Autodesk 建议对您自己的函数使用一个单独的 .ps1 文件。

以下图表包含直接从附加模块或从 XAML 文件中调用的函数的列表。为提高代码的可读性,这些函数可能调用其他函数。这些其他函数未明确列出。

函数

文件

使用附加模块

使用 XAML

描述

ActivateOKButton

Vault:Default.ps1

Vault

用于验证以及在编辑和创建对话框中启用“确定”按钮。默认情况下,它将调用函数 Validate(),该函数随后会根据窗口类型调用其他验证函数。

因为每当对话框中的数据更改时都会调用 ActivateOkButton ,所以如果验证函数过于复杂,可能导致出现性能问题。

AddinLoaded

CAD:Default.ps1

CAD

在加载 VDS Inventor 或 AutoCAD 附加模块时调用。

Addinunloaded

CAD:Default.ps1

CAD

在卸载 VDS Inventor 或 AutoCAD 附加模块时调用。

GetCategories

Vault、

CAD:Default.ps1

Vault、CAD

此函数在 Vault 和 CAD 的创建对话框中用于在组合框中显示类别。

默认实现会根据窗口名称返回所有文件、文件夹或自定义实体类别的列表。用于动态特性。对于 CAD 编辑对话框,返回指定的类别。

GetNewCustomObjectName

Vault:Default.ps1

Vault

在创建自定义对象对话框中单击“确定”按钮时调用。此函数返回新的自定义对象的名称。默认实现从具有名称 CUSTOMOBJECTNAME 的创建对话框控件获取值,或者从特殊特性 _GeneratedNumber 获取值(如果定义了 Vault 编号方案)。有关详细信息,请参见 Data Standard 和编号方案

GetNewFileName

Vault:Default.ps1

Vault

在创建文件对话框中单击“确定”按钮时调用。此函数返回新文件的文件名。默认实现从具有名称 FILENAME 的创建对话框控件获取值,或者从特殊特性 _GeneratedNumber 获取值(如果定义了 Vault 编号方案)。有关详细信息,请参见 Data Standard 和编号方案

GetNewFolderName

Vault:Default.ps1

Vault

在创建文件夹对话框中单击“确定”按钮时调用。此函数返回新文件夹的名称。默认实现从具有名称 FOLDERNAME 的创建对话框控件获取值,或者从特殊特性 _GeneratedNumber 获取值(如果定义了 Vault 编号方案)。有关详细信息,请参见 Data Standard 和编号方案

GetNumSchms

Vault、

CAD:Default.ps1

Vault、CAD

此函数在 Vault 和 CAD 的创建文件对话框中用于在组合框中显示编号方案。默认实现返回所有已激活的 Vault 文件编号方案。默认编号方案是与选定类别名称相同的方案。如果与选定类别名称相同的方案不存在,则该方案是在 Vault 设置中设定的默认方案。

GetParentFolderName

Vault:Default.ps1

Vault

在创建文件夹对话框中单击“确定”按钮时调用。使用新的标准文件或新的标准文件夹函数时,可使用此函数强制采用特定的文件夹名称。如果返回空字符串,则使用选定的文件夹。

InitializeTabWindow

Vault:Default.ps1

Vault

在 Vault 中初始化 Data Standard 选项卡时调用。

InitializeWindow

Vault:Default.ps1

Vault

在初始化 Data Standard 对话框时调用。

ItemTitle

Vault:Default.ps1

Vault

在条目和 ECO 对象的选项卡中使用。默认实现返回条目或 ECO“Title (item,CO)”特性的值。

注: 由于特性名称方面的原因,不能直接在 XAML 中使用 {Binding Prop[_XLTN_TITLE_ITEM_CO]}

ItemDescription

Vault:Default.ps1

Vault

在条目和 ECO 对象的选项卡中使用。默认实现返回条目或 ECO“Description (item,CO)”特性的值。

注: 由于特性名称方面的原因,不能直接在 XAML 中使用 {Binding Prop[_XLTN_DESCRIPTION_ITEM_CO]}

OnLogOn

Vault:Default.ps1

Vault

当用户登录到 Vault 时调用。

OnLogOff

Vault:Default.ps1

Vault

当用户注销时调用。

OnPostCloseDialog

CAD:Default.ps1

CAD

在通过单击“确定”按钮关闭 Data Standard 对话框时、设置文件名和更新特性之前调用。

OnTabContextChanged

Vault:Default.ps1

Vault

在 Vault 中的自定义选项卡的上下文发生变化时调用。用于更新该选项卡中显示的数据。

SetWindowTitle($newFile, $editFile, $name)

Vault、CAD:Default.ps1

Vault、CAD

从 InitializeWindow 函数中调用。根据是处于创建模式还是编辑模式以及它是用于文件、文件夹还是自定义对象,为此函数提供相应的输入。返回的输出被设置为对话框的标题。

注: 菜单项的 ps1 文件,该文件位于 C:\ProgramData\Autodesk\<Vault 版本>\Extensions\DataStandard\Vault\addinVault\Menus 中,包含不在 PowerShell 函数作用范围内的代码。此代码在单击该菜单项时直接执行。