Class XRefSpec
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
XRefSpec(XRefSpec)
Declaration
public XRefSpec(XRefSpec spec)
Parameters
XRefSpec(IDictionary<String, String>)
Declaration
public XRefSpec(IDictionary<string, string> dictionary)
Parameters
Fields
Declaration
public const string CommentIdKey = "commentId"
Field Value
HrefKey
Declaration
public const string HrefKey = "href"
Field Value
NameKey
Declaration
public const string NameKey = "name"
Field Value
UidKey
Declaration
public const string UidKey = "uid"
Field Value
Properties
Declaration
public string CommentId { get; set; }
Property Value
Count
Declaration
public int Count { get; }
Property Value
Implements
Href
Declaration
public string Href { get; set; }
Property Value
IsReadOnly
Declaration
public bool IsReadOnly { get; }
Property Value
Implements
Item[String]
Declaration
public string this[string key] { get; set; }
Parameters
Type |
Name |
Description |
String |
key |
|
Property Value
Implements
Keys
Declaration
public ICollection<string> Keys { get; }
Property Value
Implements
Name
Declaration
public string Name { get; set; }
Property Value
Uid
Declaration
public string Uid { get; set; }
Property Value
Values
Declaration
public ICollection<string> Values { get; }
Property Value
Implements
Methods
Add(String, String)
Declaration
public void Add(string key, string value)
Parameters
Implements
Clear()
Declaration
Implements
ContainsKey(String)
Declaration
public bool ContainsKey(string key)
Parameters
Type |
Name |
Description |
String |
key |
|
Returns
Implements
GetEnumerator()
Declaration
public IEnumerator<KeyValuePair<string, string>> GetEnumerator()
Returns
Implements
Merge(XRefSpec, XRefSpec)
Merge two xref spec (right overwrite left).
Declaration
public static XRefSpec Merge(XRefSpec left, XRefSpec right)
Parameters
Returns
Remove(String)
Declaration
public bool Remove(string key)
Parameters
Type |
Name |
Description |
String |
key |
|
Returns
Implements
ToReadOnly()
Declaration
public XRefSpec ToReadOnly()
Returns
TryGetValue(String, out String)
Declaration
public bool TryGetValue(string key, out string value)
Parameters
Returns
Implements
Operators
Addition(XRefSpec, XRefSpec)
Declaration
public static XRefSpec operator +(XRefSpec left, XRefSpec right)
Parameters
Returns
Explicit Interface Implementations
ICollection<KeyValuePair<String, String>>.Add(KeyValuePair<String, String>)
Declaration
void ICollection<KeyValuePair<string, string>>.Add(KeyValuePair<string, string> item)
Parameters
Implements
ICollection<KeyValuePair<String, String>>.Contains(KeyValuePair<String, String>)
Declaration
bool ICollection<KeyValuePair<string, string>>.Contains(KeyValuePair<string, string> item)
Parameters
Returns
Implements
ICollection<KeyValuePair<String, String>>.CopyTo(KeyValuePair<String, String>[], Int32)
Declaration
void ICollection<KeyValuePair<string, string>>.CopyTo(KeyValuePair<string, string>[] array, int arrayIndex)
Parameters
Implements
ICollection<KeyValuePair<String, String>>.Remove(KeyValuePair<String, String>)
Declaration
bool ICollection<KeyValuePair<string, string>>.Remove(KeyValuePair<string, string> item)
Parameters
Returns
Implements
IEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Implements
Extension Methods