Share via

WebFileProperties2.CustomTool Property

  • Article

 

Gets or sets the program identifier of the custom tool that is associated with the Web file. A custom tool takes as input the Web file represented and writes a new file.

Namespace:   VsWebSite90
Assembly:  VsWebSite.Interop90 (in VsWebSite.Interop90.dll)

Syntax

string CustomTool { get; set; }

property String^ CustomTool {
    String^ get();
    void set(String^ value);
}

abstract CustomTool : string with get, set

Property CustomTool As String

Property Value

Type: System.String

The program identifier of the custom tool that is associated with the project item.

Remarks

Custom tools convert files from one type to another at design time. The formats of the input file and the output file depend on what the custom tool is designed to handle.

A custom tool is a registered component that implements the IVsSingleFileGenerator interface. The program identifier is a short string that describes what the custom tool does. This string is assigned by the custom tool creator.

If the CustomTool property is set to an invalid identifier, the project system will add an entry to the Task List that reports that the custom tool could not be instantiated.

Note

The custom tool that is associated with a project item is not saved when a Web site is closed. Therefore, it must be re-associated every time.

See Also

RunCustomTool
CustomToolNamespace
WebFileProperties2 Interface
VsWebSite90 Namespace

Return to top