VSProjectItem.RunCustomTool 方法

运行与某 ProjectItem 对象关联的自定义工具。 自定义工具是实现 IVsSingleFileGenerator 接口的已注册组件。 自定义工具类似于设计器和编辑器。

命名空间:  VSLangProj
程序集:  VSLangProj(在 VSLangProj.dll 中)

语法

声明
Sub RunCustomTool
void RunCustomTool()
void RunCustomTool()
abstract RunCustomTool : unit -> unit
function RunCustomTool()

备注

自定义工具将 ProjectItem 所表示的文件视为输入,并写入一个新文件,其文件名可在 CustomToolOutput 属性中找到。 RunCustomTool 方法按下列方式控制 CustomToolOutput 属性的值:

  • 如果 CustomToolOutput 属性为空,则项目系统将创建一个适当的文件名;ProjectItem 对象调用了 RunCustomTool 方法,此文件名所基于的便是该对象的名称。

  • 如果 CustomToolOutput 属性不为空,则项目系统使用现有值。

  • 如果 RunCustomTool 执行失败(在 HRESULT 中返回错误),则将 CustomToolOutput 属性设置为空字符串。

  • RunCustomTool 方法创建的项目项将替换以前由自定义工具创建的任何项目项。 如果自定义工具的执行不成功,则将从项目中移除以前由自定义工具创建的所有项目项。

在可调用此方法之前,必须通过设置 ProjectItem 对象的 CustomTool 属性将自定义工具与 ProjectItem 相关联。 CustomTool 属性需要该工具的程序标识符。

.NET Framework 安全性

请参阅

参考

VSProjectItem 接口

VSLangProj 命名空间