Текст

Text (Текст)
Статус разработки: Реализован Создание объекта: Create

• Начальная страница
• Общее описание
• Объекты

Объект текст используется для быстрого разбора текстов по строкам. Объект может загружать текст из файла в любой кодировке, получить произвольную строку текста, добавлять строки в текст, сохранять текст в файл. Текст хранится либо в кодировке ANSI, либо в UTF-8 (unicode), при загрузке из других кодировок, текст превращается в универсальную кодировку UTF-16. Сохранять текст можно в любой из кодировок. Разделителями строк должны служить два знака с кодами 13 и 10 (_NEWLINE).

Атрибуты и функции

Идентификатор	Статус	Тип	Визуальная	Параметры	Описание
[<Номер строки (INT)>]	Реализована	Атрибут		Text[<Номер строки текста (INT)>]:<Содержимое строки (STRING)>	Использование синтаксиса массивов позволяет получить содержимое строки по ее номеру или изменить текст, начиная с номера строки.
IsUnicode	Реализована	Атрибут		Text.IsUnicode:<Кодировка объекта 1 -- UTF-16, 0 -- ANSI (INT)>	Атрибут проверяет, хранится ли текст в кодировке UFT-16, а также позволяет перекодировать текст из ANSI в UTF-16 и обратно. При кодировании в ANSI возможна потеря международных символов.
IsVisible	Реализована	Атрибут	Да	Text.IsVisible:<Текст выведен на экран отдельным окном (INT)>	Атрибут проверяет, выведен ли текст на экран отдельным окном. Текст можно вывести на экран с помощью функции Show, после чего пользователь может закрыть окно. Пока окно открыто, функция будет отдавать 1, при закрытии окна или в случае, если текст никогда не выводился на экран, функция возвратит 0.
Create	Реализована	Функция		Text.Create(<Создать текст в Unicode (INT)>=0):<Новый объект (TEXT)>	Функция возвращает новый объект типа Текст.
Size	Реализована	Функция		Text.Size():<Количество строк в тексте (INT)>	Функция возвращает количество строк в тексте.
TextSize	Реализована	Функция		Text.TextSize():<Размер текста в символах (INT)>	Функция возвращает количество символов в тексте. Чтобы превратить это значение в размер текста в байтах для текста в формате UTF-16 необходимо умножить это количество на два.
GetLine	Реализована	Функция		Text.GetLine(<Номер строки текста (INT)>):<Содержимое строки (STRING)>	Функция получает содержимое строки текста по ее номеру.
Load	Реализована	Функция		Text.Load(<Имя файла для загрузки или буфер (STRING,BUFFER)>,<Кодовая страница (INT)>=0):<Размер загруженного файла в символах (INT)>	Функция очищает содержимое текущего объекта и загружает его из файла в требуемой кодировке.
Save	Реализована	Функция		Text.Save(<Имя файла для сохранения или буфер (STRING,BUFFER)>,<Кодовая страница (INT)>=-1,<Добавить BOM (INT)>=0):<Файл сохранен успешно (INT)>	Функция сохраняет текущий файл на диск в указанной кодировке.
AddString	Реализована	Функция		Text.AddString(<Строка или совокупность строк (STRING)>,<Добавлять, начиная со строки (INT)>)	Функция добавляет (или вставляет) в текст строковой аргумент (который может состоять из нескольких строк).
SetString	Реализована	Функция		Text.SetString(<Строка или совокупность строк (STRING)>,<Заменять, начиная со строки (INT)>)	Функция изменяет текст, начиная с указанной строки на строку, заданную первым аргументом (аргумент может состоять из нескольких строк).
Clear	Реализована	Функция		Text.Clear()	Функция очищает очищает содержимое текущего объекта
RemoveLine	Реализована	Функция		Text.RemoveLine(<Номер начальной строки для удаления (INT)>,<Количество строк для удаления (INT)>=1)	Функция удаляет одну или более строк из текста
Append	Реализована	Функция		Text.Append(<Имя файла для сохранения (STRING)>,<Кодовая страница (INT)>=-1,<Добавить BOM (INT)>=0):<Файл сохранен успешно (INT)>	Функция добавляет к содержимому указанного файла текст текущего объекта в указанной кодировке.
ToString	Реализована	Функция		Text.ToString():<Текст в виде строки (STRING)>	Функция возвращает текущее содержимое объекта в виде строки (с сохранением знаков перевода строки)
TranslateFrom	Реализована	Функция		Text.TranslateFrom(<Кодовая страница (INT)>,<Удалять BOM (INT)>=1)	Функция производит перекодировку текущего содержимого объекта (предположительно загруженного в режиме ANSI) из кодовой страницы, заданной первым аргументом в UTF-16, при необходимости удаляя BOM.
TranslateTo	Реализована	Функция		Text.TranslateTo(<Кодовая страница (INT)>,<Добавить BOM (INT)>=0)	Функция производит перекодировку текущего содержимого объекта в кодовую страницу, заданную первым аргументом, при необходимости добавляя BOM. При перекодировке в UTF-16 объект будет иметь режим Unicode, при перекодировке в любую другую кодировку -- режим ANSI.
Translate	Реализована	Функция		Text.Translate(<Исходная кодовая страница (INT)>,<Результирующая кодовая страница (INT)>,<Удалять и добавлять BOM (INT)>=0)	Функция производит перекодировку текущего содержимого объекта из кодовой страницы, заданной первым аргументом, в кодовую страницу, заданную вторым аргументом в UTF-16, при необходимости удаляя и добавляя BOM. При перекодировке в UTF-16 объект-результат будет иметь режиме Unicode, при перекодировке в любую другую кодировку -- режим ANSI.
Show	Реализована	Функция	Да	Text.Show(<Заголовок окна (STRING)>,<Наименование файла по умолчанию (STRING)>,<Режим просмотра (INT)>=0,<Фокусироваться на окне в момент вывода (INT)>=1,<Код, исполняемый вместо стандартного кода сохранения файла на диск (STRING)>)	Функция отображает содержимое текущего объекта в виде окна с текстом. Задается также заголовок окна, наименование файла по умолчанию при попытке пользователя сохранить текст и т.п. Возможно также задание кода, который будет исполняться при попытке пользователя сохранить текст на диск. Код, к примеру, может вызвать функцию записи, чтобы сохранить файл в реквизиты объекта базы данных.