Class FileModel

Inheritance
Object
FileModel
Implements
Inherited Members
Namespace: Microsoft.DocAsCode.Plugins
Assembly: Microsoft.DocAsCode.Plugins.dll
Syntax
public sealed class FileModel : IDisposable

Constructors

| Improve this Doc View Source

FileModel(FileAndType, Object, FileAndType, IFormatter)

Declaration
public FileModel(FileAndType ft, object content, FileAndType original = null, IFormatter serializer = null)
Parameters
Type Name Description
FileAndType ft
Object content
FileAndType original
IFormatter serializer
| Improve this Doc View Source

FileModel(FileAndType, Object, FileAndType, IFormatter, String)

Declaration
public FileModel(FileAndType ft, object content, FileAndType original, IFormatter serializer, string key)
Parameters
Type Name Description
FileAndType ft
Object content
FileAndType original
IFormatter serializer
String key

Properties

| Improve this Doc View Source

BaseDir

Declaration
public string BaseDir { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Content

Declaration
public object Content { get; set; }
Property Value
Type Description
Object
| Improve this Doc View Source

DocumentType

Declaration
public string DocumentType { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

File

Declaration
public string File { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

FileAndType

Declaration
public FileAndType FileAndType { get; }
Property Value
Type Description
FileAndType
| Improve this Doc View Source

FileLinkSources

Declaration
public ImmutableDictionary<string, ImmutableList<LinkSourceInfo>> FileLinkSources { get; set; }
Property Value
Type Description
ImmutableDictionary<String, ImmutableList<LinkSourceInfo>>
| Improve this Doc View Source

Key

Declaration
public string Key { get; }
Property Value
Type Description
String
| Improve this Doc View Source

LinkToFiles

Declaration
public ImmutableHashSet<string> LinkToFiles { get; set; }
Property Value
Type Description
ImmutableHashSet<String>
| Improve this Doc View Source

LinkToUids

Declaration
public ImmutableHashSet<string> LinkToUids { get; set; }
Property Value
Type Description
ImmutableHashSet<String>
| Improve this Doc View Source

LocalPathFromRoot

Declaration
public string LocalPathFromRoot { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

ManifestProperties

Declaration
public dynamic ManifestProperties { get; }
Property Value
Type Description
Object
| Improve this Doc View Source

MarkdownFragmentsModel

Declaration
public FileModel MarkdownFragmentsModel { get; set; }
Property Value
Type Description
FileModel
| Improve this Doc View Source

ModelWithCache

Declaration
public ModelWithCache ModelWithCache { get; }
Property Value
Type Description
ModelWithCache
| Improve this Doc View Source

OriginalFileAndType

Declaration
public FileAndType OriginalFileAndType { get; }
Property Value
Type Description
FileAndType
| Improve this Doc View Source

Properties

Declaration
public dynamic Properties { get; }
Property Value
Type Description
Object
| Improve this Doc View Source

Serializer

Declaration
public IFormatter Serializer { get; set; }
Property Value
Type Description
IFormatter
| Improve this Doc View Source

Type

Declaration
public DocumentType Type { get; }
Property Value
Type Description
DocumentType
| Improve this Doc View Source

UidLinkSources

Declaration
public ImmutableDictionary<string, ImmutableList<LinkSourceInfo>> UidLinkSources { get; set; }
Property Value
Type Description
ImmutableDictionary<String, ImmutableList<LinkSourceInfo>>
| Improve this Doc View Source

Uids

Declaration
public ImmutableArray<UidDefinition> Uids { get; set; }
Property Value
Type Description
ImmutableArray<UidDefinition>

Methods

| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()

Events

| Improve this Doc View Source

ContentAccessed

Declaration
public event EventHandler ContentAccessed
Event Type
Type Description
EventHandler
| Improve this Doc View Source

FileOrBaseDirChanged

Declaration
public event EventHandler FileOrBaseDirChanged
Event Type
Type Description
EventHandler
| Improve this Doc View Source

UidsChanged

Declaration
public event EventHandler<PropertyChangedEventArgs<ImmutableArray<UidDefinition>>> UidsChanged
Event Type
Type Description
EventHandler<PropertyChangedEventArgs<ImmutableArray<UidDefinition>>>

Implements

Extension Methods