Chilkat C# StringArray Class Reference
StringArray
* This is a freeware class/component/library.
Component for managing and manipulating collections of strings.
Object Creation
(C#)
Chilkat.StringArray obj = new Chilkat.StringArray();
(VB.NET)
Dim obj As New Chilkat.StringArray()
Properties
public int Count {get; }
The number of strings in the array.
public bool Crlf {get; set; }
If true, strings are always automatically converted to use CRLF line endings. If false, strings are automatically converted to use bare LF line endings.
public int Length {get; }
The number of strings in the array. (Identical to the Count property.)
public bool Trim {get; set; }
If true, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the array.
public bool Unique {get; set; }
If true, the array does not allow duplicates. When an attempt is made to insert a string that already exists in the array, the insertion simply doesn't happen and no error is returned.
Methods
public void Append(string str);
Appends a string to the end of the array.
public bool AppendSerialized(string encodedStr);
Appends multiple strings to the end of the array. The encodedStrings argument is what is returned from the Serialize method (see below).
public bool Clear();
Remove all strings from the array.
public bool Contains(string str);
Returns true if the string is present in the array. The string comparisons are case sensitive.
public int Find(string str, int firstIndex);
Finds the index of the first string equal to the string passed. The search begins at beginIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.
public int FindFirstMatch(string str, int firstIndex);
To be documented soon...
public string GetString(int index);
Returns the string at a location in the array. The first string is at index 0. Returns a null on failure
public int GetStringLen(int index);
Returns Nth's string length, in characters. The first string is at index 0.
public void InsertAt(int index, string str);
Insert a string into the array at a particular index. Using index 0 will insert at the beginning.
public string LastString();
Returns the last string in the array. Returns a null on failure
public bool LoadFromFile(string filename);
Adds strings from a file (one per line) into the string array. Returns true for success, false for failure.
public void LoadFromText(string str);
Adds strings from an in-memory string (one per line) into the string array.
public string Pop();
Returns the last string and removes it from the array. Returns a null on failure
public void Prepend(string str);
Adds a string to the beginning of the array.
public void Remove(string str);
Removes all strings equal to the string argument from the array.
public bool RemoveAt(int index);
Removes the string at a particular index.
public bool SaveNthToFile(int index, string filename);
Saves the Nth string in the StringArray object to a file. Returns true for success, false for failure.
public bool SaveToFile(string filename);
Saves the array of strings to a file, one string per line. Returns true for success, false for failure.
public string SaveToText();
Saves the array of strings to a single string, one string per line (separated by CRLF line endings).
public string Serialize();
Returns an string which is an encoded representation of all the strings in the array. The StringArray can be re-created by calling the AppendSerialized method. One reason this method exists is to make it easy to pass entire string arrays as a form parameter in a Web page. Returns a null on failure
public void Sort(bool ascending);
Sorts the string array in ascending or descending order.
public void SplitAndAppend(string str, string boundary);
Splits a string at a character or substring boundary and adds each resulting string to the StringArray object.
public void Subtract(StringArray sa);
Subtracts the strings in the argument object from the calling object's set.
public void Union(StringArray array);
Performs the union set-operator. The caller will contain the union of two string arrays.
|