IProjectSnapshot Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.ProjectSystem.Query

Assembly:: Microsoft.VisualStudio.ProjectSystem.Query.dll

Package:: Microsoft.VisualStudio.ProjectSystem.Query v17.11.308

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Describes a Project in Visual Studio. Holds information in regards to a Project like its Name, Guid, Path, etc.

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.VisualStudio.ProjectSystem.Query.Framework.ProjectModelEntityJsonConverter), new System.Object[] { Mono.Cecil.CustomAttributeArgument })]
public interface IProjectSnapshot : Microsoft.VisualStudio.ProjectSystem.Query.IEntityWithId<Microsoft.VisualStudio.ProjectSystem.Query.IProjectSnapshot>

[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.VisualStudio.ProjectSystem.Query.Framework.ProjectModelEntityJsonConverter), new System.Object[] { Mono.Cecil.CustomAttributeArgument })>]
type IProjectSnapshot = interface
    interface IEntityWithId<IProjectSnapshot>
    interface IEntityWithId
    interface IEntity

Public Interface IProjectSnapshot
Implements IEntityWithId(Of IProjectSnapshot)

Attributes: Newtonsoft.Json.JsonConverterAttribute

Implements: IEntity IEntityWithId IEntityWithId<IProjectSnapshot>

Properties

ActiveConfigurations	Gets a queryable collection of active configurations for the project.
Capabilities	Gets a collection of the project's capabilities.
ConfigurationDimensions	Gets a queryable collection of configuration dimensions of the project.
Configurations	Gets a queryable collection of configurations for the project.
DefaultNamespace	Gets the string that represents the default namespace of the project.
ExternalFiles	Gets a queryable collection of external files for the project.
Files	Gets a queryable collection of files of the project.
Folders	Gets a queryable collection of folders of the project.
Guid	Gets the guid of the project.
Id	Gets the identity of the object. (Inherited from IEntityWithId)
IsProjectFileSearchable	Gets whether the project file is subject to search-and-replace through find/replace in files.
Kind	Gets a GUID string indicating the kind of the project.
LaunchProfiles	Gets a collection of launch profiles for the project.
LaunchProfileTypes	Gets a collection of the types of launch profiles for the project.
Name	Gets the name of the project.
Path	Gets the path of the project.
ProjectReferences	Gets a collection of project to project references of the project.
Properties	Gets a queryable collection of properties for the project.
PropertiesAvailableStatus	Gets available properties status of a Project.
PropertyPages	Gets a collection of the property pages for the project.
Type	Gets the project type of the project.
TypeGuid	Gets the type guid of the project.
VisualPath	Gets the visual path of the project in the solution explorer.

Methods

AsQueryable()

Creates a queryable returning this entity object.

(Inherited from IEntityWithId<TEntity>)

Extension Methods

AddExistingFileAsync(IProjectSnapshot, Uri, CancellationToken)	Adds an existing file on disk to the project.
ConfigurationsByName(IProjectSnapshot, String[])	Gets project configurations that satisfy the specified expression.
FilesByPath(IProjectSnapshot, String[])	Gets source files with the given paths.
FilesEndingWith(IProjectSnapshot, String[])	Gets source files with the given ending with expressions.
FilesUnderDirectory(IProjectSnapshot, String, Boolean)	Gets source files physically present under the given directory.
FilesUnderView(IProjectSnapshot, String, Boolean)	Gets source files present under the given path in the solution explorer view.
FilesWithItemTypes(IProjectSnapshot, String[])	Gets source files with the given item types.
FoldersByPath(IProjectSnapshot, String[])	Gets folders with the given paths.
PropertiesByName(IProjectSnapshot, String[])	Gets project properties with a set of known names.
BuildAsync(IProjectSnapshot, CancellationToken)	Builds the project in the solution.
CleanAsync(IProjectSnapshot, CancellationToken)	Cleans the project in the solution.
DebugLaunchAsync(IProjectSnapshot, CancellationToken)	Debugs the project in the solution.
LaunchAsync(IProjectSnapshot, CancellationToken)	Runs the project in the solution.
RebuildAsync(IProjectSnapshot, CancellationToken)	Rebuilds the project in the solution.
SaveAsync(IProjectSnapshot, CancellationToken)	Saves a single project to disk.
WaitIntellisenseReadyAsync(IProjectSnapshot, CancellationToken)	Wait intellisense operation progress of a single project to be ready.

Applies to

Share via