VCFileConfigurationProperties.ExcludedFromBuild Property

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

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

Syntax

'Declaration
Property ExcludedFromBuild As Boolean

'Usage
Dim instance As VCFileConfigurationProperties 
Dim value As Boolean 

value = instance.ExcludedFromBuild

instance.ExcludedFromBuild = value

bool ExcludedFromBuild { get; set; }

property bool ExcludedFromBuild {
    bool get ();
    void set (bool value);
}

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 General Property Page (File) for information about accessing ExcludedFromBuild for a file from the development environment.

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

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. See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

Examples

[Visual Basic]

The following example code modifies the VCPreLinkEventTool object's ExcludedFromBuild property in the development environment:

' 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

The following example shows how to use ExcludedFromBuild on a VCFileConfiguration object.

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

Public Module Module1
    Sub Test()
        Dim file As VCFile
        Dim col As IVCCollection
        Dim fileconfig As VCFileConfiguration
        Dim prj As VCProject
        prj = DTE.Solution.Projects.Item(1).Object
        col = prj.Files
        file = col.Item("project6.cpp")
        col = file.FileConfigurations
        fileconfig = col.Item(1)
        fileconfig.ExcludedFromBuild = True
    End Sub
End Module

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

VCFileConfigurationProperties Interface

VCFileConfigurationProperties Members

Microsoft.VisualStudio.VCProject Namespace