CkString C# Reference Documentation

CkString

Current Version: 9.5.0.75

The Chilkat string class.

Object Creation

Chilkat.CkString obj = new Chilkat.CkString();

Methods

append
public void append(string str);

The str is appended to end of this instance.

top
appendInt
public void appendInt(int n);

Appends the decimal string representation of an integer to the end of this instance.

top
appendObfuscated
public void appendObfuscated(string obfuscatedStr);

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.

top
autoLinkUrls
public void autoLinkUrls();

Searches the string for URLS (http://..., https://...) and auto-links them. For example, if "http://www.chilkatsoft.com/" is found in the string, it is replaced with "http://www.chilkatsoft.com/" URLs that are already linked are not modified.

top
base64Decode
public void base64Decode(string charsetEncoding);

In-place base64 decodes the string and inteprets the results according to the character encoding specified.

More Information and Examples
top
base64Encode
public void base64Encode(string charsetEncoding);

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.

More Information and Examples
top
beginsWith
public bool beginsWith(string substr);

Return true if this string begins with substr (case sensitive), otherwise returns false.

top
charAt
public char charAt(int idx);

Returns the ANSI character at a specified index.The first character is at index 0.

top
chopAtFirstChar
public void chopAtFirstChar(char ch);

Finds the first occurrence of ch and discards the characters at and following ch.

top
clear
public void clear();

Clears the string. The string contains 0 characters after calling this method.

top
containsSubstring
public bool containsSubstring(string substr);

Returns true if the string contains the specified substring, otherwise returns false. The string comparison is case-sensitive.

top
containsSubstringNoCase
public bool containsSubstringNoCase(string substr);

Same as containsSubstring except the matching is case insensitive.

top
decodeXMLSpecial
public void decodeXMLSpecial();

Decodes XML special characters. For example, < is converted to '<'

top
doubleValue
public double doubleValue();

Converts the string to a double and returns the value.

top
eliminateChar
public void eliminateChar(char ansiChar, int startIndex);

Eliminate all occurrences of a particular ANSI character.

top
encodeXMLSpecial
public void encodeXMLSpecial();

Encodes XML special characters. For example, '<' is converted to <

top
entityDecode
public void entityDecode();

Decodes any HTML entities found within the string, replacing them with the characters represented.

top
entityEncode
public void entityEncode();

HTML encodes any characters that are special to HTML or cannot be represented by 7-bit us-ascii.

top
equals
public bool equals(string str);

Returns true if the strings are equal, otherwise returns false. (case-sensitive)

top
equalsIgnoreCase
public bool equalsIgnoreCase(string str);

Returns true if the strings are equal, otherwise returns false. (case-insensitive)

top
getNumChars
public int getNumChars();

Returns the number of characters in the string.

top
getSizeAnsi
public int getSizeAnsi();

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

top
getSizeUnicode
public int getSizeUnicode();

Returns the size, in bytes, of the Unicode encoding of the string.

top
getSizeUtf8
public int getSizeUtf8();

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

top
getString
public mbString getString();

Returns the contents of this instance.

top
hexDecode
public void hexDecode(string charsetEncoding);

Hex decodes a string and inteprets the bytes according to the character encoding specified.

More Information and Examples
top
hexEncode
public void hexEncode(string charsetEncoding);

Converts the string to the character encoding specified and replaces the string contents with the hex encoding of the character data.

More Information and Examples
top
intValue
public int intValue();

Converts the string to an integer and returns the integer value.

top
loadFile
public bool loadFile(string path, string charsetEncoding);

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.

More Information and Examples
top
loadXmlFile
public bool loadXmlFile(string path);

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.

top
obfuscate
public void obfuscate();

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.

top
prepend
public void prepend(string str);

Prepends str to this instance.

top
punyDecode
public void punyDecode();
Introduced in version 9.5.0.52

In-place decodes the string from punycode.

top
punyEncode
public void punyEncode();
Introduced in version 9.5.0.52

In-place encodes the string to punycode.

top
qpDecode
public void qpDecode(string charsetEncoding);

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.

More Information and Examples
top
qpEncode
public void qpEncode(string charsetEncoding);

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.

More Information and Examples
top
removeCharOccurances
public void removeCharOccurances(char ch);

Removes all occurrences of a specific ANSI character from the string.

top
removeChunk
public void removeChunk(int charStartPos, int numChars);

Removes a chunk of characters specified by starting index and length.

top
removeDelimited
public void removeDelimited(string beginDelim, string endDelim, bool caseSensitive);
Introduced in version 9.5.0.52

Remove all occurrences of strings delimited by beginDelim and endDelim. Also removes the delimiters.

top
replaceAllOccurances
public int replaceAllOccurances(string findStr, string replaceStr);

Replaces all occurrences of a substring with another substring. The replacement string is allowed to be empty or different in length.

top
replaceChar
public void replaceChar(char findCh, char replaceCh);

Replaces all occurrences of a specified ANSI character with another.

top
replaceFirstOccurance
public bool replaceFirstOccurance(string findStr, string replaceStr);

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

top
saveToFile
public bool saveToFile(string path, string charsetEncoding);

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.

More Information and Examples
top
setString
public void setString(string str);

Clears the contents of this instance and appends str.

top
shorten
public void shorten(int n);

Discards the last N characters.

top
toCRLF
public void toCRLF();

Converts all line endings to CRLF.

top
toLF
public void toLF();

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

top
toLowerCase
public void toLowerCase();

Converts the string to lowercase.

top
toUpperCase
public void toUpperCase();

Converts the string to uppercase.

top
trim
public void trim();

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

top
trim2
public void trim2();

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

top
trimInsideSpaces
public void trimInsideSpaces();

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.

top
unobfuscate
public void unobfuscate();

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.

top
urlDecode
public void urlDecode(string charsetEncoding);

URL decodes the string and interprets the resulting byte data in the specified charset encoding.

More Information and Examples
top
urlEncode
public void urlEncode(string charsetEncoding);

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.

More Information and Examples
top