From d49c607f428aa88aa4f3408b874673f822f3a6dc Mon Sep 17 00:00:00 2001 From: alexs75 Date: Thu, 17 Sep 2015 11:16:33 +0000 Subject: [PATCH] RxFPC: documentation git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@4334 8e941d3f-bd1b-0410-a28a-d453659cc2b4 --- components/rx/trunk/docs/curredit.xml | 123 +++++++ components/rx/trunk/docs/rxctrls.xml | 209 ++++++++++++ components/rx/trunk/docs/rxdbgrid.xml | 23 ++ components/rx/trunk/docs/rxfpc.xml | 447 -------------------------- components/rx/trunk/docs/rxlookup.xml | 148 +++++++++ 5 files changed, 503 insertions(+), 447 deletions(-) create mode 100644 components/rx/trunk/docs/curredit.xml create mode 100644 components/rx/trunk/docs/rxctrls.xml create mode 100644 components/rx/trunk/docs/rxlookup.xml diff --git a/components/rx/trunk/docs/curredit.xml b/components/rx/trunk/docs/curredit.xml new file mode 100644 index 000000000..5099d8285 --- /dev/null +++ b/components/rx/trunk/docs/curredit.xml @@ -0,0 +1,123 @@ + + + + + + + TCurrencyEdit Component + +

Компонента служит для ввода и редактирования чисел и денежных сумм. TCurrencyEdit имеет те же свойства, что и ее предок TEdit, но позволяет дополнительно указать формат отображения числа и символы для обозначения вида валюты с помощью свойства DisplayFormat, а также максимальное число символов после десятичной точки (при вводе данных) с помощью свойства DecimalPlaces. Свойство Value позволяет получить или установить численную величину отображаемого в компоненте значения.

+

Если свойство BeepOnError установлено в True, то при вводе в строку недопустимых символов раздается звуковой сигнал.

+ + + + + + + +

Свойство позволяет обратиться к значению Value, сохраненному в компоненте - редакторе для ввода чисел, как к целому числу.

+ + + + Свойство служит для доступа на чтение к форматированному в соответствии со значением DisplayFormat представлению значения ValueValue (совпадает с отображаемой строкой в компоненте, когда элемент редактирования не имеет фокуса ввода). В отличие от этого свойства, свойство Text всегда возвращает неформатированную строку. + + + Свойство позволяет установить (или получить) численную величину значения, отображаемого в строке ввода. В случае пустой строки возвращается значение 0. + + + + Определяет факт автоматического выделения всего текста при попадании фокуса клавиатурного ввода в компонент + + + Свойство определяет, будет ли размер автоматически изменяться размер шрифта + + + Если значение этого свойства установлено в True (по умолчанию False), то при ошибках ввода с клавиатуры (недопустимых символов и т.д.) раздается звуковой сигнал. + + + + + +

Свойство определяет, будет ли проверяться допустимый диапазон числа в компонентах TCurrencyEdit при потере фокуса строкой редактирования.

+

Если CheckOnExit = True, то в случае ввода недопустимого значения происходит исключение (exception).

+ + + + + Свойство определяет максимально допустимое число десятичных знаков при вводе и изменении данных в строке редактирования компоненты TCurrencyEdit. Используется, когда строка имеет фокус ввода. При отображении значения в несфокусированной строке редактирования свойство не используется - применяется маска, заданная свойством DisplayFormat. + + + + Свойство задает формат отображения данных в компоненте TCurrencyEdit. При получении компонентой фокуса ввода форматирование данных отменяется и ввод происходит как в обычную строку ввода TEdit. При потере фокуса ввода данные форматируются согласно заданному формату. + + + + + + + Свойство определяет, будет ли автоматически форматироваться значение в строке редактора непосредственно при редактировании. +Формат ввода определяется переменными DecimalSeparator и ThousandSeparator из модуля SysUtils.pas и свойством DecimalPlaces + + + + + + + + + + Максимально допустимое значение свойства Value. Значение MaxValue ограничивает максимальную величину числа, которое можно ввести в строку ввода. + + + Минимально допустимое значение свойства Value. Значение MinValue ограничивает минимальную величину числа, которое можно ввести в строку ввода. + + + + + + + + + + + + + + Если значение этого свойства равно True, то когда редактор имеет фокус ввода и значение ValueValue = 0, в нем с качестве текста отображается пустая строка. Если ZeroEmpty = False, то в этом случае текст '0'. + + + + + + + + + + + + + + + + + + + + CurrEdit Unit + +

The CurrEdit unit contains the declarations for the certain components on the RX Controls page of the Component palette and their associated objects, types, and constants. +When you add a component declared in this unit to a form, the unit is automatically added to the uses clause of that form's unit.

+

The following items are declared in the CurrEdit unit:

+

+ Components and objects +

+

+ TCurrencyEdit +

+

To see a listing of items declared in this unit including their declarations, use the ObjectBrower.

+ + + + + + diff --git a/components/rx/trunk/docs/rxctrls.xml b/components/rx/trunk/docs/rxctrls.xml new file mode 100644 index 000000000..3b4638738 --- /dev/null +++ b/components/rx/trunk/docs/rxctrls.xml @@ -0,0 +1,209 @@ + + + + + + +

Компонента TRxLabel аналогична стандартной компоненте VCL TLabel, однако дополнительно позволяет придать тексту статического элемента управления (Label) 3-мерный вид, либо отобразить "тень" текста.

+

С помощью свойст ShadowPos, ShadowColor и ShadowSize вы можете задать расположение, цвет и толщину "тени" букв текста. Значения, заданные для этих свойств по умолчанию, создают "трехмерный" эффект изображения текста.

+ + Компонента TRxLabel аналогична стандартной компоненте VCL TLabel, однако дополнительно позволяет придать тексту статического элемента управления (Label) 3-мерный вид, либо отобразить "тень" текста. + + + + + + + + + + + + + + + + + + + + + Свойство задает цвет "тени" букв текста статического элемента управления TRxLabel. + Свойство задает цвет "тени" букв текста статического элемента управления TRxLabel. + + + Свойство задает толщину "тени" букв текста статического элемента управления TrxLabel. + Свойство задает толщину "тени" букв текста статического элемента управления TrxLabel. + + + Свойство задает расположение "тени" букв текста статического элемента управления TrxLabel. + Свойство задает расположение "тени" букв текста статического элемента управления TrxLabel. + + + + + + + + + + + + + + + + + Событие происходит, когда пользователь перемещает курсор мыши в область, находящуюся над элементом управления. + Событие происходит, когда пользователь перемещает курсор мыши в область, находящуюся над элементом управления. + + + Событие происходит, когда пользователь уводит курсор мыши из области, находящейся над элементом управления. + Событие происходит, когда пользователь уводит курсор мыши из области, находящейся над элементом управления. + + + + + + + Компонента TSecretPanel предназначена, как и компонента TPanel, для помещения в форму "панелей", на которых могут быть размещены другие элементы управления. + +

Компонента TSecretPanel предназначена, как и компонента TPanel, для помещения в форму "панелей", на которых могут быть размещены другие элементы управления.

+

В дополнение к свойствам и методам компоненты TPanel, TSecretPanel имеет возможность размещения "скрытого" текста и изображения, доступных для отображения при установленном в True значении свойства Active. Свойство LinesLines задает список строк текста, который будет "прокручиваться" в направлении снизу вверх или справа налево (в зависимости от значения свойства ScrollDirection) в клиентской области компоненты TSecretPanel при установке Active = True. Если свойство Glyph ассоциировано с графическим изображением, то одновременно это изображение будет показано в области TSecretPanel, заданной свойством GlyphLayout. По окончании прокрутки текста, если свойство Cycled = False, свойство Active автоматически установится в значение False, если же Cycled = True, прокрутка текста возобновится сначала. Вы можете также прервать прокрутку, вручную установив свойство Active в значение False.

+

Событие OnPaintClient позволяет вам достигать всевозможных эффектов при отрисовке клиентской области панели как в активном состоянии (при прокрутке текста), так и в неактивном.

+ + + + + + + + + +

Свойство определяет, как будет осуществляться перерисовка компоненты при "прокрутке" текста, т.е. когда свойство Active = True.

+

Если AsyncDrawing = False, то перерисовка синхронизируется с основным потоком приложения. Если AsyncDrawing = True (по умолчанию), то прокрутка текста и перерисовка осуществляется асинхронно, в отдельном потоке.

+ + Свойство определяет, как будет осуществляться перерисовка компоненты при "прокрутке" текста + + + +

Свойство определяет состояние компоненты TSecretPanel. При установке значения этого свойства в True, все компоненты, размещенные на TSecretPanel (у которых свойство Parent указывает на этот объект), скрываются, отображается изображение, заданное свойством Glyph, и начинается автоматическая прокрутка текста, определенного свойством Lines. +

+

Если свойство Cycled = False, то при прокрутке всего текста свойство Active автоматически устанавливается в значение False. Вы можете также прервать прокрутку ранее, присвоив свойству Active значение False.

+ + Свойство определяет состояние компоненты TSecretPanel + + + + +

Свойство Cycled определяет поведение компоненты после прокрутки всего текста, заданного свойством Lines. Если Cycled = True, то прокрутка текста будет продолжена с начала, если же Cycled = False (по умолчанию), то после прокрутки всего текста свойство Active будет установлено в значение False.

+ + Свойство Cycled определяет поведение компоненты после прокрутки всего текста, заданного свойством Lines + + + + + Свойство определяет временной интервал (в милисекундах), с которым происходит смена изображений в компоненте. +Для TSecretPanel свойство определяет скорость "прокрутки" текста при значении свойства Active = True. + + + Свойство задает набор текстовых строк, которые не отображаются компонентой TSecretPanel в нормальном ее состоянии, но могут быть "прокручены" (одновременно с отображением битового изображения, заданного свойством Glyph) при установке в True значения свойства Active. + + + Свойство определяет направление прокрутки срок текста при значении Active=True. +Возможные значения свойства ScrollDirection: +• sdVertical - текст прокручивается снизу вверх. +• sdHorizontal - прокрутка текста осуществляется в направлении справа налево. + + + Свойство задает стиль отображения текста при его прокрутке в компоненте TSecretPanel. При значении этого свойства, отличном от bvNone, текст выглядит либо "продавленным" (bvLowered), либо "выпуклым" (bvRaised). + + + + + + + + + + + + + + + + + + + + + + + + + + +

Событие возникает при перерисовке панели как в активном состоянии (Active=True) при прокрутке текста, так и в неактивном. +Вы можете использовать это событие для создания всевозможных эффектов при отрисовке панели.

+ Имейте в виду, что при наличии обработчика события OnPaintClient компонента TSecretPanel не отрисовывает область, заданную параметром Rect, следовательно, при написании обработчика этого события вы должны как минимум заполнить указанную область, например вызовом метода FillRect. + + + + + + + + + + + + + + + + + + + + + Компонента аналогична стандартной компоненте TSpeedButton, но имеет некоторые дополнительные возможности. +Она может быть прозрачной (свойство Transparent) и "всплывающей" (свойство Flat), что позволяет создавать кнопки, аналогичные используемым в панели инструментов Microsoft Internet Explorer 3.x. При установленном значении свойств GrayedInactive и Flat битовое изображение "неактивной" кнопки будет изменяться по сравнению с обычным вариантом. + +При установке свойства AllowTimer в значение True, кнопка будет генерировать повторяющиеся события OnClick при нажатии на кнопку до тех пор, пока кнопка находится в нажатом состоянии. Вы можете регулировать интервал между событиями OnClick с помощью свойств InitPause и RepeatInterval. +Кроме того, Вы можете задать выпадающее меню (с помощью свойства DropDownMenu), которое будет появляться при нажатии на кнопку. + +Остальные свойства и методы компоненты TRxSpeedButton те же, что и у TSpeedButton. + Компонента аналогична стандартной компоненте TSpeedButton, но имеет некоторые дополнительные возможности. + + + + + Когда свойство AllowTimer установлено в значение True, кнопка будет генерировать повторяющиеся события OnClick при нажатии на кнопку до тех пор, пока кнопка находится в нажатом состоянии. Вы можете регулировать интервал между событиями OnClick с помощью свойств InitRepeatPause и RepeatPause. + + + Свойство позволяет задать интервал (в миллисекундах) перед первым событием OnClick, вызывающемся при нажатии кнопки, если свойство AllowTimer установлено в значение True. + + + Свойство позволяет задать интервал (в миллисекундах) между повторяющимися вызовами события OnClick, если кнопка нажата и свойство AllowTimer = True. + + + Тип определяет возможные значения свойства ScrollDirection компоненты TSecretPanel + + Тип определяет возможные значения свойства ScrollDirection компоненты TSecretPanel + + + + Тип определяет метод - обработчик события OnPaintClient компоненты TSecretPanel. + Тип определяет метод - обработчик события OnPaintClient компоненты TSecretPanel. + + + Тип TGlyphLayout задает возможные значения свойства GlyphLayout компоненты TSecretPanel. + Тип TGlyphLayout задает возможные значения свойства GlyphLayout компоненты TSecretPanel. + + + Тип TShadowPosition задает возможные допустимые значения для свойства ShadowPos компоненты TRxLabel, задающего положение "тени" статического элемента управления. + + + + + diff --git a/components/rx/trunk/docs/rxdbgrid.xml b/components/rx/trunk/docs/rxdbgrid.xml index 2c3b98c95..021c84478 100644 --- a/components/rx/trunk/docs/rxdbgrid.xml +++ b/components/rx/trunk/docs/rxdbgrid.xml @@ -86,6 +86,29 @@ Событие возникает при отрисовке итоговой строкСобытие возникает при отрисовке итоговой строк Событие возникает при расчёте итоговой строкСобытие возникает при расчёте итоговой строк Признак необходимости отрисовки вертикальных линий сетки до итоговой строкиПризнак необходимости отрисовки вертикальных линий сетки до итоговой строки + Включение автоматической сортировки данныхВключение автоматической сортировки данных в гриде. Сортировка осуществляется щелчком мышки по заголовку столбца. + Метод производит подбор ширины всех колонок в зависимости от данныхМетод производит подбор ширины всех колонок в зависимости от данных + Метод производит подбор ширины указанных колонок в зависимости от данных + Метод выполняет пересчёт итоговой строки списка + Метод отображает диалоговое окно поиска в гриде + Метод отображает диалоговое окно настроек колонок списка + Метод отображает диалоговое окно фильтрации данных + Номер версии сохранённых настроек гридаСвойство определяет номер версии настроек списка. +При чтении настроек из файла если номер версии списка больше номера версии в файле, то настройки будут проигнорированны. +Используется в случае необходимости принудительно установить все настроки списка с новой версией программы. + + Класс определяет параметры итовой строки грида + Признак активности итоговой строки + Цвет итоговой строки + Кол-во строк с текстом в итоговой строке грида + Стиль отображения итоговой строки + Параметры итоговой строки грида + Настройки клавиатрных комбинаций для грида + Класс содержит настройки клавиатрных комбинаций для грида + Класс содержит клавиатурную комбинацию для грида + Команда грида + Клавиатурная комбинация + Признак разрешённой команды diff --git a/components/rx/trunk/docs/rxfpc.xml b/components/rx/trunk/docs/rxfpc.xml index c8969dad6..cd33c4709 100644 --- a/components/rx/trunk/docs/rxfpc.xml +++ b/components/rx/trunk/docs/rxfpc.xml @@ -671,453 +671,6 @@ Признак запрета данного сочетания клавишь - - - -

Компонента TRxLabel аналогична стандартной компоненте VCL TLabel, однако дополнительно позволяет придать тексту статического элемента управления (Label) 3-мерный вид, либо отобразить "тень" текста.

-

С помощью свойст ShadowPos, ShadowColor и ShadowSize вы можете задать расположение, цвет и толщину "тени" букв текста. Значения, заданные для этих свойств по умолчанию, создают "трехмерный" эффект изображения текста.

- - - - - - - - - - - - - - - - - - - - - - Свойство задает цвет "тени" букв текста статического элемента управления TRxLabel. - - - Свойство задает толщину "тени" букв текста статического элемента управления TrxLabel. - - - Свойство задает расположение "тени" букв текста статического элемента управления TrxLabel. - - - - - - - - - - - - - - - - - Событие происходит, когда пользователь перемещает курсор мыши в область, находящуюся над элементом управления. - - - Событие происходит, когда пользователь уводит курсор мыши из области, находящейся над элементом управления. - - - - - - - Компонента TSecretPanel предназначена, как и компонента TPanel, для помещения в форму "панелей", на которых могут быть размещены другие элементы управления. - -

Компонента TSecretPanel предназначена, как и компонента TPanel, для помещения в форму "панелей", на которых могут быть размещены другие элементы управления.

-

В дополнение к свойствам и методам компоненты TPanel, TSecretPanel имеет возможность размещения "скрытого" текста и изображения, доступных для отображения при установленном в True значении свойства Active. Свойство LinesLines задает список строк текста, который будет "прокручиваться" в направлении снизу вверх или справа налево (в зависимости от значения свойства ScrollDirection) в клиентской области компоненты TSecretPanel при установке Active = True. Если свойство Glyph ассоциировано с графическим изображением, то одновременно это изображение будет показано в области TSecretPanel, заданной свойством GlyphLayout. По окончании прокрутки текста, если свойство Cycled = False, свойство Active автоматически установится в значение False, если же Cycled = True, прокрутка текста возобновится сначала. Вы можете также прервать прокрутку, вручную установив свойство Active в значение False.

-

Событие OnPaintClient позволяет вам достигать всевозможных эффектов при отрисовке клиентской области панели как в активном состоянии (при прокрутке текста), так и в неактивном.

- - - - - - - - - -

Свойство определяет, как будет осуществляться перерисовка компоненты при "прокрутке" текста, т.е. когда свойство Active = True.

-

Если AsyncDrawing = False, то перерисовка синхронизируется с основным потоком приложения. Если AsyncDrawing = True (по умолчанию), то прокрутка текста и перерисовка осуществляется асинхронно, в отдельном потоке.

- - - - -

Свойство определяет состояние компоненты TSecretPanel. При установке значения этого свойства в True, все компоненты, размещенные на TSecretPanel (у которых свойство Parent указывает на этот объект), скрываются, отображается изображение, заданное свойством Glyph, и начинается автоматическая прокрутка текста, определенного свойством Lines. -

-

Если свойство Cycled = False, то при прокрутке всего текста свойство Active автоматически устанавливается в значение False. Вы можете также прервать прокрутку ранее, присвоив свойству Active значение False.

- - - - - -

Свойство Cycled определяет поведение компоненты после прокрутки всего текста, заданного свойством Lines. Если Cycled = True, то прокрутка текста будет продолжена с начала, если же Cycled = False (по умолчанию), то после прокрутки всего текста свойство Active будет установлено в значение False.

- - - - - - Свойство определяет временной интервал (в милисекундах), с которым происходит смена изображений в компоненте. -Для TSecretPanel свойство определяет скорость "прокрутки" текста при значении свойства Active = True. - - - Свойство задает набор текстовых строк, которые не отображаются компонентой TSecretPanel в нормальном ее состоянии, но могут быть "прокручены" (одновременно с отображением битового изображения, заданного свойством Glyph) при установке в True значения свойства Active. - - - Свойство определяет направление прокрутки срок текста при значении Active=True. -Возможные значения свойства ScrollDirection: -• sdVertical - текст прокручивается снизу вверх. -• sdHorizontal - прокрутка текста осуществляется в направлении справа налево. - - - Свойство задает стиль отображения текста при его прокрутке в компоненте TSecretPanel. При значении этого свойства, отличном от bvNone, текст выглядит либо "продавленным" (bvLowered), либо "выпуклым" (bvRaised). - - - - - - - - - - - - - - - - - - - - - - - - - - -

Событие возникает при перерисовке панели как в активном состоянии (Active=True) при прокрутке текста, так и в неактивном. -Вы можете использовать это событие для создания всевозможных эффектов при отрисовке панели.

- Имейте в виду, что при наличии обработчика события OnPaintClient компонента TSecretPanel не отрисовывает область, заданную параметром Rect, следовательно, при написании обработчика этого события вы должны как минимум заполнить указанную область, например вызовом метода FillRect. - - - - - - - - - - - - - - - - - - - - - Компонента аналогична стандартной компоненте TSpeedButton, но имеет некоторые дополнительные возможности. -Она может быть прозрачной (свойство Transparent) и "всплывающей" (свойство Flat), что позволяет создавать кнопки, аналогичные используемым в панели инструментов Microsoft Internet Explorer 3.x. При установленном значении свойств GrayedInactive и Flat битовое изображение "неактивной" кнопки будет изменяться по сравнению с обычным вариантом. - -При установке свойства AllowTimer в значение True, кнопка будет генерировать повторяющиеся события OnClick при нажатии на кнопку до тех пор, пока кнопка находится в нажатом состоянии. Вы можете регулировать интервал между событиями OnClick с помощью свойств InitPause и RepeatInterval. -Кроме того, Вы можете задать выпадающее меню (с помощью свойства DropDownMenu), которое будет появляться при нажатии на кнопку. - -Остальные свойства и методы компоненты TRxSpeedButton те же, что и у TSpeedButton. - - - - - Когда свойство AllowTimer установлено в значение True, кнопка будет генерировать повторяющиеся события OnClick при нажатии на кнопку до тех пор, пока кнопка находится в нажатом состоянии. Вы можете регулировать интервал между событиями OnClick с помощью свойств InitRepeatPause и RepeatPause. - - - Свойство позволяет задать интервал (в миллисекундах) перед первым событием OnClick, вызывающемся при нажатии кнопки, если свойство AllowTimer установлено в значение True. - - - Свойство позволяет задать интервал (в миллисекундах) между повторяющимися вызовами события OnClick, если кнопка нажата и свойство AllowTimer = True. - - - Тип определяет возможные значения свойства ScrollDirection компоненты TSecretPanel - - - - Тип определяет метод - обработчик события OnPaintClient компоненты TSecretPanel. - - - Тип TGlyphLayout задает возможные значения свойства GlyphLayout компоненты TSecretPanel. - - - Тип TShadowPosition задает возможные допустимые значения для свойства ShadowPos компоненты TRxLabel, задающего положение "тени" статического элемента управления. - - - - - TCurrencyEdit Component - -

Компонента служит для ввода и редактирования чисел и денежных сумм. TCurrencyEdit имеет те же свойства, что и ее предок TEdit, но позволяет дополнительно указать формат отображения числа и символы для обозначения вида валюты с помощью свойства DisplayFormat, а также максимальное число символов после десятичной точки (при вводе данных) с помощью свойства DecimalPlaces. Свойство Value позволяет получить или установить численную величину отображаемого в компоненте значения.

-

Если свойство BeepOnError установлено в True, то при вводе в строку недопустимых символов раздается звуковой сигнал.

- - - - - - - -

Свойство позволяет обратиться к значению Value, сохраненному в компоненте - редакторе для ввода чисел, как к целому числу.

- - - - Свойство служит для доступа на чтение к форматированному в соответствии со значением DisplayFormat представлению значения ValueValue (совпадает с отображаемой строкой в компоненте, когда элемент редактирования не имеет фокуса ввода). В отличие от этого свойства, свойство Text всегда возвращает неформатированную строку. - - - Свойство позволяет установить (или получить) численную величину значения, отображаемого в строке ввода. В случае пустой строки возвращается значение 0. - - - - Определяет факт автоматического выделения всего текста при попадании фокуса клавиатурного ввода в компонент - - - Свойство определяет, будет ли размер автоматически изменяться размер шрифта - - - Если значение этого свойства установлено в True (по умолчанию False), то при ошибках ввода с клавиатуры (недопустимых символов и т.д.) раздается звуковой сигнал. - - - - - -

Свойство определяет, будет ли проверяться допустимый диапазон числа в компонентах TCurrencyEdit при потере фокуса строкой редактирования.

-

Если CheckOnExit = True, то в случае ввода недопустимого значения происходит исключение (exception).

- - - - - Свойство определяет максимально допустимое число десятичных знаков при вводе и изменении данных в строке редактирования компоненты TCurrencyEdit. Используется, когда строка имеет фокус ввода. При отображении значения в несфокусированной строке редактирования свойство не используется - применяется маска, заданная свойством DisplayFormat. - - - - Свойство задает формат отображения данных в компоненте TCurrencyEdit. При получении компонентой фокуса ввода форматирование данных отменяется и ввод происходит как в обычную строку ввода TEdit. При потере фокуса ввода данные форматируются согласно заданному формату. - - - - - - - Свойство определяет, будет ли автоматически форматироваться значение в строке редактора непосредственно при редактировании. -Формат ввода определяется переменными DecimalSeparator и ThousandSeparator из модуля SysUtils.pas и свойством DecimalPlaces - - - - - - - - - - Максимально допустимое значение свойства Value. Значение MaxValue ограничивает максимальную величину числа, которое можно ввести в строку ввода. - - - Минимально допустимое значение свойства Value. Значение MinValue ограничивает минимальную величину числа, которое можно ввести в строку ввода. - - - - - - - - - - - - - - Если значение этого свойства равно True, то когда редактор имеет фокус ввода и значение ValueValue = 0, в нем с качестве текста отображается пустая строка. Если ZeroEmpty = False, то в этом случае текст '0'. - - - - - - - - - - - - - - - - - - - - CurrEdit Unit - -

The CurrEdit unit contains the declarations for the certain components on the RX Controls page of the Component palette and their associated objects, types, and constants. -When you add a component declared in this unit to a form, the unit is automatically added to the uses clause of that form's unit.

-

The following items are declared in the CurrEdit unit:

-

- Components and objects -

-

- TCurrencyEdit -

-

To see a listing of items declared in this unit including their declarations, use the ObjectBrower.

- - - - - TRxLookupEdit Component - -

Компонента TRxLookupEdit представляет собой редактор с возможностью как прямого ввода текста пользователем в строке редактирования, так и выбора текста из выпадающего списка, заполняемого значениями из базы данных. При открытом списке набор пользователем символов с клавиатуры приводит к позиционированию списка на ближайшую запись, совпадающую с введенным текстом.

-

Для заполнения выпадающего списка используются свойства LookupSource, LookupField, LookupDisplay и LookupDisplayIndex, аналогично списку компоненты TRxDBLookupCombo.

-

Введенное пользователем или выбранное из списка значение доступно через свойство Text. -Свойство LookupValue (read-only) позволяет получить значение ключевого поля из lookup-набора данных (заданного свойством LookupField), если пользвателем был сделан выбор из списка.

- - - - - - - - - В случае, если свойство LookupDisplay задает более одного поля для отображения в списке, значение свойства LookupDisplayIndex определяет номер поля, значение которого возвращается свойством DisplayValue. - - - - - - TRxDBLookupCombo Component - Unit -RxLookup -Description -Компонента TRxDBLookupCombo почти полностью аналогична стандартной компоненте из VCL TDBLookupCombo и имеет те же самые свойства, методы и события. Однако по сравнению с TDBLookupCombo у этой компоненты есть некоторые дополнительные возможности и свойства. -TRxDBLookupCombo позволяет использовать в качестве LookupSource любой источник данных - как TTable, так и TQuery, при этом свойство LookupField не обязательно должно быть индексированным полем. -Компонента TRxDBLookupCombo также позволяет производить поиск нужного термина при наборе первых букв этого термина. -Например, у вас имеется таблица или результат запроса, седержащий поля CustNo и CustName. Тогда вы можете указать поле CustName как значение свойства LookupDisplay. Если пользователь вашего приложения наберет первые буквы нужной ему фамилии (находящейся в поле CustName), то если компонента TRxDBLookupCombo имеет фокус ввода, автоматически выпадет список доступных значений и выделенный элемент в списке установится в значение, первые буквы которого совпадают с введенными пользователем. -Если свойство IgnoreCase установлено в True, то при наборе пользователем первых букв термина регистр символов не учитывается. Надо иметь в виду, что при работе с русскоязычными значениями в полях БД не все драйвера поддерживают преобразование регистра символов. -Свойство IndexSwitch определяет, будет ли при необходимости производиться переключение индексов таблицы (если источником данных служит таблица, а не результат запроса). В случае использования больших SQL-таблиц переключение индексов может занять длительное время, поэтому в таких случаях свойство желательно устанавливать в значение False. -Свойтсво DisplayEmpty позволяет задать текстовую строку для отображения в строке TRxDBLookupCombo, когда не сделано никакого выбора. Вызов метода ResetField приводит к очистке содержимого компоненты, устоновке значения Value в пустую строку, и отображению значения DisplayEmpty. -В дополнение к событию OnDropDown, имеющемуся у TDBLookupCombo, компонента имеет событие OnCloseUp, вызываемое при закрытии выпадающего списка. Метод IsDropDown позволяет определить текущее состояние выпадающего списка выбора. Событие OnChange происходит при смене значения cвойства Value. -Компонента также позволяет задать изображения для рисования в левой части каждой строки списка, в зависимости от содержимого полей БД, с помощью события OnGetImage. -В остальном компонента TRxDBLookupCombo полностью аналогична компоненте TDBLookupCombo. - -ВНИМАНИЕ -При присвоении значений свойству Value или DisplayValue компонент TRxDBLookupCombo или TRxDBLookupList безошибочное позиционирование на соответствующую запись в списке произойдет только в том случае, если соответствующее поле в подмножестве записей, заданном источником данных DataSource, имеет только уникальные неповторяющиеся значения. В противном случае Вы получите несколько "выбранных" элементов в списке (причем реально будет выбран только один самый первый), значения полей в которых равны заданному. Избегайте таких ситуаций! - -При работе с некоторыми SQL-серверами БД установка свойств IndexSwitch или IgnoreCase в значение True может приводить к неожиданному поведению компоненты. В этом случае постарайтесь добиться "правильного" поведения за счет комбинирования разных значений свойств IgnoreCase и IndexSwitch. - - - - - - - - - - - - - - - - - - - - - - - property EmptyValue: string; - Свойство задает значение, присвоение которого свойству Value будет восприниматься как присвоение "пустого" значения и приведет к очистке DataField. По умолчанию значение свойства есть пустая строка. - - - property EmptyItemColor: TColor; - Свойство задает значение цвета, которым будет рисоваться дополнительный нескролируемый элемент списка для "пустого" значения (т.е. которое совпадает с DisplayEmpty). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

The RxLookup unit contains the declarations for the certain components on the RX DBAware page of the Component palette and their associated objects, types, and constants. -When you add a component declared in this unit to a form, the unit is automatically added to the uses clause of that form's unit.

- - - Событие возникает при закрытии PopUp окна выбора данных. - - - Событие возникает при закрытии PopUp окна выбора данных. - - - - - Компонента TDBDateEdit - ориентированная на работу с базами данных компонента для редактирования даты. Установленное значение свойства Date становится новым значением поля в БД, если значение свойства ReadOnly компоненты TDBDateEdit - False. -TDBDateEdit является наследником TDateEdit и имеет все те же свойства и методы, и дополнительно имеет свойства, необходимые для работы с полями базы данных. - -Компонента TDBDateEdit может быть применена к тем полям наборов данных, которые позволяют чтение и присвоение значений через свойство AsDateTime. - - - - - - - - Свойство DialogTitle задает заголовок диалогового окна, появляющегося при нажатии на кнопку компоненты TFilenameEdit (TOpenDialog) или TDateEdit, TDBDateEdit (диалог выбора даты). - - - Компонента TRxDBCalcEdit - ориентированная на работу с базами данных компонента для редактирования чисел с возможностью импользования выпадающего калькулятора. Установленное значение свойства Value становится новым значением поля в БД, если значение свойства ReadOnly - False. -TRxDBCalcEdit является наследником TDBCalcEdit и имеет все те же свойства и методы, и дополнительно имеет свойства, необходимые для работы с полями базы данных. -Компонента TRxDBCalcEdit может быть применена к тем полям данных, которые позволяют чтение и присвоение значений через свойства AsFloat, AsInteger. - - - - - - - Класс по управлению списком файлов diff --git a/components/rx/trunk/docs/rxlookup.xml b/components/rx/trunk/docs/rxlookup.xml new file mode 100644 index 000000000..4e45e5126 --- /dev/null +++ b/components/rx/trunk/docs/rxlookup.xml @@ -0,0 +1,148 @@ + + + + + TRxLookupEdit Component + +

Компонента TRxLookupEdit представляет собой редактор с возможностью как прямого ввода текста пользователем в строке редактирования, так и выбора текста из выпадающего списка, заполняемого значениями из базы данных. При открытом списке набор пользователем символов с клавиатуры приводит к позиционированию списка на ближайшую запись, совпадающую с введенным текстом.

+

Для заполнения выпадающего списка используются свойства LookupSource, LookupField, LookupDisplay и LookupDisplayIndex, аналогично списку компоненты TRxDBLookupCombo.

+

Введенное пользователем или выбранное из списка значение доступно через свойство Text. +Свойство LookupValue (read-only) позволяет получить значение ключевого поля из lookup-набора данных (заданного свойством LookupField), если пользвателем был сделан выбор из списка.

+ + + + + + + + + В случае, если свойство LookupDisplay задает более одного поля для отображения в списке, значение свойства LookupDisplayIndex определяет номер поля, значение которого возвращается свойством DisplayValue. + + + + + + TRxDBLookupCombo Component + Unit +RxLookup +Description +Компонента TRxDBLookupCombo почти полностью аналогична стандартной компоненте из VCL TDBLookupCombo и имеет те же самые свойства, методы и события. Однако по сравнению с TDBLookupCombo у этой компоненты есть некоторые дополнительные возможности и свойства. +TRxDBLookupCombo позволяет использовать в качестве LookupSource любой источник данных - как TTable, так и TQuery, при этом свойство LookupField не обязательно должно быть индексированным полем. +Компонента TRxDBLookupCombo также позволяет производить поиск нужного термина при наборе первых букв этого термина. +Например, у вас имеется таблица или результат запроса, седержащий поля CustNo и CustName. Тогда вы можете указать поле CustName как значение свойства LookupDisplay. Если пользователь вашего приложения наберет первые буквы нужной ему фамилии (находящейся в поле CustName), то если компонента TRxDBLookupCombo имеет фокус ввода, автоматически выпадет список доступных значений и выделенный элемент в списке установится в значение, первые буквы которого совпадают с введенными пользователем. +Если свойство IgnoreCase установлено в True, то при наборе пользователем первых букв термина регистр символов не учитывается. Надо иметь в виду, что при работе с русскоязычными значениями в полях БД не все драйвера поддерживают преобразование регистра символов. +Свойство IndexSwitch определяет, будет ли при необходимости производиться переключение индексов таблицы (если источником данных служит таблица, а не результат запроса). В случае использования больших SQL-таблиц переключение индексов может занять длительное время, поэтому в таких случаях свойство желательно устанавливать в значение False. +Свойтсво DisplayEmpty позволяет задать текстовую строку для отображения в строке TRxDBLookupCombo, когда не сделано никакого выбора. Вызов метода ResetField приводит к очистке содержимого компоненты, устоновке значения Value в пустую строку, и отображению значения DisplayEmpty. +В дополнение к событию OnDropDown, имеющемуся у TDBLookupCombo, компонента имеет событие OnCloseUp, вызываемое при закрытии выпадающего списка. Метод IsDropDown позволяет определить текущее состояние выпадающего списка выбора. Событие OnChange происходит при смене значения cвойства Value. +Компонента также позволяет задать изображения для рисования в левой части каждой строки списка, в зависимости от содержимого полей БД, с помощью события OnGetImage. +В остальном компонента TRxDBLookupCombo полностью аналогична компоненте TDBLookupCombo. + +ВНИМАНИЕ +При присвоении значений свойству Value или DisplayValue компонент TRxDBLookupCombo или TRxDBLookupList безошибочное позиционирование на соответствующую запись в списке произойдет только в том случае, если соответствующее поле в подмножестве записей, заданном источником данных DataSource, имеет только уникальные неповторяющиеся значения. В противном случае Вы получите несколько "выбранных" элементов в списке (причем реально будет выбран только один самый первый), значения полей в которых равны заданному. Избегайте таких ситуаций! + +При работе с некоторыми SQL-серверами БД установка свойств IndexSwitch или IgnoreCase в значение True может приводить к неожиданному поведению компоненты. В этом случае постарайтесь добиться "правильного" поведения за счет комбинирования разных значений свойств IgnoreCase и IndexSwitch. + + + + + + + + + + + + + + + + + + + + + + + property EmptyValue: string; + Свойство задает значение, присвоение которого свойству Value будет восприниматься как присвоение "пустого" значения и приведет к очистке DataField. По умолчанию значение свойства есть пустая строка. + + + property EmptyItemColor: TColor; + Свойство задает значение цвета, которым будет рисоваться дополнительный нескролируемый элемент списка для "пустого" значения (т.е. которое совпадает с DisplayEmpty). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

The RxLookup unit contains the declarations for the certain components on the RX DBAware page of the Component palette and their associated objects, types, and constants. +When you add a component declared in this unit to a form, the unit is automatically added to the uses clause of that form's unit.

+ + + Событие возникает при закрытии PopUp окна выбора данных. + + + Событие возникает при закрытии PopUp окна выбора данных. + + + + + Компонента TDBDateEdit - ориентированная на работу с базами данных компонента для редактирования даты. Установленное значение свойства Date становится новым значением поля в БД, если значение свойства ReadOnly компоненты TDBDateEdit - False. +TDBDateEdit является наследником TDateEdit и имеет все те же свойства и методы, и дополнительно имеет свойства, необходимые для работы с полями базы данных. + +Компонента TDBDateEdit может быть применена к тем полям наборов данных, которые позволяют чтение и присвоение значений через свойство AsDateTime. + + + + + + + + Свойство DialogTitle задает заголовок диалогового окна, появляющегося при нажатии на кнопку компоненты TFilenameEdit (TOpenDialog) или TDateEdit, TDBDateEdit (диалог выбора даты). + + + Компонента TRxDBCalcEdit - ориентированная на работу с базами данных компонента для редактирования чисел с возможностью импользования выпадающего калькулятора. Установленное значение свойства Value становится новым значением поля в БД, если значение свойства ReadOnly - False. +TRxDBCalcEdit является наследником TDBCalcEdit и имеет все те же свойства и методы, и дополнительно имеет свойства, необходимые для работы с полями базы данных. +Компонента TRxDBCalcEdit может быть применена к тем полям данных, которые позволяют чтение и присвоение значений через свойства AsFloat, AsInteger. + + + + + + + + + +