CkString ActiveX Reference Documentation

CkString

Current Version: 9.5.0.73

The Chilkat string class.

Object Creation

(Visual Basic 6.0)
Dim obj As New CkString

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.CkString")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.CkString")

(Delphi)
obj := TCkString.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.CkString')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.CkString")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.CkString', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.CkString");

Properties

NumArabic
NumArabic As Long (read-only)
Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

top
NumAscii
NumAscii As Long (read-only)
Introduced in version 9.5.0.25

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

top
NumCentralEuro
NumCentralEuro As Long (read-only)
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
NumChars As Long (read-only)

To be documented soon...

top
NumChinese
NumChinese As Long (read-only)
Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

top
NumCyrillic
NumCyrillic As Long (read-only)
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
NumGreek As Long (read-only)
Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

top
NumHebrew
NumHebrew As Long (read-only)
Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

top
NumJapanese
NumJapanese As Long (read-only)
Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

top
NumKorean
NumKorean As Long (read-only)
Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

top
NumLatin
NumLatin As Long (read-only)
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
NumThai As Long (read-only)
Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

top
SizeAnsi
SizeAnsi As Long (read-only)

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

top
SizeUtf8
SizeUtf8 As Long (read-only)

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

top
Str
Str As String

The string value of this object.

top

Methods

AnsiCharAt
AnsiCharAt(ByVal index As Long) As Long

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

top
Append
Append(str As String)

The str is appended to end of this instance.

top
AppendDateRfc3339
AppendDateRfc3339(ByVal dt As Date)

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

top
AppendDateRfc822
AppendDateRfc822(ByVal dateTime As Date)

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

top
AppendEncoded
AppendEncoded(str As String, encoding As String, charset As String)

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
AppendMultibyte(mbtext As Variant, charsetEncoding As String)

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
AppendToFile(path As String, charsetEncoding As String) As Long

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
BeginsWith(str As String) As Long

Returns 1 if the string begins with str. Otherwise returns 0. This method is case sensitive.

top
ChopAfter
ChopAfter(findStr As String)

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

top
ChopBefore
ChopBefore(findStr As String)

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

top
Clear
Clear()

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

top
Contains
Contains(substr As String) As Long

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

top
EmitMultibyte
EmitMultibyte(charsetEncoding As String) As Variant

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

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

top
EndsWith
EndsWith(substr As String) As Long

Returns 1 if the string ends with substr (case-sensitive). Otherwise returns 0.

top
GetEncoded
GetEncoded(binaryEncoding As String, charsetEncoding As String) As 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 Nothing on failure

More Information and Examples
top
HtmlEntityDecode
HtmlEntityDecode()

Decodes any HTML entities found in the string.

More Information and Examples
top
HtmlEntityEncode
HtmlEntityEncode()

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

More Information and Examples
top
LastAnsiChar
LastAnsiChar() As Long

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

top
Left
Left(ByVal numChars As Long) As String

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

Returns Nothing on failure

top
Length
Length() As Long

Returns the length, in characters, of the string.

top
LoadFile
LoadFile(path As String, charsetEncoding As String) As Long

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
LoadXmlDoc(xmlDocumentBytes As Variant)

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
Matches(strPattern As String, ByVal caseSensitive As Long) As Long

Returns 1 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
Mid(ByVal index As Long, ByVal numChars As Long) As 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 Nothing on failure

top
ParseDateRfc3339
ParseDateRfc3339() As Date

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

More Information and Examples
top
ParseDateRfc822
ParseDateRfc822() As Date

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

More Information and Examples
top
Pluralize
Pluralize()

Pluralizes an English word.

More Information and Examples
top
Prepend
Prepend(str As String)

Prepends str to this instance.

top
PunyDecode
PunyDecode()
Introduced in version 9.5.0.52

In-place decodes the string from punycode.

top
PunyEncode
PunyEncode()
Introduced in version 9.5.0.52

In-place encodes the string to punycode.

top
RemoveAnsiChar
RemoveAnsiChar(ByVal ch As Long)

Removes all occurrences of ch from the string.

top
ReplaceAll
ReplaceAll(findStr As String, replaceStr As String)

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

top
ReplaceAnsiChar
ReplaceAnsiChar(ByVal findCh As Long, ByVal replaceCh As Long)

Replaces all occurrences of findCh with replaceCh.

top
ReplaceFirst
ReplaceFirst(findStr As String, replaceStr As String)

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

top
Right
Right(ByVal numChars As Long) As String

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

Returns Nothing on failure

top
SaveToFile
SaveToFile(path As String, charsetEncoding As String) As Long

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 1 for success, 0 for failure.

More Information and Examples
top
Shorten
Shorten(ByVal numChars As Long)

Removes the final numChars from the string.

top
StrComp
StrComp(str As String, ByVal caseSensitive As Long) As Long

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
StripHtml()

Strips HTML tags from a string.

More Information and Examples
top
ToCRLF
ToCRLF()

Converts all line endings to CRLF.

top
ToLF
ToLF()

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

top
Trim
Trim()

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

top
Trim2
Trim2()

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

top
TrimInside
TrimInside()

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
Unpluralize()

Unpluralizes an English word.

More Information and Examples
top