Назначение


Компонент является продвинутым текстовым редактором c широкими возможностями по форматированию текста. С возможностью вставлять графические файлы, таблицы, ссылки и т.д. Формат хранения данных RTF (Rich Text Format).



Класс: TdbRichEdit



Свойства компонента

 Свойство

 Тип

 Описание

 dbTable

 String

 Определяет, к какой таблице базы данных принадлежит данный компонент.

 dbField

 String

 Определяет, к какому полю таблицы базы данных принадлежит данный компонент.

 sqlValue

 String

 Возвращает значение компонента, для использования в SQL запросах. Значение свойства уже содержит экранирующие кавычки. В случае пустого значение, вернет строку NULL

 пример: SQLExecute ('INSERT INTO tablename (fieldname) VALUES ('+Form1.RichEdit1.sqlValue+')');

 Enabled

 Boolean

 Определяет доступность компонента для пользователя.

 ItemCount

 Integer

 Возвращает количество элементов в документе.

 Name

 String

 Уникальное имя компонента на форме.

 Ruler

 Boolean

 Определяет видимость линеек.

 SelLength

 Integer

 Длинна выделенного текста в компоненте.

 SelStart

 Integer

 Определяет позиция первого выделенного символа. Если нет выделенного текста, возвращает позицию курсора в тексте.

 Modified

 Boolean

 Определяет, были ли внесены изменения в документ после сохранения.

 ReadOnly

 Boolean

 Запрещает изменение текста пользователем.

 Text

 String

 Позволяет получить и присвоить текст документу.

 TextRTF

 String

 Позволяет получить и присвоить текст документу в формате RTF.

 ToolBar1

 Boolean

 Определяет видимость панели инструментов первого ряда.

 ToolBar2

 Boolean

 Определяет видимость панели инструментов второго ряда.

 ToolBar3

 Boolean

 Определяет видимость панели инструментов  третьего ряда.

 Visible

 Boolean

 Определяет видимость компонента.

 VScrollVisible

 Boolean

 Определяет видимость вертикального скролла.

 WheelStep

 Integer

 Определяет шаг скролла мыши. Если значение 0, тогда скролл мыши будет проигнорирован.

 Left

 Integer

 X координата компонента на форме.

 Top

 Integer

 Y координата компонента на форме.

 Width

 Integer

 Ширина компонента.

 Height

 Integer

 Высота компонента.

 Tag

 Integer

 Позволяет присвоить число компоненту для собственных нужд.

 TagString

 String

 Позволяет присвоить строку компоненту для собственных нужд.





Методы компонента

 

 Метод

 Описание

 procedure AddHotPicture (const Name: String; gr: TGraphic; ParaNo: Integer = -1; VAlign: TRVVAlign = rvvaBaseline)

 Добавление рисунка-ссылку в конец документа. Подробней.

 procedure AddHyperlink (const s: String; url: String)

 Добавление ссылки в конец документа. Подробней.

 procedure AddNL (const s: String; StyleNo: Integer; ParaNo: Integer = -1)

 Добавление текстового элемента в конец документа. Подробней.

 procedure AddPicture (const Name: String; gr: TGraphic; ParaNo: Integer = -1; VAlign: TRVVAlign = rvvaBaseline)

 Добавление рисунка в конец документа. Подробней.

 procedure AddTab (TextStyleNo, ParaNo: Integer)

 Добавление символа табуляции в конец документа. Подробней.

 procedure AddTextNL (const s: String; StyleNo, FirstParaNo, OtherParaNo: Integer; AsSingleParagraph: Boolean = False)

 Добавление многострочного текста в конец документа. Подробней.

 function AppendRTF (const FileName: String): Boolean

 Добавление в документ содержимое RTF файла.

 function AppendRTFFromStream (Stream: TStream): Boolean

 Добавление в документ содержимое RTF потока. Подробней.

 function AppendTextA (const FileName: String; StyleNo, ParaNo: Integer; AsSingleParagraph: Boolean): Boolean

 Добавление в документ текстового файла в ANSI кодировке. Подробней.

 function AppendText (const FileName: String; StyleNo, ParaNo: Integer; DefAsSingleParagraph: Boolean): Boolean

 Добавление в документ содержимое текстового файла в UTF-16 кодировке. Подробней.

 function AppendTextFromStreamA (Stream: TStream; StyleNo, ParaNo: Integer; AsSingleParagraph: Boolean): Boolean

 Добавление в документ содержимое текстового потока в ANSI кодировке. Подробней.

 function AppendTextFromStream (Stream: TStream; StyleNo, ParaNo: Integer; DefAsSingleParagraph: Boolean): Boolean

 Добавление в документ содержимое текстового потока в UTF-16 кодировке. Подробней.

 procedure ApplyTextStyle (TextStyleNo: Integer)

 Не используется.

 function CanFocus: Boolean

 Проверяет, может ли компонент получить фокус ввода. Обычно свойство используется совместно с методом SetFocus.

 procedure Clear

 Очищает документ.

 procedure Copy

 Копирует выделенный текст в буфер обмена во всех форматах. (Текст, Изображение, RTF)

 procedure CopyImage

 Копирует выделенное изображение в буфер обмена.

 procedure CopyRTF

 Копирует выделенный текст в буфер обмена в формате RTF.

 procedure CopyText

 Копирует выделенный текст в буфер обмена в кодировке UTF-16.

 procedure CopyTextA

 Копирует выделенный текст в буфер обмена в кодировке ANSI.

 procedure DeleteItems (FirstItemNo, Count: Integer)

 Удаляет определенное количество элементов (Count), начиня с элемента FirstItemNo.

 procedure DeleteSelection

 Удаляет выделенный фрагмент из документа.

 procedure Deselect

 Снимает выделение.

 function Focused: Boolean

 Проверяет, имеет ли компонент фокус ввода.

 procedure Format

 Форматирует документ. Данный метод необходимо вызывать, чтобы применить изменения, которые были сделаны методами: AddHotPicture, AddHyperlink, AddNL, AddPicture и т.д.

 procedure FormatTail

 Форматирует документ, но только его новые элементы. Работает более быстро, чем Format.

 procedure Reformat

 Форматирует документ с сохранением выделения и позиции курсора.

 function GetSelectedImage: TGraphic

 Возвращает ссылку на выделенное графическое изображение. Если нет выделенного изображения, функция возвращает значение nil. Подробней.

 function GetSelText: String

 Возвращает выделенный текст.

 procedure InsertHyperlink (const s: String; url: string)

 Вставка ссылки в позицию курсора ввода. Подробней.

 function InsertPicture (const Name: String; gr: TGraphic; VAlign: TRVVAlign = rvvaBaseline): Boolean

 Вставка рисунка в позицию курсора ввода. Подробней.

 function InsertRTFFromFileEd (const FileName: String): Boolean

 Вставка содержимого RTF файла в документ в позицию курсора.

 function InsertRTFFromStreamEd (Stream: TStream): Boolean

 Вставка содержимого RTF потока в документ в позицию курсора. Подробней.

 procedure InsertText (const text: String; CaretBefore: Boolean=False)

 Вставка текста в позицию курсора ввода. Подробней.

 procedure InsertTextEx (const text: String; FontColor: TColor = -1; FontSize: integer = -1; FontStyles: Integer = -1; FontName: string = '')

 Вставка текста в позицию курсора ввода с возможность указать цвет, размер, стиль и имя шрифта. Подробней.

 function InsertTextFromFileA (const FileName: String): Boolean

 Вставка в документ содержимого текстового файла в ANSI кодировке.

 function InsertTextFromFile (const FileName: String): Boolean

 Вставка в документ содержимого текстового файла в UTF-16 кодировке.

 function LoadHTML (const FileName: String): Boolean

 Загрузка HTML файла.

 function LoadRTF (const FileName: String): Boolean

 Загрузка RTF документа.

 function LoadRTFFromStream (Stream: TStream): Boolean

 Загрузка RTF потока. Подробней.

 function LoadTextA (const FileName: String; StyleNo, ParaNo: Integer; AsSingleParagraph: Boolean): Boolean

 Загрузка текстового файла в кодировке ANSI. Подробней.

 function LoadText (const FileName: String; StyleNo, ParaNo: Integer; DefAsSingleParagraph: Boolean): Boolean

 Загрузка текстового файла в кодировке UTF-16. Подробней.

 function LoadTextFromStreamA (Stream: TStream; StyleNo, ParaNo: Integer; AsSingleParagraph: Boolean): Boolean

 Загрузка текстового потока в кодировке ANSI. Подробней.

 function LoadTextFromStream (Stream: TStream; StyleNo, ParaNo: Integer; DefAsSingleParagraph: Boolean): Boolean

 Загрузка текстового потока в кодировке UTF-16. Подробней.

 procedure Paste

 Вставка содержимого из буфера обмена в позицию курсора ввода.

 procedure PasteRTF

 Вставка RTF из буфера обмена в позицию курсора ввода.

 procedure PasteText

 Вставка текста в кодировке UTF-16 из буфера обмена в позицию курсора ввода.

 procedure PasteTextA

 Вставка текста в кодировке ANSI из буфера обмена в позицию курсора ввода.

 function SaveDocX (const FileName: String; SelectionOnly: Boolean = False): Boolean

 Сохраняет документ в формате DocX в файл. Подробней.

 function SaveDocXToStream (Stream: TStream; SelectionOnly: Boolean = False): Boolean

 Сохраняет документ в формате DocX в поток. Подробней.

 function SaveHTML (FileName, Title: String; ImagesPrefix: String = ''): Boolean

 Сохраняет документ в формате HTML в файл, включая изображения. Подробней.

 function SaveHTMLEx (const FileName, Title, ImagesPrefix, ExtraStyles, ExternalCSS: String): Boolean

 Сохраняет документ в формате HTML в файл, включая изображения и CSS стили. Подробней.

 function SaveHTMLToStream (Stream: TStream; const Path, Title, ImagesPrefix: String): Boolean

 Сохраняет документ в формате HTML в поток.

 function SaveRTF (const FileName: String; SelectionOnly: Boolean = False): Boolean

 Сохраняет документ в формате RTF в файл. Подробней.

 function SaveRTFToStream (Stream: TStream; SelectionOnly: Boolean = False): Boolean

 Сохраняет документ в формате RTF в поток. Подробней.

 function SaveText (const FileName: String; LineWidth: Integer = 0): Boolean

 Сохраняет документ в текстовом формате с кодировкой UTF-16.

 function SaveTextA (const FileName: String; LineWidth: Integer = 0): Boolean

 Сохраняет документ в текстовом формате с кодировкой ANSI.

 function SaveTextToStreamA (const Path: String; Stream: TStream; LineWidth: Integer; SelectionOnly, TextOnly: Boolean): Boolean

 Сохраняет документ в поток в текстовом формате с кодировкой ANSI. Подробней.

 function SaveTextToStream (const Path: String; Stream: TStream; LineWidth: Integer; SelectionOnly, TextOnly: Boolean): Boolean

 Сохраняет документ в поток в текстовом формате с кодировкой UTF-16. Подробней.

 function SearchText (s: String; MatchCase: boolean = False; Down: boolean = True; WholeWord: boolean = False; MultiItem: boolean = True; SmartStart: boolean = False): Boolean

 Поиск строки в документе. Подробней.

 procedure SelectAll

 Выделяет весь текст в документе.

 procedure SetFocus

 Устанавливает фокус ввода для компонента.

 procedure SelectionToHyperlink (url: string)

 Преобразует выделенный текст в ссылку с указанным URL.






События компонента

 Событие

 Описание

 OnClick

 При клике мышкой по компоненту.

 OnDoubleClick

 При двойном клике мышкой по компоненту.

 OnEnter

 При получении компонентом фокуса ввода.

 OnExit

 При потере компонентом фокуса ввода.

 OnKeyDown

 При нажатии на любую кнопку клавиатуры.

 OnKeyPress

 При нажатии на кнопку клавиатуры. Работает только для печатных символов.

 OnKeyUp

 При отпускании любой кнопки на клавиатуре.

 OnMouseDown

 При нажатии кнопки мыши над компонентом.

 OnMouseEnter

 При заходе курсора мыши на компонент.

 OnMouseLeave

 При покидании курсора мыши компонента.

 OnMouseMove

 При перемещении курсора мыши по компоненту.

 OnMouseUp

 При отпускании кнопки мыши.

 OnDropFiles

 При попытке перетащить файл из проводника на компонент. Подробней.