TCkStringArray Delphi Reference

TCkStringArray

* This is a freeware class/component/library.

Component for managing and manipulating collections of strings.

Object Creation

var
obj: ICkStringArray;
...
begin
obj := TCkStringArray.Create(Self).ControlInterface;

Properties

property Count: Integer readonly

The number of strings in the array.

property Crlf: Integer

If 1, strings are always automatically converted to use CRLF line endings. If 0, strings are automatically converted to use bare LF line endings.

property Trim: Integer

If 1, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the array.

property Unique: Integer

If 1, 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

procedure Append(str: WideString);

Appends a string to the end of the array.

procedure AppendSerialized(encodedStr: WideString);

Appends multiple strings to the end of the array. The encodedStrings argument is what is returned from the Serialize method (see below).

procedure Clear();

Remove all strings from the array.

function Contains(str: WideString): Integer;

Returns 1 if the string is present in the array. The string comparisons are case sensitive.

function Find(str: WideString, beginIndex: Integer): Integer;

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.

function FindFirstMatch(str: WideString, beginIndex: Integer): Integer;

To be documented soon...

function GetString(index: Integer): WideString;

Returns the string at a location in the array. The first string is at index 0.

Returns a zero-length WideString on failure

procedure InsertAt(index: Integer, str: WideString);

Insert a string into the array at a particular index. Using index 0 will insert at the beginning.

procedure Intersect(array: TCkStringArray);

The caller will contain the intersection of both string arrays. (In other words, all strings that are present in both the calling object and the argument object.)

function LastString(): WideString;

Returns the last string in the array.

Returns a zero-length WideString on failure

function LoadFromFile(filename: WideString): Integer;

Adds strings from a file (one per line) into the string array.

Returns 1 for success, 0 for failure.

procedure LoadFromText(txt: WideString);

Adds strings from an in-memory string (one per line) into the string array.

function Pop(): WideString;

Returns the last string and removes it from the array.

Returns a zero-length WideString on failure

procedure Prepend(str: WideString);

Adds a string to the beginning of the array.

procedure Remove(str: WideString);

Removes all strings equal to the string argument from the array.

procedure RemoveAt(index: Integer);

Removes the string at a particular index.

function SaveNthToFile(index: Integer, filename: WideString): Integer;

Saves the Nth string in the StringArray object to a file.

Returns 1 for success, 0 for failure.

function SaveToFile(filename: WideString): Integer;

Saves the array of strings to a file, one string per line.

Returns 1 for success, 0 for failure.

function SaveToText(): WideString;

Saves the array of strings to a single string, one string per line (separated by CRLF line endings).

function Serialize(): WideString;

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 zero-length WideString on failure

procedure Sort(ascending: Integer);

Sorts the string array in ascending or descending order.

procedure SplitAndAppend(str: WideString, boundary: WideString);

Splits a string at a character or substring boundary and adds each resulting string to the StringArray object.

procedure Subtract(array: TCkStringArray);

Subtracts the strings in the argument object from the calling object's set.

procedure Union(array: TCkStringArray);

Performs the union set-operator. The caller will contain the union of two string arrays.