Show / Hide Table of Contents

    Class XRefSpec

    Inheritance
    Object
    XRefSpec
    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 XRefSpec : IDictionary<string, string>, ICollection<KeyValuePair<string, string>>, IEnumerable<KeyValuePair<string, string>>, IEnumerable

    Constructors

    XRefSpec()

    Declaration
    public XRefSpec()

    XRefSpec(XRefSpec)

    Declaration
    public XRefSpec(XRefSpec spec)
    Parameters
    Type Name Description
    XRefSpec spec

    XRefSpec(IDictionary<String, String>)

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

    Fields

    CommentIdKey

    Declaration
    public const string CommentIdKey = "commentId"
    Field Value
    Type Description
    String

    HrefKey

    Declaration
    public const string HrefKey = "href"
    Field Value
    Type Description
    String

    NameKey

    Declaration
    public const string NameKey = "name"
    Field Value
    Type Description
    String

    UidKey

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

    Properties

    CommentId

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

    Count

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    Int32
    Implements
    ICollection<T>.Count

    Href

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

    IsReadOnly

    Declaration
    public bool IsReadOnly { get; }
    Property Value
    Type Description
    Boolean
    Implements
    ICollection<T>.IsReadOnly

    Item[String]

    Declaration
    public string this[string key] { get; set; }
    Parameters
    Type Name Description
    String key
    Property Value
    Type Description
    String
    Implements
    IDictionary<TKey, TValue>.Item[TKey]

    Keys

    Declaration
    public ICollection<string> Keys { get; }
    Property Value
    Type Description
    ICollection<String>
    Implements
    IDictionary<TKey, TValue>.Keys

    Name

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

    Uid

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

    Values

    Declaration
    public ICollection<string> Values { get; }
    Property Value
    Type Description
    ICollection<String>
    Implements
    IDictionary<TKey, TValue>.Values

    Methods

    Add(String, String)

    Declaration
    public void Add(string key, string value)
    Parameters
    Type Name Description
    String key
    String value
    Implements
    IDictionary<TKey, TValue>.Add(TKey, TValue)

    Clear()

    Declaration
    public void Clear()
    Implements
    ICollection<T>.Clear()

    ContainsKey(String)

    Declaration
    public bool ContainsKey(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean
    Implements
    IDictionary<TKey, TValue>.ContainsKey(TKey)

    GetEnumerator()

    Declaration
    public IEnumerator<KeyValuePair<string, string>> GetEnumerator()
    Returns
    Type Description
    IEnumerator<KeyValuePair<String, String>>
    Implements
    IEnumerable<T>.GetEnumerator()

    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

    Remove(String)

    Declaration
    public bool Remove(string key)
    Parameters
    Type Name Description
    String key
    Returns
    Type Description
    Boolean
    Implements
    IDictionary<TKey, TValue>.Remove(TKey)

    ToReadOnly()

    Declaration
    public XRefSpec ToReadOnly()
    Returns
    Type Description
    XRefSpec

    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
    IDictionary<TKey, TValue>.TryGetValue(TKey, TValue)

    Operators

    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

    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
    ICollection<T>.Add(T)

    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
    ICollection<T>.Contains(T)

    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
    ICollection<T>.CopyTo(T[], Int32)

    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
    ICollection<T>.Remove(T)

    IEnumerable.GetEnumerator()

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

    Extension Methods

    JsonUtility.ToJsonString(Object, Formatting, JsonSerializer)
    TaskHelper.ForEachInParallelAsync<T>(IEnumerable<T>, Func<T, Task>, Int32)
    TaskHelper.ForEachInParallelAsync<T>(IEnumerable<T>, Func<T, Task>)
    TaskHelper.SelectInParallelAsync<TSource, TResult>(IEnumerable<TSource>, Func<TSource, Task<TResult>>, Int32)
    TaskHelper.SelectInParallelAsync<TSource, TResult>(IEnumerable<TSource>, Func<TSource, Task<TResult>>)
    Back to top Copyright © 2015-2017 Microsoft
    Generated by DocFX