ProjectInstance Class
Represents a project instance.
Assembly: Microsoft.Build (in Microsoft.Build.dll)
The ProjectInstance type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ProjectInstance(ProjectRootElement) | Creates a new project instance and initializes it from the given project root, using the default project collection. |
![]() | ProjectInstance(String) | Creates a new project instance and initializes it from the given project file, using the default project collection. |
![]() | ProjectInstance(String, IDictionary<String, String>, String) | Creates a new project instance and initializes it from the given project file, using the given global properties, tools version, and the default project collection. |
![]() | ProjectInstance(ProjectRootElement, IDictionary<String, String>, String, ProjectCollection) | Creates a new project instance and initializes it from the given project root, using the given global properties, tools version, and project collection. |
![]() | ProjectInstance(String, IDictionary<String, String>, String, ProjectCollection) | Creates a new project instance and initializes it from the given project file, using the given global properties, tools version, and project collection. |
| Name | Description | |
|---|---|---|
![]() | DefaultTargets | Gets or sets the list of default targets for this project. |
![]() | Directory | Gets the project root directory. Used for evaluation of relative paths and setting the current directory during build. Is never null: projects not loaded from disk use the current directory from the time the build started. |
![]() | FullPath | Gets the full path to the project file. Used for logging. |
![]() | GlobalProperties | Gets the dictionary of global properties this project was evaluated with, if any. |
![]() | InitialTargets | Gets the list of initial targets for the project and all its imports, depth-first. These targets are built before any other targets. |
![]() | ItemDefinitions | Gets a read-only dictionary of the item definitions in the project, keyed by item type. |
![]() | Items | Gets all items in this project. |
![]() | ItemTypes | Gets all item types in this project. |
![]() | Properties | Gets all properties in this project. |
![]() | Targets | Gets an enumerator over all targets in this project. This collection is read-only. |
![]() | ToolsVersion | Gets the tools version this project was evaluated with, if any. |
| Name | Description | |
|---|---|---|
![]() | AddItem(String, String) | Adds an item with no metadata to the project. |
![]() | AddItem(String, String, IEnumerable<KeyValuePair<String, String>>) | Adds an item with the given metadata to the project. |
![]() | Build() | Builds the default targets of the project with loggers of the project collection. |
![]() | Build(IEnumerable<ILogger>) | Builds the default targets of the project with the given loggers. |
![]() | Build(IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>) | Builds the default targets of the project with the given loggers and remote loggers. |
![]() | Build(String, IEnumerable<ILogger>) | Builds the given target of the project with the given loggers. |
![]() | Build(array<String>, IEnumerable<ILogger>) | Builds the given targets of the project with the given loggers. |
![]() | Build(String, IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>) | Builds the given target of the project with the given loggers and remote loggers. |
![]() | Build(array<String>, IEnumerable<ILogger>, IDictionary<String, TargetResult>%) | Build a list of targets with specified loggers. Targets may be null. Loggers may be null. |
![]() | Build(array<String>, IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>) | Builds the given targets of the project with the given loggers and remote loggers. |
![]() | Build(array<String>, IEnumerable<ILogger>, IEnumerable<ForwardingLoggerRecord>, IDictionary<String, TargetResult>%) | Builds the given targets with the given target outputs and with the given loggers and remote loggers. |
![]() | DeepCopy | Creates an independent, deep clone of this project and everything in it. Useful for compiling a single file or for keeping build results between builds. |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | EvaluateCondition | Evaluates the provided string as a condition by expanding items and properties, using the current items and properties available, then doing a logical evaluation. |
![]() | ExpandString | Evaluates the provided string by expanding items and properties, using the current items and properties available. |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetEvaluatedItemIncludeEscaped(ProjectItemDefinitionInstance) | Gets the evaluated, escaped value of the Include attribute of the provided item definition. |
![]() ![]() | GetEvaluatedItemIncludeEscaped(ProjectItemInstance) | Gets the evaluated, escaped value of the Include attribute of the provided item. |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetItems | Gets all the items in this project of the specified type. This is a read-only list. |
![]() ![]() | GetMetadataValueEscaped(ProjectMetadataInstance) | Gets the escaped value of the provided metadatum. |
![]() ![]() | GetMetadataValueEscaped(ProjectItemDefinitionInstance, String) | Gets the escaped value of the metadatum with the provided name of the provided item definition. |
![]() ![]() | GetMetadataValueEscaped(ProjectItemInstance, String) | Gets the escaped value of the metadatum with the provided name on the provided item. |
![]() | GetProperty | Get the property with the given name. |
![]() | GetPropertyValue | Get the value of the property with the given name. |
![]() ![]() | GetPropertyValueEscaped | Get the escaped value of the provided property. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | RemoveItem | Removes an item from the project, if present. Returns true if it was present, false otherwise. |
![]() | RemoveProperty | Removes a property with the given name. Returns true if the property had a value (possibly empty string), otherwise false. |
![]() | SetProperty | Add a property with the specified name and value to the project. Overwrites any property with the same name already in the property collection. |
![]() | ToProjectRootElement | Creates a ProjectRootElement from the contents of this ProjectInstance. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Instances of this class result when a project is cloned. Constructors are internal in order to require users to create project instances from existing projects.
New project instances are immutable, except that instance items can be added to them and instance properties set on them. Project instances are useful because they can be modified and built several times without disturbing the original project.
Neither this class nor any of its constituents is allowed to have references to Microsoft.Build.Construction or Microsoft.Build.Evaluation objects.
Project instance targets, host services, and the task registry are not exposed.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
