Skip to main content

Class CompositeDictionary

Namespace: DocFxToTemplate.Models.DocFx
Assembly: DocFxToTemplate.dll
Source: src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L9

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L9
public class CompositeDictionary : IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable

Inheritance:
object <- CompositeDictionary

Inherited Members:
object.Equals(object, object), object.Equals(object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Implements:
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>, System.Collections.Generic.IDictionary<System.String,System.Object>, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Object>>, System.Collections.IEnumerable

Properties

this[string]

Gets or sets the element with the specified key.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L24
public object this[string key] { get; set; }

Property value

object
The element with the specified key.

Count

Gets the number of elements contained in the System.Collections.Generic.ICollection%601.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L55
public int Count { get; }

Property value

int
The number of elements contained in the .

IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection%601 is read-only.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L57
public bool IsReadOnly { get; }

Property value

bool
true if the is read-only; otherwise, false.

Keys

Gets an System.Collections.Generic.ICollection%601 containing the keys of the System.Collections.Generic.IDictionary%602.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L59
public ICollection<string> Keys { get; }

Property value

ICollection<string>
An containing the keys of the object that implements .

Values

Gets an System.Collections.Generic.ICollection%601 containing the values in the System.Collections.Generic.IDictionary%602.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L61
public ICollection<object> Values { get; }

Property value

ICollection<object>
An containing the values in the object that implements .

Methods

Add(string, object)

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary%602.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L68
public void Add(string key, object value)

Parameters

key string
The object to use as the key of the element to add.
value object
The object to use as the value of the element to add.

Clear()

Removes all items from the System.Collections.Generic.ICollection%601.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L82
public void Clear()

ContainsKey(string)

Determines whether the System.Collections.Generic.IDictionary%602 contains an element with the specified key.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L92
public bool ContainsKey(string key)

Parameters

key string
The key to locate in the .

Returns

bool
true if the contains an element with the key; otherwise, false.

GetEnumerator()

Returns an enumerator that iterates through the collection.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L111
public IEnumerator<KeyValuePair<string, object>> GetEnumerator()

Returns

IEnumerator<KeyValuePair<string, object>>
An enumerator that can be used to iterate through the collection.

Remove(string)

Removes the element with the specified key from the System.Collections.Generic.IDictionary%602.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L124
public bool Remove(string key)

Parameters

key string
The key of the element to remove.

Returns

bool
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original .

TryGetValue(string, out object)

Gets the value associated with the specified key.

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L134
public bool TryGetValue(string key, out object value)

Parameters

key string
The key whose value to get.
value object
When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

bool
true if the object that implements contains an element with the specified key; otherwise, false.

CreateBuilder()

src/DocFxToTemplate/Models/DocFx/CompositeDictionary.cs#L155
public static CompositeDictionary.Builder CreateBuilder()

Returns

CompositeDictionary.Builder

Implements

  • System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String,System.Object>>

  • System.Collections.Generic.IDictionary<System.String,System.Object>

  • System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Object>>

  • System.Collections.IEnumerable