TAnsiStringBuilder¶

Ansi-string version of string builder.

Declaration¶

Source position: sysstrh.inc line 340

type

  TAnsiStringBuilder = class
  public
    constructor Create;
    constructor Create(aCapacity: Integer);
    constructor Create(const AValue: AnsiString);
    constructor Create(aCapacity: Integer; aMaxCapacity: Integer);
    constructor Create(const AValue: AnsiString; aCapacity: Integer);
    constructor Create(const AValue: AnsiString; StartIndex: Integer; 
                  aLength: Integer; aCapacity: Integer);
    function Append(const AValue: Boolean) : TAnsiStringBuilder;
    function Append(const AValue: Byte) : TAnsiStringBuilder;
    function Append(const AValue: AnsiChar) : TAnsiStringBuilder;
    function Append(const AValue: Currency) : TAnsiStringBuilder;
    function Append(const AValue: Double) : TAnsiStringBuilder;
    function Append(const AValue: SmallInt) : TAnsiStringBuilder;
    function Append(const AValue: LongInt) : TAnsiStringBuilder;
    function Append(const AValue: Int64) : TAnsiStringBuilder;
    function Append(const AValue: TObject) : TAnsiStringBuilder;
    function Append(const AValue: ShortInt) : TAnsiStringBuilder;
    function Append(const AValue: Single) : TAnsiStringBuilder;
    function Append(const AValue: UInt64) : TAnsiStringBuilder;
    function Append(const AValue: Array of AnsiChar = char)
                : TAnsiStringBuilder;
    function Append(const AValue: Word) : TAnsiStringBuilder;
    function Append(const AValue: Cardinal) : TAnsiStringBuilder;
    function Append(const AValue: PAnsiChar) : TAnsiStringBuilder;
    function Append(const AValue: UnicodeString) : TAnsiStringBuilder;
    function Append(const AValue: UnicodeChar) : TAnsiStringBuilder;
    function Append(const AValue: RawByteString) : TAnsiStringBuilder;
    function Append(const AValue: AnsiChar; RepeatCount: Integer)
                : TAnsiStringBuilder;
    function Append(const AValue: Array of AnsiChar = char; 
               StartIndex: Integer; SBCharCount: Integer)
                : TAnsiStringBuilder;
    function Append(const AValue: AnsiString; StartIndex: Integer; 
               Count: Integer) : TAnsiStringBuilder;
    function Append(const Fmt: AnsiString; const Args: Array of const)
                : TAnsiStringBuilder;
    function AppendFormat : TAnsiStringBuilder;
    function AppendLine : TAnsiStringBuilder;
    function AppendLine(const AValue: RawByteString) : TAnsiStringBuilder;
    procedure Clear;
    procedure CopyTo;
    function EnsureCapacity : Integer;
    function Equals : Boolean;
    function GetEnumerator : TCharEnumerator;
    function Insert(Index: Integer; const AValue: Boolean)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Byte) : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: AnsiChar)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Currency)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Double)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: SmallInt)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: LongInt)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Array of AnsiChar = char)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Int64)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: TObject)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: ShortInt)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Single)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: AnsiString)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Word) : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Cardinal)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: UInt64)
                : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: AnsiString; 
               const aRepeatCount: Integer) : TAnsiStringBuilder;
    function Insert(Index: Integer; const AValue: Array of AnsiChar = char; 
               startIndex: Integer; SBCharCount: Integer)
                : TAnsiStringBuilder;
    function Remove : TAnsiStringBuilder;
    function Replace(const OldChar: AnsiChar; const NewChar: AnsiChar)
                 : TAnsiStringBuilder;
    function Replace(const OldChar: AnsiChar; const NewChar: AnsiChar; 
                StartIndex: Integer; Count: Integer)
                 : TAnsiStringBuilder;
    function Replace(const OldValue: RawByteString; 
                const NewValue: RawByteString) : TAnsiStringBuilder;
    function Replace(const OldValue: RawByteString; 
                const NewValue: RawByteString; StartIndex: Integer; 
                Count: Integer) : TAnsiStringBuilder;
    function ToString : AnsiString;
    function ToString(UpdateCapacity: Boolean) : AnsiString; overload;
    function ToString(aStartIndex: Integer; aLength: Integer) : AnsiString;
    property Chars[index : Integer]: AnsiChar; {rw}
    property &Length: Integer; {rw}
    property Capacity: Integer; {rw}
    property MaxCapacity: Integer; {r}
  end;

Inheritance¶

Description¶

TAnsiStringBuilder is a class to construct an ansistring out of other strings or characters. It's methods can be used instead of constructing the string manually using the normal + or concat operators. If used properly (e.g. by setting a sufficiently large Capacity), will result in faster operation. It offers various methods to append to the string.

To create a unicode string, use the TUnicodeStringBuilder class instead.

Properties¶

Member	Visibility	Description
Capacity	public	Current capacity of the string buffer.
Chars	public	Indexed access to the characters in the string.
Length	public	Currentl length of the string buffer.
MaxCapacity read only	public	Maximum capacity of the string buffer.

Methods¶

Member	Visibility	Description
Append	public	Append data in string form to the buffer.
AppendFormat	public	Append the result of a Format.
AppendLine	public	Append a string followed by a newline.
Clear	public	Clear the string being built.
CopyTo	public	Copy string bytes to an array.
Create	public	Create a new TAnsiStringBuilder instance.
EnsureCapacity	public	Set the capacity if needed.
Equals	public	Check if 2 stringbuilders have the same content string.
GetEnumerator	public
Insert	public	Insert data in string form into the buffer at a given position.
Remove	public	Remove data from the string.
Replace	public	Replace a range of characters.
ToString	public	Return the string buffer as an AnsiString.