Class StructuredMetadataDictionary

A collection class to contain StructuredMetadata objects.

Inheritance

System.Object

StructuredMetadataDictionary

Implements

System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IList<StructuredMetadata>>

System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Collections.Generic.IList<StructuredMetadata>>>

System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Collections.Generic.IList<StructuredMetadata>>>

System.Collections.IEnumerable

Namespace: OpenGraphNet.Metadata

Assembly: OpenGraphNet.dll

Syntax

public class StructuredMetadataDictionary : Object

Constructors

StructuredMetadataDictionary()

Declaration

public StructuredMetadataDictionary()

Properties

Count

Gets the number of elements contained in the System.Collections.Generic.ICollection<>.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

IsReadOnly

Gets a value indicating whether the System.Collections.Generic.ICollection<> is read-only.

Declaration

public bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean

Item[String]

Gets or sets the System.Collections.Generic.IList<> with the specified key.

Declaration

public IList<StructuredMetadata> this[string key] { get; set; }

Parameters

Type	Name	Description
System.String	key	The key.

Property Value

Type	Description
System.Collections.Generic.IList<StructuredMetadata>	The System.Collections.Generic.IList<>.

Keys

Gets an System.Collections.Generic.ICollection<> containing the keys of the System.Collections.Generic.IDictionary<, >.

Declaration

public ICollection<string> Keys { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.String>

Values

Gets an System.Collections.Generic.ICollection<> containing the values in the System.Collections.Generic.IDictionary<, >.

Declaration

public ICollection<IList<StructuredMetadata>> Values { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.Collections.Generic.IList<StructuredMetadata>>

Methods

Add(KeyValuePair<String, IList<StructuredMetadata>>)

Adds an item to the System.Collections.Generic.ICollection<>.

Declaration

public void Add(KeyValuePair<string, IList<StructuredMetadata>> item)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.Collections.Generic.IList<StructuredMetadata>>	item	The object to add to the System.Collections.Generic.ICollection<>.

Add(String, IList<StructuredMetadata>)

Adds an element with the provided key and value to the System.Collections.Generic.IDictionary<, >.

Declaration

public void Add(string key, IList<StructuredMetadata> value)

Parameters

Type	Name	Description
System.String	key	The object to use as the key of the element to add.
System.Collections.Generic.IList<StructuredMetadata>	value	The object to use as the value of the element to add.

Clear()

Removes all items from the System.Collections.Generic.ICollection<>.

Declaration

public void Clear()

Contains(KeyValuePair<String, IList<StructuredMetadata>>)

Determines whether the System.Collections.Generic.ICollection<> contains a specific value.

Declaration

public bool Contains(KeyValuePair<string, IList<StructuredMetadata>> item)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.Collections.Generic.IList<StructuredMetadata>>	item	The object to locate in the System.Collections.Generic.ICollection<>.

Returns

Type	Description
System.Boolean	true if item is found in the System.Collections.Generic.ICollection<>; otherwise, false.

ContainsKey(String)

Determines whether the System.Collections.Generic.IDictionary<, > contains an element with the specified key.

Declaration

public bool ContainsKey(string key)

Parameters

Type	Name	Description
System.String	key	The key to locate in the System.Collections.Generic.IDictionary<, >.

Returns

Type	Description
System.Boolean	true if the System.Collections.Generic.IDictionary<, > contains an element with the key; otherwise, false.

CopyTo(KeyValuePair<String, IList<StructuredMetadata>>[], Int32)

Copies the elements of the System.Collections.Generic.ICollection<> to an System.Array, starting at a particular System.Array index.

Declaration

public void CopyTo(KeyValuePair<string, IList<StructuredMetadata>>[] array, int arrayIndex)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.Collections.Generic.IList<StructuredMetadata>>[]	array	The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Generic.ICollection<>. The System.Array must have zero-based indexing.
System.Int32	arrayIndex	The zero-based index in array at which copying begins.

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<KeyValuePair<string, IList<StructuredMetadata>>> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<System.String, System.Collections.Generic.IList<StructuredMetadata>>>	An enumerator that can be used to iterate through the collection.

Remove(KeyValuePair<String, IList<StructuredMetadata>>)

Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection<>.

Declaration

public bool Remove(KeyValuePair<string, IList<StructuredMetadata>> item)

Parameters

Type	Name	Description
System.Collections.Generic.KeyValuePair<System.String, System.Collections.Generic.IList<StructuredMetadata>>	item	The object to remove from the System.Collections.Generic.ICollection<>.

Returns

Type	Description
System.Boolean	true if item was successfully removed from the System.Collections.Generic.ICollection<>; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection<>.

Remove(String)

Removes the element with the specified key from the System.Collections.Generic.IDictionary<, >.

Declaration

public bool Remove(string key)

Parameters

Type	Name	Description
System.String	key	The key of the element to remove.

Returns

Type	Description
System.Boolean	true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original System.Collections.Generic.IDictionary<, >.

TryGetValue(String, out IList<StructuredMetadata>)

Gets the value associated with the specified key.

Declaration

public bool TryGetValue(string key, out IList<StructuredMetadata> value)

Parameters

Type	Name	Description
System.String	key	The key whose value to get.
System.Collections.Generic.IList<StructuredMetadata>	value	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

Type	Description
System.Boolean	true if the object that implements System.Collections.Generic.IDictionary<, > contains an element with the specified key; otherwise, false.

Implements

System.Collections.Generic.IDictionary<, >

System.Collections.Generic.ICollection<>

System.Collections.Generic.IEnumerable<>

System.Collections.IEnumerable