CkString DataFlex Reference Documentation

CkString

Current Version: 9.5.0.75

The Chilkat string class.

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoCkString
Get Create(RefClass(cComCkString)) to hoCkString

Properties

NumArabic
Function ComNumArabic Returns Integer
Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

top
NumAscii
Function ComNumAscii Returns Integer
Introduced in version 9.5.0.25

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

top
NumCentralEuro
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.

top
NumChars
Function ComNumChars Returns Integer

To be documented soon...

top
NumChinese
Function ComNumChinese Returns Integer
Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

top
NumCyrillic
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.

top
NumGreek
Function ComNumGreek Returns Integer
Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

top
NumHebrew
Function ComNumHebrew Returns Integer
Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

top
NumJapanese
Function ComNumJapanese Returns Integer
Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

top
NumKorean
Function ComNumKorean Returns Integer
Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

top
NumLatin
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.

top
NumThai
Function ComNumThai Returns Integer
Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

top
SizeAnsi
Function ComSizeAnsi Returns Integer

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

top
SizeUtf8
Function ComSizeUtf8 Returns Integer

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

top
Str
Function ComStr Returns String
Procedure Set ComStr String value

The string value of this object.

top

Methods

AnsiCharAt
Function ComAnsiCharAt Integer index Returns Integer

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

top
Append
Procedure ComAppend String str

The str is appended to end of this instance.

top
AppendDateRfc3339
Procedure ComAppendDateRfc3339 DateTime dt

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

top
AppendDateRfc822
Procedure ComAppendDateRfc822 DateTime dateTime

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

top
AppendEncoded
Procedure ComAppendEncoded String str String encoding String charset

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")

More Information and Examples
top
AppendMultibyte
Procedure ComAppendMultibyte Variant mbtext String charsetEncoding

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

More Information and Examples
top
AppendToFile
Function ComAppendToFile String path String charsetEncoding 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.

More Information and Examples
top
BeginsWith
Function ComBeginsWith String str Returns Boolean

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

top
ChopAfter
Procedure ComChopAfter String findStr

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

top
ChopBefore
Procedure ComChopBefore String findStr

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

top
Clear
Procedure ComClear

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

top
Contains
Function ComContains String substr Returns Boolean

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

top
EmitMultibyte
Function ComEmitMultibyte String charsetEncoding Returns Variant

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

Returns null on failure

top
EndsWith
Function ComEndsWith String substr Returns Boolean

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

top
GetEncoded
Function ComGetEncoded String binaryEncoding String charsetEncoding 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

More Information and Examples
top
HtmlEntityDecode
Procedure ComHtmlEntityDecode

Decodes any HTML entities found in the string.

More Information and Examples
top
HtmlEntityEncode
Procedure ComHtmlEntityEncode

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

More Information and Examples
top
LastAnsiChar
Function ComLastAnsiChar Returns Integer

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

top
Left
Function ComLeft Integer numChars Returns String

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

Returns null on failure

top
Length
Function ComLength Returns Integer

Returns the length, in characters, of the string.

top
LoadFile
Function ComLoadFile String path String charsetEncoding 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.

More Information and Examples
top
LoadXmlDoc
Procedure ComLoadXmlDoc Variant xmlDocumentBytes

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.

top
Matches
Function ComMatches String strPattern Boolean caseSensitive 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.

More Information and Examples
top
Mid
Function ComMid Integer index Integer numChars 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

top
ParseDateRfc3339
Function ComParseDateRfc3339 Returns DateTime

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

More Information and Examples
top
ParseDateRfc822
Function ComParseDateRfc822 Returns DateTime

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

More Information and Examples
top
Pluralize
Procedure ComPluralize

Pluralizes an English word.

More Information and Examples
top
Prepend
Procedure ComPrepend String str

Prepends str to this instance.

top
PunyDecode
Procedure ComPunyDecode
Introduced in version 9.5.0.52

In-place decodes the string from punycode.

More Information and Examples
top
PunyEncode
Procedure ComPunyEncode
Introduced in version 9.5.0.52

In-place encodes the string to punycode.

More Information and Examples
top
RemoveAnsiChar
Procedure ComRemoveAnsiChar Integer ch

Removes all occurrences of ch from the string.

top
ReplaceAll
Procedure ComReplaceAll String findStr String replaceStr

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

top
ReplaceAnsiChar
Procedure ComReplaceAnsiChar Integer findCh Integer replaceCh

Replaces all occurrences of findCh with replaceCh.

top
ReplaceFirst
Procedure ComReplaceFirst String findStr String replaceStr

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

top
Right
Function ComRight Integer numChars Returns String

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

Returns null on failure

top
SaveToFile
Function ComSaveToFile String path String charsetEncoding 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.

More Information and Examples
top
Shorten
Procedure ComShorten Integer numChars

Removes the final numChars from the string.

top
StrComp
Function ComStrComp String str Boolean caseSensitive 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.

top
StripHtml
Procedure ComStripHtml

Strips HTML tags from a string.

More Information and Examples
top
ToCRLF
Procedure ComToCRLF

Converts all line endings to CRLF.

top
ToLF
Procedure ComToLF

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

top
Trim
Procedure ComTrim

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

top
Trim2
Procedure ComTrim2

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

top
TrimInside
Procedure ComTrimInside

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.

More Information and Examples
top
Unpluralize
Procedure ComUnpluralize

Unpluralizes an English word.

More Information and Examples
top