CkString DataFlex Reference Documentation

CkString

The Chilkat string class.

Object Creation

Handle hoCkString
Get Create(RefClass(cComCkString)) to hoCkString

Properties

Function ComNumArabic Returns Integer

Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

Function ComNumAscii Returns Integer

Introduced in version 9.5.0.25

The number of us-ascii characters contained in this string.

Function ComNumCentralEuro Returns Integer

Introduced in version 9.5.0.25

The number of Central European and Eastern European characters found in this string. These are characters specific to Polish, Czech, Slovak, Hungarian, Slovene, Croatian, Serbian (Latin script), Romanian and Albanian.

Function ComNumChars Returns Integer

To be documented soon...

Function ComNumChinese Returns Integer

Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

Function ComNumCyrillic Returns Integer

Introduced in version 9.5.0.25

The number of Cyrillic characters contained in this string. The Cyrillic alphabet also called azbuka, from the old name of the first two letters) is actually a family of alphabets, subsets of which are used by certain East and South Slavic languages "” Belarusian, Bulgarian, Macedonian, Russian, Rusyn, Serbian and Ukrainian"”as well as many other languages of the former Soviet Union, Asia and Eastern Europe.

Function ComNumGreek Returns Integer

Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

Function ComNumHebrew Returns Integer

Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

Function ComNumJapanese Returns Integer

Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

Function ComNumKorean Returns Integer

Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

Function ComNumLatin Returns Integer

Introduced in version 9.5.0.25

The number of Latin characters contained in this string. Latin characters include all major Western European languages, such as German, Spanish, French, Italian, Nordic languages, etc.

Function ComNumThai Returns Integer

Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

Function ComSizeAnsi Returns Integer

The size, in bytes, of the ANSI encoding of the string.

Function ComSizeUtf8 Returns Integer

The size, in bytes, of the utf-8 encoding of the string.

Function ComStr Returns String
Procedure Set ComStr String value

The string value of this object.

Methods

Function ComAnsiCharAt Returns Integer

Returns the ASCII value of the Nth char in the string. The 1st char is at index 0.

Procedure ComAppend

The str is appended to end of this instance.

Procedure ComAppendDateRfc3339

Appends a date/time string in RFC 3339 format to the end of this instance.

Procedure ComAppendDateRfc822

The dateTime is appended in RFC 822 format to the end of this instance.

Procedure ComAppendEncoded

Appends characters from an encoded string. The encoding may be "base64", "hex", "url", or "quoted-printable". For example, to append "ABC 123" from a URL-encoded string, call:

strObj.AppendEncoded("ABC+123","url","iso-8859-1")

Supported Character Encodings

Procedure ComAppendMultibyte

Appends characters from a byte array. mbtext contains the character data. The input bytes are interpreted according to the character encoding specified by charsetEncoding.

Supported Character Encodings

Function ComAppendToFile Returns Boolean

Appends the contents of the string to a file. The string is first converted to the character encoding specified by charsetEncoding before being appended to the file.

Supported Character Encodings

Function ComBeginsWith Returns Boolean

Returns True if the string begins with str. Otherwise returns False. This method is case sensitive.

Procedure ComChopAfter

Truncates the string after the 1st occurance of findStr. If findStr is not present, nothing is truncated.

Procedure ComChopBefore

Truncates the string before the 1st occurance of findStr. If findStr is not present, nothing is truncated.

Procedure ComClear

Clears the string. After calling this method, the string contains 0 characters.

Function ComContains Returns Boolean

Returns True if substr is present in the string (case sensitive), otherwise returns False.

Function ComEmitMultibyte Returns Variant

Converts the string to a byte array using the character encoding specified by charsetEncoding.

Returns null on failure

Demystifying ASP Code Pages, Response.Write, Response.BinaryWrite, Strings, and Charsets

Supported Character Encodings

Function ComEndsWith Returns Boolean

Returns True if the string ends with substr (case-sensitive). Otherwise returns False.

Function ComGetEncoded Returns String

Returns the character string in an encoding use the charsetEncoding specified. The binaryEncoding may be "base64", "hex", "url", or "quoted-printable". For example:

(Visual Basic 6.0)

Dim s As New CkString

s.Str = "èèè"
Text1.Text = s.GetEncoded("hex", "iso-8859-1") & vbCrLf
Text1.Text = Text.Text & s.GetEncoded("hex", "utf-8") & vbCrLf
Text1.Text = Text1.Text & s.GetEncoded("hex", "unicode")

'Output:
'E8E8E8
'C3A8C3A8C3A8
'E800E800E800

Returns null on failure

Supported Character Encodings

Procedure ComHtmlEntityDecode

Decodes any HTML entities found in the string.

HTML Entity Decode ASP Example

Procedure ComHtmlEntityEncode

HTML entity encodes all special characters. (Those characters that might require HTML entity encoding.)

ASP HTML Entity Encode Example

Function ComLastAnsiChar Returns Integer

Returns the ASCII value of the last character in the string.

Function ComLeft Returns String

Returns a string that is the leftmost numChars of this instance.

Returns null on failure

Function ComLength Returns Integer

Returns the length, in characters, of the string.

Function ComLoadFile Returns Boolean

Loads an entire text file into the string object. The character encoding of the text file is specified by charsetEncoding. This method allows for text files in any charset to be loaded: utf-8, Unicode, Shift_JIS, iso-8859-1, etc.

Supported Character Encodings

Procedure ComLoadXmlDoc

Loads an XML document into the CkString. The xmlDocumentBytes contains the raw bytes of the XML document. The reason for providing a separate method for loading an XML document is because the charset encoding is usually specified using a "charset" attribute at the beginning of the XML document. The LoadXmlDoc method reads just enough of the XML document to get the charset, and then it knows how to read and interpret the bytes of the entire XML document, so that the bytes of the characters are properly interpeted and loaded into the CkString object.

Function ComMatches Returns Boolean

Returns True if the string matches the strPattern, which may contain one or more asterisk wildcard characters. Case-sensitivity is controlled by , where 1 = case sensitive, 0 = case insensitive.

ASP String Patttern Matching

Function ComMid Returns String

Same as the VB/VBScript "Mid" function, except that the 1st char is at index 0 (i.e. it is not 1-based). Returns a substring of length numChars starting at index.

Returns null on failure

Function ComParseDateRfc3339 Returns DateTime

Converts the date string (in RFC 3339 format) to a Date type.

Convert RFC 3339 Date to String and back

Function ComParseDateRfc822 Returns DateTime

Converts the date string (in RFC 822 format) to a Date type.

Convert RFC 822 Date to String and back

Procedure ComPluralize

Pluralizes an English word.

Pluralize English Word

Procedure ComPrepend

Prepends str to this instance.

Procedure ComPunyDecode

Introduced in version 9.5.0.52

In-place decodes the string from punycode.

Punycode Encoding / Decoding

Procedure ComPunyEncode

Introduced in version 9.5.0.52

In-place encodes the string to punycode.

Punycode Encoding / Decoding

Procedure ComRemoveAnsiChar

Removes all occurances of ch from the string.

Procedure ComReplaceAll

Replaces all occurances of findStr with replaceStr. (case sensitive)

Procedure ComReplaceAnsiChar

Replaces all occurances of findCh with replaceCh.

Procedure ComReplaceFirst

Replaces the first occurance of findStr with replaceStr. (case sensitive)

Function ComRight Returns String

Returns a string that is the rightmost numChars of this instance.

Returns null on failure

Function ComSaveToFile Returns Boolean

Saves the string to a file, using the character encoding specified by charsetEncoding. This method allows for the string to be saved using character encodings such as "utf-8", "Unicode", "Shift-JIS", or anything else...

Returns True for success, False for failure.

Supported Character Encodings

Procedure ComShorten

Removes the final numChars from the string.

Function ComStrComp Returns Integer

Lexicographically compares two strings. Returns 0 if both strings are equal. A value greater than zero indicates that the first character that does not match has a greater value in the caller's string than in str; And a value less than zero indicates the opposite.

Procedure ComStripHtml

Strips HTML tags from a string.

Strip HTML from a String

Procedure ComToCRLF

Converts all line endings to CRLF.

Procedure ComToLF

Converts all line endings to bare-LF (Unix/Linux style).

Procedure ComTrim

Trim SPACE and Tab characters from both ends of the string.

Procedure ComTrim2

Trim SPACE, Tab, CR, and LF characters from both ends of the string.

Procedure ComTrimInside

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.

Trim Inside SPACE/TAB Characters

Procedure ComUnpluralize

Unpluralizes an English word.

Unpluralize English Word