ProjectSnapshot Class

Definition

Namespace:

Microsoft.VisualStudio.ProjectSystem.Query.Framework

Assembly:

Microsoft.VisualStudio.ProjectSystem.Query.dll

Package:

Microsoft.VisualStudio.ProjectSystem.Query v17.12.128

Implementation for IProjectSnapshot

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.VisualStudio.ProjectSystem.Query.Framework.ProjectModelEntityJsonConverter), new System.Object[] { Mono.Cecil.CustomAttributeArgument })]
[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })]
public class ProjectSnapshot : Microsoft.VisualStudio.ProjectSystem.Query.Framework.EntityValueWithId<Microsoft.VisualStudio.ProjectSystem.Query.IProjectSnapshot,Microsoft.VisualStudio.ProjectSystem.Query.Framework.ProjectPropertiesAvailableStatus>, Microsoft.VisualStudio.ProjectSystem.Query.IEntityWithId<Microsoft.VisualStudio.ProjectSystem.Query.IProjectSnapshot>, Microsoft.VisualStudio.ProjectSystem.Query.IProjectSnapshot

[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.VisualStudio.ProjectSystem.Query.Framework.ProjectModelEntityJsonConverter), new System.Object[] { Mono.Cecil.CustomAttributeArgument })>]
[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 1 })>]
type ProjectSnapshot = class
    inherit EntityValueWithId<IProjectSnapshot, ProjectPropertiesAvailableStatus>
    interface IProjectSnapshot
    interface IEntityWithId<IProjectSnapshot>
    interface IEntityWithId
    interface IEntity

Public Class ProjectSnapshot
Inherits EntityValueWithId(Of IProjectSnapshot, ProjectPropertiesAvailableStatus)
Implements IEntityWithId(Of IProjectSnapshot), IProjectSnapshot

Inheritance

Object

EntityValueBase

EntityValueWithId

EntityValueWithId<IProjectSnapshot,ProjectPropertiesAvailableStatus>

ProjectSnapshot

Attributes

Newtonsoft.Json.JsonConverterAttribute NullableAttribute

Implements

IEntity IEntityWithId IEntityWithId<IProjectSnapshot> IProjectSnapshot

Constructors

ProjectSnapshot(IEntityRuntimeModel, EntityIdentity, ProjectPropertiesAvailableStatus)

ProjectSnapshot(IEntityRuntimeModel, EntityIdentity)

Properties

ActiveConfigurations
Capabilities
ConfigurationDimensions
Configurations
DefaultNamespace
EntityRuntime	(Inherited from EntityValueBase)
ExternalFiles
Files
Folders
Guid
Id	(Inherited from EntityValueWithId)
IsFrozen	Gets whether the object is immutable. Once the entity values are initialized, it will be frozen and become immutable. (Inherited from EntityValueBase)
IsProjectFileSearchable
Kind
LaunchProfiles
LaunchProfileTypes
Name
Path
ProjectReferences
Properties
PropertiesAvailableStatus
PropertyPages
SelfQuery	Gets a base query to query information under this entity. (Inherited from EntityValueWithId<TEntity,TPropertiesAvailableStatus>)
Site	Gets the site of the entity. (It is a part of infrastructure to attach additional collections to it. (Inherited from EntityValueBase)
Type
TypeGuid
VisualPath

Methods

AsQueryable()	(Inherited from EntityValueWithId<TEntity,TPropertiesAvailableStatus>)
ConvertChildrenCollection<TChildType>(IEnumerable<IEntityValue>)	Converts a generic children collection to a specific collection. (Inherited from EntityValueBase)
EnsureMutable()	Check and throw, if the object is set to readonly. (Inherited from EntityValueBase)
EnsurePropertyMarkedAsAvailable(IEntityProperty)	Ensures the property is marked as available. (Inherited from EntityValueBase)
Freeze()	Freeze the entity value object, so it cannot be changed. (Inherited from EntityValueBase)
GetEntityType()
GetPropertiesAvailableStatus(Boolean)	(Inherited from EntityValueWithId<TEntity,TPropertiesAvailableStatus>)
ReadProperty(String, JsonReader)	(Inherited from EntityValueWithId)
SetRelatedEntities(String, IEnumerable<IEntityValue>)
ToString()	(Inherited from EntityValueWithId)
TryGetRelatedEntities(String, IEnumerable<IEntity>)

Explicit Interface Implementations

IEntity.PropertiesAvailableStatus	(Inherited from EntityValueBase)
IEntityValue.LimitAvailableProperties(IPropertiesAvailableStatus)	(Inherited from EntityValueBase)
IEntityValue.SetRelatedEntities(String, IReadOnlyCollection<IEntityValue>)	(Inherited from EntityValueBase)
IEntityValue.SetSite(IEntitySite)	(Inherited from EntityValueBase)
IEntityValue.TryGetRelatedEntities(String, IEnumerable<IEntityValue>)	(Inherited from EntityValueBase)
IEntityValueFromProvider.ProviderState	(Inherited from EntityValueBase)
IFreezable.IsFrozen	(Inherited from EntityValueBase)

Extension Methods

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.