FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Common::DictionaryElementCollection Class Reference

Inherits OSGeo::FDO::Runtime::Disposable.

Inheritance diagram for OSGeo::FDO::Common::DictionaryElementCollection:

[legend]
List of all members.

Detailed Description

DictionaryElementCollection is a collection of DictionaryElement objects(name-value pairs).


Public Member Functions

System::Int32 Add (DictionaryElement *value)
 Adds a DictionaryElement object into the collection.
System::Void Clear ()
 Removes all elements from the collection.
System::Boolean Contains (String *name)
 Determines whether the collection contains a specific DictionaryElement object.
System::Boolean Contains (DictionaryElement *value)
 Determines whether the collection contains a specific DictionaryElement object.
System::Void CopyTo (DictionaryElement *array[], System::Int32 index)
 Copies the elements of the collection to an array.
 DictionaryElementCollection (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a dictionary object based on an unmanaged instance of the object.
 DictionaryElementCollection ()
 Constructs a new empty dictionary element collection
__property System::Int32 get_Count (System::Void)
 Gets the count of items in collection.
__property DictionaryElementget_Item (System::Int32 index)
 Gets a DictionaryElement in the collection.
__property DictionaryElementget_RealTypeItem (System::String *index)
 Gets a named DictionaryElement in the collection.
__property DictionaryElementget_RealTypeItem (System::Int32 index)
 Gets a DictionaryElement in the collection.
__sealed System::Collections::IEnumerator * GetEnumerator (System::Void)
 Gets an enumerator that can iterate through a collection.
System::Int32 IndexOf (String *name)
 Determines the index of a specific DictionaryElement object.
System::Int32 IndexOf (DictionaryElement *value)
 Determines the index of a specific DictionaryElement object.
System::Void Insert (System::Int32 index, DictionaryElement *value)
 Inserts a DictionaryElement object into the collection at the specified position.
System::Void Remove (DictionaryElement *value)
 Removes the first occurrence of a specific DictionaryElement object.
System::Void RemoveAt (System::Int32 index)
 Removes the index-th DictionaryElement from this collection.
__property System::Void set_Item (System::Int32 index, DictionaryElement *value)
 Sets a DictionaryElement in the collection.
__property System::Void set_RealTypeItem (System::Int32 index, DictionaryElement *value)
 Sets a DictionaryElement in the collection.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Common::DictionaryElementCollection::DictionaryElementCollection  ) 
 

Constructs a new empty dictionary element collection

OSGeo::FDO::Common::DictionaryElementCollection::DictionaryElementCollection System::IntPtr  unmanaged,
System::Boolean  autoDelete
 

Constructs a dictionary object based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged collection.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

System::Int32 OSGeo::FDO::Common::DictionaryElementCollection::Add DictionaryElement value  ) 
 

Adds a DictionaryElement object into the collection.

Parameters:
value Input the DictionaryElement object to add.
Returns:
Returns the position into which the new element was inserted.

System::Void OSGeo::FDO::Common::DictionaryElementCollection::Clear  ) 
 

Removes all elements from the collection.

System::Boolean OSGeo::FDO::Common::DictionaryElementCollection::Contains String *  name  ) 
 

Determines whether the collection contains a specific DictionaryElement object.

Parameters:
name Input The name of the DictionaryElement object to find in the collection.
Returns:
Returns true if the value is found in the collection; otherwise, false.

System::Boolean OSGeo::FDO::Common::DictionaryElementCollection::Contains DictionaryElement value  ) 
 

Determines whether the collection contains a specific DictionaryElement object.

Parameters:
value Input The DictionaryElement object to find in the collection.
Returns:
Returns true if the value is found in the collection; otherwise, false.

System::Void OSGeo::FDO::Common::DictionaryElementCollection::CopyTo DictionaryElement array[],
System::Int32  index
 

Copies the elements of the collection to an array.

Parameters:
array Output the one-dimensional Array that is the destination of the elements copied from this collection.
index Input an integer that represents the index in array at which copying begins.

__property System::Int32 OSGeo::FDO::Common::DictionaryElementCollection::get_Count System::Void   ) 
 

Gets the count of items in collection.

Returns:
Returns the number of items in the collection.

__property DictionaryElement* OSGeo::FDO::Common::DictionaryElementCollection::get_Item System::Int32  index  ) 
 

Gets a DictionaryElement in the collection.

Parameters:
index Input index of the DictionaryElement to retrieve.
Returns:
Returns the requested dictionary element.

__property DictionaryElement* OSGeo::FDO::Common::DictionaryElementCollection::get_RealTypeItem System::String *  index  ) 
 

Gets a named DictionaryElement in the collection.

Parameters:
index Input name of the DictionaryElement to retrieve.
Returns:
Returns the requested dictionary element.

__property DictionaryElement* OSGeo::FDO::Common::DictionaryElementCollection::get_RealTypeItem System::Int32  index  ) 
 

Gets a DictionaryElement in the collection.

Parameters:
index Input index of the DictionaryElement to retrieve.
Returns:
Returns the requested dictionary element.

__sealed System::Collections::IEnumerator* OSGeo::FDO::Common::DictionaryElementCollection::GetEnumerator System::Void   ) 
 

Gets an enumerator that can iterate through a collection.

Returns:
Returns an enumerator on the dictionary.

System::Int32 OSGeo::FDO::Common::DictionaryElementCollection::IndexOf String *  name  ) 
 

Determines the index of a specific DictionaryElement object.

Parameters:
name Input the name of the DictionaryElement object to locate in the collection.
Returns:
The index of value if found in the collection; otherwise, -1.

System::Int32 OSGeo::FDO::Common::DictionaryElementCollection::IndexOf DictionaryElement value  ) 
 

Determines the index of a specific DictionaryElement object.

Parameters:
value Input the DictionaryElement object to locate in the collection.
Returns:
The index of value if found in the collection; otherwise, -1.

System::Void OSGeo::FDO::Common::DictionaryElementCollection::Insert System::Int32  index,
DictionaryElement value
 

Inserts a DictionaryElement object into the collection at the specified position.

Parameters:
index Input the zero-based index at which value should be inserted.
value Input the DictionaryElement object to insert.

System::Void OSGeo::FDO::Common::DictionaryElementCollection::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.

System::Void OSGeo::FDO::Common::DictionaryElementCollection::Remove DictionaryElement value  ) 
 

Removes the first occurrence of a specific DictionaryElement object.

Parameters:
value Input the DictionaryElement object to remove from the collection.

System::Void OSGeo::FDO::Common::DictionaryElementCollection::RemoveAt System::Int32  index  ) 
 

Removes the index-th DictionaryElement from this collection.

Parameters:
index Input index of the element to remove.

__property System::Void OSGeo::FDO::Common::DictionaryElementCollection::set_Item System::Int32  index,
DictionaryElement value
 

Sets a DictionaryElement in the collection.

Parameters:
index Input The index of the DictionaryElement to set.
value The dictionary element to set at the specified index

__property System::Void OSGeo::FDO::Common::DictionaryElementCollection::set_RealTypeItem System::Int32  index,
DictionaryElement value
 

Sets a DictionaryElement in the collection.

Parameters:
index Input The index of the DictionaryElement to set.
value The dictionary element to set at the specified index

Comments or suggestions? Send us feedback.