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::StringCollection Class Reference

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

Inheritance diagram for OSGeo::FDO::Common::StringCollection:

[legend]
List of all members.

Detailed Description

StringCollection is a collection of name-value pairs.


Public Member Functions

System::Int32 Add (StringElement *value)
 Adds a StringElement object into the collection.
System::Void Append (StringCollection *collection)
 Appends the strings from src to the end of this collection.
System::Void Clear ()
 Removes all elements from the collection.
System::Boolean Contains (StringElement *value)
 Determines whether the collection contains a specific StringElement object.
System::Void CopyTo (StringElement *array[], System::Int32 index)
 Copies the elements of the collection to an array.
__property System::Int32 get_Count (System::Void)
 Gets the count of items in collection.
__property StringElementget_Item (System::Int32 index)
 Gets a StringElement in the collection.
__property StringElementget_RealTypeItem (System::Int32 index)
 Gets a StringElement in the collection.
__property System::String * get_String (System::Int32 index)
 Gets a String in the collection.
__sealed System::Collections::IEnumerator * GetEnumerator (System::Void)
 Gets an enumerator that can iterate through a collection.
System::Int32 IndexOf (StringElement *value)
 Determines the index of a specific StringElement object.
System::Void Insert (System::Int32 index, StringElement *value)
 Inserts a StringElement object into the collection at the specified position.
System::Void Remove (StringElement *value)
 Removes the first occurrence of a specific StringElement object.
System::Void RemoveAt (System::Int32 index)
 Removes the index-th StringElement from this collection.
__property System::Void set_Item (System::Int32 index, StringElement *value)
 Sets the value of the StringElement at the specified index.
__property System::Void set_RealTypeItem (System::Int32 index, StringElement *value)
 Sets the value of the StringElement at the specified index.
 StringCollection (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a String Collection based on an unmanaged instance of the object.
 StringCollection (String *data, String *delimiters, Boolean nullTokens)
 Creates a string collection that is tokenized from a string. The collection contains an element for each token.
 StringCollection (String *data, String *delimiters)
 Creates a string collection that is tokenized from a string. The collection contains an element for each token.
 StringCollection (StringCollection *collection)
 Creates a copy of string collection.
 StringCollection ()
 Constructs a new empty string collection

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Common::StringCollection::StringCollection  ) 
 

Constructs a new empty string collection

OSGeo::FDO::Common::StringCollection::StringCollection StringCollection collection  ) 
 

Creates a copy of string collection.

Parameters:
collection Input the source collection

OSGeo::FDO::Common::StringCollection::StringCollection String *  data,
String *  delimiters
 

Creates a string collection that is tokenized from a string. The collection contains an element for each token.

Parameters:
data Input the string to tokenize.
delimiters Input list of single character token delimiters.

OSGeo::FDO::Common::StringCollection::StringCollection String *  data,
String *  delimiters,
Boolean  nullTokens
 

Creates a string collection that is tokenized from a string. The collection contains an element for each token.

Parameters:
data Input the string to tokenize.
delimiters Input list of single character token delimiters.
nullTokens true: include zero-length tokens in the collection. false: exclude zero-length tokens

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

Constructs a String Collection based on an unmanaged instance of the object.

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

Member Function Documentation

System::Int32 OSGeo::FDO::Common::StringCollection::Add StringElement value  ) 
 

Adds a StringElement object into the collection.

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

System::Void OSGeo::FDO::Common::StringCollection::Append StringCollection collection  ) 
 

Appends the strings from src to the end of this collection.

Parameters:
collection Input the source collection

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

Removes all elements from the collection.

System::Boolean OSGeo::FDO::Common::StringCollection::Contains StringElement value  ) 
 

Determines whether the collection contains a specific StringElement object.

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

System::Void OSGeo::FDO::Common::StringCollection::CopyTo StringElement 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::StringCollection::get_Count System::Void   ) 
 

Gets the count of items in collection.

Returns:
Returns the number of items in the collection.

__property StringElement* OSGeo::FDO::Common::StringCollection::get_Item System::Int32  index  ) 
 

Gets a StringElement in the collection.

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

__property StringElement* OSGeo::FDO::Common::StringCollection::get_RealTypeItem System::Int32  index  ) 
 

Gets a StringElement in the collection.

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

__property System::String* OSGeo::FDO::Common::StringCollection::get_String System::Int32  index  ) 
 

Gets a String in the collection.

Parameters:
index Input index of the String to retrieve.
Returns:
Returns the requested String.

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

Gets an enumerator that can iterate through a collection.

Returns:
Returns an enumerator on the dictionary.

System::Int32 OSGeo::FDO::Common::StringCollection::IndexOf StringElement value  ) 
 

Determines the index of a specific StringElement object.

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

System::Void OSGeo::FDO::Common::StringCollection::Insert System::Int32  index,
StringElement value
 

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

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

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

DOXYGEN-IGNORE

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

System::Void OSGeo::FDO::Common::StringCollection::Remove StringElement value  ) 
 

Removes the first occurrence of a specific StringElement object.

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

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

Removes the index-th StringElement from this collection.

Parameters:
index Input index of the element to remove.

__property System::Void OSGeo::FDO::Common::StringCollection::set_Item System::Int32  index,
StringElement value
 

Sets the value of the StringElement at the specified index.

Parameters:
index Input index of the StringElement to set.
value Input the value of the string

__property System::Void OSGeo::FDO::Common::StringCollection::set_RealTypeItem System::Int32  index,
StringElement value
 

Sets the value of the StringElement at the specified index.

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

Comments or suggestions? Send us feedback.