Class XRefSpec

Inheritance
Object
XRefSpec
Inherited Members
Namespace: Microsoft.DocAsCode.Plugins
Assembly: Microsoft.DocAsCode.Plugins.dll
Syntax
[Serializable]
public sealed class XRefSpec : IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, 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, Object>)

Declaration
public XRefSpec(IDictionary<string, object> dictionary)
Parameters
Type Name Description
IDictionary<String, Object> 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

IsSpecKey

Declaration
public const string IsSpecKey = "isSpec"
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
| 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
| Improve this Doc View Source

IsSpec

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

Item[String]

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

Keys

Declaration
public ICollection<string> Keys { get; }
Property Value
Type Description
ICollection<String>
| 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<object> Values { get; }
Property Value
Type Description
ICollection<Object>

Methods

| Improve this Doc View Source

Add(String, Object)

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

Clear()

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

ContainsKey(String)

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

GetEnumerator()

Declaration
public IEnumerator<KeyValuePair<string, object>> GetEnumerator()
Returns
Type Description
IEnumerator<KeyValuePair<String, Object>>
| 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
| Improve this Doc View Source

ToReadOnly()

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

TryGetValue(String, out Object)

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

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, Object>>.Add(KeyValuePair<String, Object>)

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

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

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

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

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

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

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

IEnumerable.GetEnumerator()

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
Type Description
IEnumerator

Implements

Extension Methods