proglib/documentation/text/stringBuilder.md

Многофункциональная библиотека

# StringBuilder
Предоставляет изменяемую строку символов.

## Инициализация
```js
const Text = require('proglib').Text;
const StringBuilder = Text.StringBuilder;

// Инициализирует новый экземпляр класса StringBuilder.
let _stringBuilder = new StringBuilder();

// Инициализирует новый экземпляр класса StringBuilder, используя указанную строку.
//
// Параметры:
//    Value
//       Строка, используемая для инициализации значения экземпляра.
let _stringBuilder = new StringBuilder(Value);
```

## Свойства
```js
// Возвращает длину текущего объекта StringBuilder.
// 
// Возврат:
//    Number
_stringBuilder.length;
```

## Методы
```js
// Добавляет строковое представление указанного объекта к данному экземпляру.
// 
// Параметры:
//    Value
//       Добавляемый объект.
// 
// Возврат:
//    StringBuilder
_stringBuilder.Append(Value);

// Добавляет к данному экземпляру строку, возвращаемую в результате обработки строки составного формата, содержащей ноль или более элементов формата.
// Каждый элемент формата заменяется строковым представлением соответствующего аргумента в массиве параметров.
// 
// Параметры:
//    Format
//       Строка составного формата.
// 
//    Values
//       Массив объектов для форматирования.
// 
// Возврат:
//    StringBuilder
_stringBuilder.AppendFormat(Format, ...Values);

// Добавляет строковое представление указанного объекта к данному экземпляру.
// 
// Параметры:
//    Value
//       Добавляемый объект.
// 
// Возврат:
//    StringBuilder
_stringBuilder.AppendLine(Value);

// Вставляет строковое представление объекта в данный экземпляр на указанную позицию символа.
// 
// Параметры:
//    Index
//       Позиция в данном экземпляре, с которой начинается вставка.
// 
//    Value
//       Объект для вставки.
// 
// Возврат:
//    StringBuilder
_stringBuilder.Insert(Index, Value);

// Удаляет указанный диапазон символов из данного экземпляра.
// 
// Параметры:
//    StartIndex
//       Отсчитываемая с нуля позиция в данном экземпляре, с которой начинается удаление.
// 
//    Length
//       Число знаков для удаления.
// 
// Возврат:
//    StringBuilder
_stringBuilder.Remove(StartIndex, Length);

// Замещает все вхождения указанной строки в подстроке данного экземпляра на другую указанную строку.
// Если параметры StartIndex и Count не указывать, замена производиться по всей строке.
// 
// Параметры:
//    OldValue
//       Замещаемая строка.
// 
//    NewValue
//       Строка, замещающая OldValue.
// 
//    StartIndex
//       Позиция в данном экземпляре, с которой начинается подстрока.
// 
//    Count
//       Длина подстроки.
// 
// Возврат:
//    StringBuilder
_stringBuilder.Replace(OldValue, NewValue, StartIndex, Count);

// Удаляет все символы из текущего экземпляра StringBuilder.
// 
// Возврат:
//    StringBuilder
_stringBuilder.Clear();

// Возвращает значение, показывающее, равен ли данный экземпляр заданному объекту.
// 
// Параметры:
//    sb 
//       Объект, сравниваемый с этим экземпляром.
// 
// Возврат:
//    Boolean
_stringBuilder.Equals(sb);

// Преобразует значение данного экземпляра в строчное представление.
// 
// Возврат:
//    String
_stringBuilder.toString();

// Возвращает тип для текущего экземпляра.
// 
// Возврат:
//    String
_stringBuilder.GetType();
```