StringArray Object

A StringArray is used to hold and manipulate a set of strings. The StringArray has N elements, indexed by n = 0,1,2...N-1. The number of elements in a StringArray can be set when the StringArray is created using square brackets. If the number of elements is not specified, the StringArray will have ten elements. StringArray indices are accessed using square brackets. This example shows how to create a StringArray with three elements and assign a value to the first element:

Available In Editions:

Timing Precision Mode

Signatures	Description
StringArray()	Creates a new StringArray object using the default StringArray length (0).
StringArray(Variable dimension)	Creates a new StringArray object using the length specified by dimension.

Name	Description	Attributes
Capacity	The amount of memory that is reserved for the StringArray in units of number of elements. The Capacity will equal the maximum Dimension that the StringArray has had, unless it is set to a different value. The capacity can never be smaller than the current StringArray Dimension.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Dimension	The number of elements (N) contained within the StringArray.	Type: Variable Access: Read/Write
DisplayName	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
First	Returns the value of the first element in the StringArray.	Type: String Access: Read-Only
Last	Returns the value of the last element in the StringArray.	Type: String Access: Read-Only
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only

Name	Description
BuildSingleString	Returns a concatenation of the elements of the StringArray, delimited by the user-specified character sequence.
Clear	Clears all elements of the StringArray.
ClearSavedStates	Clears previous saved states for this object.
Erase	Erases the value at the specified index.
Find	Returns the position of the specified string (or character) in the calling String, or the number of matches in the calling StringArray.
FindAll	Finds all indices at which the specified value is present.
FindFirst	Finds the first index at which the specified value is present. If the value is not present in the array, -1 will be returned.
FindLast	Finds the last index at which the specified value is present. If the value is not present in the array, -1 will be returned.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetShuffledElements	Returns a copy of the calling StringArray where the elements have been randomly shuffled. Calling SeedNoise will set the seed for this method.
GetUniqueElements	Returns a StringArray containing the unique elements of the calling StringArray in the order in which they appeared in the calling StringArray.
IFind	Returns the position of the specified string (or character) in the calling String, or the number of matches in the calling StringArray, ignoring case.
Insert	Inserts the specified value at the specified index of the StringArray.
IsEqualTo	Determines if two arrays are equal.
PopBack	Removes the last value of the StringArray and returns its value. If the StringArray is empty, an error occurs.
PopFront	Removes the first value of the StringArray and returns its value. If the StringArray is empty, an error occurs.
PushBack	Adds the specified value to the end of the StringArray.
PushFront	Adds the specified value to the start of the StringArray.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReadFromFile	Reads the entire contents of a file and places each line into an individual element of a StringArray.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Reverse	Performs an in-place reversal of the StringArray elements.
Reversed	Returns a copy of the StringArray with the elements in reverse order.
Save	Save the object's state so that it can be restored later.
Shuffle	Randomly shuffles the elements of the calling StringArray. Calling SeedNoise will set the seed for this method.
SortAscending	Sorts the elements of the array in ascending order (smallest to largest).
SortAscendingCaseInsensitive	Sorts the calling StringArray in ascending order and reorders all input StringArray, Array, and TimeSpanArray arguments to maintain their relative indexing with respect to the calling StringArray. This method is case-insensitive.
SortDescending	Sorts the elements of the array in descending order (largest to smallest).
SortDescendingCaseInsensitive	Sorts the calling StringArray in descending order, reordering all input StringArray, Array, and TimeSpanArray arguments in order to maintain the relative positions of the array elements. This method is case-insensitive.
SortedAscending	Returns a copy of the calling StringArray sorted in ascending order.
SortedDescending	Returns a copy of the calling StringArray sorted in descending order.
SplitSort	Splits each element of the calling StringArray into columns based on the delimiter specified by an input String, then sorts the columns based on the precedence specified in an input Array. If no input Array is used, the first column will be sorted, reordering the other columns to maintain the relative positions of the array elements. Then reforms each row, using spaces or a second input String to merge the columns.
ToArray	Converts the StringArray to a normal Array with Variable values.
WriteToFile	Writes the contents of a StringArray to a file. Each Element becomes a new line in the file.

StringArray Object

Description

Available In Editions:

Timing Precision Mode