StringArray

The number of strings contained within the object's internal array (i.e. ordered collection).

Important: This is an object that contains a collection of strings. Although the class/object name includes the word "Array", it should not be confused with an array in the sense of the primitive array type used in a given programming language.

If true, strings are always automatically converted to use CRLF line endings. If false, strings are automatically converted to use bare LF line endings.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

The number of strings contained within the internal collection. (Identical to the Count property.)

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

If true, then duplicates are not allowed. When an attempt is made to insert a string that already exists, the duplicate insertion is silently suppressed and no error is returned. The default value is false.

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version of the component/library, such as "10.1.0"

Appends a string to the end of the internal ordered collection.

Returns true for success, false for failure.

Appends multiple strings to the end of the internal ordered collection. The encodedStr is what is returned from the Serialize method (see below).

Returns true for success, false for failure.

Remove all strings from the internal collection.

Returns true if the string is present in the internal collection. The string comparisons are case sensitive.

Finds the index of the first string equal to findStr. The search begins at startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.

Finds the first string that matches the matchPattern. The search begins at startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.

The matchPattern may contain zero or more asterisk chars, each of which matches 0 or more of any character.

Returns the string at an indexed location within the internal collection. The first string is located at index 0.

Returns nil on failure

Returns Nth string's length, in characters. The first string is located at index 0.

Inserts a string into the internal collection at a specified index. Using index 0 will insert at the beginning.

Returns the last string in the internal collection.

Returns nil on failure

Loads strings from a file (one per line) into the internal collection. It is assumed the file contains ANSI strings. To load from a file containing non-ANSI strings (such as utf-8), call LoadFromFile2 instead.

Note: This method appends the strings in path to the existing collection of strings contained in this object.

Returns true for success, false for failure.

Loads strings from a file (one per line) into the internal collection. The charset specifies the character encoding (such as utf-8) of the strings contained in the file.

Note: This method appends the strings in path to the existing collection of strings contained in this object.

Returns true for success, false for failure.

Loads strings from an in-memory string (one per line) into the internal collection.

Note: This method appends the strings in str to the existing collection of strings contained in this object.

Loads the string collection from a completed asynchronous task.

Returns true for success, false for failure.

Returns the last string and removes it from the internal collection.

Returns nil on failure

Adds a string to the beginning of the internal collection.

Removes all strings equal to the string argument from the internal collection.

Removes the string at a particular index.

Replaces the string at a specified index.

Saves the Nth string in the collection to a file.

Returns true for success, false for failure.

Saves the collection of strings to a file, one string per line. Strings are saved using the ANSI charset. (Call SaveToFile2 to specify a charset, such as "utf-8")

Returns true for success, false for failure.

Saves the collection of strings to a file, one string per line. Strings are saved using the specified charset.

Returns true for success, false for failure.

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

Returns nil on failure

Returns an string which is an encoded representation of all the strings in the collection. The string collection can be re-created by calling the AppendSerialized method.

Returns nil on failure

Sorts the strings in the collection in ascending or descending order. To sort in ascending order, set ascending to true, otherwise set ascending equal to false.

Splits a string at a character or substring boundary and adds each resulting string to the internal collection.

Subtracts the strings contained within stringArrayObj from the caller's internal collection.

Performs the union set-operator. The result is that the caller will have a string collection that is the union of itself and stringArrayObj.