CkString C# Reference Documentation
CkString
Current Version: 10.0.0
The Chilkat string class.
Object Creation
Chilkat.CkString obj = new Chilkat.CkString();
Methods
append
The str is appended to end of this instance.
topappendInt
Appends the decimal string representation of an integer to the end of this instance.
topappendObfuscated
Unobfuscates and appends obfuscatedStr to the end of this instance.
The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.
topautoLinkUrls
Searches the string for URLS (http://..., https://...) and auto-links them. For example, if "https://www.chilkatsoft.com/" is found in the string, it is replaced with "https://www.chilkatsoft.com/" URLs that are already linked are not modified.
topbase64Decode
In-place base64 decodes the string and inteprets the results according to the character encoding specified.
base64Encode
In-place base64 encodes the string. Internally, the string is first converted to the character encoding specified and then base-64 encoded. Typical charsetEncoding values are "utf-8", "ANSI", "iso-8859-1", etc.
beginsWith
Return true if this string begins with substr (case sensitive), otherwise returns false.
topcharAt
Returns the ANSI character at a specified index.The first character is at index 0.
topchopAtFirstChar
Finds the first occurrence of ch and discards the characters at and following ch.
topclear
Clears the string. The string contains 0 characters after calling this method.
topcontainsSubstring
Returns true if the string contains the specified substring, otherwise returns false. The string comparison is case-sensitive.
topcontainsSubstringNoCase
Same as containsSubstring except the matching is case insensitive.
topdecodeXMLSpecial
Decodes XML special characters. For example, < is converted to '<'
topdoubleValue
Converts the string to a double and returns the value.
topeliminateChar
Eliminate all occurrences of a particular ANSI character.
topencodeXMLSpecial
Encodes XML special characters. For example, '<' is converted to <
topentityDecode
Decodes any HTML entities found within the string, replacing them with the characters represented.
topentityEncode
HTML encodes any characters that are special to HTML or cannot be represented by 7-bit us-ascii.
topequals
Returns true if the strings are equal, otherwise returns false. (case-sensitive)
topequalsIgnoreCase
Returns true if the strings are equal, otherwise returns false. (case-insensitive)
topgetNumChars
Returns the number of characters in the string.
topgetSizeAnsi
Returns the size, in bytes, of the ANSI encoding of the string.
topgetSizeUnicode
Returns the size, in bytes, of the Unicode encoding of the string.
topgetSizeUtf8
Returns the size, in bytes, of the utf-8 encoding of the string.
topgetString
Returns the contents of this instance.
tophexDecode
Hex decodes a string and inteprets the bytes according to the character encoding specified.
hexEncode
Converts the string to the character encoding specified and replaces the string contents with the hex encoding of the character data.
intValue
Converts the string to an integer and returns the integer value.
toploadFile
Load the contents of a text file into the CkString object. The string is cleared before loading. 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.
Returns true for success, false for failure.
loadXmlFile
Loads an XML document into the CkString. 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 LoadXmlFile 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.
Returns true for success, false for failure.
topobfuscate
Obfuscates the string. (The unobfuscate method can be called to reverse the obfuscation to restore the original string.)
The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.
topprepend
Prepends str to this instance.
toppunyDecode
In-place decodes the string from punycode.
toppunyEncode
In-place encodes the string to punycode.
topqpDecode
Quoted-printable decodes the string and interprets the resulting character data according to the specified character encoding. The result is that the quoted-printable string is in-place decoded.
qpEncode
Quoted-printable encodes the string. The string is first converted to the charset specified, and those bytes are QP-encoded. The contents of the string are replaced with the QP-encoded result.
removeCharOccurances
Removes all occurrences of a specific ANSI character from the string.
topremoveChunk
Removes a chunk of characters specified by starting index and length.
topremoveDelimited
Remove all occurrences of strings delimited by beginDelim and endDelim. Also removes the delimiters.
topreplaceAllOccurances
Replaces all occurrences of a substring with another substring. The replacement string is allowed to be empty or different in length.
topreplaceChar
Replaces all occurrences of a specified ANSI character with another.
topreplaceFirstOccurance
Replaces the first occurrence of a substring with another. The replacement string is allowed to be empty or different in length. (Chilkat is aware of the misspelling of the word "occurrence", but unfortunately it is too late to change..)
topsaveToFile
Saves the string to a file using the character encoding specified by charsetEncoding. If a file of the same name exists, it is overwritten. For charsets such as "utf-8", "utf-16", or others that have a possible BOM/preamble, the preamble is output by default. To exclude the BOM/preamble, prepend "no-bom-" to the charset name. For example "no-bom-utf-8".
Returns true for success, false for failure.
setString
Clears the contents of this instance and appends str.
topshorten
Discards the last N characters.
toptoCRLF
Converts all line endings to CRLF.
toptoLF
Converts all line endings to bare-LF (Unix/Linux style line endings).
toptoLowerCase
Converts the string to lowercase.
toptoUpperCase
Converts the string to uppercase.
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.
toptrimInsideSpaces
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.
topunobfuscate
Unobfuscates the string.
The Chilkat string obfuscation algorithm works by taking the utf-8 bytes of the string, base64 encoding it, and then scrambling the letters of the base64 encoded string. It is deterministic in that the same string will always obfuscate to the same result. It is not a secure way of encrypting a string. It is only meant to be a simple means of transforming a string into something unintelligible.
topurlDecode
URL decodes the string and interprets the resulting byte data in the specified charset encoding.
urlEncode
URL encodes the string. The string is first converted to the specified charset encoding, and those bytes are URL-encoded. The contents of the string are replaced with the URL-encoded result.