CkString DataFlex Reference Documentation
CkString
Current Version: 10.1.0
The Chilkat string class.
Object Creation
// (Dataflex programs use the 32-bit Chilkat ActiveX) Handle hoCkString
Get Create(RefClass(cComCkString)) to hoCkString
Properties
NumArabic
The number of Arabic characters contained in this string.
topNumAscii
The number of us-ascii characters contained in this string.
topNumCentralEuro
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.
topNumChars
To be documented soon...
topNumChinese
The number of Chinese characters contained in this string.
topNumCyrillic
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.
topNumGreek
The number of Greek characters contained in this string.
topNumHebrew
The number of Hebrew characters contained in this string.
topNumJapanese
The number of Japanese characters contained in this string.
topNumKorean
The number of Korean characters contained in this string.
topNumLatin
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.
Note: This is the number of chars that are Latin characters that do not fall in the us-ascii range. In other words, the 8bit Latin chars.
topNumThai
The number of Thai characters contained in this string.
topSizeAnsi
The size, in bytes, of the ANSI encoding of the string.
topSizeUtf8
The size, in bytes, of the utf-8 encoding of the string.
topStr
Procedure Set ComStr String value
The string value of this object.
topMethods
AnsiCharAt
Returns the ASCII value of the Nth char in the string. The 1st char is at index 0.
topAppend
The str is appended to end of this instance.
topAppendDateRfc3339
Appends a date/time string in RFC 3339 format to the end of this instance.
topAppendDateRfc822
The dateTime is appended in RFC 822 format to the end of this instance.
topAppendEncoded
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")
AppendMultibyte
Appends characters from a byte array. mbtext contains the character data. The input bytes are interpreted according to the character encoding specified by charsetEncoding.
AppendToFile
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.
BeginsWith
Returns True if the string begins with str. Otherwise returns False. This method is case sensitive.
topChopAfter
Truncates the string after the 1st occurrence of findStr. If findStr is not present, nothing is truncated.
topChopBefore
Truncates the string before the 1st occurrence of findStr. If findStr is not present, nothing is truncated.
topClear
Clears the string. After calling this method, the string contains 0 characters.
topContains
Returns True if substr is present in the string (case sensitive), otherwise returns False.
topEmitMultibyte
Converts the string to a byte array using the character encoding specified by charsetEncoding.
Returns null on failure
EndsWith
Returns True if the string ends with substr (case-sensitive). Otherwise returns False.
topGetEncoded
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
HtmlEntityDecode
HtmlEntityEncode
HTML entity encodes all special characters. (Those characters that might require HTML entity encoding.)
LastAnsiChar
Returns the ASCII value of the last character in the string.
topLeft
Length
Returns the length, in characters, of the string.
topLoadFile
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.
LoadXmlDoc
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.
topMatches
Returns True if the string matches the strPattern, which may contain one or more asterisk wildcard characters. Case-sensitivity is controlled by
Mid
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
topParseDateRfc3339
ParseDateRfc822
Pluralize
Prepend
Prepends str to this instance.
topPunyDecode
In-place decodes the string from punycode.
topPunyEncode
In-place encodes the string to punycode.
topRemoveAnsiChar
Removes all occurrences of ch from the string.
topReplaceAll
Replaces all occurrences of findStr with replaceStr. (case sensitive)
topReplaceAnsiChar
Replaces all occurrences of findCh with replaceCh.
topReplaceFirst
Replaces the first occurrence of findStr with replaceStr. (case sensitive)
topRight
SaveToFile
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.
Shorten
Removes the final numChars from the string.
topStrComp
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.
topStripHtml
ToCRLF
Converts all line endings to CRLF.
topToLF
Converts all line endings to bare-LF (Unix/Linux style).
topTrim
Trim SPACE and Tab characters from both ends of the string.
topTrim2
Trim SPACE, Tab, CR, and LF characters from both ends of the string.
topTrimInside
Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurrences of more than one SPACE char in a row.