Show / Hide Table of Contents

    Class FileModel

    Inheritance
    Object
    FileModel
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace:Microsoft.DocAsCode.Plugins
    Assembly:Microsoft.DocAsCode.Plugins.dll
    Syntax
    public sealed class FileModel : IDisposable

    Constructors

    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

    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

    BaseDir

    Declaration
    public string BaseDir { get; set; }
    Property Value
    Type Description
    String

    Content

    Declaration
    public object Content { get; set; }
    Property Value
    Type Description
    Object

    DocumentType

    Declaration
    public string DocumentType { get; set; }
    Property Value
    Type Description
    String

    File

    Declaration
    public string File { get; set; }
    Property Value
    Type Description
    String

    FileAndType

    Declaration
    public FileAndType FileAndType { get; }
    Property Value
    Type Description
    FileAndType

    FileLinkSources

    Declaration
    public ImmutableDictionary<string, ImmutableList<LinkSourceInfo>> FileLinkSources { get; set; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableDictionary<String, System.Collections.Immutable.ImmutableList<LinkSourceInfo>>

    Key

    Declaration
    public string Key { get; }
    Property Value
    Type Description
    String

    LinkToFiles

    Declaration
    public ImmutableHashSet<string> LinkToFiles { get; set; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableHashSet<String>

    LinkToUids

    Declaration
    public ImmutableHashSet<string> LinkToUids { get; set; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableHashSet<String>

    LocalPathFromRoot

    Declaration
    public string LocalPathFromRoot { get; set; }
    Property Value
    Type Description
    String

    ManifestProperties

    Declaration
    public dynamic ManifestProperties { get; }
    Property Value
    Type Description
    Object

    ModelWithCache

    Declaration
    public ModelWithCache ModelWithCache { get; }
    Property Value
    Type Description
    ModelWithCache

    OriginalFileAndType

    Declaration
    public FileAndType OriginalFileAndType { get; }
    Property Value
    Type Description
    FileAndType

    Properties

    Declaration
    public dynamic Properties { get; }
    Property Value
    Type Description
    Object

    Serializer

    Declaration
    public IFormatter Serializer { get; set; }
    Property Value
    Type Description
    IFormatter

    Type

    Declaration
    public DocumentType Type { get; }
    Property Value
    Type Description
    DocumentType

    UidLinkSources

    Declaration
    public ImmutableDictionary<string, ImmutableList<LinkSourceInfo>> UidLinkSources { get; set; }
    Property Value
    Type Description
    System.Collections.Immutable.ImmutableDictionary<String, System.Collections.Immutable.ImmutableList<LinkSourceInfo>>

    Uids

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

    Methods

    Dispose()

    Declaration
    public void Dispose()
    Implements
    IDisposable.Dispose()

    Events

    ContentAccessed

    Declaration
    public event EventHandler ContentAccessed
    Event Type
    Type Description
    EventHandler

    FileOrBaseDirChanged

    Declaration
    public event EventHandler FileOrBaseDirChanged
    Event Type
    Type Description
    EventHandler

    UidsChanged

    Declaration
    public event EventHandler<PropertyChangedEventArgs<ImmutableArray<UidDefinition>>> UidsChanged
    Event Type
    Type Description
    EventHandler<PropertyChangedEventArgs<System.Collections.Immutable.ImmutableArray<UidDefinition>>>

    Extension Methods

    JsonUtility.ToJsonString(Object, Formatting, JsonSerializer)
    Back to top Copyright © 2015-2017 Microsoft
    Generated by DocFX