FileSnapshot Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.ProjectSystem.Query.Framework

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

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

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.

Implementation for IFileSnapshot

[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 FileSnapshot : Microsoft.VisualStudio.ProjectSystem.Query.Framework.EntityValueWithId<Microsoft.VisualStudio.ProjectSystem.Query.IFileSnapshot,Microsoft.VisualStudio.ProjectSystem.Query.Framework.FilePropertiesAvailableStatus>, Microsoft.VisualStudio.ProjectSystem.Query.IEntityWithId<Microsoft.VisualStudio.ProjectSystem.Query.IFileSnapshot>, Microsoft.VisualStudio.ProjectSystem.Query.IFileSnapshot

[<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 FileSnapshot = class
    inherit EntityValueWithId<IFileSnapshot, FilePropertiesAvailableStatus>
    interface IFileSnapshot
    interface IEntityWithId<IFileSnapshot>
    interface IEntityWithId
    interface IEntity

Public Class FileSnapshot
Inherits EntityValueWithId(Of IFileSnapshot, FilePropertiesAvailableStatus)
Implements IEntityWithId(Of IFileSnapshot), IFileSnapshot

Inheritance: Object

EntityValueBase

EntityValueWithId

EntityValueWithId<IFileSnapshot,FilePropertiesAvailableStatus>
FileSnapshot

Attributes: Newtonsoft.Json.JsonConverterAttribute NullableAttribute

Implements: IEntity IEntityWithId IEntityWithId<IFileSnapshot> IFileSnapshot

Constructors

FileSnapshot(IEntityRuntimeModel, EntityIdentity, FilePropertiesAvailableStatus)
FileSnapshot(IEntityRuntimeModel, EntityIdentity)

Properties

EntityRuntime	(Inherited from EntityValueBase)
Extension
FileName
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)
IsHidden
IsSearchable
ItemName
ItemType
LinkPath
Path
Properties
PropertiesAvailableStatus
SelfQuery	Gets a base query to query information under this entity. (Inherited from EntityValueWithId<TEntity,TPropertiesAvailableStatus>)
SharedPath
Site	Gets the site of the entity. (It is a part of infrastructure to attach additional collections to it. (Inherited from EntityValueBase)
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

PropertiesByName(IFileSnapshot, String[])	Gets source file properties with a set of known names.
RunCustomToolAsync(IFileSnapshot, CancellationToken)	Runs the custom code generator for a single file.

Applies to

Partager via