CkoStringBuilder Objective-C Reference Documentation

CkoStringBuilder

Current Version: 9.5.0.75

A simple class for building strings. (Represents a mutable string of characters.)

Note: This class was introduced in Chilkat v9.5.0.58.

Object Creation

CkoStringBuilder *obj = [[CkoStringBuilder alloc] init];

Properties

IntValue
@property (nonatomic, copy) NSNumber *IntValue;
Introduced in version 9.5.0.58

Returns the content of the string converted to an integer.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Length
@property (nonatomic, readonly, copy) NSNumber *Length;
Introduced in version 9.5.0.58

The number of characters of the string contained within this instance.

top

Methods

Append
- (BOOL)Append:(NSString *)value;
Introduced in version 9.5.0.58

Appends a copy of the specified string to this instance.

Returns YES for success, NO for failure.

top
AppendBd
- (BOOL)AppendBd:(CkoBinData *)binData
    charset:(NSString *)charset
    offset:(NSNumber *)offset
    numBytes:(NSNumber *)numBytes;
Introduced in version 9.5.0.64

Appends the contents of binData. The charset specifies the character encoding of the bytes contained in binData. The charset can be any of the supported encodings listed at Chilkat Supported Character Encodings. To append the entire contents of binData, set offset and numBytes equal to zero. To append a range of binData, set the offset and numBytes to specify the range.

Returns YES for success, NO for failure.

top
AppendEncoded
- (BOOL)AppendEncoded:(NSData *)binaryData
    encoding:(NSString *)encoding;
Introduced in version 9.5.0.58

Appends binary data using the encoding specified by encoding, such as "base64", "hex", etc.

Returns YES for success, NO for failure.

top
AppendInt
- (BOOL)AppendInt:(NSNumber *)value;
Introduced in version 9.5.0.58

Appends the string representation of a specified 32-bit signed integer to this instance.

Returns YES for success, NO for failure.

top
AppendInt64
- (BOOL)AppendInt64:(NSNumber *)value;
Introduced in version 9.5.0.58

Appends the string representation of a specified 64-bit signed integer to this instance.

Returns YES for success, NO for failure.

top
AppendLine
- (BOOL)AppendLine:(NSString *)value
    crlf:(BOOL)crlf;
Introduced in version 9.5.0.65

Appends the value followed by a CRLF or LF to the end of the curent StringBuilder object. If crlf is YES, then a CRLF line ending is used. Otherwise a LF line ending is used.

Returns YES for success, NO for failure.

top
AppendSb
- (BOOL)AppendSb:(CkoStringBuilder *)sb;
Introduced in version 9.5.0.62

Appends the contents of another StringBuilder to this instance.

Returns YES for success, NO for failure.

top
Clear
- (void)Clear;
Introduced in version 9.5.0.58

Removes all characters from the current StringBuilder instance.

top
Contains
- (BOOL)Contains:(NSString *)str
    caseSensitive:(BOOL)caseSensitive;
Introduced in version 9.5.0.58

Returns YES if the str is contained within this object. For case sensitive matching, set caseSensitive equal to YES. For case-insensitive, set caseSensitive equal to NO.

top
ContainsWord
- (BOOL)ContainsWord:(NSString *)word
    caseSensitive:(BOOL)caseSensitive;
Introduced in version 9.5.0.69

Returns YES if the word is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

For case sensitive matching, set caseSensitive equal to YES. For case-insensitive, set caseSensitive equal to NO.

top
ContentsEqual
- (BOOL)ContentsEqual:(NSString *)str
    caseSensitive:(BOOL)caseSensitive;
Introduced in version 9.5.0.62

Returns YES if the contents of this object equals the str. Returns NO if unequal. For case insensitive equality, set caseSensitive equal to NO.

top
ContentsEqualSb
- (BOOL)ContentsEqualSb:(CkoStringBuilder *)sb
    caseSensitive:(BOOL)caseSensitive;
Introduced in version 9.5.0.62

Returns YES if the contents of this object equals the sb. Returns NO if unequal. For case insensitive equality, set caseSensitive equal to NO.

top
Decode
- (BOOL)Decode:(NSString *)encoding
    charset:(NSString *)charset;
Introduced in version 9.5.0.62

Decodes and replaces the contents with the decoded string. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: This method can only be called if the encoded content decodes to a string. The charset indicates the charset to be used in intepreting the decoded bytes. For example, the charset can be "utf-8", "utf-16", "iso-8859-1", "shift_JIS", etc.

Returns YES for success, NO for failure.

top
Encode
- (BOOL)Encode:(NSString *)encoding
    charset:(NSString *)charset;
Introduced in version 9.5.0.62

Encodes to base64, hex, quoted-printable, URL encoding, etc. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns YES for success, NO for failure.

top
EndsWith
- (BOOL)EndsWith:(NSString *)substr
    caseSensitive:(BOOL)caseSensitive;
Introduced in version 9.5.0.62

Returns YES if the string ends with substr. Otherwise returns NO. The comparison is case sensitive if caseSensitive is YES, and case insensitive if caseSensitive is NO.

top
EntityDecode
- (BOOL)EntityDecode;
Introduced in version 9.5.0.62

Decodes HTML entities. See HTML entities for more information about HTML entities.

Returns YES for success, NO for failure.

More Information and Examples
top
GetAfterBetween
- (NSString *)GetAfterBetween:(NSString *)searchAfter
    beginMark:(NSString *)beginMark
    endMark:(NSString *)endMark;
Introduced in version 9.5.0.62

Begin searching after the 1st occurrence of searchAfter is found, and then return the substring found between the next occurrence of beginMark and the next occurrence of endMark.

Returns nil on failure

top
GetAsString
- (NSString *)GetAsString;
Introduced in version 9.5.0.58

Returns the contents as a string.

Returns nil on failure

top
GetBetween
- (NSString *)GetBetween:(NSString *)beginMark
    endMark:(NSString *)endMark;
Introduced in version 9.5.0.62

Returns the substring found between the 1st occurrence of beginMark and the next occurrence of endMark.

Returns nil on failure

More Information and Examples
top
GetDecoded
- (NSData *)GetDecoded:(NSString *)encoding;
Introduced in version 9.5.0.62

Decodes and returns the decoded bytes. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns nil on failure

top
GetEncoded
- (NSString *)GetEncoded:(NSString *)encoding
    charset:(NSString *)charset;
Introduced in version 9.5.0.62

Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.

Returns nil on failure

top
GetNth
- (NSString *)GetNth:(NSNumber *)index
    delimiterChar:(NSString *)delimiterChar
    exceptDoubleQuoted:(BOOL)exceptDoubleQuoted
    exceptEscaped:(BOOL)exceptEscaped;
Introduced in version 9.5.0.62

Returns the Nth substring in string that is a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is YES, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is YES, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns nil on failure

More Information and Examples
top
LastNLines
- (NSString *)LastNLines:(NSNumber *)numLines
    bCrlf:(BOOL)bCrlf;
Introduced in version 9.5.0.62

Returns the last N lines of the text. If fewer than numLines lines exists, then all of the text is returned. If bCrlf is YES, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.

Returns nil on failure

More Information and Examples
top
LoadFile
- (BOOL)LoadFile:(NSString *)path
    charset:(NSString *)charset;
Introduced in version 9.5.0.62

Loads the contents of a file.

Returns YES for success, NO for failure.

More Information and Examples
top
Prepend
- (BOOL)Prepend:(NSString *)value;
Introduced in version 9.5.0.61

Prepends a copy of the specified string to this instance.

Returns YES for success, NO for failure.

top
PunyDecode
- (BOOL)PunyDecode;
Introduced in version 9.5.0.71

In-place decodes the string from punycode.

Returns YES for success, NO for failure.

top
PunyEncode
- (BOOL)PunyEncode;
Introduced in version 9.5.0.71

In-place encodes the string to punycode.

Returns YES for success, NO for failure.

top
Replace
- (NSNumber *)Replace:(NSString *)value
    replacement:(NSString *)replacement;
Introduced in version 9.5.0.58

Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.

top
ReplaceAfterFinal
- (BOOL)ReplaceAfterFinal:(NSString *)marker
    replacement:(NSString *)replacement;
Introduced in version 9.5.0.73

Replaces the content found after the final occurrence of marker with replacement.

Returns YES for success, NO for failure.

top
ReplaceAllBetween
- (BOOL)ReplaceAllBetween:(NSString *)beginMark
    endMark:(NSString *)endMark
    replacement:(NSString *)replacement
    replaceMarks:(BOOL)replaceMarks;
Introduced in version 9.5.0.64

Replaces the first occurrence of ALL the content found between beginMark and endMark with replacement. The beginMark and endMark are included in what is replaced if replaceMarks is YES.

Returns YES for success, NO for failure.

top
ReplaceBetween
- (NSNumber *)ReplaceBetween:(NSString *)beginMark
    endMark:(NSString *)endMark
    value:(NSString *)value
    replacement:(NSString *)replacement;
Introduced in version 9.5.0.62

Replaces all occurrences of value with replacement, but only where value is found between beginMark and endMark. Returns the number of replacements made.

More Information and Examples
top
ReplaceI
- (NSNumber *)ReplaceI:(NSString *)value
    replacement:(NSNumber *)replacement;
Introduced in version 9.5.0.67

Replaces all occurrences of value with the decimal integer replacement. Returns the number of replacements.

top
ReplaceWord
- (NSNumber *)ReplaceWord:(NSString *)value
    replacement:(NSString *)replacement;
Introduced in version 9.5.0.62

Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.

Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

More Information and Examples
top
SecureClear
- (void)SecureClear;
Introduced in version 9.5.0.67

Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.

top
SetNth
- (BOOL)SetNth:(NSNumber *)index
    value:(NSString *)value
    delimiterChar:(NSString *)delimiterChar
    exceptDoubleQuoted:(BOOL)exceptDoubleQuoted
    exceptEscaped:(BOOL)exceptEscaped;
Introduced in version 9.5.0.62

Sets the Nth substring in string in a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is YES, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is YES, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns YES for success, NO for failure.

More Information and Examples
top
SetString
- (BOOL)SetString:(NSString *)value;
Introduced in version 9.5.0.61

Sets this instance to a copy of the specified string.

Returns YES for success, NO for failure.

top
StartsWith
- (BOOL)StartsWith:(NSString *)substr
    caseSensitive:(BOOL)caseSensitive;
Introduced in version 9.5.0.62

Returns YES if the string starts with substr. Otherwise returns NO. The comparison is case sensitive if caseSensitive is YES, and case insensitive if caseSensitive is NO.

top
ToCRLF
- (BOOL)ToCRLF;
Introduced in version 9.5.0.62

Converts line endings to CRLF (Windows) format.

Returns YES for success, NO for failure.

top
ToLF
- (BOOL)ToLF;
Introduced in version 9.5.0.62

Converts line endings to LF-only (UNIX) format.

Returns YES for success, NO for failure.

top
ToLowercase
- (BOOL)ToLowercase;
Introduced in version 9.5.0.62

Converts the contents to lowercase.

Returns YES for success, NO for failure.

top
ToUppercase
- (BOOL)ToUppercase;
Introduced in version 9.5.0.62

Converts the contents to uppercase.

Returns YES for success, NO for failure.

top
Trim
- (BOOL)Trim;
Introduced in version 9.5.0.62

Trims whitespace from both ends of the string.

Returns YES for success, NO for failure.

top
TrimInsideSpaces
- (BOOL)TrimInsideSpaces;
Introduced in version 9.5.0.62

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurances of more than one SPACE char in a row.

Returns YES for success, NO for failure.

top
WriteFile
- (BOOL)WriteFile:(NSString *)path
    charset:(NSString *)charset
    emitBom:(BOOL)emitBom;
Introduced in version 9.5.0.62

Writes the contents to a file. If emitBom is YES, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns YES for success, NO for failure.

top
WriteFileIfModified
- (BOOL)WriteFileIfModified:(NSString *)path
    charset:(NSString *)charset
    emitBom:(BOOL)emitBom;
Introduced in version 9.5.0.73

Writes the contents to a file, but only if it is a new file or if the contents are different than the existing file. If emitBom is YES, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns YES for success, NO for failure.

top