Microsoft.VisualStudio.ProjectSystem.Query Namespace
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.
Classes
| AssemblyReferenceChanges |
Entity Changes Model for IAssemblyReferenceSnapshot |
| AssemblyReferenceQueryResultsExtensions |
Query Results Extensions for IAssemblyReferenceSnapshot |
| AsyncQueryableExtensions |
Extension methods to construct queries. They are all placeholders for now. |
| BuildPropertyChanges |
Entity Changes Model for IBuildPropertySnapshot |
| BuildPropertyQueryResultsExtensions |
Query Results Extensions for IBuildPropertySnapshot |
| CategoryChanges |
Entity Changes Model for ICategorySnapshot |
| CategoryQueryResultsExtensions |
Query Results Extensions for ICategorySnapshot |
| ConfigurationDimensionChanges |
Entity Changes Model for IConfigurationDimensionSnapshot |
| ConfigurationDimensionDefinitionChanges |
Entity Changes Model for IConfigurationDimensionDefinitionSnapshot |
| ConfigurationDimensionDefinitionQueryResultsExtensions |
Query Results Extensions for IConfigurationDimensionDefinitionSnapshot |
| ConfigurationDimensionNames |
Predefined configuration dimension names. |
| ConfigurationDimensionQueryResultsExtensions |
Query Results Extensions for IConfigurationDimensionSnapshot |
| EntityCollectionChanges<TEntity,TEntityChanges> |
Represents the sets of changes between IEntity Collections. |
| EntityIdentity |
The structure to represent the identity of an entity object in the project system model. Identities of object in the project model are composed by a set of string key value pairs. Keys and values are treated as case-sensitive. |
| ExternalFileChanges |
Entity Changes Model for IExternalFileSnapshot |
| ExternalFileQueryResultsExtensions |
Query Results Extensions for IExternalFileSnapshot |
| FileChanges |
Entity Changes Model for IFileSnapshot |
| FilePropertiesFilterExtensions |
Contains extension methods to support accessing collection properties of source files with additional filtering parameters. |
| FileQueryResultsExtensions |
Query Results Extensions for IFileSnapshot |
| FolderChanges |
Entity Changes Model for IFolderSnapshot |
| FolderQueryResultsExtensions |
Query Results Extensions for IFolderSnapshot |
| InvalidEntityTypeException |
Exception thrown when an entity type is invalid in the model. |
| InvalidPropertyException |
Exception thrown when a property is invalid in the model. |
| ItemUpdate<TEntity> |
Represents the item update info in the tracked query results. |
| LaunchProfileChanges |
Entity Changes Model for ILaunchProfileSnapshot |
| LaunchProfileQueryResultsExtensions |
Query Results Extensions for ILaunchProfileSnapshot |
| LaunchProfileTypeChanges |
Entity Changes Model for ILaunchProfileTypeSnapshot |
| LaunchProfileTypeQueryResultsExtensions |
Query Results Extensions for ILaunchProfileTypeSnapshot |
| MissingDataException |
The type of Exception thrown, when accessing a property which doesn't contain valid data. |
| NotSupportedQueryExpressionException |
The exception thrown when an unsupported query expression is being used. |
| OutputChanges |
Entity Changes Model for IOutputSnapshot |
| OutputGroupChanges |
Entity Changes Model for IOutputGroupSnapshot |
| OutputGroupQueryResultsExtensions |
Query Results Extensions for IOutputGroupSnapshot |
| OutputQueryResultsExtensions |
Query Results Extensions for IOutputSnapshot |
| PackageManagerType |
Predefined Package Reference Manager Types |
| PackageReferenceChanges |
Entity Changes Model for IPackageReferenceSnapshot |
| PackageReferenceQueryResultsExtensions |
Query Results Extensions for IPackageReferenceSnapshot |
| PersistenceStorageType |
Predefined Persitence Storage Types |
| ProjectChanges |
Entity Changes Model for IProjectSnapshot |
| ProjectConfigurationChanges |
Entity Changes Model for IProjectConfigurationSnapshot |
| ProjectConfigurationPropertiesFilterExtensions |
Contains additional extension methods to support accessing collection properties with additional filtering parameters. UNDONE: this code would be generated eventually. |
| ProjectConfigurationQueryResultsExtensions |
Query Results Extensions for IProjectConfigurationSnapshot |
| ProjectContextChanges |
Entity Changes Model for IProjectContextSnapshot |
| ProjectContextQueryResultsExtensions |
Query Results Extensions for IProjectContextSnapshot |
| ProjectPropertiesFilterExtensions |
Contains additional extension methods to support accessing collection properties with additional filtering parameters. UNDONE: this code would be generated eventually. |
| ProjectQueryableSpace |
Implementation of IProjectModelQueryableSpace. |
| ProjectQueryableSpacePropertiesFilterExtensions | |
| ProjectQueryResultsExtensions |
Query Results Extensions for IProjectSnapshot |
| ProjectReferenceChanges |
Entity Changes Model for IProjectReferenceSnapshot |
| ProjectReferenceQueryResultsExtensions |
Query Results Extensions for IProjectReferenceSnapshot |
| ProjectReferenceType |
Represents the type of the project reference from ReferenceType |
| ProjectsData |
Contains information about loaded projects and the solution version. |
| ProjectSnapshotVersions |
Version Keys used in query result. |
| PropertyChanges |
Entity Changes Model for IPropertySnapshot |
| PropertyPageChanges |
Entity Changes Model for IPropertyPageSnapshot |
| PropertyPageQueryResultsExtensions |
Query Results Extensions for IPropertyPageSnapshot |
| PropertyQueryResultsExtensions |
Query Results Extensions for IPropertySnapshot |
| QueryDataVersions |
Represents data version of a project query result |
| QueryDataVersionsJsonConverter |
A JSON convert to support serializing QueryDataVersions. |
| QueryEntityChangesBase<TEntity> |
A base class for Query Entity Changes. |
| QueryExecutionError<TEntity> |
Represents the error encountered in query execution. The error will be reported back in the query result. |
| QueryExecutionErrorBase |
Base class representing the error encountered in query execution. The error will be reported back in the query result. |
| QueryExecutionException |
Exception thrown when the query engine fails to execute a query. |
| QueryExpressionExtensions |
Additional methods to be used inside query conditional expression to help filtering data. |
| QueryResultsDiffCalculator<TResult> |
Gets the type of query results and invokes diff calculation. |
| ReferenceType |
Predefined Reference types |
| RuleResultChanges |
Entity Changes Model for IRuleResultSnapshot |
| RuleResultItemChanges |
Entity Changes Model for IRuleResultItemSnapshot |
| RuleResultItemQueryResultsExtensions |
Query Results Extensions for IRuleResultItemSnapshot |
| RuleResultQueryResultsExtensions |
Query Results Extensions for IRuleResultSnapshot |
| SolutionChanges |
Entity Changes Model for ISolutionSnapshot |
| SolutionConfigurationChanges |
Entity Changes Model for ISolutionConfigurationSnapshot |
| SolutionConfigurationQueryResultsExtensions |
Query Results Extensions for ISolutionConfigurationSnapshot |
| SolutionFolderChanges |
Entity Changes Model for ISolutionFolderSnapshot |
| SolutionFolderPropertiesFilterExtensions |
Contains additional extension methods to support accessing collection properties with additional filtering parameters. UNDONE: this code would be generated eventually. |
| SolutionFolderQueryResultsExtensions |
Query Results Extensions for ISolutionFolderSnapshot |
| SolutionPropertiesFilterExtensions | |
| SolutionQueryResultsExtensions |
Query Results Extensions for ISolutionSnapshot |
| SolutionVersionInfo |
This holds the version information of the solution. |
| SupportedValueChanges |
Entity Changes Model for ISupportedValueSnapshot |
| SupportedValueQueryResultsExtensions |
Query Results Extensions for ISupportedValueSnapshot |
| UIEditorMetadataChanges |
Entity Changes Model for IUIEditorMetadataSnapshot |
| UIEditorMetadataQueryResultsExtensions |
Query Results Extensions for IUIEditorMetadataSnapshot |
| UIPropertyChanges |
Entity Changes Model for IUIPropertySnapshot |
| UIPropertyEditorChanges |
Entity Changes Model for IUIPropertyEditorSnapshot |
| UIPropertyEditorQueryResultsExtensions |
Query Results Extensions for IUIPropertyEditorSnapshot |
| UIPropertyQueryResultsExtensions |
Query Results Extensions for IUIPropertySnapshot |
| UIPropertyValueChanges |
Entity Changes Model for IUIPropertyValueSnapshot |
| UIPropertyValueQueryResultsExtensions |
Query Results Extensions for IUIPropertyValueSnapshot |
| UpdateExtensions |
Provides extension methods to apply actions/updates to the project model. |
Interfaces
| IAssemblyReferencePropertiesAvailableStatus |
Provides information on what properties contain values in a IAssemblyReferencePropertiesAvailableStatus. |
| IAssemblyReferenceSnapshot |
Describes a referenced assembly in a Project Configuration. Holds useful information in regards to an Assembly Reference like its Name, Path, Type, etc. |
| IAsyncExecutable<TEntity> |
Represent a set of actions to be executed on the remote side. |
| IAsyncQueryable |
Provides functionality to evaluate queries against the project system API model. |
| IAsyncQueryable<TEntity> |
Provides functionality to evaluate queries against the project system API model. |
| IAsyncUpdatable<TEntity> |
Represents a set changes to be made to the remote side. |
| IBuildPropertyPropertiesAvailableStatus |
Provides information on what properties contain values in a IBuildPropertyPropertiesAvailableStatus. |
| IBuildPropertySnapshot |
Describes a Build Property. Holds useful information in regards to a Build Property like its Name, Value, and Storage Type. |
| ICategoryPropertiesAvailableStatus |
Provides information on what properties contain values in a ICategoryPropertiesAvailableStatus. |
| ICategorySnapshot |
Describes a Category for Launch Profiles and Property Pages. Holds useful information in regards to a Category like its Name, Display Name, Order. |
| ICommonQueryableSpace |
It contains core functions to be exposed to the user from the root queryable space. |
| IConfigurationDimensionDefinitionPropertiesAvailableStatus |
Provides information on what properties contain values in a IConfigurationDimensionDefinitionPropertiesAvailableStatus. |
| IConfigurationDimensionDefinitionSnapshot |
Describes values to declare project configurations. Holds useful information in regards to a Configuration Dimension Definition like its Name and Values. |
| IConfigurationDimensionPropertiesAvailableStatus |
Provides information on what properties contain values in a IConfigurationDimensionPropertiesAvailableStatus. |
| IConfigurationDimensionSnapshot |
Describes values of each dimension of a single Project Configuration. Holds useful information in regards to a Configuration Dimension like its Name and Value. |
| IEntity |
A shared common interface for all entities in the project system API. |
| IEntityIdProperty |
Represent the Id field |
| IEntityModel |
The entity model is the root of the metadata model of types in the project system API. |
| IEntityProperty |
The metadata of a property inside an entity type. |
| IEntityRelationshipProperty | |
| IEntitySite |
An entity site provides data attaching point for entity data object. This is essentially useful on the server side, when child collection data comes from a different data provider, and need be hosted inside query engine managed node (to control data versions). Also, this provides a data attaching point for 3rd party extension models in the future. |
| IEntityType |
The metadata information about an entity type. |
| IEntityValue |
An entity data is the implementation of an entity type. |
| IEntityValueProperty |
The metadata of a value property inside an entity type. |
| IEntityValueProperty<TValue> |
The metadata of a value property inside an entity type. |
| IEntityWithId |
Represent an entity object which has an identity. |
| IEntityWithId<TEntity> |
Represent an entity object which has an identity. |
| IExternalFilePropertiesAvailableStatus |
Provides information on what properties contain values in a IExternalFilePropertiesAvailableStatus. |
| IExternalFileSnapshot |
Describes an External File referenced by a Project, such as a header file in C++ projects. Holds useful information in regards to a External File like its Path. |
| IFilePropertiesAvailableStatus |
Provides information on what properties contain values in a IFilePropertiesAvailableStatus. |
| IFileSnapshot |
Describes a File contained by a project or a solution folder. Holds useful information in regards to a File like its Path, Extension, Name, etc. |
| IFolderPropertiesAvailableStatus |
Provides information on what properties contain values in a IFolderPropertiesAvailableStatus. |
| IFolderSnapshot |
Describes a Folder in the project. Holds useful information in regards to a Folder like its Name, Files, etc. |
| ILaunchProfilePropertiesAvailableStatus |
Provides information on what properties contain values in a ILaunchProfilePropertiesAvailableStatus. |
| ILaunchProfileSnapshot |
Describes a Launch Profile defined in a Project. Holds useful information in regards to a Launch Profile like its Name, Command Name, Categories, etc. |
| ILaunchProfileTypePropertiesAvailableStatus |
Provides information on what properties contain values in a ILaunchProfileTypePropertiesAvailableStatus. |
| ILaunchProfileTypeSnapshot |
Describes a Launch Profile Type. Holds useful information in regards to a Launch Profile Type like its Display Name, Help URL, ImageMoniker, etc. |
| IOutputGroupPropertiesAvailableStatus |
Provides information on what properties contain values in a IOutputGroupPropertiesAvailableStatus. |
| IOutputGroupSnapshot |
Describes a collection of project output. Holds useful information in regards to a Output Group like its Name, Outputs, and Description. |
| IOutputPropertiesAvailableStatus |
Provides information on what properties contain values in a IOutputPropertiesAvailableStatus. |
| IOutputSnapshot |
Describes an item inside a single output group. Holds useful information in regards to an Output like its Name, Final Output Path, Is Key Output, etc. |
| IPackageReferencePropertiesAvailableStatus |
Provides information on what properties contain values in a IPackageReferencePropertiesAvailableStatus. |
| IPackageReferenceSnapshot |
Describes a Package Reference in a Project Configuration, typically NuGet package references. Holds useful information in regards to a Package Reference like its Name, Type, and Version. |
| IProjectConfigurationPropertiesAvailableStatus |
Provides information on what properties contain values in a IProjectConfigurationPropertiesAvailableStatus. |
| IProjectConfigurationSnapshot |
Describes a Project Configuration. Holds useful information in regards to a Project Configuration like its Name, Output Groups, Package References, etc. |
| IProjectContextPropertiesAvailableStatus |
Provides information on what properties contain values in a IProjectContextPropertiesAvailableStatus. |
| IProjectContextSnapshot |
Describes a Project Context that determine how various operations should be performed. Holds useful information in regards to a Project Context like its Project Path, Should Build, Should Deploy, etc. |
| IProjectModelQueryableSpace |
The root of the workspace for the project model. Contains queryable collections for Solutions as well as Projects. |
| IProjectPropertiesAvailableStatus |
Provides information on what properties contain values in a IProjectPropertiesAvailableStatus. |
| IProjectReferencePropertiesAvailableStatus |
Provides information on what properties contain values in a IProjectReferencePropertiesAvailableStatus. |
| IProjectReferenceSnapshot |
Describes a Project to Project Reference, including references to Shared Projects. Holds useful information in regards to a Project Reference like its Canonical Name, Reference Project Path, Reference Type, etc. |
| IProjectSnapshot |
Describes a Project in Visual Studio. Holds information in regards to a Project like its Name, Guid, Path, etc. |
| IProjectSystemQueryService |
The entry point to use the project system query APIs. It is exposed as a service inside VS. From here, a client can get the root queryable workspace to retrieve project system data. Note: when a major change impacting the entire object space happens, (for example, client is disconnected from Nexus server), the original IProjectModelQueryableSpace will be disposed (and firing notification before that.) A client is expected to retrieve a new workspace when the client connects to a new server (or opens a solution locally, in which case it will use a server side workspace object). |
| IPropertiesAvailableStatus |
Provides information on what properties contain values in a query result. |
| IPropertyPagePropertiesAvailableStatus |
Provides information on what properties contain values in a IPropertyPagePropertiesAvailableStatus. |
| IPropertyPageSnapshot |
Describes a Property Page shown for a Project. Holds useful information in regards to a Property Page like its Name, Catagories, Properties, etc. |
| IPropertyPropertiesAvailableStatus |
Provides information on what properties contain values in a IPropertyPropertiesAvailableStatus. |
| IPropertySnapshot |
Describes a Property of a Project, Configuration, or File. Holds useful information in regards to a Property like its Name, Value, Supported Values, etc. |
| IQueryResultItem<TEntity> |
Represents items inside IAsyncEnumerable<T> of a query result. The interface is a placeholder so further version information can be added into it. |
| IQueryResults<TEntity> |
Represents the result after executing a query. |
| IQueryTrackUpdates<TEntity> |
Represents the results of a tracked query. |
| IRuleResultItemPropertiesAvailableStatus |
Provides information on what properties contain values in a IRuleResultItemPropertiesAvailableStatus. |
| IRuleResultItemSnapshot |
Describes an Item in the rule result. Holds useful information in regards to an item like its Name. |
| IRuleResultPropertiesAvailableStatus |
Provides information on what properties contain values in a IRuleResultPropertiesAvailableStatus. |
| IRuleResultSnapshot |
Describes a Project Rule Result. Holds useful information in regards to a Rule Result like its Name, Items. |
| ISolutionConfigurationPropertiesAvailableStatus |
Provides information on what properties contain values in a ISolutionConfigurationPropertiesAvailableStatus. |
| ISolutionConfigurationSnapshot |
Describes a Solution Configuration that has solution-level properties about a particular way to build the solution. Holds useful information in regards to a Solution Configuration like its Name and Project Contexts. |
| ISolutionDataManager |
Defines methods to get projects and version information from the solution manager. |
| ISolutionFolderPropertiesAvailableStatus |
Provides information on what properties contain values in a ISolutionFolderPropertiesAvailableStatus. |
| ISolutionFolderSnapshot |
Describes a Solution Folder. Holds useful information in regards to a Solution Folder like its Name, Files, Projects, etc. |
| ISolutionPropertiesAvailableStatus |
Provides information on what properties contain values in a ISolutionPropertiesAvailableStatus. |
| ISolutionSnapshot |
Describes a Solution in Visual Studio. Holds useful information in regards to a Solution like its Path, Solution Folders, Solution Configurations, etc. |
| ISupportedValuePropertiesAvailableStatus |
Provides information on what properties contain values in a ISupportedValuePropertiesAvailableStatus. |
| ISupportedValueSnapshot |
Describes a Supported Value. Holds useful information in regards to a Supported Value like its Value, and Display Name. |
| IUIEditorMetadataPropertiesAvailableStatus |
Provides information on what properties contain values in a IUIEditorMetadataPropertiesAvailableStatus. |
| IUIEditorMetadataSnapshot |
Describes a UI Editor Metadata. Holds useful information in regards to a UI Property Editor like its Name, and Value. |
| IUIPropertyEditorPropertiesAvailableStatus |
Provides information on what properties contain values in a IUIPropertyEditorPropertiesAvailableStatus. |
| IUIPropertyEditorSnapshot |
Describes a UI Property Editor. Holds useful information in regards to a UI Property Editor like its Name, and Metadata. |
| IUIPropertyPropertiesAvailableStatus |
Provides information on what properties contain values in a IUIPropertyPropertiesAvailableStatus. |
| IUIPropertySnapshot |
Describes a UI Property for Launch Profile and Property Page. Holds useful information in regards to a UI Property like its Name, Description, Values, etc. |
| IUIPropertyValuePropertiesAvailableStatus |
Provides information on what properties contain values in a IUIPropertyValuePropertiesAvailableStatus. |
| IUIPropertyValueSnapshot |
Describes a UI Property Value. Holds useful information in regards to a UI Property Value like its Configuration Dimensions, Supported Values, Evaluated Value, etc. |
| IUpdateResults<TEntity> |
Represents the result after executing an update query. |
Enums
| PropertySourceType |
The different types of sources properties can be from. |
| UpdateType |
Represents type of update. |