Class XRefSpec

    Inheritance
    Object
    XRefSpec
    Inherited Members
    Namespace:Microsoft.DocAsCode.Plugins
    Assembly:Microsoft.DocAsCode.Plugins.dll
    Syntax
    public sealed class XRefSpec : IDictionary<string, string>, ICollection<KeyValuePair<string, string>>, IEnumerable<KeyValuePair<string, string>>, IEnumerable

    Constructors

    | Improve this Doc View Source

    XRefSpec()

    Declaration
    public XRefSpec()
    | Improve this Doc View Source

    XRefSpec(XRefSpec)

    Declaration
    public XRefSpec(XRefSpec spec)
    Parameters
    Type Name Description
    XRefSpec spec
    | Improve this Doc View Source

    XRefSpec(IDictionary<String, String>)

    Declaration
    public XRefSpec(IDictionary<string, string> dictionary)
    Parameters
    Type Name Description
    IDictionary<String, String> dictionary

    Fields

    | Improve this Doc View Source

    CommentIdKey

    Declaration
    public const string CommentIdKey = "commentId"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    HrefKey

    Declaration
    public const string HrefKey = "href"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    NameKey

    Declaration
    public const string NameKey = "name"
    Field Value
    Type Description
    String
    | Improve this Doc View Source

    UidKey

    Declaration
    public const string UidKey = "uid"
    Field Value
    Type Description
    String

    Properties

    | Improve this Doc View Source

    CommentId

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

    Count

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    Int32
    Implements
    | Improve this Doc View Source

    Href

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

    IsReadOnly

    Declaration
    public bool IsReadOnly { get; }
    Property Value
    Type Description
    Boolean
    Implements
    | Improve this Doc View Source

    Item[String]

    Declaration
    public string this[string key] { get; set; }
    Parameters
    Type Name Description
    String key
    Property Value
    Type Description
    String
    Implements
    | Improve this Doc View Source

    Keys

    Declaration
    public ICollection<string> Keys { get; }
    Property Value
    Type Description
    ICollection<String>
    Implements
    | Improve this Doc View Source

    Name

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

    Uid

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

    Values

    Declaration
    public ICollection<string> Values { get; }
    Property Value
    Type Description
    ICollection<String>
    Implements

    Methods

    | Improve this Doc View Source

    Add(String, String)

    Declaration
    public void Add(string key, string value)
    Parameters
    Type Name Description
    String key
    String value
    Implements
    | Improve this Doc View Source

    Clear()

    Declaration
    public void Clear()
    Implements
    | Improve this Doc View Source

    ContainsKey(String)

    Declaration
    public bool ContainsKey(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean
    Implements
    | Improve this Doc View Source

    GetEnumerator()

    Declaration
    public IEnumerator<KeyValuePair<string, string>> GetEnumerator()
    Returns
    Type Description
    IEnumerator<KeyValuePair<String, String>>
    Implements
    | Improve this Doc View Source

    Merge(XRefSpec, XRefSpec)

    Merge two xref spec (right overwrite left).

    Declaration
    public static XRefSpec Merge(XRefSpec left, XRefSpec right)
    Parameters
    Type Name Description
    XRefSpec left
    XRefSpec right
    Returns
    Type Description
    XRefSpec
    | Improve this Doc View Source

    Remove(String)

    Declaration
    public bool Remove(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean
    Implements
    | Improve this Doc View Source

    ToReadOnly()

    Declaration
    public XRefSpec ToReadOnly()
    Returns
    Type Description
    XRefSpec
    | Improve this Doc View Source

    TryGetValue(String, out String)

    Declaration
    public bool TryGetValue(string key, out string value)
    Parameters
    Type Name Description
    String key
    String value
    Returns
    Type Description
    Boolean
    Implements

    Operators

    | Improve this Doc View Source

    Addition(XRefSpec, XRefSpec)

    Declaration
    public static XRefSpec operator +(XRefSpec left, XRefSpec right)
    Parameters
    Type Name Description
    XRefSpec left
    XRefSpec right
    Returns
    Type Description
    XRefSpec

    Explicit Interface Implementations

    | Improve this Doc View Source

    ICollection<KeyValuePair<String, String>>.Add(KeyValuePair<String, String>)

    Declaration
    void ICollection<KeyValuePair<string, string>>.Add(KeyValuePair<string, string> item)
    Parameters
    Type Name Description
    KeyValuePair<String, String> item
    Implements
    | Improve this Doc View Source

    ICollection<KeyValuePair<String, String>>.Contains(KeyValuePair<String, String>)

    Declaration
    bool ICollection<KeyValuePair<string, string>>.Contains(KeyValuePair<string, string> item)
    Parameters
    Type Name Description
    KeyValuePair<String, String> item
    Returns
    Type Description
    Boolean
    Implements
    | Improve this Doc View Source

    ICollection<KeyValuePair<String, String>>.CopyTo(KeyValuePair<String, String>[], Int32)

    Declaration
    void ICollection<KeyValuePair<string, string>>.CopyTo(KeyValuePair<string, string>[] array, int arrayIndex)
    Parameters
    Type Name Description
    KeyValuePair<String, String>[] array
    Int32 arrayIndex
    Implements
    | Improve this Doc View Source

    ICollection<KeyValuePair<String, String>>.Remove(KeyValuePair<String, String>)

    Declaration
    bool ICollection<KeyValuePair<string, string>>.Remove(KeyValuePair<string, string> item)
    Parameters
    Type Name Description
    KeyValuePair<String, String> item
    Returns
    Type Description
    Boolean
    Implements
    | Improve this Doc View Source

    IEnumerable.GetEnumerator()

    Declaration
    IEnumerator IEnumerable.GetEnumerator()
    Returns
    Type Description
    IEnumerator
    Implements

    Extension Methods