Partager via


VCPreBuildEventTool.ExcludedFromBuild Property

Gets or sets a value indicating whether this item is excluded from the build.

Namespace:  Microsoft.VisualStudio.VCProjectEngine
Assembly:  Microsoft.VisualStudio.VCProjectEngine (in Microsoft.VisualStudio.VCProjectEngine.dll)

Syntax

'Declaration
Property ExcludedFromBuild As Boolean
bool ExcludedFromBuild { get; set; }
property bool ExcludedFromBuild {
    bool get ();
    void set (bool value);
}
abstract ExcludedFromBuild : bool with get, set
function get ExcludedFromBuild () : boolean 
function set ExcludedFromBuild (value : boolean)

Property Value

Type: System.Boolean
true if this item is excluded from the build; otherwise, false.

Remarks

See the General Property Page (File) for information about accessing ExcludedFromBuild for a file from the integrated development environment (IDE).

See Specifying Build Events for information about accessing ExcludedFromBuild for a build event from the IDE.

ExcludedFromBuild specifies whether or not deployment occurs when the project is built. Set to true to disable deployment or set to false to enable deployment.

Examples

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

The following example modifies the VCPreLinkEventTool object's ExcludedFromBuild property in the IDE:

' add reference to Microsoft.VisualStudio.VCProjectEngine
Imports EnvDTE
Imports Microsoft.VisualStudio.VCProjectEngine

Public Module Module1
    Sub Test()
        Dim prj As VCProject
        Dim cfgs, tools As IVCCollection
        Dim cfg As VCConfiguration
        Dim tool As VCPostBuildEventTool
        prj = DTE.Solution.Projects.Item(1).Object
        cfgs = prj.Configurations
        cfg = cfgs.Item(1)
        tool = cfg.Tools("VCPreLinkEventTool")
        tool.ExcludedFromBuild = False
    End Sub
End Module

.NET Framework Security

See Also

Reference

VCPreBuildEventTool Interface

Microsoft.VisualStudio.VCProjectEngine Namespace