IFileSnapshot Interface

Definition

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.

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.VisualStudio.ProjectSystem.Query.Framework.ProjectModelEntityJsonConverter), new System.Object[] { Mono.Cecil.CustomAttributeArgument })]
public interface IFileSnapshot : Microsoft.VisualStudio.ProjectSystem.Query.IEntityWithId<Microsoft.VisualStudio.ProjectSystem.Query.IFileSnapshot>
[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.VisualStudio.ProjectSystem.Query.Framework.ProjectModelEntityJsonConverter), new System.Object[] { Mono.Cecil.CustomAttributeArgument })>]
type IFileSnapshot = interface
    interface IEntityWithId<IFileSnapshot>
    interface IEntityWithId
    interface IEntity
Public Interface IFileSnapshot
Implements IEntityWithId(Of IFileSnapshot)
Derived
Attributes
Newtonsoft.Json.JsonConverterAttribute
Implements

Properties

Extension

Gets the extension of the filename.

FileName

Gets the file name of the file (name and extensions parts of the file's path).

Id

Gets the identity of the object.

(Inherited from IEntityWithId)
IsHidden

Gets whether the file is hidden from the solution explorer.

IsSearchable

Gets whether the file is subject to search-and-replace through Find/Replace.

ItemName

Gets the item name of the file.

ItemType

Gets the item type for the file.

LinkPath

Gets the link path of the file.

Path

Gets the path of the file.

Properties

Gets a queryable collection of properties of the file.

PropertiesAvailableStatus

Gets available properties status of a File.

SharedPath

Gets the shared path for the file.

VisualPath

Gets the visual path of the file based on how file is nested in the solution explorer.

Methods

AsQueryable()

Creates a queryable returning this entity object.

(Inherited from IEntityWithId<TEntity>)

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