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::Commands::PropertyValueCollection Class Reference

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

Inheritance diagram for OSGeo::FDO::Commands::PropertyValueCollection:

[legend]
List of all members.

Detailed Description

The PropertyValueCollection class represents a collection of PropertyValue objects.


Public Member Functions

System::Int32 Add (OSGeo::FDO::Commands::PropertyValue *value)
 Adds a PropertyValue object into the collection.
System::Void Clear ()
 Removes all elements from the collection.
System::Boolean Contains (OSGeo::FDO::Commands::PropertyValue *value)
 Determines whether the collection contains a specific PropertyValue object.
System::Void CopyTo (OSGeo::FDO::Commands::PropertyValue *array[], System::Int32 startAt)
 Copies the elements of the collection to an array.
OSGeo::FDO::Commands::PropertyValueFindItem (System::String *name)
 Finds the item in the collection with the specified name. Returns NULL if an item with the specified name does not exist in the collection.
__property System::Int32 get_Count (System::Void)
 Gets the count of items in collection.
__property OSGeo::FDO::Commands::PropertyValueget_Item (System::Int32 index)
 Gets an item in the collection.
__property OSGeo::FDO::Commands::PropertyValueget_RealTypeItem (System::Int32 index)
 Gets the item in the collection at the specified index.
__sealed System::Collections::IEnumerator * GetEnumerator (System::Void)
 Gets an enumerator that can iterate through a collection.
OSGeo::FDO::Commands::PropertyValueGetItem (System::Int32 index)
 Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.
OSGeo::FDO::Commands::PropertyValueGetItem (System::String *name)
 Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.
System::Int32 IndexOf (OSGeo::FDO::Commands::PropertyValue *value)
 Determines the index of a specific PropertyValue object.
System::Void Insert (System::Int32 index, OSGeo::FDO::Commands::PropertyValue *value)
 Inserts a PropertyValue object into the collection at the specified position.
 PropertyValueCollection ()
 Constructs a new empty PropertyValue collection
System::Void Remove (OSGeo::FDO::Commands::PropertyValue *value)
 Removes the first occurrence of a specific PropertyValue object.
System::Void RemoveAt (System::Int32 index)
 Removes the index-th PropertyValue from this collection.
__property System::Void set_Item (System::Int32 index, OSGeo::FDO::Commands::PropertyValue *value)
 Sets the value of the item at the specified index.
__property System::Void set_RealTypeItem (System::Int32 index, OSGeo::FDO::Commands::PropertyValue *value)
 Sets the value of the item at the specified index.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Commands::PropertyValueCollection::PropertyValueCollection  ) 
 

Constructs a new empty PropertyValue collection


Member Function Documentation

System::Int32 OSGeo::FDO::Commands::PropertyValueCollection::Add OSGeo::FDO::Commands::PropertyValue value  ) 
 

Adds a PropertyValue object into the collection.

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

System::Void OSGeo::FDO::Commands::PropertyValueCollection::Clear  ) 
 

Removes all elements from the collection.

System::Boolean OSGeo::FDO::Commands::PropertyValueCollection::Contains OSGeo::FDO::Commands::PropertyValue value  ) 
 

Determines whether the collection contains a specific PropertyValue object.

Parameters:
value Input the PropertyValue object to search in the collection.
Returns:
Returns true if the value is found in the collection; otherwise, false.

System::Void OSGeo::FDO::Commands::PropertyValueCollection::CopyTo OSGeo::FDO::Commands::PropertyValue array[],
System::Int32  startAt
 

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.
startAt Input an integer that represents the index in array at which copying begins.

OSGeo ::FDO ::Commands ::PropertyValue* OSGeo::FDO::Commands::PropertyValueCollection::FindItem System::String *  name  ) 
 

Finds the item in the collection with the specified name. Returns NULL if an item with the specified name does not exist in the collection.

Parameters:
name Input the item name
Returns:
Returns Identifier

__property System::Int32 OSGeo::FDO::Commands::PropertyValueCollection::get_Count System::Void   ) 
 

Gets the count of items in collection.

Returns:
Returns the number of items in the collection.

__property OSGeo ::FDO ::Commands ::PropertyValue* OSGeo::FDO::Commands::PropertyValueCollection::get_Item System::Int32  index  ) 
 

Gets an item in the collection.

Parameters:
index Input index of the item to retrieve.
Returns:
Returns the item at the specified index

__property OSGeo ::FDO ::Commands ::PropertyValue* OSGeo::FDO::Commands::PropertyValueCollection::get_RealTypeItem System::Int32  index  ) 
 

Gets the item in the collection at the specified index.

Parameters:
index The index of the item in the collection. The index is 0 based.
Returns:
Returns an instance of a the collected item. Throws an instance of Exception if the index is out of range or an error occurs.

__sealed System::Collections::IEnumerator* OSGeo::FDO::Commands::PropertyValueCollection::GetEnumerator System::Void   ) 
 

Gets an enumerator that can iterate through a collection.

Returns:
Returns a collection enumerator.

OSGeo ::FDO ::Commands ::PropertyValue* OSGeo::FDO::Commands::PropertyValueCollection::GetItem System::Int32  index  ) 
 

Gets the item in the collection at the specified index. Throws an invalid argument exception if the index is out of range.

Parameters:
index Input index of item
Returns:
Returns Identifier

OSGeo ::FDO ::Commands ::PropertyValue* OSGeo::FDO::Commands::PropertyValueCollection::GetItem System::String *  name  ) 
 

Gets the item in the collection with the specified name. Throws an invalid argument exception if an item with the specified name does not exist in the collection.

Parameters:
name Input the item name
Returns:
Returns Identifier

System::Int32 OSGeo::FDO::Commands::PropertyValueCollection::IndexOf OSGeo::FDO::Commands::PropertyValue value  ) 
 

Determines the index of a specific PropertyValue object.

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

System::Void OSGeo::FDO::Commands::PropertyValueCollection::Insert System::Int32  index,
OSGeo::FDO::Commands::PropertyValue value
 

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

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

System::Void OSGeo::FDO::Commands::PropertyValueCollection::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

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

System::Void OSGeo::FDO::Commands::PropertyValueCollection::Remove OSGeo::FDO::Commands::PropertyValue value  ) 
 

Removes the first occurrence of a specific PropertyValue object.

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

System::Void OSGeo::FDO::Commands::PropertyValueCollection::RemoveAt System::Int32  index  ) 
 

Removes the index-th PropertyValue from this collection.

Parameters:
index Input index of the element to remove.

__property System::Void OSGeo::FDO::Commands::PropertyValueCollection::set_Item System::Int32  index,
OSGeo::FDO::Commands::PropertyValue value
 

Sets the value of the item at the specified index.

Parameters:
index Input index of the item to set.
value Input the value of the item

__property System::Void OSGeo::FDO::Commands::PropertyValueCollection::set_RealTypeItem System::Int32  index,
OSGeo::FDO::Commands::PropertyValue value
 

Sets the value of the item at the specified index.

Parameters:
index Input index of the item to set.
value Input the value of the item

Comments or suggestions? Send us feedback.