IEntityValueFromProvider Interface

Definition

Namespace:

Microsoft.VisualStudio.ProjectSystem.Query.Framework

Assembly:

Microsoft.VisualStudio.ProjectSystem.Query.dll

Package:

Microsoft.VisualStudio.ProjectSystem.Query v17.12.128

This contract allows query providers to pass state to a child collection provider.

public interface IEntityValueFromProvider : Microsoft.VisualStudio.ProjectSystem.Query.IEntityValue

type IEntityValueFromProvider = interface
    interface IEntityValue
    interface IEntity

Public Interface IEntityValueFromProvider
Implements IEntityValue

Derived

Microsoft.VisualStudio.ProjectSystem.Query.Framework.EntityValueBase

Implements

IEntity IEntityValue

Properties

EntityRuntime	The runtime owns this entity. (Inherited from IEntityValue)
PropertiesAvailableStatus	Gets available properties status of the entity (Inherited from IEntity)
ProviderState	A temporary state set to IEntityValue object to provide additional context for child collection queries, so they can work efficiently. Note: the state will be cleared out, once the query execution is done, and never passed to the client.

Methods

LimitAvailableProperties(IPropertiesAvailableStatus)	Eliminates properties which are not allowed defined in a specific type. This method is used to remove properties used in conditional filtering, but not in the final result. (Inherited from IEntityValue)
SetRelatedEntities(String, IReadOnlyCollection<IEntityValue>)	Sets related entities. This method is used by query engine to fill data. (Inherited from IEntityValue)
SetSite(IEntitySite)	Set the site to the entity data object. (Inherited from IEntityValue)
TryGetRelatedEntities(String, IEnumerable<IEntityValue>)	Try to get related entities saved through earlier SetRelatedEntities(String, IReadOnlyCollection<IEntityValue>). (Inherited from IEntityValue)