Copyright: Copyright © 1999 Master-Bank, RX Library 2.60


RX LibraryComponentsList
RX Library Components

The following is a list of all components in the RX Library:

TAnimatedImage

TAppEvents

TBDEItems

TClipboardViewer

TColorComboBox

TComboEdit

TConverter

TCurrencyEdit

TDatabaseItems

TDateEdit

TDBDateEdit

TDBIndexCombo

TDBProgress

TDBSecurity

TDBStatusLabel

TDirectoryEdit

TDualListDialog

TFilenameEdit

TFontComboBox

TFormPlacement

TFormStorage

TMemoryTable

TMRUManager

TPageManager

TPicClip

TQBEQuery

TRxCalcEdit

TRxCalculator

TRxCheckListBox

TRxClock

TRxDBCalcEdit

TRxDBComboBox

TRxDBComboEdit

TRxDBFilter

TRxDBGrid

TRxDBLookupCombo

TRxDBLookupList

TRxDBRichEdit

TRxDice

TRxDrawGrid

TRxFolderMonitor

TRxGIFAnimator

TRxGradientCaption

TRxLabel

TRxLookupEdit

TRxMainMenu

TRxMemoryData

TRxPopupMenu

TRxQuery

TRxRichEdit

TRxSlider

TRxSpeedButton

TRxSpinButton

TRxSpinEdit

TRxSplitter

TRxSwitch

TRxTimerList

TRxTrayIcon

TRxWindowHook

TSecretPanel

TSpeedbar

TSQLScript

TStrHolder

TTableItems

TTextListBox


RX LibraryObjectsList
RX Library Objects

The following is a list of all objects directly descended from TObject in the RX Library:

TAnimatedCursorImage

TDatabaseDesc

TDateTimeFormat

TDBLocate

TDriverDesc

TGIFFrame

TGIFImage

THugeList

TIconList

TLocateObject

TObjectStrings

TOleController

TPageProxy

TRxBdeErrorDlg

TRxCaption

TRxCaptionList

TRxIniFile

TRxMathParser

TRxParaAttributes

TRxTextAttributes

TRxTimerEvent

TSpeedItem

TVersionInfo

TWinMinMaxInfo


RX Library
RX Library Contents

RX Library contains a large number of components, objects and routines for Borland Delphi with full source code. This library is compatible with Borland Delphi 1, 2, 3, 4 and Borland C++ Builder 1 and 3.

The RX Library is made up of objects, most of which are also components.

Unit's list of the RX Library:

AniFile

Animate

AppEvent

AppUtils

BdeUtils

BoxProcs

ClipIcon

ClipView

CurrEdit

DataConv

DateUtil

DBExcpt

DBFilter

DBIndex

DBLists

DBPrgrss

DBQbe

DBRichEd

DBSecur

DBUtils

DualList

FileUtil

GIFCtrl

IcoList

MaxMin

MemTable

MRUList

ObjStr

Ole2Auto

PageMngr

Parsing

PicClip

PickDate

Placemnt

RxCalc

RxClock

RxCombos

RxCtrls

RxDBComb

RxDBCtrl

RxDice

RxGIF

RxGraph

RxGrdCpt

RxGrids

RxHook

RxIni

RxLookup

RxMemDS

RxMenus

RxNotify

RxQuery

RxRichEd

RxShell

RxSlider

RxSpin

RxSplit

RxSwitch

RxVerInf

Speedbar

SplshWnd

StrHlder

StrUtils

TimerLst

ToolEdit

VCLUtils


The topic you are looking for was not found. It may

be inaccessible because of a property, event, method,

function, procedure, or type you are looking for

does not exist in yor Delphi or C++Builder version.


AniFile Unit

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 AniFile unit:

Components and objects

TAnimatedCursorImage

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


TAnimatedCursorImage object
TAnimatedCursorImage Class

Hierarchy             See also             Properties             Methods

Unit

AniFile

Description

Класс предназначен для считывания иконок из файла формата ANI (animated cursors) Windows.

Вы можете загрузить ANI-файл вызовом метода LoadFromFile, после чего Вы можете получить доступ к иконкам, загруженным из этого файла, через свойства Icons и IconCount. Вы также можете поместить последовательность битовых изображений из этих иконок в объект класса TBitmap с помощью метода AssignToBitmap.


TAnimatedCursorImage See Also
See also

TAnimatedImage

TBitmap

TGraphic

TIcon

TImage


TAnimatedCursorImage Hierarchy
Hierarchy

TObject

  |

TPersistent


TAnimatedCursorImage properties
Properties

Run-time only    [image] Key properties

Creator	IconCount	OriginalColors
DefaultRate	Icons	Title


TAnimatedCursorImage methods
Methods

Key methods

Assign	Create	LoadFromFile
AssignToBitmap	Destroy


Creator
Creator Property

Applies to

TAnimatedCursorImage component

Declaration

property Creator: string;

Description

После загрузки ANI-файла свойство содержит сохраненные в этом файле сведения о его авторе (copyright), если такая строка присутствует в исходном файле.


DefaultRate
DefaultRate Property

Applies to

TAnimatedCursorImage component

Declaration

property DefaultRate: Longint;

Description

После загрузки ANI-файла свойство содержит длительность отображения иконок в курсоре при анимации (в мсек).

Если продолжительность отображения икнок различна, то это свойство содержит длительность для первого изображения в курсоре.


TAnimatedCursorImage.IconCount
IconCount Property

Applies to

TAnimatedCursorImage component

Declaration

property IconCount: Integer;

Description

После загрузки ANI-файла свойство содержит количество иконок, загруженных из файла курсора.


TAnimatedCursorImage.Icons[Index: Integer]
Icons Property

Applies to

TAnimatedCursorImage component

Declaration

property Icons[Index: Integer]: TIcon;

Description

После загрузки ANI-файла свойство содержит список иконок, загруженных из файла курсора.


OriginalColors
OriginalColors Property

Applies to

TAnimatedCursorImage component

Declaration

property OriginalColors: Word;

Description

После загрузки ANI-файла свойство содержит количество цветов в оригинальных битовых изображениях, содержащихся в файле курсора. Это значение может быть 2, 16, 256 или 0. Значение 0 обозначает HighColor или TrueColor - иконки.


TAnimatedCursorImage.Title
Title Property

Applies to

TAnimatedCursorImage component

Declaration

property Title: string;

Description

После загрузки ANI-файла свойство содержит сохраненное в этом файле название курсора, если такая строка присутствует в исходном файле.


TAnimatedCursorImage.AssignToBitmap
AssignToBitmap Method

Applies to

TAnimatedCursorImage component

Declaration

procedure AssignToBitmap(Bitmap: TBitmap; BackColor: TColor; DecreaseColors, Vertical: Boolean);

Description

Метод позволяет заполнить последовательно изображениями из иконок, загруженных из ANI-файла, битовое изображение Bitmap. Полученное таким образом битовое изображение можно затем использовать, например, в компоненте TAnimatedImage. Параметр BackColor задает фоновый цвет битового изображения, параметр DecreaseColors при установке в True заставляет уменьшить число цветов в заполняемом изображении до оригинального (содержащихся в ANI-файле изображений), параметр Vertical определяет расположение последовательности иконок при заполнении выходного изображения - слева направо или сверху вниз.


TAnimatedCursorImage.LoadFromFile
LoadFromFile Method

Applies to

TAnimatedCursorImage component

Declaration

procedure LoadFromFile(const Filename: string); virtual;

Description

Метод предназначен для загрузки набора иконок из ANI-файла (animated cursor) с именем FileName.


Animate Unit

The Animate 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 Animate unit:

Components and objects

TAnimatedImage

Types

TGlyphOrientation

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


TAnimatedImage Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

Animate

Description

Компонента предназначена для отображения последовательно сменяющих друг друга графических изображений в форме, что создает иллюзию движения. Рисунок, отображаемый в форме, задается свойством Glyph. Это битовое изображение, которое должно содержать набор последовательных рисунков (следующих слева направо или сверху вниз, в зависимости от значения свойства Orientation), число которых задается свойством NumGlyphs. Номер рисунка, отображаемого в настоящий момент, во время выполнения можно определить по значению свойства GlyphNum. Вы можете также задать это значение в дизайнере. Если свойство Active установлено в True, то изображения сменяют друг друга с частотой, задаваемой свойством Interval.

Свойство Opaque определяет, будет ли компонента заполнять фон под картинкой цветом Color или же она будет полностью прозрачной.

Компонета также включает в себя свойства, аналогичные свойствам TImage.

Вы можете также использовать компоненту TAnimatedImage для помещения на форму прозрачных неподвижных изображений, например, при наложении изображений друг на друга.

С помощью редактора компоненты TAnimatedImage Вы можете загрузить в нее последовательность битовых изображений из файла с "анимированным курсором" Windows (ANI-файла).


Using the TAnimatedImage Component

See also             TAnimatedImage Reference

Purpose

Используйте эту компоненту для создания небольших анимаций в ваших формах и для размещения в них битовых изображений в формате .BMP.

Вы можете также использовать компоненту TAnimatedImage для помещения на форму прозрачных неподвижных изображений, например, при наложении изображений друг на друга.

Tasks

» Битовое изображение для анимации, задаваемое свойством Glyph,  должно представлять из себя набор рисунков равной ширины (или высоты, в зависимости от свойства Orientation), помещенных в одно битовое изображение формата .BMP и расположенных в последовательности, необходимой для анимации (слева направо или сверху вниз). Одно из изображений (кадров) может не использоваться при анимации и отображаться в неактивном состоянии, номер этого изображения задается свойством InactiveGlyph.

» Используйте свойство Active для включения и выключения режима анимации. При изменении свойства Active вызываются события OnStart и OnStop, соответственно.

» Вы можете изменить частоту смены изображений в компоненте с помощью свойства Interval.

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

» С помощью редактора компоненты TAnimatedImage Вы можете загрузить в нее последовательность битовых изображений из файла с "анимированным курсором" Windows (ANI-файла).


TAnimatedImage See Also
See also

Common Component Tasks


TAnimatedImage See Also
See also

TBitmap

TImage


TAnimatedImage Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TGraphicControl

  |

TRxImageControl


TAnimatedImage properties
Properties

Run-time only    [image] Key properties

Active	GlyphNum	ParentShowHint
AsyncDrawing	Height	PopupMenu
AutoSize	Hint	ShowHint
Canvas	InactiveGlyph	Showing
Center	Interval	Stretch
ComponentCount	Left	Tag
ComponentIndex	Name	Top
Components	NumGlyphs	TransparentColor
Cursor	Opaque	Visible
DragCursor	Orientation	Width
DragMode	Owner
Glyph	Parent


TAnimatedImage events
Events

Run-time only    [image] Key events

OnClick	OnEndDrag	OnStart
OnDblClick	OnMouseDown	OnStartDrag
OnDragDrop	OnMouseMove	OnStop
OnDragOver	OnMouseUp


TAnimatedImage methods
Methods

Key methods

BringToFront	FindComponent	Repaint
ClientToScreen	Hide	ScreenToClient
Create	InsertComponent	SendToBack
Destroy	Invalidate	SetBounds
Dragging	Refresh	Show
EndDrag	RemoveComponent	Update


TAnimatedImage.Active
Active Property

Applies to

TAnimatedImage component

Declaration

property Active: Boolean;

Description

Свойство определяет, будет ли автоматически с интервалом, заданным свойством Interval, меняться номер отображаемого битового изображения в компоненте. Если это свойство имеет значение False, то смены изображений не происходит, а номер текущего отображаемого рисунка задается свойством GlyphNum.


AsyncDrawing
AsyncDrawing Property

Applies to

TRxGIFAnimator, TAnimatedImage components

Declaration

property AsyncDrawing: Boolean;

Description

Свойство определяет, как будет осуществляться перерисовка "кадров" во время анимации изображения.

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

Внимание

Свойство доступно только в версиях Delphi 3.0 и выше или C++Builder 3.0 и выше.


TAnimatedImage.Glyph
Glyph Property

Applies to

TAnimatedImage component

Declaration

property Glyph: TBitmap;

Description

Свойство содержит битовое изображение, используемое для анимации. Это изображение должно содержать набор последовательных рисунков (следующих слева направо или сверху вниз, в зависимости от значения свойства Orientation), число которых задается свойством NumGlyphs.


GlyphNum
GlyphNum Property

Applies to

TAnimatedImage component

Declaration

property GlyphNum: Integer;

Description

Свойство определяет номер текущего отображаемого рисунка в компоненте в том случае, если свойство Active установлено в значение False.

Если свойство InactiveGlyph установлено в значение, отличное от -1, то значение свойства GlyphNum игнорируется.


InactiveGlyph
InactiveGlyph Property

Applies to

TAnimatedImage component

Declaration

property InactiveGlyph: Integer;

Description

Если значение этого свойства отлично от -1, то в неактивном состоянии компонента TAnimatedImage всегда будет отображать рисунок, соответствующий индексу InactiveGlyph (значение свойства GlyphNum игнорируется). Кроме этого, рисунок, имеющий индекс InactiveGlyph никогда не используется при анимации, т.е. он пропускается при прокрутке изображений.

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


Interval
Interval Property

Applies to

TSecretPanel, TRxTrayIcon, TRxDice, TAnimatedImage components

Declaration

property Interval: Word;

Description

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

Для TAnimatedImage (при Active = True) и TRxDice (при Rotate = True) это частота смены битовых изображений.

Для TSecretPanel свойство определяет скорость "прокрутки" текста при значении свойства Active = True.

Для TRxTrayIcon (только в 32-битной версии RX) - это частота смены иконок в tray-области панели задач при установленном в True значении свойства Animated.


TAnimatedImage.NumGlyphs
NumGlyphs Property

Applies to

TAnimatedImage component

Declaration

property NumGlyphs: Integer;

Description

Свойство определяет число рисунков, которое содержит битовое изображение, заданное свойством Glyph. Это битовое изображение должно представлять из себя набор рисунков равной ширины или высоты, в зависимости от их расположения, помещенных в одно битовое изображение формата .BMP и расположенных горизонтально или вертикально в последовательности, необходимой для анимации.


Opaque
Opaque Property

Applies to

TAnimatedImage component

Declaration

property Opaque: Boolean;

Description

Свойство определяет, будет ли компонента TAnimatedImage заполнять фон под картинкой цветом Color или же она будет полностью прозрачной.

При установке свойства TransparentColor в значение clNone свойство Opaque эффекта не имеет.


TAnimatedImage.Orientation
Orientation Property

Applies to

TAnimatedImage component

Declaration

property Orientation: TGlyphOrientation;

Description

Свойство задает расположение кадров в исходном битовом изображении, заданном свойством Glyph - по горизонтали (слева направо) или по вертикали (сверху вниз). По умолчанию - горизонтальное расположение кадров (goHorizontal).


TAnimatedImage.TransparentColor
TransparentColor Property

Applies to

TAnimatedImage component

Declaration

property TransparentColor: TColor;

Description

Свойство TransparentColor позволяет вам выбрать цвет точек изображения, заданного свойством Glyph, которые будут оставаться прозрачными при отображении рисунков в форме. Если свойство Opaque = True, то эти точки будут заменены на цвет, заданный свойством Color (по умолчанию - свопадающий с цветом Parent), в противном случае они остануться прозрачными.


OnStart
OnStart Event

Applies to

TRxGIFAnimator, TRxDice, TAnimatedImage components

Declaration

property OnStart: TNotifyEvent;

Description

Событие OnStart происходит, когда свойство Active (Animate, Rotate) принимает значение True, и начинается автоматическая смена графических изображений (анимация).


OnStop
OnStop Event

Applies to

TRxGIFAnimator, TRxDice, TAnimatedImage components

Declaration

property OnStop: TNotifyEvent;

Description

Событие OnStop происходит, когда свойство Active (Animate) принимает значение False, и автоматическая смена графических изображений (анимация) прекращается.


TGlyphOrientation Type

Unit

Animate

Declaration

type

TGlyphOrientation = (goHorizontal, goVertical);

Description

Тип задает возможные значения для свойства Orientation компоненты TAnimatedImage. Значение goHorizontal задает горизонтальное (слева направо) чередование кадров, значение goVertical - вертикальное (сверху вниз).


AppEvent Unit

The AppEvent unit contains the declarations for the certain components on the RX Tools 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 AppEvent unit:

Components and objects

TAppEvents

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


TAppEvents Component

Hierarchy             See also             Properties             Methods             Events

Unit

AppEvent

Description

Компонента предназначена для создания в режиме дизайна формы обработчиков событий TApplication и задания значения некоторых свойств TApplication.


TAppEvents See Also
See also

TApplication

TForm


TAppEvents Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TAppEvents properties
Properties

Run-time only    [image] Key properties

Canvas	HintColor	Owner
Chained	HintHidePause	ShowHint
ComponentCount	HintPause	ShowMainForm
ComponentIndex	HintShortPause	Tag
Components	Name	UpdateFormatSettings


TAppEvents events
Events

Run-time only    [image] Key events

OnActivate	OnHelp	OnPaintIcon
OnActiveControlChange	OnHint	OnRestore
OnActiveFormChange	OnIdle	OnSettingsChanged
OnDeactivate	OnMessage	OnShowHint
OnException	OnMinimize


TAppEvents methods
Methods

Key methods

Create	FindComponent	RemoveComponent
Destroy	InsertComponent


Chained
Chained Property

Applies to

TAppEvents component

Declaration

property Chained: Boolean;

Description

Свойство определяет, будет ли вызываться сохраненный (существовавший ранее, до создания компоненты TAppEvents) обработчик событий TApplication. Может быть использовано при создании нескольких экземпляров компоненты TAppEvents.


OnPaintIcon
OnPaintIcon Event

Applies to

TAppEvents component

Declaration

property OnPaintIcon: TNotifyEvent;

Description

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


TAppEvents.OnSettingsChanged
OnSettingsChanged Event

Applies to

TAppEvents component

Declaration

property OnSettingsChanged: TNotifyEvent;

Description

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


AppUtils Unit

The following items are declared in the AppUtils unit:

Constants

DefCompanyName

RegUseAppTitle

Procedures and functions

AppBroadcast

FindForm

FindShowForm

GetDefaultIniName

GetDefaultIniRegKey

GetDefaultSection

GetUniqueFileNameInDir

InstantiateForm

ReadFormPlacement

ReadFormPlacementReg

RestoreFormPlacement

RestoreGridLayout

RestoreGridLayoutReg

RestoreMDIChildren

RestoreMDIChildrenReg

SaveFormPlacement

SaveGridLayout

SaveGridLayoutReg

SaveMDIChildren

SaveMDIChildrenReg

ShowDialog

WriteFormPlacement

WriteFormPlacementReg

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


DefCompanyName Constant

Unit

AppUtils

Declaration

const

  DefCompanyName: string = '';

Description

Константа используется в функции GetDefaultIniRegKey.


RegUseAppTitle Constant

Unit

AppUtils

Declaration

const

  RegUseAppTitle: Boolean = False;

Description

Константа используется в функции GetDefaultIniRegKey.


AppBroadcast Procedure

Examples

Unit

AppUtils

Declaration

procedure AppBroadcast(Msg, wParam: Longint; lParam: Longint);

Description

Функция посылает сообщение Msg всем формам приложения.


AppBroadcast example
Example

const

  CM_MYMESSAGE = WM_USER + 1;

begin

  {...}

  AppBroadcast(CM_MYMESSAGE, MyWParam, MyLParam);

  {...}

end;


FindForm Function

Examples

Unit

AppUtils

Declaration

function FindForm(FormClass: TFormClass): TForm;

Description

Функция перебирает формы приложения, проверяя для каждой из них, является ли она экземпляром класса FormClass или экземпляром класса - наследника FormClass (с помощью оператора is). Встретив форму, удовлетворяющую этому условию, функция возвращает ссылку на нее как свой результат. Если ни одна из форм не удовлетворяет условию, то функция возвращает nil.


FindForm example
Example

Этот пример показывает, как можно с помощью функции FindForm обеспечить одновременное открытие только одного экземпляра формы данного класса в приложении:

 begin

   F := FindForm(TMyForm);

   if F = nil then Application.CreateForm(TMyForm, F);

   with F do begin

     if WindowState = wsMinimized then WindowState := wsNormal;

     Show;

   end;

 end;


FindShowForm Function

Examples

Unit

AppUtils

Declaration

function FindShowForm(FormClass: TFormClass; const Caption: string): TForm;

Description

Функция перебирает формы приложения, проверяя для каждой из них, является ли она экземпляром класса FormClass или экземпляром класса - наследника FormClass (с помощью оператора is). Если параметр Caption задает не пустую строку, то функция также проветяет, имеет ли найденная форма заголовок Caption. Если форма, удовлетворяющая указанным условиям не найдена, то она создается с помощью вызова метода Application.CreateForm.

Найденная (либо созданная) форма делается видимой с помощью вызова ее метода Show. При этом если найденная (уже существующая) форма находится в минимизированном состоянии, то она "разворачивается" в нормальное состояние (присвоением значения wsNormal свойству WindowState). Функция возвращает ссылку на созданную или найденную форму.


FindShowForm example
Example

procedure MainForm.ShowFormItemClick(Sender: TObject);

begin

  FindShowForm(TForm1, '');

end;


GetDefaultIniName Function

Examples

Unit

AppUtils

Declaration

function GetDefaultIniName: string;

Description

Функция возвращает имя INI-файла "по умолчанию" для приложения. Таковым она считает имя EXE-файла (получаемое с помощью Application.ExeName) с расширением ".INI", при этом из имени удаляется путь, что задает размещение INI-файла в директории Windows.


GetDefaultIniName example
Example

 begin

   ...

   IniFile := TIniFile.Create(GetDefaultIniName);

   ...

 end;


GetDefaultIniRegKey Function

Examples

Unit

AppUtils

Declaration

function GetDefaultIniRegKey: string;

Description

Функция возвращает имя ключа регистрационной базы данных Windows (Registry) "по умолчанию" для приложения. Это значение зависит от глобальных переменных RegUseAppTitle и DefCompanyName. Если значение DefCompanyName <> '', то в качестве результата возвращается:

 "HKEY_CURRENT_USER\Software\" + "<DefCompanuName>\" + <имя>

иначе

 "HKEY_CURRENT_USER\Software\" + <имя>

где <имя> - это имя EXE-файла без расширения, если RegUseAppTitle = False или значение свойства Application.Title, если RegUseAppTitle = True. Использование аналогично функции GetDefaultIniName, только для применения в Registry.


GetDefaultIniRegKey example
Example

  begin

    ...

    RegUseAppTitle := True;

    DefCompanyName := 'My Company';

    ...

    RegIniFile := TRegIniFile.Create(GetDefaultIniRegKey);

    ...

  end;


GetDefaultSection Function

Examples

Unit

AppUtils

Declaration

function GetDefaultSection(Component: TComponent): string;

Description

Функция возвращает строку для указанной компоненты Component, которая может быть использована, например, в качестве имени секции в INI-файле, описывающей параметры этой компоненты. Характер возвращаемого функцией значения ясен из приведенного ниже текста реализации функции:

function GetDefaultSection(Component: TComponent): string;

var

  F: TCustomForm;

  Owner: TComponent;

begin

  if Component <> nil then begin

    if Component is TCustomForm then Result := Component.ClassName

    else begin

      Result := Component.Name;

      if Component is TControl then begin

        F := GetParentForm(TControl(Component));

        if F <> nil then Result := F.ClassName + Result

        else begin

          if TControl(Component).Parent <> nil then

            Result := TControl(Component).Parent.Name + Result;

        end;

      end

      else begin

        Owner := Component.Owner;

        if Owner is TForm then

          Result := Format('%s.%s', [Owner.ClassName, Result]);

      end;

    end;

  end

  else Result := '';

end;


GetDefaultSection example
Example

 var

   Ini: TIniFile;

   Sect: string;

 begin

   ...

   Sect := GetDefaultSection(Bevel1);

   with Bevel1 do begin

     Ini.WriteInteger(Sect, 'Shape', Integer(Bevel1.Shape));

     Ini.WriteInteger(Sect, 'Width', Bevel1.Width);

   end;

 end;


GetUniqueFileNameInDir Function

Examples

Unit

AppUtils

Declaration

function GetUniqueFileNameInDir(const Path, FileNameMask: string): string;

Description

Возвращает уникальное для заданного каталога имя файла, формируемое с помощью указанной маски. Маска ДОЛЖНА содержать %d.


GetUniqueFileNameInDir example
Example

FileName := GetUniqueFileNameInDir('C:\TEMP', 'file%d.tmp');


InstantiateForm Function

Examples

Unit

AppUtils

Declaration

function InstantiateForm(FormClass: TFormClass; var Reference): TForm;

Description

Если переданное значение Reference равно nil, то функция создает экземпляр формы типа FormClass, помещая ссылку на созданный экземпляр в Reference. Если переданное значение Reference не равно nil, то новый экземпляр не создается. Как результат функция возвращает Reference.


InstantiateForm example
Example

with InstantiateForm(TMyForm, MyForm) do

  ShowModal;


ReadFormPlacement Procedure

Examples

Unit

AppUtils

Declaration

procedure ReadFormPlacement(Form: TForm; IniFile: TIniFile; const Section: string; LoadState, LoadPosition: Boolean);

Description

Процедура ReadFormPlacement используется для восстановления состояния формы, задаваемой параметром Form с помощью установок из INI-файла, который задается параметром IniFile. Для сохраненения установок предполагается использовать процедуру WriteFormPlacement или SaveFormPlacement. Если параметр LoadState равен True, то восстанавливается состояние формы (нормальное, максимизированное или минимизированное); если параметр LoadPosition равен True, то восстанавливаются также расположение формы и ее размеры в каждом из состояний(нормальном, максимизированном или минимизированном).

Процедура аналогична процедуре RestoreFormPlacement, только вместо имени INI-файла ReadFormPlacement требует в качестве параметра созданный объект класса TIniFile. Процедура может использоваться для форм с любым стилем (fsNormal, fsMDIChild, fsMDIForm,...).


ReadFormPlacement example
Example

 ReadFormPlacement(MyMDIChildForm, IniFile, MyMDIChildForm.ClassName,

   True, False);


ReadFormPlacementReg Procedure

Examples

Unit

AppUtils

Declaration

procedure ReadFormPlacementReg(Form: TForm; IniFile: TRegIniFile; const Section: string; LoadState, LoadPosition: Boolean);

Description

Функция полностью аналогична ReadFormPlacement, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).


ReadFormPlacementReg example
Example

 ReadFormPlacementReg(MyMDIChildForm, RegIniFile, MyMDIChildForm.ClassName,

   True, False);


RestoreFormPlacement Procedure

Examples

Unit

AppUtils

Declaration

procedure RestoreFormPlacement(Form: TForm; const IniFileName: string);

Description

В 32-разрядной версии синтаксис процедуры изменен и выглядит так:

 procedure RestoreFormPlacement(Form: TForm; const IniFileName: string; UseRegistry: Boolean);

ВНИМАНИЕ За исключением особых случаев вместо прямого вызова процедур SaveFormPlacement и RestoreFormPlacement предлагается использовать компоненту TFormPlacement. Вам достаточно поместить ее в форму - остальное она сделает сама в нужное время.

Процедура RestoreFormPlacement используется для восстановления состояния формы, задаваемой параметром Form с помощью установок из INI-файла с именем IniFileName.

Для сохраненения установок предполагается использовать функцию SaveFormPlacement. Восстанавливается расположение формы, ее состояние (нормальное, максимизированное или минимизированное), а также ее размеры в каждом из этих состояний.

Процедура может использоваться для форм с любым стилем (fsNormal, fsMDIChild, fsMDIForm,...).


RestoreFormPlacement example
Example

 RestoreFormPlacement(MyForm, GetDefaultIniName);


RestoreGridLayout Procedure

Examples

Unit

AppUtils

Declaration

procedure RestoreGridLayout(Grid: TCustomGrid; IniFile: TIniFile);

Description

Восстанавливает из INI-файла ширины колонок компонент, порожденных от TCustomGrid (TStringGrid, TDrawGrid, TRxDrawGrid и любых других классов-наследников). Значения должны быть предварительно сохранены в INI-файле с помощью процедуры SaveGridLayout. Вы можете вызывать эти процедуры в обработчиках событий OnSavePlacement и OnRestorePlacement компонент TFormPlacement, TFormStorage.


RestoreGridLayout example
Example

RestoreGridLayout(DrawGrid1, Placement.IniFile);


RestoreGridLayoutReg Procedure

Examples

Unit

AppUtils

Declaration

procedure RestoreGridLayoutReg(Grid: TCustomGrid; IniFile: TRegIniFile);

Description

Функция полностью аналогична RestoreGridLayout, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).


RestoreGridLayoutReg example
Example

RestoreGridLayoutReg(DrawGrid1, Placement.RegIniFile);


RestoreMDIChildren Procedure

Examples

Unit

AppUtils

Declaration

procedure RestoreMDIChildren(MainForm: TForm; IniFile: TIniFile);

Description

Создает и показывает MDIChild-формы такими и в таком составе, как они были сохранены SaveMDIChildren.

Классы MDIChild-форм должны быть зарегистрированы с помощью процедуры RegisterClasses или RegisterClass.


RestoreMDIChildren example
Example

RestoreMDIChildren(MainForm, IniFile);

...

initialization

  RegisterClasses([TChildForm1, TChildForm2]);

end.


RestoreMDIChildrenReg Procedure

Examples

Unit

AppUtils

Declaration

procedure RestoreMDIChildrenReg(MainForm: TForm; IniFile: TRegIniFile);

Description

Функция полностью аналогична RestoreMDIChildren, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).

Классы MDIChild-форм должны быть зарегистрированы с помощью процедуры RegisterClasses или RegisterClass.


RestoreMDIChildrenReg example
Example

RestoreMDIChildrenReg(MainForm, RegIniFile);

...

initialization

  RegisterClasses([TChildForm1, TChildForm2]);

end.


SaveFormPlacement Procedure

Examples

Unit

AppUtils

Declaration

procedure SaveFormPlacement(Form: TForm; const IniFileName: string);

Description

В 32-разрядной версии синтаксис процедуры изменен и выглядит так:

procedure SaveFormPlacement(Form: TForm; const IniFileName: string; UseRegistry: Boolean);

ВНИМАНИЕ

За исключением особых случаев вместо прямого вызова процедур SaveFormPlacement и RestoreFormPlacement предлагается использовать компоненту TFormPlacement. Вам достаточно поместить ее в форму - остальное она сделает сама в нужное время.

Процедура SaveFormPlacement используется для сохранения состояния формы, задаваемой параметром Form, в INI-файле с именем IniFileName. Сохраняется расположение формы, ее состояние (нормальное, максимизированное или минимизированное), а также ее размеры в каждом из этих состояний. Запись производится в секцию с именем Form.ClassName.


SaveFormPlacement example
Example

 SaveFormPlacement(MyForm, GetDefaultIniName);


SaveGridLayout Procedure

Examples

Unit

AppUtils

Declaration

procedure SaveGridLayout(Grid: TCustomGrid; IniFile: TIniFile);

Description

Сохраняет в INI-файле ширины колонок компонент, порожденных от TCustomGrid (TStringGrid, TDrawGrid и любых других классов-наследников). Используется в паре с RestoreGridLayout для последующего восстановления. Вы можете вызывать эти процедуры в обработчиках событий OnSavePlacement и OnRestorePlacement компонент TFormPlacement, TFormStorage.


SaveGridLayout example
Example

SaveGridLayout(DrawGrid1, Placement.IniFile);


SaveGridLayoutReg Procedure

Examples

Unit

AppUtils

Declaration

procedure SaveGridLayoutReg(Grid: TCustomGrid; IniFile: TRegIniFile);

Description

Функция полностью аналогична SaveGridLayout, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).


SaveGridLayoutReg example
Example

SaveGridLayoutReg(DrawGrid1, Placement.RegIniFile);


SaveMDIChildren Procedure

Examples

Unit

AppUtils

Declaration

procedure SaveMDIChildren(MainForm: TForm; IniFile: TIniFile);

Description

Сохраняет в INI-файле состав и свойства открытых MDIChild форм. Используется в паре с RestoreMDIChildren.

Классы MDIChild-форм должны быть зарегистрированы с помощью процедуры RegisterClasses или RegisterClass.


SaveMDIChildren example
Example

SaveMDIChildren(MainForm, IniFile);


SaveMDIChildrenReg Procedure

Examples

Unit

AppUtils

Declaration

procedure SaveMDIChildrenReg(MainForm: TForm; IniFile: TRegIniFile);

Description

Функция полностью аналогична SaveMDIChildren, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).

Классы MDIChild-форм должны быть зарегистрированы с помощью процедуры RegisterClasses или RegisterClass.


SaveMDIChildrenReg example
Example

SaveMDIChildrenReg(MainForm, RegIniFile);


ShowDialog Function

Examples

Unit

AppUtils

Declaration

function ShowDialog(FormClass: TFormClass): Boolean;

Description

Создание и модальное исполнение диалога. Использование аналогично функции FindShowForm, однако диалоговая форма класса FormClass всегда создается и освобождается при вызове функции ShowDialog.

Функция возвращает True, если исполнение диалога закончилось с результатом mrOk или mrYes.


ShowDialog example
Example

var

  Ok: Boolean;

begin

  Ok := ShowDialog(TAboutDlg);

end;


WriteFormPlacement Procedure

Examples

Unit

AppUtils

Declaration

procedure WriteFormPlacement(Form: TForm; IniFile: TIniFile; const Section: string);

Description

Процедура WriteFormPlacement используется для сохранения состояния формы, задаваемой параметром Form, в INI-файле.

Объект класса TIniFile передается в качестве параметра IniFile. Сохраняется расположение формы, ее состояние (нормальное, максимизированное или минимизированное), а также ее размеры в каждом из этих состояний. Запись производится в секцию с именем Section.

Процедура аналогична процедуре SaveFormPlacement, только вместо имени INI-файла WriteFormPlacement требует в качестве параметра созданный объект класса TIniFile.


WriteFormPlacement example
Example

 WriteFormPlacement(MyForm, IniFile, MyForm.ClassName);


WriteFormPlacementReg Procedure

Examples

Unit

AppUtils

Declaration

procedure WriteFormPlacementReg(Form: TForm; IniFile: TRegIniFile; const Section: string);

Description

Функция полностью аналогична WriteFormPlacement, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).


WriteFormPlacementReg example
Example

 WriteFormPlacementReg(MyForm, RegIniFile, MyForm.ClassName);


BdeUtils Unit

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 BdeUtils unit:

Components and objects

TDBLocate

Procedures and functions

AsyncQrySupported

CheckOpen

ConvertStringToLogicType

CurrentRecordDeleted

DataSetFindValue

DataSetPositionStr

DataSetRecNo

DataSetShowDeleted

DeleteRange

ExecuteQuery

ExportDataSet

FetchAllRecords

FieldLogicMap

GetAliasPath

GetBDEDirectory

InitRSRun

IsBookmarkStable

PackTable

RestoreIndex

SetIndex

SetToBookmark

TransActive

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


TDBLocate object
TDBLocate Class

Hierarchy             See also             Properties             Methods

Unit

BdeUtils

Description

Класс TDBLocate является наследником TLocateObject и предназначен для позиционирования набора данных на запись, соответствующую заданному условию, при работе с данными через BDE. Единственный метод этого класса - функция Locate, в которую вы можете передать имя любого поля из набора данных, заданного свойством DataSet, и значение этого поля. Набор данных будет позиционирован на первую запись, удовлетворяющую этому условию.

Поиск производится по следующему алгоритму: если набор данных является таблицей и имеет индекс по тому полю, на которое накладывается условие, то используется этот индекс. Если же свойство IndexSwitch имеет значение False, то индекс будет использоваться только в том случае, если таблица уже открыта по этому индексу; переключения индексов производится не будет. При этом объект класса TLocateObject заботится о сохранении и восстановлении значений свойств IndexFieldNames, IndexName и MasterSource набора данных. Если индекса нет, либо набор данных не является таблицей, то происходит наложение фильтра на таблицу с помощью вызова функций BDE. Если же набор данных не является наследником TDBDataSet и не поддерживает функций фильтрации (например, TDatabaseList), то поиск проводится простым перебором записей.


TDBLocate See Also
See also

TDataSet

TLocateObject

TQuery

TTable


TDBLocate Hierarchy
Hierarchy

TObject

  |

TLocateObject


TDBLocate properties
Properties

Run-time only    [image] Key properties

DataSet	IndexSwitch


TDBLocate methods
Methods

Key methods

Create	Destroy	Locate


TDBLocate.DataSet
DataSet Property

Applies to

TDBLocate component

Declaration

property DataSet: TDataSet;

Description

Свойство DataSet задает набор данных (таблицу или результат запроса), в котором будет производиться поиск при вызове метода Locate.


AsyncQrySupported Function

Examples

Unit

BdeUtils

Declaration

function AsyncQrySupported(Database: TDatabase): Boolean;

Description

Функция AsyncQrySupported возвращает True, если драйвер специфицированной базы данных Database поддерживает асинхронное выполнение запросов. В 32-битной версии Delphi Вы можете в этом случае прервать выполнение длительного запроса в обработчике события TQuery.OnServerYield (например, если запрос выполняется в отдельном потоке).

Если AsyncQrySupported возвращает False, то сервер не поддерживает асинхронное выполнение запросов, и событие OnServerYield не будет вызываться по ходу выполнения запроса.


AsyncQrySupported example
Example

Если запрос выполнеяется в отдельном потоке, то Вы можете установить обработчик события OnServerYield, который прерывает выполнение запроса, если пользователь выбрал соответствующий пункт в меню. Вы можете сделать этот пункт меню видимым или невидимым при старте запроса:

  CancelQueryItem.Visible := AsyncQrySupported(Database);


CheckOpen Function

Examples

Unit

BdeUtils

Declaration

function CheckOpen(Status: DBIResult): Boolean;

Description

Функция служит для обрамления вызовов функций BDE API, открывающих курсоры. Вызывает DbiError в случае любых ошибок, кроме ошибки, вызванной отсутствием в текущей сессии пароля на открытие таблицы. В этом же случае вызывает появление диалога PasswordDialog для ввода пароля к таблице.


CheckOpen example
Example

function TFieldList.CreateHandle: HDBICur;

var

  STableName: PChar;

begin

  STableName := StrAlloc(Length(FTableName) + 1);

  try

    while not CheckOpen(DbiOpenFieldList(DBHandle, AnsiToNative(DBLocale,

      FTableName, STableName, Length(FTableName)), nil, False, Result)) do

      {Retry};

  finally

    StrDispose(STableName);

  end;

end;


ConvertStringToLogicType Procedure

Examples

Unit

BdeUtils

Declaration

procedure ConvertStringToLogicType(Locale: TLocale; FldLogicType: Integer; FldSize: Word; const FldName, Value: String; Buffer: Pointer);

Description

Процедура предназначена для конвертации строки Value в значение, соответствующее логическому типу данных BDE, переданному как параметр FldLogicType (константы, определяющие логические типы данных BDE, определены в модуле DbiTypes). Значение, передаваемое в качестве этого параметра, можно получить с помощью функции FieldLogcMap. Сконвертированное значение будет помещено по адресу, заданному параметром Buffer. Вы должны выделить необходимое количество памяти (не меньшее FldSize) для параметра Buffer.


ConvertStringToLogicType example
Example

 var

   DataSet: TDataSet;

   Fld: TField;

   Buffer: Pointer;

   FldName: string;

 begin

   ...

   Fld := DataSet.FieldByName(FldName);

   GetMem(Buffer, Fld.DataSize);

   try

     ConvertStringToLogicType(DataSet.Locale, FieldLogicMap(Fld.DataType),

       Fld.DataSize, FldName, Value, Buffer);

     { use the value in Buffer }

   finally

      FreeMem(Buffer, Fld.DataSize);

   end;

 end;


CurrentRecordDeleted Function

Examples

Unit

BdeUtils

Declaration

function CurrentRecordDeleted(DataSet: TBDEDataSet): Boolean;

Description

Функция определяет, является ли текущая запись набора данных удаленной (помеченной как удаленная) или нет. Имеет смысл при включенном режиме просмотра удаленных записей с помощью процедуры DataSetShowDeleted.


CurrentRecordDeleted example
Example

if CurrentRecordDeleted(Table1) then

begin

  { undelete record }

end;


DataSetFindValue Function

Examples

Unit

BdeUtils

Declaration

function DataSetFindValue(DataSet: TDataSet; const Value, FieldName: string): Boolean;

Description

Функция пытается установить набор данных, переданный в качестве параметра DataSet, на первую от начала запись, удовлетворяющую заданному условию. Условие задается для поля с именем FieldName путем передачи в функцию параметра Value - строкового представления искомого значения поля.


DataSetFindValue example
Example

 var

   DataSet: TDataSet;

   FieldName: string;

   Found: Boolean;

 begin

   ...

   Found := DataSetFindValue(DataSet, DataSet.FieldByName(FieldName).AsString,

     FieldName);

   if not Found then

     MessageDlg('Record not found', mtError, [mbOk], 0);

 end;


DataSetPositionStr Function

Examples

Unit

BdeUtils

Declaration

function DataSetPositionStr(DataSet: TDataSet): string;

Description

Для драйверов DBase и Paradox функция возвращает строку, содержащую текущий номер записи и полное число записей в DataSet в формате

 <номер_записи> : <число_записей>.

Для других драйверов БД функция возвращает пустую строку.


DataSetPositionStr example
Example

procedure TMDIChild.DataSource1DataChange(Sender: TObject; Field: TField);

begin

  Panel1.Caption := DataSetPositionStr(DataSource1.DataSet);

end;


DataSetRecNo Function

Examples

Unit

BdeUtils

Declaration

function DataSetRecNo(DataSet: TDataSet): Longint;

Description

Функция возвращает номер текущей записи в DataSet. Для драйвера DBase - физический номер записи; для драйвера Paradox - логический номер записи; для остальных драйверов БД функция возвращает значение 0.


DataSetRecNo example
Example

  RecNo := DataSetRecNo(Table1);


DataSetShowDeleted Procedure

Examples

Unit

BdeUtils

Declaration

procedure DataSetShowDeleted(DataSet: TBDEDataSet; Show: Boolean);

Description

Процедура устанавливает режим показа удаленных записей в таблицах формата DBase.


DataSetShowDeleted example
Example

  DataSetShowDeleted(Table1, True);


DeleteRange Procedure

Examples

Unit

BdeUtils

Declaration

procedure DeleteRange(Table: TTable; IndexFields: array of const; FieldValues: array of const);

Description

Удаление диапазона записей из таблицы.

Сначала устанавливается индекс в IndexFields, разделенные точкой с запятой. Затем вызывается SetRange с параметром FieldValues. Удаляются все записи диапазона. Отменяется установка диапазона CancelRange. Переключается на прежний индекс.


DeleteRange example
Example

DeleteRange(Table1, ['ORDER_ID', 'CUSTOMER_NO'], [1, 255]);


ExecuteQuery Procedure

Examples

Unit

BdeUtils

Declaration

procedure ExecuteQuery(const DbName, QueryText: string);

Description

Процедура предназначена для выполнения SQL-запросов. Создает объект класса TQuery, передает ему в качестве текста запроса QueryText и выполняет его с помощью метода ExecSQL.


ExecuteQuery example
Example

ExecuteQuery('DBDEMOS',

  'DELETE FROM CUSTOMER WHERE CustNo = 2135');


ExportDataSet Procedure

Examples

Unit

BdeUtils

Declaration

procedure ExportDataSet(Source: TDataSet; DestTable: TTable; TableType: TTableType; const AsciiCharSet: string; AsciiDelimited: Boolean; MaxRecordCount: Longint);

Description

Процедура служит для экспорта данных из таблицы БД или результата запроса Source в выходную таблицу DestTable. Если выходная таблица DestTable уже существует, она будет переписана и ее структура будет изменена. У выходной таблицы DestTable должно быть определено свойство TableName. Если свойство TableType у нее не равно ttDefault, а значение параметра процедуры TableType = ttDefault, то используется соотвутствующее значение свойства компоненты DestTable.

В большинстве случаев для экспорта данных из TDataSet Вы можете воспользоваться компонентой TBatchMove со значением свойства Mode = batCopy, однако эта процедура предоставляет некоторые дополнительные возможности. Если Вы экспортируете данные в текстовый формат (ASCII), то TBatchMove всегда создает выходную таблицу в фиксированном формате ("Fixed") c языковым драйвером "ascii", при этом в случае наличия BLOB-полей в исходном наборе данных Вы обязательно должны задать свойство Mappings, т.к. ASCII-драйвер не поддерживает BLOB-полей. При использовании же этой функции Вам не надо задавать ограничений на поля - при экспорте в выходную таблицу будут записаны все поля, свойство Visible у которых равно True, и которые допустимы для использования в выходном формате ASCII. Кроме того, Вы можете задать использование вместо фиксированного ("Fixed") формата ASCII формата с разделителями ("Varying" или "Delimited") с помощью параметра AsciiDelimited, а также используемый в выходной ASCII-таблице набор символов (языковой драйвер) с помощью параметра AsciiCharSet. В случае, если формат выходной таблицы не совпадает с ttASCII, то значение двух предпоследних параметров процедуры игнорируется. Имя языкового драйвера совпадает с именем, которое можно получить, воспользовавшись функцией DbiOpenLdList или компонентой из библиотеки RX TLangDrivList. В 16-битной версии BDE это имя также совпадает с именем файла языкового драйвера (файлы с расширением .LD). Последний параметр MaxRecordCount определяет, сколько записей будет выгружено процедурой в выходной файл. Значение 0 задает вывод всех записей исходного набора данных, начиная от первой, значение, отличное от 0 - вывод не более MaxRecordCount записей, начиная от текущей позиции в исходном наборе данных.


ExportDataSet example
Example

var

  SourceDataSet: TDataSet;

  DestName, CharSet: string;

begin

  {...}

  if (SourceDataSet <> nil) then begin

    if SourceDataSet.Active then

      SourceDataSet.CheckBrowseMode;

    if (SourceDataSet is TTable) then

      DestName := ExtractFileName(TTable(SourceDataSet).TableName)

    else begin

      if not SourceDataSet.Active then DBError(SDataSetClosed);

      DestName := 'Query';

    end;

    DestName := ChangeFileExt(DestName, '.TXT');

  end;

  DestTable.TableName := DestName;

  ExportDataSet(SourceDataSet, DestTable, ttASCII, 'db866ru0', True, 0);

  MessageDlg(Format('Table %s successfully created.', [DestTable.TableName]),

    mtInformation, [mbOk], 0);

end;


FetchAllRecords Procedure

Examples

Unit

BdeUtils

Declaration

procedure FetchAllRecords(DataSet: TDataSet);

Description

The FetchAllRecords procedure, when used with a query against a server database, forces the server to release all intermediate locks and reads the entire result set. In Delphi 2.x, use TDataset.FetchAll method instead.


FetchAllRecords example
Example

  Query1.Open;

  try

    FetchAllRecords(Query1);

    { working with query result set }

  finally

    Query1.Close;

  end;


FieldLogicMap Function

Examples

Unit

BdeUtils

Declaration

function FieldLogicMap(FldType: TFieldType): Integer;

Description

Функция возвращает для конкретного значения FldType (которое можно получить для любого объекта класса TField через свойство TField.DataType) целочисленное значение, идентифицирующее логический тип данных BDE.


FieldLogicMap example
Example

 var

   I: Integer;

   Fld: TField;

 begin

   ...

   I := FieldLogicMap(Fld.DataType);

 end;


GetAliasPath Function

Examples

Unit

BdeUtils

Declaration

function GetAliasPath(const AliasName: string): string;

Description

Функция возвращает физический путь для алиаса (псевдонима) BDE, заданного как параметр AliasName. Для локальных БД это физический путь к таблицам, для серверных SQL-ориентрованных БД функция возвращает имя сервера.


GetAliasPath example
Example

  ...

  S := Format('Database path: %s', GetAliasPath(Database.AliasName));

  ...


GetBDEDirectory Function

Examples

Unit

BdeUtils

Declaration

function GetBDEDirectory: string;

Description

Функция возвращает имя каталога, в котором установлены библиотеки (DLL), относящиеся к BDE (Borland Database Engine).


GetBDEDirectory example
Example

ShowMessage(Format('BDI installed at %s', [GetBDEDirectory]));


InitRSRun Procedure

Examples

Unit

BdeUtils

Declaration

procedure InitRSRun(Database: TDatabase; const ConName: string; ConType: Integer; const ConServer: string);

Description

Инициализация RUNTIME ReportSmith.

Обновляет в файле rptsmith.con информацию о соединении, включая тип используемого IDAPI-драйвера, пути к таблицам и т.д.

ConName - имя соединения (connection), с которым вы создавали отчеты.Вместо ConName может быть передана пустая строка, что будет означать использование имени EXE-файла в качестве имени соединения.

ConType - тип драйвера для ReportSmith. Константы (например ctIDAPIDBase) определены в файле report.pas.

ConServer - например 'PARADOX', 'IBLOCAL'.


InitRSRun example
Example

procedure TMainForm.FormCreate(Sender: TObject);

begin

  InitRSRUN(Database, '', ctIDAPIParadox, 'PARADOX');

end;

Так как имя connection'а не указано (ConName = ''), то в качестве него будет использовано имя EXE-файла.


IsBookmarkStable Function

Examples

Unit

BdeUtils

Declaration

function IsBookmarkStable(DataSet: TDataSet): Boolean;

Description

Return True, if specified DataSet supports stable bookmarks. Stable bookmarks are those that remain unchanged after another user has modified the table. For example, return value is True for Paradox tables having a primary key, but False for Paradox heap tables.


IsBookmarkStable example
Example

 BM := Table1.GetBookmark;

 try

   {...}

   if IsBookmarkStable(Table1) then

     SetToBookmark(Table1, BM); { no exceptions raised }

 finally

   Table1.FreeBookmark(BM);

 end;


PackTable Procedure

Examples

Unit

BdeUtils

Declaration

procedure PackTable(Table: TTable);

Description

Процедура предназначена для "упаковки" таблиц формата DBase и Paradox (физического удаления записей, помеченных как удаленные и т.д.). Обрабатываемая таблица должна быть открыта в монопольном режиме (свойство Exclusive = True).


PackTable example
Example

PackTable(Table1);


RestoreIndex Procedure

Examples

Unit

BdeUtils

Declaration

procedure RestoreIndex(Table: TTable);

Description

Восстанавливает свойство IndexFieldNames у Table в значение, сохраненное при вызове SetIndex. Важно, чтобы вызовы SetIndex и RestoreIndex были парными.


RestoreIndex example
Example

SetIndex(Table1, 'NAME');

try

  ...

finally

  RestoreIndex(Table1);

end;


SetIndex Procedure

Examples

Unit

BdeUtils

Declaration

procedure SetIndex(Table: TTable; const IndexFieldNames: string);

Description

Устанавливает свойство IndexFieldNames у Table, сохраняя во внутреннем списке текущее значение свойства. Обязательно используйте обработку исключений:

  SetIndex(Table1, 'NAME');

  try

    ...

  finally

    RestoreIndex(Table1);

  end;

Важно, чтобы вызовы SetIndex и RestoreIndex были парными. Вложенные SetIndex обрабатываются корректно.


SetIndex example
Example

  SetIndex(Table1, 'NAME');

  try

    ...

  finally

    RestoreIndex(Table1);

  end;


SetToBookmark Function

Examples

Unit

BdeUtils

Declaration

function SetToBookmark(ADataSet: TDataSet; ABookmark: TBookmark): Boolean;

Description

Функция устанавливает ADataSet в позицию, соответствующую переданному значению ABookmark, аналогично методу TDataSet.GotoBookmark. ABookmark должна быть получена вызовом метода TDataSet.GetBookmark. Если свойство ADataSet.Active = False или ABookmark = nil, функция просто возвращает False.

В отличие от метода GotoBookmark не вызывает исключительную ситуацию (exception) при ошибке позиционирования курсора.

В случае успешного завершения возвращает True, иначе - False.


SetToBookmark example
Example

 BM := Table1.GetBookmark;

 try

   {...}

   SetToBookmark(Table1, BM); { no exceptions raised }

 finally

   Table1.FreeBookmark(BM);

 end;


TransActive Function

Examples

Unit

BdeUtils

Declaration

function TransActive(Database: TDatabase): Boolean;

Description

Функция определяет, имеет ли база данных Database активную транзакцию и в этом случае возвращает True, в противном случае результат - False.

В 32-битной версии, в отличие от обращения к свойству TDatabase.InTransaction, не изменяет текущую сессию BDE.


TransActive example
Example

if TransActive(Database) then

  Database.Commit;


BoxProcs Unit

The following items are declared in the BoxProcs unit:

Procedures and functions

BoxDragOver

BoxMoveAllItems

BoxMoveFocusedItem

BoxMoveSelectedItems

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


BoxDragOver Procedure

Examples

Unit

BoxProcs

Declaration

procedure BoxDragOver(List: TCustomListBox; Source: TObject; X, Y: Integer; State: TDragState; var Accept: Boolean; Sorted: Boolean);

Description

Предполагается вызывать из обработчика события OnDragOver.


BoxDragOver example
Example

procedure TMyForm.MyListDragOver(Sender, Source: TObject; X,

  Y: Integer; State: TDragState; var Accept: Boolean);

begin

  BoxDragOver(MyList, Source, X, Y, State, Accept, MyList.Sorted);

  if State = dsDragLeave then

    (Source as TListBox).DragCursor := crDrag;

  if (State = dsDragEnter) and ((Source as TListBox).SelCount > 1) then

    (Source as TListBox).DragCursor := crMultiDrag;

end;


BoxMoveAllItems Procedure

Examples

Unit

BoxProcs

Declaration

procedure BoxMoveAllItems(SrcList, DstList: TCustomListBox);

Description

Копирует все элементы SrcList в DstList, затем очищает SrcList.


BoxMoveAllItems example
Example

BoxMoveAllItems(DstList, SrcList);


BoxMoveFocusedItem Procedure

Examples

Unit

BoxProcs

Declaration

procedure BoxMoveFocusedItem(List: TCustomListBox; DstIndex: Integer);

Description

Предполагается использовать в обработчике события OnDragDrop.


BoxMoveFocusedItem example
Example

procedure TMyForm.SrcListDragDrop(Sender, Source: TObject; X,

  Y: Integer);

begin

  if Source = DstList then ExclBtnClick(SrcList)

  else

    if Source = SrcList then begin

      BoxMoveFocusedItem(SrcList, SrcList.ItemAtPos(Point(X, Y), True));

    end;

end;


BoxMoveSelectedItems Procedure

Examples

Unit

BoxProcs

Declaration

procedure BoxMoveSelectedItems(SrcList, DstList: TCustomListBox);

Description

Перемещает выделенные элементы из SrcList в DstList


BoxMoveSelectedItems example
Example

procedure TMyForm.IncBtnClick(Sender: TObject);

begin

  BoxMoveSelectedItems(SrcList, DstList);

end;


ClipIcon Unit

The following items are declared in the ClipIcon unit:

Constants

CF_ICON

Procedures and functions

AssignClipboardIcon

CopyIconToClipboard

CreateIconFromClipboard

CreateRealSizeIcon

DrawRealSizeIcon

GetIconSize

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


CF_ICON Constant

Unit

ClipIcon

Declaration

const

  CF_ICON: Word = 0;

Description

Константа служит для регистрации и описания формата, используемого буфером обмена (Clipboard). После инициализации модуля ClipIcon константа CF_ICON содержит значение, которое можно использовать для определения наличия в буфере данных в формате иконки Windows. Функция CopyIconToClipboard также помещает в Clipboard данные в формате CF_BITMAP.


AssignClipboardIcon Procedure

Examples

Unit

ClipIcon

Declaration

procedure AssignClipboardIcon(Icon: TIcon);

Description

Процедура заполняет иконку Icon данными из буфера обмена (Clipboard), если буфер содержит данные в формате CF_ICON. В противном случае процедура ничего не делает. Данные в формате CF_ICON можно поместить в буфер обмена с помощью функции CopyIconToClipboard.


AssignClipboardIcon example
Example

 begin

    {...}

    if Clipboard.HasFormat(CF_ICON) then

      AssignClipboardIcon(Application.Icon);

    {...}

 end;


CopyIconToClipboard Procedure

Examples

Unit

ClipIcon

Declaration

procedure CopyIconToClipboard(Icon: TIcon; BackColor: TColor);

Description

Функция помещает в Clipboard данные в формате CF_ICON из иконки, переданной в качестве параметра Icon. Одновременно в буфер обмена помещаются данные в формате CF_BITMAP, при этом "прозрачный" цвет у иконки заменяется на цвет, заданный в качестве параметра BackColor. Для извлечения данных в формате CF_ICON из буфера обмена служит функция CreateIconFromClipboard.


CopyIconToClipboard example
Example

 var

   Icon: TIcon;

 begin

   ...

   CopyIconToClipboard(Icon, clBtnFace);

 end;


CreateIconFromClipboard Function

Examples

Unit

ClipIcon

Declaration

function CreateIconFromClipboard: TIcon;

Description

Функция создает объект класса TIcon, если буфер обмена (Clipboard) содержит данные в формате CF_ICON. В противном случае функция возвращает NIL-указатель.  Данные в формате CF_ICON можно поместить в буфер обмена с помощью функции CopyIconToClipboard.


CreateIconFromClipboard example
Example

 var

   Icon: TIcon;

 begin

   ...

   Icon := CreateIconFromClipboard;

   try

     { using the icon }

   finally

     Icon.Free;

   end;

   ...

 end;


CreateRealSizeIcon Function

Examples

Unit

ClipIcon

Declaration

function CreateRealSizeIcon(Icon: TIcon): HIcon;

Description

Функция создает иконку из объекта Icon класса TIcon, возвращая ее обработчик HIcon, имеющую "реальные" размеры. (Класс TIcon всегда создает иконку с размерами SM_CXICON, SM_CYICON).

После использования обработчика иконки, возвращенного этой процедурой, Вы должны освободить его функцией Windows API DestroyIcon.

В 16-битной версии функция служит только в качестве "заглушки" и возвращает иконку, всегда имеющую размеры SM_CXICON, SM_CYICON.


CreateRealSizeIcon example
Example

var

  Ico: HIcon;

begin

  Ico := CreateRealSizeIcon(Form1.Icon);

  try

    { ... }

  finally

    DestroyIcon(Ico);

  end;

end;


DrawRealSizeIcon Procedure

Examples

Unit

ClipIcon

Declaration

procedure DrawRealSizeIcon(Canvas: TCanvas; Icon: TIcon; X, Y: Integer);

Description

Функция рисует иконку Icon на устройстве Canvas, используя (в 32-битной версии) "реальные" размеры иконки. (Класс TIcon всегда создает и рисует иконку с размерами SM_CXICON, SM_CYICON).

Примечание

В 16-битной версии функция служит только в качестве "заглушки" и всегда изображает иконку, имеющую размеры SM_CXICON, SM_CYICON.


DrawRealSizeIcon example
Example

  DrawRealSizeIcon(Canvas, Icon, 0, 0);


GetIconSize Procedure

Examples

Unit

ClipIcon

Declaration

procedure GetIconSize(Icon: HICON; var W, H: Integer);

Description

Процедура возвращает в аргументах W и H соответственно ширину и высоту иконки, заданной обработчиком Icon типа hIcon.

В 32-битной версии возвращает реальный размер иконки, в 16-битной версии служит только в качестве "заглушки" и возвращает размеры, соответствующие SM_CXICON, SM_CYICON.


GetIconSize example
Example

 GetIconSize(Icon.Handle, W, H);


ClipView Unit

The ClipView unit contains the declarations for the certain components on the RX Tools 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 ClipView unit:

Components and objects

TClipboardViewer

Types

TClipboardViewFormat

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


TClipboardViewer Component

Hierarchy             See also             Properties             Methods             Events

Unit

ClipView

Description

Компонента TClipboardViewer предназначена для отображения содержимого буфера обмена Windows (Clipboard) в ваших формах. Текущее содержимое буфера обмена может быть представлено в форматах, определенных типом TClipboardViewFormat.

Вы можете изменить текущий формат отображения данных Clipboard с помощью свойства ViewFormat. Индексированное свойство ClipboardFormatNames[Index: Integer] (run-time and read only) служит для определения строковых имен зарегистрированных форматов Clipboard.

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

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


TClipboardViewer See Also
See also

TClipboard


TClipboardViewer Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TScrollingWinControl

  |

TScrollBox

  |

TCustomClipboardViewer


TClipboardViewer properties
Properties

Run-time only    [image] Key properties

Align	Font	ParentShowHint
ClipboardFormatNames	Height	PopupMenu
Color	HelpContext	ShowHint
ComponentCount	Hint	Showing
ComponentIndex	Left	TabOrder
Components	Name	TabStop
Ctl3D	Owner	Tag
Cursor	Parent	Top
DragCursor	ParentColor	ViewFormat
DragMode	ParentCtl3D	Visible
Enabled	ParentFont	Width


TClipboardViewer events
Events

Run-time only    [image] Key events

OnChange	OnDragOver	OnMouseDown
OnClick	OnEndDrag	OnMouseMove
OnDblClick	OnEnter	OnMouseUp
OnDragDrop	OnExit	OnStartDrag


TClipboardViewer methods
Methods

Key methods

BeginDrag	EndDrag	Repaint
BringToFront	FindComponent	ScreenToClient
CanDrawFormat	Hide	SendToBack
ClientToScreen	InsertComponent	SetBounds
Create	Invalidate	SetFocus
Destroy	Refresh	Show
Dragging	RemoveComponent	Update


ClipboardFormatNames[Index: Integer]
ClipboardFormatNames Property

Applies to

TClipboardViewer component

Declaration

property ClipboardFormatNames[Index: Integer]: string;

Description

Индексированное свойство ClipboardFormatNames (только для чтения) служит для определения текстовых имен доступных форматов буфера обмена. Целочисленное значение Index соответствует индексу свойства Formats класса TClipboard и может изменяться в пределах от 0 до значения свойства FormatCount класса TClipboard.

Значения этого свойства могут быть вами использованы, например, для вывода в меню доступных для отображения форматов Clipboard (совместно со значениями, возвращаемыми функцией класса CanDrawFormat).


ViewFormat
ViewFormat Property

Applies to

TClipboardViewer component

Declaration

property ViewFormat: TClipboardViewFormat;

Description

Свойство определяет текущий формат отображения данных буфера обмена в компоненте TClipboardViewer. В случае установки этого свойства в значение, недопустимое для текущего содержимого буфера обмена, содержимое Clipboard отображается в допустимом формате "по умолчанию".


TClipboardViewer.OnChange
OnChange Event

Applies to

TClipboardViewer component

Declaration

property OnChange: TNotifyEvent;

Description

Событие OnChange происходит при изменении содержимого буфера обмена (Clipboard). Вы можете использовать обработчик этого события для задания необходимого вам формата отображения данных (свойство ViewFormat) в компоненте TClipboardViewer.


CanDrawFormat
CanDrawFormat Method

Applies to

TClipboardViewer component

Declaration

class function CanDrawFormat(ClipboardFormat: Word): Boolean;

Description

Функция класса возвращает True, если формат буфера обмена, заданный параметром ClipboardFormat, может быть отображен компонентой TClipboardViewer, и False в противном случае.


TClipboardViewFormat Type

Unit

ClipView

Declaration

type

TClipboardViewFormat = (cvDefault, cvEmpty, cvUnknown, cvText, cvBitmap, cvMetafile, cvPalette, cvOemText, cvPicture, cvComponent, cvIcon);

Description

Тип используется компонентой TClipboardViewer для задания формата отображения текущих данных, содержащихся в буфере обмена.


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

TRxCalcEdit

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


TCurrencyEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

CurrEdit

Description

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

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


TCurrencyEdit See Also
See also

TComboEdit

TEdit

TMaskEdit

TRxCalcEdit

TRxDBCalcEdit


TCurrencyEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit

  |

TCustomNumEdit


TCurrencyEdit properties
Properties

Run-time only    [image] Key properties

Alignment	Enabled	ParentShowHint
AsInteger	Font	PopupMenu
AutoSelect	FormatOnEditing	ReadOnly
AutoSize	Height	ShowHint
BeepOnError	HelpContext	Showing
BorderStyle	HideSelection	TabOrder
CheckOnExit	Hint	TabStop
ComponentCount	Left	Tag
ComponentIndex	MaxValue	Text
Components	MinValue	Top
Cursor	Name	Value
DecimalPlaces	Owner	Visible
DisplayFormat	Parent	Width
DisplayText	ParentColor	ZeroEmpty
DragCursor	ParentCtl3D
DragMode	ParentFont


TCurrencyEdit events
Events

Run-time only    [image] Key events

OnChange	OnEndDrag	OnKeyUp
OnClick	OnEnter	OnMouseDown
OnDblClick	OnExit	OnMouseMove
OnDragDrop	OnKeyDown	OnMouseUp
OnDragOver	OnKeyPress	OnStartDrag


TCurrencyEdit methods
Methods

Key methods

BeginDrag	GetTextBuf	ScreenToClient
BringToFront	GetTextLen	SelectAll
Clear	Hide	SendToBack
ClientToScreen	InsertComponent	SetBounds
CopyToClipboard	Invalidate	SetFocus
Create	PasteFromClipboard	SetTextBuf
CutToClipboard	Perform	Show
Destroy	Refresh	Update
EndDrag	RemoveComponent
FindComponent	Repaint


AsInteger
AsInteger Property

Applies to

TRxSpinEdit, TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property AsInteger: Longint;

Description

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


BeepOnError
BeepOnError Property

Applies to

TRxDBCalcEdit, TRxCalculator, TRxCalcEdit, TCurrencyEdit components

Declaration

property BeepOnError: Boolean;

Description

Если значение этого свойства установлено в True (по умолчанию False), то при ошибках ввода с клавиатуры (недопустимых символов и т.д.) раздается звуковой сигнал.


DecimalPlaces
DecimalPlaces Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property DecimalPlaces: Word;

Description

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


DisplayFormat
DisplayFormat Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property DisplayFormat: string;

Description

Свойство задает формат отображения данных в компоненте TCurrencyEdit, TRxCalcEdit. При получении компонентой фокуса ввода форматирование данных отменяется и ввод происходит как в обычную строку ввода TEdit. При потере фокуса ввода данные форматируются согласно заданному формату.


DisplayText
DisplayText Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property DisplayText: string;

Description

Свойство служит для доступа на чтение к форматированному в соответствии со значением DisplayFormat представлению значения Value (совпадает с отображаемой строкой в компоненте, когда элемент редактирования не имеет фокуса ввода). В отличие от этого свойства, свойство Text всегда возвращает неформатированную строку.


FormatOnEditing
FormatOnEditing Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property FormatOnEditing: Boolean;

Description

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

Формат ввода определяется переменными DecimalSeparator и ThousandSeparator из модуля SysUtils.pas и свойством DecimalPlaces.


MaxValue
MaxValue Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property MaxValue: Extended;

Description

Максимально допустимое значение свойства Value. Значение MaxValue ограничивает максимальную величину числа, которое можно ввести в строку ввода.


MinValue
MinValue Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property MinValue: Extended;

Description

Минимально допустимое значение свойства Value. Значение MinValue ограничивает минимальную величину числа, которое можно ввести в строку ввода.


TCurrencyEdit.Value
Value Property

Applies to

TCurrencyEdit component

Declaration

property Value: Extended;

Description

Свойство позволяет установить (или получить) численную величину значения, отображаемого в строке ввода. В случае пустой строки возвращается значение 0.


ZeroEmpty
ZeroEmpty Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TCurrencyEdit components

Declaration

property ZeroEmpty: Boolean;

Description

Если значение этого свойства равно True, то когда редактор имеет фокус ввода и значение Value = 0, в нем с качестве текста отображается пустая строка. Если ZeroEmpty = False, то в этом случае текст '0'.


TRxCalcEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

CurrEdit

Description

Компонента служит для ввода и редактирования чисел и денежных сумм и имеет те же свойства и методы, что и TCurrencyEdit. Дополнительно TRxCalcEdit имеет кнопку с возможностью вызова простого popup-калькулятора, позволяющего произвести четыре арифметических действия. После проведения вычислений и закрытия калькулятора полученное значение заносится в строку ввода.

Если Вы не хотите использовать popup-калькулятор, установите свойство ButtonWidth в значение 0. Чтобы запретить прямой ввод в строку ввода, и оставить только возможность занести данные с помощью калькулятора, установите свойство DirectInput в значение False.

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

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


TRxCalcEdit See Also
See also

TCurrencyEdit

TRxCalculator

TRxDBCalcEdit


TRxCalcEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit

  |

TCustomNumEdit

  |

TRxCustomCalcEdit


TRxCalcEdit properties
Properties

Run-time only    [image] Key properties

Alignment	DisplayText	Parent
AsInteger	DragCursor	ParentColor
AutoSelect	DragMode	ParentCtl3D
AutoSize	Enabled	ParentFont
BeepOnError	Font	ParentShowHint
BorderStyle	FormatOnEditing	PopupAlign
ButtonHint	Glyph	PopupMenu
ButtonWidth	GlyphKind	ReadOnly
CheckOnExit	Height	ShowHint
ClickKey	HelpContext	Showing
Color	HideSelection	TabOrder
ComponentCount	Hint	TabStop
ComponentIndex	Left	Tag
Components	MaxLength	Text
Ctl3D	MaxValue	Top
Cursor	MinValue	Value
DecimalPlaces	Name	Visible
DirectInput	NumGlyphs	Width
DisplayFormat	Owner	ZeroEmpty


TRxCalcEdit events
Events

Run-time only    [image] Key events

OnButtonClick	OnEndDrag	OnMouseDown
OnChange	OnEnter	OnMouseMove
OnClick	OnExit	OnMouseUp
OnDblClick	OnKeyDown	OnStartDrag
OnDragDrop	OnKeyPress
OnDragOver	OnKeyUp


TRxCalcEdit methods
Methods

Key methods

BeginDrag	Dragging	Repaint
BringToFront	EndDrag	ScreenToClient
Clear	GetTextBuf	SelectAll
ClientToScreen	GetTextLen	SendToBack
CopyToClipboard	Hide	SetBounds
Create	Invalidate	SetFocus
CutToClipboard	PasteFromClipboard	SetTextBuf
Destroy	Perform	Show
DoClick	Refresh	Update


GlyphKind
GlyphKind Property

Applies to

TRxDBComboEdit, TRxDBCalcEdit, TRxCalcEdit, TFilenameEdit, TDirectoryEdit, TDBDateEdit, TDateEdit, TComboEdit components

Declaration

property GlyphKind: TGlyphKind;

Description

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


TRxCalcEdit.Value
Value Property

Applies to

TRxCalcEdit component

Declaration

property Value: Extended;

Description

Свойство позволяет установить (или получить) численную величину значения, отображаемого в строке ввода. В случае пустой строки возвращается значение 0.


DataConv Unit

The DataConv unit contains the declarations for the certain components on the RX Tools 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 DataConv unit:

Components and objects

TConverter

TDateTimeFormat

Types

TDataType

TTimeFormat

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


TConverter Component

Hierarchy             See also             Properties             Methods             Events

Unit

DataConv

Description

Компонента предназначена для организации доступа к данным в различных форматах представления и конвертации данных между разными форматами.

Аналогично компонентам-наследникам TField, класс TConverter имеет свойства AsBoolean, AsDate, AsDateTime, AsFloat, AsInteger, AsString и AsTime. Вы можете присвоить значение любому из этих свойств и затем получить любое допустимое представление тех же самых данных, считав значение одного из перечисленных свойств.

Присвоив значение, отличное от dtString, свойству DataType, вы можете контролировать правильность присвоения данных через любое свойство, не совпадающее по формату с указанным через DataType. Например, если

  DataType = dtInteger,

то при присвоении свойству AsString строкового значения, которое не может быть преобразовано в целое число, будет инициирована исключительная ситуация (exception). Если свойство RaiseOnError установлено в False, исключительной ситуации не будет.


TConverter See Also
See also

TDateTimeFormat


TConverter Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TConverter properties
Properties

Run-time only    [image] Key properties

AsBoolean	ComponentIndex	Name
AsDate	Components	Owner
AsDateTime	DataType	Precision
AsFloat	DateTimeFormat	RaiseOnError
AsInteger	Digits	Tag
AsString	DisplayFalse	Text
AsTime	DisplayTrue
ComponentCount	FloatFormat


TConverter events
Events

Run-time only    [image] Key events

OnChange


TConverter methods
Methods

Key methods

Clear	FindComponent	RemoveComponent
Create	InsertComponent
Destroy	IsValidChar


TConverter.AsBoolean
AsBoolean Property

Applies to

TConverter component

Declaration

property AsBoolean: Boolean;

Description

Свойство служит для преобразования данных. Доступно на этапе выполнения приложения (runtime-only).

Используется для чтения или установки данных в компонент класса TConverter в формате логического значения, представляемого в языке Pascal типом Boolean. При преобразовании данных логического типа в строку используются значения свойств DisplayFalse и DisplayTrue.


TConverter.AsDate
AsDate Property

Applies to

TConverter component

Declaration

property AsDate: TDateTime;

Description

Свойство служит для преобразования данных. Доступно на этапе выполнения приложения (runtime-only).

Используется для чтения или установки данных в компонент класса TConverter в формате даты, представляемого в языке Object Pascal типом TDateTime.


TConverter.AsDateTime
AsDateTime Property

Applies to

TConverter component

Declaration

property AsDateTime: TDateTime;

Description

Свойство служит для преобразования данных. Доступно на этапе выполнения приложения (runtime-only).

Используется для чтения или установки данных в компонент класса TConverter в формате даты и времени, представляемого в языке Object Pascal типом TDateTime.


TConverter.AsFloat
AsFloat Property

Applies to

TConverter component

Declaration

property AsFloat: Double;

Description

Свойство служит для преобразования данных. Доступно на этапе выполнения приложения (runtime-only).

Используется для чтения или установки данных в компонент класса TConverter в формате действительного числа, представляемого в языке Pascal типом Double.


TConverter.AsInteger
AsInteger Property

Applies to

TConverter component

Declaration

property AsInteger: Longint;

Description

Свойство служит для преобразования данных. Доступно на этапе выполнения приложения (runtime-only).

Используется для чтения или установки данных в компонент класса TConverter в формате целого числа, представляемого в языке Pascal типом Longint.


TConverter.AsString
AsString Property

Applies to

TConverter component

Declaration

property AsString: string;

Description

Свойство служит для преобразования данных. Доступно на этапе выполнения приложения (runtime-only).

Используется для чтения или установки данных в компонент класса TConverter в виде строки. Если свойство DataType установлено в значение, отличное от dtString, и свойство RaiseOnError установлено в True, то при присвоении значения свойству AsString, такого что это значение не может быть преобразовано к указанному типу, будет инициирована исключительная ситуация.


TConverter.AsTime
AsTime Property

Applies to

TConverter component

Declaration

property AsTime: TDateTime;

Description

Свойство служит для преобразования данных. Доступно на этапе выполнения приложения (runtime-only).

Используется для чтения или установки данных в компонент класса TConverter в формате времени, представляемого в языке Objetc Pascal типом TDateTime.


DataType
DataType Property

Applies to

TConverter component

Declaration

property DataType: TDataType;

Description

Свойство управляет "основным" на данный момент типом данных компоненты класса TCnverter. Значение, присваевоемое любому из свойств AsXXXX компоненты, будет проверяться на допустимость приведения к указанному типу, и в случае недопустимости такого приведения будет инициирована исключительная ситуация (exception). Подавить исключительную ситуацию при ошибках конвертации типов данных можно с помощью свойства RaiseOnError, установив его в значение False.


DateTimeFormat
DateTimeFormat Property

Applies to

TConverter component

Declaration

property DateTimeFormat: TDateTimeFormat;

Description

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


Digits
Digits Property

Applies to

TConverter component

Declaration

property Digits: Integer;

Description

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


TConverter.DisplayFalse
DisplayFalse Property

Applies to

TConverter component

Declaration

property DisplayFalse: string;

Description

Свойство задает строковое значение, в которое будет преобразована логическая величина, равная False, при чтении данных через свойство AsString. Аналогично срабатывает и обратное преобразование из строки в логическую величину.


TConverter.DisplayTrue
DisplayTrue Property

Applies to

TConverter component

Declaration

property DisplayTrue: string;

Description

Свойство задает строковое значение, в которое будет преобразована логическая величина, равная True, при чтении данных через свойство AsString. Аналогично срабатывает и обратное преобразование из строки в логическую величину.


FloatFormat
FloatFormat Property

Applies to

TConverter component

Declaration

property FloatFormat: TFloatFormat;

Description

Свойство управляет форматом преобразования чисел с плавающей точкой в строку.


TConverter.Precision
Precision Property

Applies to

TConverter component

Declaration

property Precision: Integer;

Description

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


RaiseOnError
RaiseOnError Property

Applies to

TConverter component

Declaration

property RaiseOnError: Boolean;

Description

Свойство позволяет подавить (при установке его значения в False) инициирование исключений (exceptions) при ошибках преобразования форматов данных. В этом случае ошибки преобразования приводят к получению "нулевых" данных из соответствующих свойств. Например, после присвоения значения 'ADAM SMITH' свойству AsString попытка получить данные из свойства AsInteger приведет к исключению, если RaiseOnError=True, либо к получению значения 0, если RaiseOnError=False.


TConverter.Text
Text Property

Applies to

TConverter component

Declaration

property Text: string;

Description

Свойство, доступное в режиме дизайна формы, и позволяющее задать данные компоненты класса TConverter в строковом формате. Аналогично присвоению значения свойству AsString.


TConverter.Clear
Clear Method

Applies to

TConverter component

Declaration

procedure Clear;

Description

Процедура "обнуляет" содержимое компоненты класса TConverter. Вызов ее аналогичен присвоению пустой строки свойствам Text или AsString.


TConverter.IsValidChar
IsValidChar Method

Applies to

TConverter component

Declaration

function IsValidChar(Ch: Char): Boolean; virtual;

Description

Метод позволяет проверить, являтся ли символ Ch допустимым при присвоении значения свойству AsString для установленного в настоящий момент значения свойства DataType.


TDateTimeFormat object
TDateTimeFormat Class

Hierarchy             See also             Properties             Methods

Unit

DataConv

Description

Класс предназначен для задания опций форматирования данных типа TDateTime. Используется компонентой TConverter.


TDateTimeFormat See Also
See also

TConverter

TDateTime


TDateTimeFormat Hierarchy
Hierarchy

TObject

  |

TPersistent


TDateTimeFormat properties
Properties

Run-time only    [image] Key properties

AMString	FourDigitYear	PMString
DateMask	LeadingZero	TimeFormat
DateOrder	LongDate	TimeMask
DateSeparator	Mask	TimeSeparator


TDateTimeFormat methods
Methods

Key methods

Assign	Destroy
Create	ResetDefault


AMString
AMString Property

Applies to

TDateTimeFormat component

Declaration

property AMString: string;

Description

Свойство задает строку для обозначения временных величин в диапазоне от 00:00 до 11:59 при 12-часовом формате времени. По умолчанию значение свойства совпадает с переменной TimeAMString модуля SysUtils.


TDateTimeFormat.DateMask
DateMask Property

Applies to

TDateTimeFormat component

Declaration

property DateMask: string;

Description

Строка, задающая формат вывода даты. Свойство только для чтения.


DateOrder
DateOrder Property

Applies to

TDateTimeFormat component

Declaration

property DateOrder: TDateOrder;

Description

Свойство задает порядок вывода компонент даты (день, месяц, год) при форматировании даты.


DateSeparator
DateSeparator Property

Applies to

TDateTimeFormat component

Declaration

property DateSeparator: Char;

Description

Символ, используемый как разделитель в строковом представлении даты. Значение по умолчанию совпадает с переменной DateSeparator модуля SysUtils.


FourDigitYear
FourDigitYear Property

Applies to

TDateTimeFormat component

Declaration

property FourDigitYear: Boolean;

Description

Свойство задает формат отображения года. При установке в True для представления года используется 4 символа (с указанием столетия), значение False определяет представление года в 2-символьном формате.


TDateTimeFormat.LeadingZero
LeadingZero Property

Applies to

TDateTimeFormat component

Declaration

property LeadingZero: Boolean;

Description

Specifies whether or not single digit month or day values have a leading zero. For example, if you enter "1/1/80" and this is set to TRUE, TDateTimeFormat interprets the date as "01/1/80." If FALSE, the value is "1/1/80." Default: TRUE.


LongDate
LongDate Property

Applies to

TDateTimeFormat component

Declaration

property LongDate: Boolean;

Description

Если значение этого свойства True, то для вывода имени месяца используется символьный формат (например, "Январь"), если False - то цифровой (например, "01.02.95").


TDateTimeFormat.Mask
Mask Property

Applies to

TDateTimeFormat component

Declaration

property Mask: string;

Description

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


PMString
PMString Property

Applies to

TDateTimeFormat component

Declaration

property PMString: string;

Description

Свойство задает строку для обозначения временных величин в диапазоне от 12:00 до 23:59 при 12-часовом формате времени. По умолчанию значение свойства совпадает с переменной TimePMString модуля SysUtils.


TimeFormat
TimeFormat Property

Applies to

TDateTimeFormat component

Declaration

property TimeFormat: TTimeFormat;

Description

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


TDateTimeFormat.TimeMask
TimeMask Property

Applies to

TDateTimeFormat component

Declaration

property TimeMask: string;

Description

Строка, задающая формат вывода времени. Свойство только для чтения.


TimeSeparator
TimeSeparator Property

Applies to

TDateTimeFormat component

Declaration

property TimeSeparator: Char;

Description

Символ, используемый как разделитель в строковом представлении времени. Значение по умолчанию совпадает с переменной TimeSeparator модуля SysUtils.


TDateTimeFormat.ResetDefault
ResetDefault Method

Applies to

TDateTimeFormat component

Declaration

procedure ResetDefault; virtual;

Description

Метод устанавливает все свойства объекта класса TDateTimeFormat в значения по умолчанию, свопадающие в большинстве случаев с установками среды Windows.


TDataType Type

Unit

DataConv

Declaration

type

TDataType = (dtString, dtInteger, dtFloat, dtDateTime, dtDate, dtTime, dtBoolean);

Description

Тип описывает допустимые типы данных для компоненты TConverter. Значения этого типа определяют возможные значения свойства DataType этой компоненты.


TTimeFormat Type

Unit

DataConv

Declaration

type

TTimeFormat = (tfHHMMSS, tfHMMSS, tfHHMM, tfHMM);

Description

Тип определяет возможные значения свойства TimeFormat объектов класса TDateTimeFormat.


DateUtil Unit

The following items are declared in the DateUtil unit:

Types

TDateOrder

TDayOfWeekName

TDaysOfWeek

Constants

CenturyOffset

FourDigitYear

Procedures and functions

CutTime

DateDiff

DaysBetween

DaysInPeriod

DaysPerMonth

DefDateFormat

DefDateMask

FirstDayOfNextMonth

FirstDayOfPrevMonth

GetDateOrder

IncDate

IncDay

IncHour

IncMinute

IncMonth

IncMSec

IncSecond

IncTime

IncYear

IsLeapYear

LastDayOfPrevMonth

MonthsBetween

StrToDateDef

StrToDateFmt

StrToDateFmtDef

ValidDate

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


CenturyOffset Constant

Unit

DateUtil

Declaration

const

  const CenturyOffset: Byte = 30;

Description

Константа определяет, как будут интерпретироваться двухсимвольные значения года при преобразовании строки в дату функциями StrToDateFmt, StrToDateDef и StrToDateFmtDef.

Если преобразуемое двузначное значение года меньше (либо равно), чем сумма двух последних цифр текущего года и (CenturyOffset - 100), то преобразуемое значение интерпретируется, как дата из следующего столетия; иначе - как дата из текущего столетия.

Значение константы по умолчанию равно 30. При этом в предположении, что текущий год 1998, следующие двухзначные значения года будут интерпретированы так:

 00 - 2000

 01 - 2001

 ...

 27 - 2027

 28 - 2028

 29 - 1929  ( [19]98 + 30 - 100 = 28 < 29 )

Вы можете изменить значение этой константы, присвоив ей нужное Вам значение.


FourDigitYear Constant

Unit

DateUtil

Declaration

const

  const FourDigitYear: Boolean = True;

Description

Эта типизированная константа определяет четыре или две цифры года будут требоваться или отображаться при вводе или отображении даты в TDateEdit, TDBDateEdit. Влияет на функции DefDateFormat и DefDateMask.

По умолчанию этой константе присваивается значение, соответствующее числу цифр года в ShortDateFormat.

При значении FourDigitYear = False, двухсимвольные даты, вводимые в TDateEdit, TDBDateEdit, преобразуются в соответствии со значением типизированной константы CenturyOffset.


TDateOrder Type

Unit

DateUtil

Declaration

type

TDateOrder = (doMDY, doDMY, doYMD);

Description

Тип задает возможные значения порядка расположения дня, месяца и года в формате даты. Используется в функциях преобразования строки в дату в модуле DateUtils.


TDayOfWeekName Type

Unit

DateUtil

Declaration

type

TDayOfWeekName = (Sun, Mon, Tue, Wed, Thu, Fri, Sat);

Description

Перечислимый тип для задания дня недели.


TDaysOfWeek Type

Unit

DateUtil

Declaration

type

TDaysOfWeek = set of TDayOfWeekName;

Description

Множество дней недели.


CutTime Function

Examples

Unit

DateUtil

Declaration

function CutTime(ADate: TDateTime): TDateTime;

Description

Устанавливает время в переданном аргументе ADate в значение 00:00:00:00.


CutTime example
Example

DateWithoutTime := CutTime(ADate);


DateDiff Procedure

Examples

Unit

DateUtil

Declaration

procedure DateDiff(Date1, Date2: TDateTime; var Days, Months, Years: Word);

Description

Определяет разницу между датами, заданными Date1 и Date2 в днях, месяцах и годах.


DateDiff example
Example

var

  D1, D2: TDateTime;

  D, M, Y: Word;

begin

   ShortDateFormat := 'dd.mm.yyyy';

   D1 := StrToDate('24.03.1994');

   D2 := StrToDate('12.08.1995');

   DateDiff(D1, D2, D, M, Y);

end;

Выход: D=19; M=4; Y=1


DaysBetween Function

Examples

Unit

DateUtil

Declaration

function DaysBetween(Date1, Date2: TDateTime): Longint;

Description

Вычисляет число дней между датами Date1 и Date2, вычитая Date1 из Date2. Если Date1 = Date2 результат = 1. Если Date1 > Date2, то результат = 0.


DaysBetween example
Example

Days := DaysBetween(Date1, Date2);


DaysInPeriod Function

Examples

Unit

DateUtil

Declaration

function DaysInPeriod(Date1, Date2: TDateTime): Longint;

Description

Вычисляет число дней между датами Date1 и Date2. Если Date1 = Date2 результат = 1. Порядок следования аргументов значения не имеет.


DaysInPeriod example
Example

Days := DaysInPeriod(Date1, Date2);


DaysPerMonth Function

Examples

Unit

DateUtil

Declaration

function DaysPerMonth(AYear, AMonth: Integer): Integer;

Description

Функция возвращает число дней в месяце для указанного года. Параметр AYear задает год, а AMonth - месяц (1- Январь,...12 - Декабрь).


DaysPerMonth example
Example

var

  D: Word;

begin

  D := DaysPerMonth(1995, 2);

end;

Выход D=28


DefDateFormat Function

Examples

Unit

DateUtil

Declaration

function DefDateFormat: string;

Description

Функция возвращает строку формата даты, соответствующую порядку расположения дня, месяца и года, заданному константой ShortDateFormat, но содержащую по две цифры на день и месяц, и четыре или две цифры на год, в зависимости от FourDigitYear, например, если

 ShortDateFormat = 'D/mm/yy',

то функция вернет значение

 'DD/MM/YYYY'.


DefDateFormat example
Example

Field1.AsDateTime := StrToDateFmt(DefDateFormat, Edit1.Text);


DefDateMask Function

Examples

Unit

DateUtil

Declaration

function DefDateMask(BlanksChar: Char): string;

Description

Функция возвращает строку маски для ввода даты (для использования как значение свойства EditMask в компонентах TMaskEdit), соответствующую порядку расположения дня, месяца и года, заданному константой ShortDateFormat, но содержащую по две цифры на день и месяц, и четыре или две цифры на год, в зависимости от FourDigitYear, например, если

 ShortDateFormat = 'D/mm/yy',

то функция вернет значение

 '!99/99/9999;1; '.


DefDateMask example
Example

MaskEdit1.EditMask := DefDateMask('_');


FirstDayOfNextMonth Function

Examples

Unit

DateUtil

Declaration

function FirstDayOfNextMonth: TDateTime;

Description

Возвращает первый день следующего месяца относительно текущей даты как TDateTime.


FirstDayOfNextMonth example
Example

First := FirstDayOfNextMonth;


FirstDayOfPrevMonth Function

Examples

Unit

DateUtil

Declaration

function FirstDayOfPrevMonth: TDateTime;

Description

Возвращает первый день предыдущего месяца относительно текущей даты как TDateTime.


FirstDayOfPrevMonth example
Example

First := FirstDayOfPrevMonth;


GetDateOrder Function

Examples

Unit

DateUtil

Declaration

function GetDateOrder(const DateFormat: string): TDateOrder;

Description

Функция возвращает порядок расположения дня, месяца и года в формате даты, переданном как параметр DateFormat.


GetDateOrder example
Example

Вы можете использовать эту функцию для получения формата даты, совпадающего с ShortDateFormat по порядку следования дня, месяца и года, но содержащего всегда заданное Вами число цифр:

  case GetDateOrder(ShortDateFormat) of

    doMDY: Result := 'MM/DD/YYYY';

    doDMY: Result := 'DD/MM/YYYY';

    doYMD: Result := 'YYYY/MM/DD';

  end;


IncDate Function

Examples

Unit

DateUtil

Declaration

function IncDate(ADate: TDateTime; Days, Months, Years: Integer): TDateTime;

Description

Увеличивает дату ADate на заданное количество дней, месяцев и лет, возвращая полученную дату как результат.


IncDate example
Example

var

  D1, D2: TDateTime;

  S: string;

begin

   ShortDateFormat := 'dd.mm.yy';

   D1 := StrToDate('24.03.1994');

   D2 := IncDate(D1, 38, 5, 2);

   S := DateToStr(D2);

end;

Выход: S = '01.10.96'


IncDay Function

Examples

Unit

DateUtil

Declaration

function IncDay(ADate: TDateTime; Delta: Integer): TDateTime;

Description

Увеличивает дату  ADate на заданное количество (Delta) дней, возвращая полученную дату как результат.


IncDay example
Example

var

  D1, D2: TDateTime;

  S: string;

begin

   ShortDateFormat := 'dd.mm.yy';

   D1 := StrToDate('24.03.1994');

   D2 := IncDay(D1, 145);

   S := DateToStr(D2);

end;

Выход: S = '16.08.94'


IncHour Function

Examples

Unit

DateUtil

Declaration

function IncHour(ATime: TDateTime; Delta: Integer): TDateTime;

Description

Увеличивает время ATime на заданное количество (Delta) часов, возвращая полученное время как результат.


IncHour example
Example

var

  T1, T2: TDateTime;

  S: string;

begin

   ShortTimeFormat := 'HH:MM:SS';

   T1 := StrToTime('00:00:00');

   T2 := IncHour(T1, -1);

   S := TimeToStr(T2);

end;

Выход: S = '23:00:00'


IncMinute Function

Examples

Unit

DateUtil

Declaration

function IncMinute(ATime: TDateTime; Delta: Integer): TDateTime;

Description

Увеличивает время ATime на заданное количество (Delta) минут, возвращая полученное время как результат.


IncMinute example
Example

var

  T1, T2: TDateTime;

  S: string;

begin

   ShortTimeFormat := 'HH:MM:SS';

   T1 := StrToTime('00:00:00');

   T2 := IncMinute(T1, 5);

   S := TimeToStr(T2);

end;

Выход: S = '00:05:00'


IncMonth Function

Examples

Unit

DateUtil

Declaration

function IncMonth(ADate: TDateTime; Delta: Integer): TDateTime;

Description

Увеличивает дату  ADate на заданное количество (Delta) месяцев, возвращая полученную дату как результат.


IncMonth example
Example

var

  D1, D2: TDateTime;

  S: string;

begin

   ShortDateFormat := 'dd.mm.yy';

   D1 := StrToDate('30.12.1991');

   D2 := IncMonth(D1, 2);

   S := DateToStr(D2);

end;

Выход: S = '01.03.92'


IncMSec Function

Examples

Unit

DateUtil

Declaration

function IncMSec(ATime: TDateTime; Delta: Integer): TDateTime;

Description

Увеличивает время ATime на заданное количество (Delta) миллисекунд, возвращая полученное время как результат.


IncMSec example
Example

var

  T: TDateTime;

  Hour, Min, Sec, MSec;

begin

   T := IncMSec(0, -100);

   DecodeTime(T, Hour, Min, Sec, MSec);

end;

Выход: Hour = 23, Min = 59, Sec = 59, MSec = 900


IncSecond Function

Examples

Unit

DateUtil

Declaration

function IncSecond(ATime: TDateTime; Delta: Integer): TDateTime;

Description

Увеличивает время ATime на заданное количество (Delta) секунд, возвращая полученное время как результат.


IncSecond example
Example

var

  T1, T2: TDateTime;

  S: string;

begin

   ShortTimeFormat := 'HH:MM:SS';

   T1 := StrToTime('00:00:00');

   T2 := IncSecond(T1, -10);

   S := TimeToStr(T2);

end;

Выход: S = '23:59:50'


IncTime Function

Examples

Unit

DateUtil

Declaration

function IncTime(ATime: TDateTime; Hours, Minutes, Seconds, MSecs: Integer): TDateTime;

Description

Увеличивает время ATime на заданное количество часов, минут, секунд и миллисекунд, возвращая полученное время как результат.


IncTime example
Example

var

  T1, T2: TDateTime;

  S: string;

begin

   ShortTimeFormat := 'HH:MM:SS';

   T1 := StrToTime('00:00:00');

   T2 := IncTime(T1, -1, 5, -10, 0);

   S := TimeToStr(T2);

end;

Выход: S = '23:04:10'


IncYear Function

Examples

Unit

DateUtil

Declaration

function IncYear(ADate: TDateTime; Delta: Integer): TDateTime;

Description

Увеличивает дату  ADate на заданное количество (Delta) лет, возвращая полученную дату как результат.


IncYear example
Example

var

  D1, D2: TDateTime;

  S: string;

begin

   ShortDateFormat := 'dd.mm.yy';

   D1 := StrToDate('30.12.1991');

   D2 := IncYear(D1, -34);

   S := DateToStr(D2);

end;

Выход: S = '30.12.57'


IsLeapYear Function

Examples

Unit

DateUtil

Declaration

function IsLeapYear(AYear: Integer): Boolean;

Description

Проверяет является ли заданный параметром AYear год високосным.


IsLeapYear example
Example

var

  Leap: Boolean;

begin

  Leap := IsLeapYear(1995);

end;

Выход: Leap =  False


LastDayOfPrevMonth Function

Examples

Unit

DateUtil

Declaration

function LastDayOfPrevMonth: TDateTime;

Description

Возвращает последний день предыдущего месяца относительно текущей даты как TDateTime.


LastDayOfPrevMonth example
Example

Last := LastDayOfPrevMonth;


MonthsBetween Function

Examples

Unit

DateUtil

Declaration

function MonthsBetween(Date1, Date2: TDateTime): Double;

Description

Функция вычисляет число месяцев между двумя датами. Целая часть результата составляет число полных месяцев между двумя датами, дробная часть вычисляется с точностью до 0.25, то есть до недели. Порядок следования аргументов не имеет значения.


MonthsBetween example
Example

Res := MonthsBetween(Date1, Date2);


StrToDateDef Function

Examples

Unit

DateUtil

Declaration

function StrToDateDef(const S: string; Default: TDateTime): TDateTime;

Description

Функция преобразует строку в дату в соответствии с форматом ShortDateFormat. В отличие от функции StrToDate в случае ошибки преобразования возвращает значение по умолчанию, переданное как параметр Default.


StrToDateDef example
Example

Field1.AsDateTime := StrToDateDef(Edit1.Text, SysUtils.Date);


StrToDateFmt Function

Examples

Unit

DateUtil

Declaration

function StrToDateFmt(const DateFormat, S: string): TDateTime;

Description

Функция преобразует строку в дату в соответствии с форматом DateFormat. В случае ошибки преобразования вызывает исключительную ситуацию (exception).


StrToDateFmt example
Example

Field1.AsDateTime := StrToDateFmt(DefDateFormat, Edit1.Text);


StrToDateFmtDef Function

Examples

Unit

DateUtil

Declaration

function StrToDateFmtDef(const DateFormat, S: string; Default: TDateTime): TDateTime;

Description

Функция преобразует строку в дату в соответствии с форматом DateFormat. В отличие от функции StrToDateFmt в случае ошибки преобразования возвращает значение по умолчанию, переданное как параметр Default.


StrToDateFmtDef example
Example

Field1.AsDateTime := StrToDateFmtDef(DefDateFormat,

  Edit1.Text, SysUtils.Date);


ValidDate Function

Examples

Unit

DateUtil

Declaration

function ValidDate(ADate: TDateTime): Boolean;

Description

Функция определяет, представляет ли собой аргумент ADate действительное значение существующей даты.


ValidDate example
Example

if ValidDate(ADate) then begin

  { deal with ADate }

end;


DBExcpt Unit

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 DBExcpt unit:

Components and objects

TRxBdeErrorDlg

Types

TDBErrorEvent

Constants

DbErrorHelpCtx

Procedures and functions

DbErrorIntercept

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


TRxBdeErrorDlg object
TRxBdeErrorDlg Class

Hierarchy             See also             Methods             Events

Unit

DBExcpt

Description

Диалог появляется при возникновении ошибки BDE и отображает информацию о причинах и характере ошибки, доступную через исключение класса EDbEngineError.

Действия, необходимые для перехвата ошибок, предпринимаются при создании формы, поэтому в большинстве случаев достаточно просто добавить модуль DBExcpt в свой проект с помощью Project Manager, оставив форму DbEngineErrorDlg AutoCreate. Вы можете также вызвать процедуру DbErrorIntercept для активизации перехвата ошибок BDE формой DbEngineErrorDlg.

После создания формы класса TRxBdeErrorDlg Вы можете задать обработчик события OnErrorMsg для изменения сообщений об ошибках, отображаемых в форме.


TRxBdeErrorDlg See Also
See also

DbErrorIntercept

EDbEngineError

TBDEError


TRxBdeErrorDlg Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TScrollingWinControl

  |

TCustomForm

  |

TForm


TRxBdeErrorDlg events
Events

Run-time only    [image] Key events

OnActivate	OnDeactivate	OnHide
OnClose	OnDestroy	OnShow
OnCreate	OnErrorMsg


TRxBdeErrorDlg methods
Methods

Key methods

Create	Free
Destroy	ShowModal


OnErrorMsg
OnErrorMsg Event

Applies to

TRxBdeErrorDlg component

Declaration

property OnErrorMsg: TDBErrorEvent;

Description

Событие позволяет изменить текст сообщения, выводимого диалогом TRxBdeErrorDlg, с помощью изменения значения параметра Msg.


DbErrorHelpCtx Constant

Unit

DBExcpt

Declaration

const

  DbErrorHelpCtx: THelpContext = 0

Description

Константа задает справочный контекст для окна с сообщением об ошибке BDE (класса TRxBdeErrorDlg). Установите ее в отличное от нуля значение, если Вы хотите разрешить пользователю вызов контекстной подсказки из этого окна при нажатии "F1".


TDBErrorEvent Type

Unit

DBExcpt

Declaration

type

TDBErrorEvent = procedure (Error: TDBError; var Msg: string) of object;

Description

Тип определяет обработчик события OnErrorMsg диалога сообщений об ошибках BDE TRxBdeErrorDlg.


DbErrorIntercept Procedure

Examples

Unit

DBExcpt

Declaration

procedure DbErrorIntercept;

Description

Процедура создает экземпляр формы TRxBdeErrorDlg, активизируя особую обработку ошибок BDE.


DbErrorIntercept example
Example

Вы можете использовать вызов процедуры DbErrorIntercept в тексте файла проекта (.DPR):

  begin

    Application.Title := 'My_Application';

    DbErrorIntercept;

    Application.CreateForm(TMainForm, MainForm);

    Application.CreateForm(...);

    ...

    Application.Run;

  end;


DBFilter Unit

The DBFilter 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.

The following items are declared in the DBFilter unit:

Components and objects

TRxDBFilter

Types

EFilterError

TDBFilterOption

TDBFilterOptions

TFilterEvent

TFilterLogicCond

Procedures and functions

DropAllFilters

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


TRxDBFilter Component

Hierarchy             See also             Properties             Methods             Events

Unit

DBFilter

Description

Компонента TRxDBFilter реализует заложенную в API BDE возможность наложения фильтров на курсор (набор данных), без применения запросов SQL или QBE. Преимущество фильтров в их быстродействии и отсутствии доплнительных обращений к серверу БД, что может оказаться необходимым в тех случаях, когда требуется многократно динамически изменять условия отбора записей. Кроме того, использование фильтра гарантирует, что набор данных останется редактируемым (live), если он был таким до наложения фильтра, в то время как некоторые запросы (Query) дают в результате нередактируемый набор данных.

Компонента позволяет задавать условия отбора записей как с помощью свойства Filter простой записью логических выражений в виде текстовых строк (синтаксис выражений фильтра подобен синтаксису выражений SQL), так и при помощи события OnFiltering, позволяющего вам проверить значения любых полей в записи и определить ее соответствие требуемым условиям.

Фильтр может накладываться на любой набор данных, как TTable, так и TQuery или TQBEQuery, при этом наличие индексов для полей, на которые накладываются условия, не требуется. Набор данных, на который будет распространяться действие фильтра, задается свойством DataSource.

Вы можете активизировать либо снять установленный фильтр при помощи изменения значения свойства Active. Свойство Priority определяет порядок активизации нескольких фильтров при их наложении на один и тот же набор данных.

Свойство LogicCond устанавливает логическую связку (И, ИЛИ) между собой нескольких условий фильтра, если условия считываются из "db-aware" элементов управления при помощи метода ReadCaptureControls.

Внимание

Компонента создавалась и была в первую очередь предназначена для использования в Delphi 1.0. В более старших версиях Delphi рекомендуется использовать стандартные свойства Filter и Filtered, имеющиеся у всех классов - наследников TDataSet.


TRxDBFilter See Also
See also

TDataSource

TDBFilterOptions

TQBEQuery

TQuery

TTable


TRxDBFilter Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxDBFilter properties
Properties

Run-time only    [image] Key properties

Active	DataSource	Name
Captured	ExprFilter	Options
ComponentCount	Filter	Owner
ComponentIndex	FuncFilter	Priority
Components	LogicCond	Tag


TRxDBFilter events
Events

Run-time only    [image] Key events

OnActivate	OnFiltering	OnSetCapture
OnDeactivate	OnReleaseCapture


TRxDBFilter methods
Methods

Key methods

Activate	FindComponent	RemoveComponent
Create	InsertComponent	SetCapture
Deactivate	ReadCaptureControls	Update
Destroy	ReleaseCapture	UpdateFuncFilter


TRxDBFilter.Active
Active Property

Applies to

TRxDBFilter component

Declaration

property Active: Boolean;

Description

Установка значения свойства Active в True приводит к активизации фильтра. При этом условие фильтрации записей берется из свойства Filter, если оно задано, и дополнительно, если определена реакция на событие OnFiltering, используется это событие. Если условие фильтра не задано ни через свойство Filter, ни через событие OnFiltering, активизации фильтра не происходит. В случае успешной активизации фильтра в свойство State, определяющее состояние компоненты, добавляется флаг fsActive.

К аналогичному результату приводит вызов метода Activate.

Деактивация (снятие) фильтра производится присвоением свойству Active значения False либо вызовом метода Deactivate.


Captured
Captured Property

Applies to

TRxDBFilter component

Declaration

property Captured: Boolean;

Description

Свойство (только-чтение), позволяющее определить, находится ли фильтр в состоянии "захвата" элементов управления. Если значение свойства Captured True, то элементы управления захвачены фильтром, в противном случае значение свойства - False. "Захват" элементов управления и их освобождение производятся с помощью методов SetCapture и ReleaseCapture соответственно.

Когда поля ввода захвачены фильтром, вызов метода Post привязанного к фильтру набора данных приводит к считыванию внесенных пользователем значений и установке фильтра, вызов метода Cancel - к освобождению захваченных элементов управления.


ExprFilter
ExprFilter Property

Applies to

TRxDBFilter component

Declaration

property ExprFilter: hDBIFilter;

Description

Свойство позволяет получить обработчик установленного фильтра (использующего выражение, заданное свойством Filter) для использования в функциях BDE API.


TRxDBFilter.Filter
Filter Property

Examples

Applies to

TRxDBFilter component

Declaration

property Filter: TStringList;

Description

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

Например, допустимо такое выражение:

   (( Cust_No > 1000) OR ([Customer Name] <= 'B'))

   AND State = 'CA'

или

   Pay = NULL

или

   [Date] > '12/01/1995'.

Для логических полей (ftBoolean) возможно использование унарного выражения без операндов или с операцией отрицания NOT:

   (NOT LogicFieldName)

Допустимые значения для унарных операций (не требующих второго опреанда):

   = NULL

   <> NULL

Допустимые значения для бинарных операций (требующих два опреанда):

   <> (not equal)

   >= (great or equal)

   <= (less or equal)

   =  (equal)

   >  (great)

   <  (less)


TRxDBFilterFilter example
Example

with rxDBFilter1.Filter do begin

  BeginUpdate;

  try

    Clear;

    Add('((Cust_No > 1000) OR');

    Add('([Customer Name] <= ''B'')) AND (State = ''CA'')');

  finally

    EndUpdate;

  end;

end;

rxDBFilter1.Active := True;


FuncFilter
FuncFilter Property

Applies to

TRxDBFilter component

Declaration

property FuncFilter: hDBIFilter;

Description

Свойство позволяет получить обработчик установленного фильтра (использующего событие OnFiltering) для использования в функциях BDE API.


LogicCond
LogicCond Property

Applies to

TRxDBFilter component

Declaration

property LogicCond: TFilterLogicCond;

Description

Если условие фильтра записывается в свойство Filter при помощи вызова метода ReadCaptureControls, то все условия фильтрации, считанные из элементов управления, объединяются в одно логическое условие с помощью одного из операторов И (flAnd) либо ИЛИ (flOr), в зависимости от значения свойства LogicCond.


TRxDBFilter.Options
Options Property

Applies to

TRxDBFilter component

Declaration

property Options: TDBFilterOptions;

Description

Свойство определяет некоторые дополнительные режимы наложения фильтра на набор данные (DataSet). Значениями свойства могут быть комбинации из значений типа TFilterOption:

foCaseInsensitive - при наложении фильтра игнорируется регистр

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

foNoPartialCompare - сравнение символьных полей происходит по

точному совпадению значения поля и символьного выражения;

символ '*' воспринимается как входящий в состав строки, а не

как символ маски.


Priority
Priority Property

Applies to

TRxDBFilter component

Declaration

property Priority: Word;

Description

Свойство задает порядок наложения нескольких фильтров на один и тот же набор данных (DataSet).


TRxDBFilter.OnActivate
OnActivate Event

Applies to

TRxDBFilter component

Declaration

property OnActivate: TNotifyEvent;

Description

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


TRxDBFilter.OnDeactivate
OnDeactivate Event

Applies to

TRxDBFilter component

Declaration

property OnDeactivate: TNotifyEvent;

Description

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


OnFiltering
OnFiltering Event

Examples

Applies to

TRxDBFilter component

Declaration

property OnFiltering: TFilterEvent;

Description

При определении реакции на событие OnFiltering фильтрация записей набора данных при активизации фильтра происходит не только в соответствии с выражением, заданным свойством Filter (если оно не пустое), но и по результатам вызова метода - обработчика события OnFiltering. В методе-обработчике события OnFiltering вы можете проверить запись на соответствие вашим условиям с помощью передаваемого в функцию параметра DataSet. Обработчик должен вернуть True в случае, если проверяемая запись удовлетворяет условиям отбора, и False в противном случае.


OnFiltering example
Example

procedure TForm1.RxFilterOnFiltering(Sender: TObject; DataSet: TDataSet): Boolean;

begin

  if (AnsiUpperCase(DataSet.FieldByName('Cust_Name')) = 'Smith') or

    ((DataSet.FieldByName('Rate') > 0.5) and

    (DataSet.FieldByName('Rate') < 0.95)) then

    Result := True

  else Result := False;

end;


OnReleaseCapture
OnReleaseCapture Event

Applies to

TRxDBFilter component

Declaration

property OnReleaseCapture: TNotifyEvent;

Description

Событие OnReleaseCapture происходит при освобождении захваченных ранее фильтром элементов управления, то есть при вызове метода ReleaseCapture.


OnSetCapture
OnSetCapture Event

Applies to

TRxDBFilter component

Declaration

property OnSetCapture: TNotifyEvent;

Description

Событие OnSetCapture происходит при захвате элементов управления фильтром, то есть при вызове метода SetCapture.


TRxDBFilter.Activate
Activate Method

Applies to

TRxDBFilter component

Declaration

procedure Activate;

Description

Вызов метода приводит к активизации фильтра и аналогичен присвоению значения True свойству Active:

  Active := True;


TRxDBFilter.Deactivate
Deactivate Method

Applies to

TRxDBFilter component

Declaration

procedure Deactivate;

Description

Вызов метода приводит к деакативации ("снятию") фильтра, ранее активизированного вызовом метода Activate. Вызов метода аналогичен присвоению значения False свойству Active:

  Active := False;


ReadCaptureControls
ReadCaptureControls Method

Applies to

TRxDBFilter component

Declaration

procedure ReadCaptureControls;

Description

Группа методов SetCapture, ReleaseCapture и ReadCaptureControls служит для "захвата" фильтром элементов управления (data-aware controls), связанных с набором данных, ассоциированным с фильтром через его свойство DataSource.

При вызове процедуры SetCapture все элементы управления, имеющие то же значение свойства DataSource, что и фильтр, "захватываются" фильтром, после чего вы можете вводить данные в эти элементы независимо от состояния источника данных (даже если он находится в режиме "только-чтение" или является результатом нередактируемого запроса). Вводимые данные не записываются в базу данных и не влияют на содержимое текущей записи набора данных. Вы можете использовать вызов метода ReadCaptureControls для чтения данных, введенных в этом режиме, в набор условий фильтра.

В результате последовательности вызовов SetCapture и ReadCaptureControls в свойство Filter будут записаны условия на равенство введенным значениям всех полей набора данных, заполненных в режиме "захвата" элементов управления фильтром, при этом условия объединяются логическим оператором И, ИЛИ в зависимости от значения свойства LogicCond.

Для "возвращения" захваченных элементов набору данных вы обязательно должны вызвать метод ReleaseCapture.


ReleaseCapture
ReleaseCapture Method

Applies to

TRxDBFilter component

Declaration

procedure ReleaseCapture;

Description

Группа методов SetCapture, ReleaseCapture и ReadCaptureControls служит для "захвата" фильтром элементов управления (data-aware controls), связанных с набором данных, ассоциированным с фильтром через его свойство DataSource.

При вызове процедуры SetCapture все элементы управления, имеющие то же значение свойства DataSource, что и фильтр, "захватываются" фильтром, после чего вы можете вводить данные в эти элементы независимо от состояния источника данных (даже если он находится в режиме "только-чтение" или является результатом нередактируемого запроса). Вводимые данные не записываются в базу данных и не влияют на содержимое текущей записи набора данных. Вы можете использовать вызов метода ReadCaptureControls для чтения данных, введенных в этом режиме, в набор условий фильтра.

После последовательности вызовов SetCapture и ReadCaptureControls в свойство Filter будут записаны условия на равенство введенным значениям всех полей набора данных, заполненных в режиме "захвата" элементов управления фильтром, при этом условия объединяются логическим оператором И, ИЛИ в зависимости от значения свойства LogicCond.

Для "возвращения" захваченных элементов набору данных вы обязательно должны вызвать метод ReleaseCapture.


SetCapture
SetCapture Method

Applies to

TRxDBFilter component

Declaration

procedure SetCapture;

Description

Группа методов SetCapture, ReleaseCapture и ReadCaptureControls служит для "захвата" фильтром элементов управления (data-aware controls), связанных с набором данных, ассоциированным с фильтром через его свойство DataSource.

При вызове процедуры SetCapture все элементы управления, имеющие то же значение свойства DataSource, что и фильтр, "захватываются" фильтром, после чего вы можете вводить данные в эти элементы независимо от состояния источника данных (даже если он находится в режиме "только-чтение" или является результатом нередактируемого запроса). Вводимые данные не записываются в базу данных и не влияют на содержимое текущей записи набора данных. Вы можете использовать вызов метода ReadCaptureControls для чтения данных, введенных в этом режиме, в набор условий фильтра.

После последовательности вызовов SetCapture и ReadCaptureControls в свойство Filter будут записаны условия на равенство введенным значениям всех полей набора данных (кроме вычисляемых и Lookup-полей), заполненных в режиме "захвата" элементов управления фильтром, при этом условия объединяются логическим оператором И, ИЛИ в зависимости от значения свойства LogicCond.

Для "возвращения" захваченных элементов набору данных вы обязательно должны вызвать метод ReleaseCapture.


TRxDBFilter.Update
Update Method

Applies to

TRxDBFilter component

Declaration

procedure Update;

Description

Вызов метода приводит к "переустановке" фильтра и обновлению данных курсора в соответствии с условиями фильтра.


UpdateFuncFilter
UpdateFuncFilter Method

Applies to

TRxDBFilter component

Declaration

procedure UpdateFuncFilter;

Description

Метод предназначен для "переустановки" фильтра при изменении условий, проверяемых в обработчике события OnFiltering в run-time.


EFilterError Type

Unit

DBFilter

Declaration

type

EFilterError = class(Exception);

Description

Исключение EFilterError инициируется в случае ошибок в работе компоненты TrxDBFilter.


TDBFilterOption Type

Unit

DBFilter

Declaration

type

TDBFilterOption = (foCaseInsensitive, foNoPartialCompare);

Description

Тип определяет возможные значения свойства Options компоненты TRxDBFilter.


TDBFilterOptions Type

Unit

DBFilter

Declaration

type

TDBFilterOptions = set of TDBFilterOption;

Description

Тип определяет возможные значения свойства Options компоненты TRxDBFilter.


TFilterEvent Type

Unit

DBFilter

Declaration

type

TFilterEvent = function (Sender: TObject; DataSet: TDataSet): Boolean of object;

Description

Тип TFilterEvent предназначен для события OnFiltering компоненты TrxDBFilter.


TFilterLogicCond Type

Unit

DBFilter

Declaration

type

TFilterLogicCond = (flAnd, flOr);

Description

Тип определяет допустимые значения свойства LogicCond компоненты TRxDBFilter.


DropAllFilters Procedure

Examples

Unit

DBFilter

Declaration

procedure DropAllFilters(DataSet: TDataSet);

Description

Процедура деактивирует все фильтры, установленные ранее на набор данных DataSet, и освобождает захваченные ими ресурсы.


DropAllFilters example
Example

 begin

   ...

   DropAllFilters(Query1);

 end;


DBIndex Unit

The DBIndex 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.

The following items are declared in the DBIndex unit:

Components and objects

TDBIndexCombo

Types

TIdxDisplayMode

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


TDBIndexCombo Component

Hierarchy             See also             Properties             Methods             Events

Unit

DBIndex

Description

Компонента предназначена для помещения в ваши формы элемента управления, задающего порядок сортировки (индекс) для записей таблиц базы данных (компоненты TTable).

Компонента представляет собой выпадающий список (ComboBox), отображающий список допустимых индексов для компоненты TTable, связанной с данным элементом через свойство DataSource. Элементы списка представляют собой, в зависимости от свойства DisplayMode, значения свойства DisplayLabel соответствующих компонент TField, имена полей или имена индексов.

Вы можете разрешить либо запретить элемент списка, отменяющий использование любого индекса, с помощью задания значения свойству EnableNoIndex. Текстовое значение этого элемента задается свойством NoIndexItem.


TDBIndexCombo See Also
See also

IndexName property

TDataSource

TField

TTable


TDBIndexCombo Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomComboBox


TDBIndexCombo properties
Properties

Run-time only    [image] Key properties

Color	EnableNoIndex	ParentFont
ComponentCount	Font	ParentShowHint
ComponentIndex	Height	PopupMenu
Components	HelpContext	ShowHint
Ctl3D	Hint	Sorted
Cursor	ItemHeight	Style
DataSource	Left	TabOrder
DispalyMode	Name	TabStop
DragCursor	NoIndexItem	Tag
DragMode	Owner	Top
DropDownCount	Parent	Visible
Enabled	ParentCtl3D	Width


TDBIndexCombo events
Events

Run-time only    [image] Key events

OnChange	OnEndDrag	OnKeyUp
OnClick	OnEnter	OnMeasureItem
OnDblClick	OnExit	OnStartDrag
OnDragDrop	OnKeyDown
OnDragOver	OnKeyPress


TDBIndexCombo methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TDBIndexCombo.DispalyMode
DispalyMode Property

Applies to

TDBIndexCombo component

Declaration

property DispalyMode: TIdxDisplayMode;

Description

Свойство определяет, как представлены индексы в списке.

В зависимости от значения свойства DisplayMode, элементы списка представляют собой следующее:

- dmFieldLabels - значения свойства DisplayLabel соответствующих компонент TField;

- dmFieldNames - имена полей, входящих в индекс;

- dmIndexName - имена индексов.


EnableNoIndex
EnableNoIndex Property

Applies to

TDBIndexCombo component

Declaration

property EnableNoIndex: Boolean;

Description

Если значение этого свойства True, то в списке появляется элемент, отменяющий использование любых индексов для таблицы, связанной с компонентой TDBIndexCombo через свойство DataSource. Строковое значение для этого элемента задается свойством NoIndexItem.


NoIndexItem
NoIndexItem Property

Applies to

TDBIndexCombo component

Declaration

property NoIndexItem: string;

Description

Значение этого свойства используется для отображения элемента выпадающего списка, отменяющего использование любых индексов для таблицы, связанной с компонентой TDBIndexCombo через свойство DataSource. Этот элемент списка отображается в случае, если значение свойства EnableNoIndex - True.


TIdxDisplayMode Type

Unit

DBIndex

Declaration

type

TIdxDisplayMode = (dmFieldLabels, dmFieldNames, dmIndexName);

Description

Тип определяет возможные значения свойства DisplayMode компоненты TDBIndexCombo.


DBLists Unit

The DBLists 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.

The following items are declared in the DBLists unit:

Components and objects

TBDEItems

TDatabaseDesc

TDatabaseItems

TDriverDesc

TTableItems

Types

TBDEItemType

TDBItemType

TTabItemType

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


TBDEItems Component

Hierarchy             See also             Properties             Methods             Events

Unit

DBLists

Description

Компонента предоставляет доступ к спискам всех доступных баз данных (включая "алиасы" или псевдонимы), драйверов баз данных или языковых драйверов (в зависимости от значения свойства ItemType) для текущей кофигурации BDE, в виде набора данных, доступ к которому осуществляется как к обычной таблице. Вы можете отобразить данные TBDEItems в компоненте класса TDBGrid либо использовать TBDEItems в качестве LookupSource (через TDataSource-компоненту) компоненты класса TrxDBLookupCombo.


TBDEItems See Also
See also

TDatabase

TDatabaseDesc

TDatabaseItems

TDriverDesc

TTableItems


TBDEItems Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TDataSet

  |

TBDEDataSet

  |

TCustomBDEItems


TBDEItems properties
Properties

Run-time only    [image] Key properties

Active	EOF	Name
AutoCalcFields	FieldCount	Owner
BOF	FieldDefs	RecNo
CanModify	Fields	RecordCount
ComponentCount	Handle	RecordSize
ComponentIndex	ItemType	SessionName
Components	Locale	State
DefaultFields	Modified	Tag


TBDEItems events
Events

Run-time only    [image] Key events

AfterCancel	BeforeCancel	OnCalcFields
AfterClose	BeforeClose	OnNewRecord
AfterOpen	BeforeOpen


TBDEItems methods
Methods

Key methods

ActiveBuffer	EnableControls	MoveBy
Cancel	FieldByName	Next
CheckBrowseMode	FindComponent	Open
ClearFields	FindField	Prior
Close	First	Refresh
Create	GetCurrentRecord	RemoveComponent
CursorPosChanged	GetFieldNames	Resync
Destroy	InsertComponent	SetFields
DisableControls	Last	UpdateCursorPos


TBDEItems.ItemType
ItemType Property

Applies to

TBDEItems component

Declaration

property ItemType: TBDEItemType;

Description

Свойство задает тип объектов в списке TBDEItems. Значениями свойства могут быть величины типа TBDEItemType:

- bdDatabases - список баз данных (aliases) в конфигурации BDE;

- bdDrivers - список установленных драйверов баз данных;

- bdLangDrivers - список установленных языковых драйверов;

- bdUsers - список пользователей, разделяющих один и тот же файл сетевых замков (Paradox);

- bdRepositories - (только в 32-битной версии) список словарей данных (Data Dictionary), зарегистрированных в конфигурации BDE.


TDatabaseDesc object
TDatabaseDesc Class

Hierarchy             See also             Properties             Methods

Unit

DBLists

Description

Класс предназначен для осуществления доступа к описателю базы данных типа DBDesc. После инициализации класса конструктором Create, описатель БД доступен через свойство Description. Конструктор Create выделяет память  для создания объекта класса TDatabaseDesc и заполняет структуру DBDesc, вызывая функцию BDE DbiGetDatabaseDesc.


TDatabaseDesc See Also
See also

TBDEItems

TDatabase


TDatabaseDesc Hierarchy
Hierarchy

TObject


TDatabaseDesc properties
Properties

Run-time only    [image] Key properties

Description


TDatabaseDesc methods
Methods

Key methods

Create	Destroy


TDatabaseDesc.Description
Description Property

Applies to

TDatabaseDesc component

Declaration

property Description: DBDesc;

Description

Свойство для доступа к описателю структуры базы данных. Тип DBDesc объявлен как:

 type

   DBDesc = record         { A given Database Description }

     szName   : DBINAME;   { Logical name (Or alias) }

     szText   : DBINAME;   { Descriptive text }

     szPhyName: DBIPATH;   { Physical name/path }

     szDbType : DBINAME;   { Database type }

   end;


TDatabaseItems Component

Hierarchy             See also             Properties             Methods             Events

Unit

DBLists

Description

Компонента предоставляет доступ к спискам объектов (таблиц, файлов или хранимых процедур, в зависимости от значения свойства ItemType) специфицированной базы данных, в виде набора данных, доступ к которому осуществляется как к обычной таблице. Вы можете отобразить данные TDatabaseItems в компоненте класса TDBGrid либо использовать TDatabaseItems в качестве LookupSource (через TDataSource-компоненту) компоненты класса TrxDBLookupCombo.

Вы можете задать имя базы данных с помошью свойства DatabaseName.


TDatabaseItems See Also
See also

TBDEItems

TDatabase

TStoredProc

TTable

TTableItems


TDatabaseItems Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TDataSet

  |

TBDEDataSet

  |

TDBDataSet

  |

TDBListDataSet

  |

TCustomDatabaseItems


TDatabaseItems properties
Properties

Run-time only    [image] Key properties

Active	EOF	Name
AutoCalcFields	ExtendedInfo	Owner
BOF	FieldCount	RecNo
CanModify	FieldDefs	RecordCount
ComponentCount	Fields	RecordSize
ComponentIndex	FileMask	SessionName
Components	Handle	State
Database	ItemType	SystemItems
DatabaseName	Locale	Tag
DefaultFields	Modified


TDatabaseItems events
Events

Run-time only    [image] Key events

AfterCancel	BeforeCancel	OnCalcFields
AfterClose	BeforeClose	OnNewRecord
AfterOpen	BeforeOpen


TDatabaseItems methods
Methods

Key methods

ActiveBuffer	EnableControls	MoveBy
Cancel	FieldByName	Next
CheckBrowseMode	FindComponent	Open
ClearFields	FindField	Prior
Close	First	Refresh
Create	GetCurrentRecord	RemoveComponent
CursorPosChanged	GetFieldNames	Resync
Destroy	InsertComponent	SetFields
DisableControls	Last	UpdateCursorPos


ExtendedInfo
ExtendedInfo Property

Applies to

TDatabaseItems component

Declaration

property ExtendedInfo: Boolean;

Description

Specifies whether to return only the standard table or procedire information, or to return extended table information as well. (The default is standard information only).


FileMask
FileMask Property

Applies to

TDatabaseItems component

Declaration

property FileMask: string;

Description

Search string for retrieving a selective list of tables or files. Two wildcard characters can be used: the asterisk (*) and the question mark (?). The asterisk expands to any number of characters; the question mark expands to a single character.

SQL: The search string has the following format: <ownername>.<objectname>. If no period is embedded in the wildcard string, it is assumed that wild represents a search for the object name only, and that the requested tables are for the current owner.

The following table provides examples of wildcard use for SQL databases:

  *.*      All tables for all owners. The default if NULL is passed.

  *        All tables for the current owner.

  *.EMP    All tables named EMP for all owners.

  *CUST    All tables for the current owner ending in CUST.

Standard: For standard databases, search conventions are those used by DOS.


TDatabaseItems.ItemType
ItemType Property

Applies to

TDatabaseItems component

Declaration

property ItemType: TDBItemType;

Description

Свойство задает тип объектов в списке TDatabaseItems. Значениями свойства могут быть величины типа TDBItemType:

- dtTables - список всех таблиц и представлений (View) базы данных;

- dtStoredProcs - список всех хранимых процедур и функций для SQL-баз данных;

- dtFiles - список файлов локальной (desktop) базы данных;

- dtFunctions - список всех функций, поддерживаемых драйвером указанной базы данных (только для SQL, имеется только в 32-битной версии).


SystemItems
SystemItems Property

Applies to

TDatabaseItems component

Declaration

property SystemItems: Boolean;

Description

Specifies whether to include system tables or system stored procedures or not. SQL only.


TDriverDesc object
TDriverDesc Class

Hierarchy             See also             Properties             Methods

Unit

DBLists

Description

Класс предназначен для осуществления доступа к описателю драйвера базы данных типа DRVType. После инициализации класса конструктором Create, описатель драйвера доступен через свойство Description. Конструктор Create выделяет память  для создания объекта класса TDriverDesc и заполняет структуру DRVType, вызывая функцию BDE DbiGetDriverDesc.


TDriverDesc See Also
See also

TBDEItems

TDatabaseDesc


TDriverDesc Hierarchy
Hierarchy

TObject


TDriverDesc properties
Properties

Run-time only    [image] Key properties

Description


TDriverDesc methods
Methods

Key methods

Create	Destroy


TDriverDesc.Description
Description Property

Applies to

TDriverDesc component

Declaration

property Description: DRVType;

Description

Свойство для доступа к описателю драйвера базы данных. Тип DRVType объявлен как:

 type

  DRVType = record                   { Driver Description/Capabilities }

    szType          : DBINAME;       { Symbolic name to identify }

    szText          : DBINAME;       { Descriptive text }

    edrvCat         : DRVCat;        { Driver category }

    bTrueDb         : Bool;          { Supports True Db concept }

    szDbType        : DBINAME;       { Db Type to be used }

    bMultiUser      : Bool;          { Supports Multi-user access }

    bReadWrite      : Bool;          { Read Write or Read-only }

    bTrans          : Bool;          { Supports Transactions }

    bPassThruSQL    : Bool;          { Supports Pass-thru SQL }

    bLogIn          : Bool;          { Requires explicit login }

    bCreateDb       : Bool;          { Can reate a Database }

    bDeleteDb       : Bool;          { Can drop database }

    bCreateTable    : Bool;          { Can create a Table }

    bDeleteTable    : Bool;          { Can delete a Table }

    bMultiplePWs    : Bool;          { Multiple passwords }

    iDriverVersion  : Word;          { Driver version 1..n }

    bSQLRowid       : Bool;          { Supports SQL rowid }

    iUnUsed         : array [0..14] of Word;

  end;


TTableItems Component

Hierarchy             See also             Properties             Methods             Events

Unit

DBLists

Description

Компонента предоставляет доступ к списку элементов (полей, индексов, правил ссылочной целостности и т.д., в зависимости от значения свойства ItemType) специфицированной свойством TableName таблицы, в виде набора данных, доступ к которому осуществляется как к обычной таблице (TTable). Вы можете отобразить данные TTableItems в компоненте класса TDBGrid либо использовать TTableItems в качестве LookupSource (через TDataSource-компоненту) компоненты класса TrxDBLookupCombo. Вы можете задать имя таблицы с помошью свойства TableName.


TTableItems See Also
See also

TBDEItems

TDatabase

TDatabaseItems

TTable


TTableItems Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TDataSet

  |

TBDEDataSet

  |

TDBDataSet

  |

TDBListDataSet

  |

TCustomTableItems


TTableItems properties
Properties

Run-time only    [image] Key properties

Active	EOF	PhysTypes
AutoCalcFields	FieldCount	RecNo
BOF	FieldDefs	RecordCount
CanModify	Fields	RecordSize
ComponentCount	Handle	SessionName
ComponentIndex	ItemType	State
Components	Locale	TableName
Database	Modified	Tag
DatabaseName	Name
DefaultFields	Owner


TTableItems events
Events

Run-time only    [image] Key events

AfterCancel	BeforeCancel	OnCalcFields
AfterClose	BeforeClose	OnNewRecord
AfterOpen	BeforeOpen


TTableItems methods
Methods

Key methods

ActiveBuffer	EnableControls	MoveBy
Cancel	FieldByName	Next
CheckBrowseMode	FindComponent	Open
ClearFields	FindField	Prior
Close	First	Refresh
Create	GetCurrentRecord	RemoveComponent
CursorPosChanged	GetFieldNames	Resync
Destroy	InsertComponent	SetFields
DisableControls	Last	UpdateCursorPos


TTableItems.ItemType
ItemType Property

Applies to

TTableItems component

Declaration

property ItemType: TTabItemType;

Description

Свойство задает тип объектов в списке TTableItems. Значениями свойства могут быть величины типа TTabItemType:

- dtFields - список полей (столбцов) таблицы или представления

- dtIndices - список индексов таблицы

- dtValChecks - список правил проверки значений полей таблицы

- dtRefInt - список правил ссылочной целостности для таблицы

- dtSecurity - список паролей на определенные операции с таблицей

- dtFamily - список всех файлов, относящихся к данной таблице (индексов, мемо-полей и т.д.).


PhysTypes
PhysTypes Property

Applies to

TTableItems component

Declaration

property PhysTypes: Boolean;

Description

Свойство задает, какие данные - о физическом или о логическом типе будут выданы в списке полей специфицированной таблицы. Имеет смысл только при значении ItemType = dtFields. При значении False (по умолчанию) отображаются данные о логических типах полей BDE, при значении True - о физических типах полей.


TTableItems.TableName
TableName Property

Applies to

TTableItems component

Declaration

property TableName: TFileName;

Description

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


TBDEItemType Type

Unit

DBLists

Declaration

type

TBDEItemType = (bdDatabases, bdDrivers, bdLangDrivers, bdUsers, bdRepositories);

Description

Тип задает возможные значения свойства ItemType компоненты TBDEItems.


TDBItemType Type

Unit

DBLists

Declaration

type

TDBItemType = (dtTables, dtStoredProcs, dtFiles, dtFunctions);

Description

Тип задает возможные значения свойства ItemType компоненты TDatabaseItems.


TTabItemType Type

Unit

DBLists

Declaration

type

TTabItemType = (dtFields, dtIndices, dtValChecks, dtRefInt, dtSecurity, dtFamily);

Description

Тип задает возможные значения свойства ItemType компоненты TTableItems.


DBPrgrss Unit

The DBPrgrss 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.

The following items are declared in the DBPrgrss unit:

Components and objects

TDBProgress

Types

TOnMessageChange

TOnPercentChange

TOnProgressEvent

TOnTraceEvent

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


TDBProgress Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

DBPrgrss

Description

Компонента использует Callback-функции IDAPI для сообщения о ходе выполнения длительных операций с БД и (в 32-битной версии) для трассировки обращений BDE к SQL-серверам.

Вы можете указать курсор с помощью свойства WaitCursor, который будет устанавливаться при операциях с БД, занимающих заметное время (> 1 сек.).

Текстовые сообщения, посылаемые IDAPI будут отображаться на элементе, указанном свойстом MessageControl.

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

В 32-битной версии Вы можете использовать эту компоненту для трассировки обращений BDE к SQL-серверам с помощью свойств Trace, TraceFlags и события OnTrace, получая текстовые сообщения, аналогичные тем, которые отображаются утилитой SQL Monitor из состава Delphi 2.0.

ПРИМЕЧАНИЕ

Не все операции предоставляют информацию о ходе своего выполнения. Ничего не сообщается, например, при открытии таблицы. При выполнении Query посылаются сообщения о выполняемом действии. Процент сообщается при индексации, пакетных операциях, а также ряде других действий.

Кроме того, не все драйвера поддерживают Callback-функции. По крайней мере их поддерживают dBase и Paradox.

Для Delphi 2.0 в качестве прогресс-индикатора может использоваться не TGauge, а TProgressBar. Для этого нужно удалить точку в {$DEFINE USE_PROGRESSBAR} в RX.INC.


Using the TDBProgress Component

See also             TDBProgress Reference

Purpose

Устанавливает курсор в "песочные часы" (или в любой другой указанный с помощью свойства WaitCursor) при операциях с БД, занимающих заметное время. Делает это (в отличии от TSession) и для локальных драйверов IDAPI, т.е. dBase и Paradox.

Позволяет отображать текстовые сообщения и процент выполнения, сообщаемые BDE при выполнении длительных операций с помощью Callback-функций.

Tasks

Свойство Active включает или выключает действие компоненты.

Используйте свойство WaitCursor, для указания курсора, появляющегося при длительных операциях с БД.

Укажите элемент управления для отображения текстовых сообщений о ходе выполнения операции свойством MessageControl.

Укажите прогресс-индикатор, чтобы показывать процент выполнения свойством Gauge.

События OnMessageChange и OnPercentChange могут быть использованы, если вам недостаточно возможностей MessageControl и Gauge.

Событие OnProgress может быть использовано для прерывания длительной операции с базой данных.


TDBProgress See Also
See also

Common Component Tasks


TDBProgress See Also
See also

TBatchMove

TDatabase

TQuery

TSession


TDBProgress Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TDBProgress properties
Properties

Run-time only    [image] Key properties

Active	MessageControl	Trace
ComponentCount	Name	TraceFlags
ComponentIndex	Owner	WaitCursor
Components	SessionName
Gauge	Tag


TDBProgress events
Events

Run-time only    [image] Key events

OnMessageChange	OnProgress
OnPercentChange	OnTrace


TDBProgress methods
Methods

Key methods

Create	FindComponent	ProgressMsgValue
Destroy	InsertComponent	RemoveComponent


TDBProgress.Active
Active Property

Applies to

TDBProgress component

Declaration

property Active: Boolean;

Description

Установка свойства в True приводит к регистрации Callback-функции IDAPI, разрешая получение сообщений об операциях с БД. Установка свойства в False отменяет регистрацию Callback-функции, при условии, что это последняя компонента данного типа для приложения.


Gauge
Gauge Property

Applies to

TDBProgress component

Declaration

property Gauge: TControl;

Description

Указывает на прогресс-индикатор, который будет отображать процент выполнения текущей операции с БД, сообщенный BDE.

В 16-битной версии Delphi может быть использована компонента TGauge. В 32-битной версии может быть также использована компонента TProgressBar.

В версии для C++ Builder компонента TGauge не используется.


MessageControl
MessageControl Property

Applies to

TDBProgress component

Declaration

property MessageControl: TControl;

Description

Указывает на элемент управления, который будет отображать сообщения BDE о текущей операции с БД.

Для отображении текста сообщения используется свойство Caption.


Trace
Trace Property

Applies to

TDBProgress component

Declaration

property Trace: Boolean;

Description

Свойство задает, будет ли производиться трассировка обращений BDE к SQL-серверу в соответствии с заданным значением свойства TraceFlags. При значении Trace=True, при каждом обращении BDE к серверу, относящимся к одной из категорий TraceFlags, будет происходить вызов события OnTrace.


WaitCursor
WaitCursor Property

Applies to

TDBProgress component

Declaration

property WaitCursor: TCursor;

Description

Курсор, который будет устанавливаться при длительных операциях с БД.


OnMessageChange
OnMessageChange Event

Applies to

TDBProgress component

Declaration

property OnMessageChange: TOnMessageChange;

Description

Событие происходит при получении текстового сообщения от BDE.


OnPercentChange
OnPercentChange Event

Applies to

TDBProgress component

Declaration

property OnPercentChange: TOnPercentChange;

Description

Событие происходит при получении от BDE процента выполнения операции.


OnProgress
OnProgress Event

Applies to

TDBProgress component

Declaration

property OnProgress: TOnProgressEvent;

Description

Вызывается всякий раз, когда BDE возвращает с помощью callback-функции информацию о ходе операции.

Для того, чтобы прервать текущую операцию, присвойте True значению параметра Abort.


OnTrace
OnTrace Event

Applies to

TDBProgress component

Declaration

property OnTrace: TOnTraceEvent;

Description

Событие возникает при трассировке обращений BDE к SQL-серверу при установленном в True значении свойства Trace.


ProgressMsgValue
ProgressMsgValue Method

Applies to

TDBProgress component

Declaration

function ProgressMsgValue(const Msg: string): Longint;

Description

Метод принимает в качестве параметра строку текстового сообщения, посылаемую IDAPI через callback-функции. Эта строка обычно имеет формат:

  <Message_text><:><Value>.

Метод возвращает численное представление величины, содержащейся в текстовом сообщении IDAPI. Вы можете использовать вызов этого метода в обработчике события OnMessageChange.


TOnMessageChange Type

Unit

DBPrgrss

Declaration

type

TOnMessageChange = procedure(Sender: TObject; const Msg: string) of object;

Description

Параметр Msg содержит текстовую строку, полученную от BDE.


TOnPercentChange Type

Unit

DBPrgrss

Declaration

type

TOnPercentChange = procedure(Sender: TObject; PercentDone: Integer) of object;

Description

Параметр PercentDone показывает процент выполнения операции с БД.


TOnProgressEvent Type

Unit

DBPrgrss

Declaration

type

TOnProgressEvent = procedure(Sender: TObject; var Abort: Boolean) of object;

Description

TOnProgressEvent is the type of the OnProgress event of the TDBProgress component.


TOnTraceEvent Type

Unit

DBPrgrss

Declaration

type

TOnTraceEvent = procedure(Sender: TObject; Flag: TTraceFlag; const Msg: string) of object;

Description

Событие при трассировке обращений BDE к SQL-серверу. Параметр Msg содержит текстовое сообщение BDE о произведенных действиях.


DBQbe Unit

The DBQbe 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.

The following items are declared in the DBQbe unit:

Components and objects

TQBEQuery

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


TQBEQuery Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

DBQbe

Description

Компонента TQBEQuery аналогична компоненте TQuery, но позволяет работать с запросами формата QBE, совпадающего с форматом Paradox for Windows и Database Desktop.

Компонента не включает в себя редактор свойства для построения запросов QBE, и вам необходимо использовать для этого Paradox for Windows или Database Desktop. Перед использованием в TQBEQuery текст запроса желательно слегка подредактировать. Если запрос к одной базе данных, то можно убрать алиасы перед именами таблиц (алиас прописывается в свойстве DatabaseName). Кроме того, можно убрать строки, относящиеся к Answer Table (все равно они не используются, хотя ошибки не вызывают).


Using the TQBEQuery Component

See also             TQBEQuery Reference

Purpose

Компонента предназначена для выполнения запросов к БД, написанных на языке QBE (query-by-example) форматат Paradox.

Tasks

Использование компоненты не отличается от использования стандартной компоненты TQuery, только в качестве языка запросов используется язык "Query-By-Example".

В случае построения гетерогенных запросов к данным текст запроса QBE будет содержать алиасы используемых баз данных. Так как в качестве свойства DatabaseName компоненты TQBEQuery Вы можете задать только один алиас БД, то Вы должны отдельно открыть все остальные БД, используемые в запросе, перед его выполнением. Поместите на форму компоненты TDatabase для каждого используемого в запросе алиаса, установите их свойство Connected в значение True, и после этого выполняйте запрос.


TQBEQuery See Also
See also

Common Component Tasks


TQBEQuery See Also
See also

TDataSource

TQuery

TStoredProc


TQBEQuery Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TDataSet

  |

TBDEDataSet

  |

TDBDataSet


TQBEQuery properties
Properties

Run-time only    [image] Key properties

Active	EOF	RecNo
AutoCalcFields	FieldCount	RecordCount
AuxiliaryTables	FieldDefs	RecordSize
BlankAsZero	Fields	RequestLive
BOF	Handle	RowsAffected
CanModify	Local	SessionName
ComponentCount	Locale	StartParam
ComponentIndex	Modified	State
Components	Name	StmtHandle
Constrained	Owner	Tag
Constraints	ParamCheck	Text
Database	ParamCount	UpdateMode
DatabaseName	Params	UpdateObject
DataSource	Prepared
DefaultFields	QBE


TQBEQuery events
Events

Run-time only    [image] Key events

AfterCancel	AfterPost	BeforeOpen
AfterClose	BeforeCancel	BeforePost
AfterDelete	BeforeClose	OnCalcFields
AfterEdit	BeforeDelete	OnNewRecord
AfterInsert	BeforeEdit
AfterOpen	BeforeInsert


TQBEQuery methods
Methods

Key methods

Append	ExecQBE	Last
AppendRecord	FieldByName	MoveBy
Cancel	FindComponent	Next
CheckBrowseMode	FindField	Open
ClearFields	First	Post
Close	FreeBookmark	Prior
Create	GetBookmark	RemoveComponent
CursorPosChanged	GetFieldNames	Resync
Delete	GotoBookmark	SetFields
Destroy	Insert	UpdateCursorPos
DisableControls	InsertComponent	UpdateRecord
Edit	InsertRecord
EnableControls	IsEmpty


AuxiliaryTables
AuxiliaryTables Property

Applies to

TQBEQuery component

Declaration

property AuxiliaryTables: Boolean;

Description

This property tells the QBE processor whether or not to create the standard auxiliary tables (keyviol, changed, inserted, etc.). When an auxiliary table is created, it remains on your disk until it is deleted. If an auxiliary table already exists, it will be overwritten without warning. The default value is True.

CAUTION: If you set this property to False, you may not be able to fully check the results of your QBE since no auxiliary tables will be created for manual verification.


BlankAsZero
BlankAsZero Property

Applies to

TQBEQuery component

Declaration

property BlankAsZero: Boolean;

Description

Свойство позволяет управлять обработкой "пустых" (NULL) значений числовых полей при обработке запроса.

При установке BlankAsZero в True пустые значения полей в тексте запроса или переданные как параметры через свойство Params будут обрабатываться как равные нулю.


ParamCheck
ParamCheck Property

Applies to

TRxQuery, TQBEQuery components

Declaration

property ParamCheck: Boolean;

Description

The ParamCheck property determines whether the query fills the Params array when the SQL or QBE property is changed at run time. Default is True.


QBE
QBE Property

Applies to

TQBEQuery component

Declaration

property QBE: TStrings;

Description

Свойство содержит текст QBE-запроса, который выполняется при вызове методов Open или ExecQBE. После выполнения запроса с помощью метода Open вы должны вызвать метод Close перед тем, как изменить текст запроса.

Вы можете создать QBE-запрос с помощью Paradox for Windows или Database Desktop и поместить его в свойство QBE с помощью редактора списков строк, выбрав свойство QBE в Object Inspector.


StartParam
StartParam Property

Applies to

TQBEQuery component

Declaration

property StartParam: Char;

Description

Так как в тексте QBE, создаваемом Database Desktop, в именах таблиц с алиасами используется двоеточие, то символ параметра в запросе можно изменять через свойство StartParam (по умолчанию #). Идентификатор в тексте запроса после символа StartParam воспринимается как параметр и автоматически добавляется в свойство Params, работа с которым аналогична тому же свойству в TQuery. Если символ, используемый для указания параметра, необходимо использовать в строковых значениях полей, то эти значения нужно заключить в двойные кавычки (Database Desktop не заключает строки в двойные кавычки автоматически, но запрос с такими кавычками выполняется корректно).


TQBEQuery.Text
Text Property

Applies to

TQBEQuery component

Declaration

property Text: string;

Description

Points to the actual text of the QBE query passed to the Borland Database Engine (BDE).

Text is a read-only property that can be examined to determine the actual contents of QBE statement passed to the BDE.

In general there should be no need to examine the Text property. To access or change the QBE statement for the query, use the QBE property. To examine or modify parameters, use the Params property.


ExecQBE
ExecQBE Method

Applies to

TQBEQuery component

Declaration

procedure ExecQBE;

Description

Use the ExecQBE method to execute an QBE statement assigned to the QBE property of a TQBEQuery if the statement does not return a result set. If the QBE statement is an INSERT, UPDATE, DELETE, or any DDL statement, then use this method.


DBRichEd Unit

The DBRichEd 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.

The following items are declared in the DBRichEd unit:

Components and objects

TRxDBRichEdit

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


TRxDBRichEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

DBRichEd

Description

A TRxDBRichEdit object is a multiline edit control that can display and edit a rich text memo field in a dataset.

Use a TRxDBRichEdit object to enable users to edit a database field in a rich text edit control. TRxDBRichEdit provides the properties and methods to enter and work with rich text. TRxRichEdit and TRxDBRichEdit controls do not provide any user interface components to make these formatting options available to the user. Applications must implement the user interface components to surface the rich text capabilities of a TRxDBRichEdit object.

TRxDBRichEdit uses the Text property to represent the contents of the field.

If the database field does not include text formatting information, consider using a TDBMemo object or a TDBEdit object instead. If the application doesn’t require the data-aware capabilities of TRxDBRichEdit, use a rich text edit control (TRxRichEdit or TRichEdit) instead, to conserve system resources.


TRxDBRichEdit See Also
See also

TDataSet

TDataSource

TDBEdit

TDBMemo

TField

TRichEdit

TRxRichEdit


TRxDBRichEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMemo

  |

TRxCustomRichEdit


TRxDBRichEdit properties
Properties

Run-time only    [image] Key properties

Align	HelpContext	SelectionBar
Alignment	HideScrollBars	SelectionType
AllowInPlace	HideSelection	SelLength
AllowObjects	Left	SelStart
AutoDisplay	Lines	SelText
AutoVerbMenu	MaxLength	ShowHint
BorderStyle	Modified	Showing
Color	Name	TabOrder
Ctl3D	Owner	TabStop
Cursor	PageRect	Tag
DataField	Paragraph	Text
DataSource	Parent	Top
DefAttributes	ParentColor	UndoLimit
DefaultConverter	ParentCtl3D	Visible
DragCursor	ParentFont	WantReturns
DragMode	PlainText	WantTabs
Enabled	PopupMenu	Width
Field	ReadOnly	WordSelection
Font	ScrollBars	WordWrap
Height	SelAttributes


TRxDBRichEdit events
Events

Run-time only    [image] Key events

OnChange	OnKeyDown	OnResizeRequest
OnClick	OnKeyPress	OnSaveClipboard
OnDragDrop	OnKeyUp	OnSelectionChange
OnDragOver	OnMouseDown	OnStartDrag
OnEndDrag	OnMouseMove	OnURLClick
OnEnter	OnMouseUp
OnExit	OnProtectChange


TRxDBRichEdit methods
Methods

Key methods

BeginDrag	GetTextLen	ScreenToClient
BringToFront	Hide	SelectAll
ClearSelection	Invalidate	SendToBack
ClientToScreen	LoadMemo	SetBounds
CopyToClipboard	PasteFromClipboard	SetFocus
CutToClipboard	Perform	SetSelTextBuf
Dragging	Print	SetTextBuf
EndDrag	Refresh	Show
FindText	RegisterConversionFormat	Update
GetTextBuf	Repaint


DBSecur Unit

The DBSecur 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.

The following items are declared in the DBSecur unit:

Components and objects

TDBSecurity

Types

TChangePasswordEvent

TCheckUnlockEvent

TCheckUserEvent

TUpdateCaption

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


TDBSecurity Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

DBSecur

Description

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

Первый - диалог входа в программу с регистрацией пользователя (проверкой пароля, прав и т.д.) и открытием БД.

Второй - диалог смены пароля пользователя.

Компонента также может заблокировать Ваше приложение, минимизировав его, и потребовать от пользователя пароль для его разблокировки.


Using the TDBSecurity Component

See also             TDBSecurity Reference

Purpose

Компонента обеспечивает три диалога

- для регистрации и открытия БД при входе в программу

- для смены пароля пользователем

- для ввода пароля при разблокировке программы, заблокированной методом Lock.

Tasks

Установите свойства Database, UsersTableName и LoginNameField, а также напишите обработку события OnCheckUser (при необходимости) для появления диалога регистрации при загрузке вашего приложения.

Если свойства UsersTableName и  LoginNameField не заданы, то в таком виде компоненту можно использовать при соединении с SQL-сервером, который сам обеспечивает проверку прав пользователя.

Вызовите метод ChangePassword для предоставления пользователю возможности сменить его пароль.


TDBSecurity See Also
See also

Common Component Tasks


TDBSecurity See Also
See also

TDatabase


TDBSecurity Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TDBSecurity properties
Properties

Run-time only    [image] Key properties

Active	Database	Owner
AllowEmptyPassword	IniFileName	SelectAlias
AttemptNumber	LoggedUser	Tag
ComponentCount	LoginNameField	UpdateCaption
ComponentIndex	MaxPasswordLen	UseRegistry
Components	Name	UsersTableName


TDBSecurity events
Events

Run-time only    [image] Key events

AfterLogin	OnChangePassword	OnIconDblClick
BeforeLogin	OnCheckUser	OnUnlock


TDBSecurity methods
Methods

Key methods

ChangePassword	FindComponent	Login
Create	InsertComponent	RemoveComponent
Destroy	Lock


TDBSecurity.Active
Active Property

Applies to

TDBSecurity component

Declaration

property Active: Boolean;

Description

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


AllowEmptyPassword
AllowEmptyPassword Property

Applies to

TDBSecurity component

Declaration

property AllowEmptyPassword: Boolean;

Description

Свойство определяет, возможно ли в диалогах ввода пароля для соединения с БД и изменения пароля оставлять значение пароля пустым.


AttemptNumber
AttemptNumber Property

Applies to

TDBSecurity component

Declaration

property AttemptNumber: Integer;

Description

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

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


TDBSecurity.Database
Database Property

Applies to

TDBSecurity component

Declaration

property Database: TDatabase;

Description

Указывает на компоненту TDatabase, задающую БД, которая, возможно, содержит таблицу UsersTableName с именами, паролями, правами и другой необходимой информацией о пользователях.


LoggedUser
LoggedUser Property

Applies to

TDBSecurity component

Declaration

property LoggedUser: string;

Description

Свойство после успешного соединения с БД и в обработчике события OnCheckUser содержит входное имя пользователя.


LoginNameField
LoginNameField Property

Applies to

TDBSecurity component

Declaration

property LoginNameField: string;

Description

Определяет имя поля в таблице с именем UsersTableName из БД Database, используемое для идентификации пользователя по введенному имени.

!!! Должен существовать индекс по этому полю.


TDBSecurity.MaxPasswordLen
MaxPasswordLen Property

Applies to

TDBSecurity component

Declaration

property MaxPasswordLen: Integer;

Description

Свойство задает максимально возможную длину для пароля при его вводе в диалогах соединения с БД (login) и изменения пароля. При значении 0 (по умолчанию) длина пароля ограничена максимально возможной длиной строки.


TDBSecurity.SelectAlias
SelectAlias Property

Applies to

TDBSecurity component

Declaration

property SelectAlias: Boolean;

Description

Свойство определяет, будет ли в диалоге ввода имени и пароля пользователя дополнительно появляться combo-box для выбора алиаса.

Если SelectAlias=True и пользователь выбрал алиас из выпадающего списка, то компоненте TDatabase, определяемой свойством Database, перед соединением с БД будет присвоено значение свойства AliasName, совпадающее со сделанным выбором.


UpdateCaption
UpdateCaption Property

Applies to

TDBSecurity component

Declaration

property UpdateCaption: TUpdateCaption;

Description

Свойство определяет, будет ли изменяться заголовок окна-владельца компоненты TDBSecurity при соединении с БД с использованием этой компоненты. Допустимые значения свойства описываются типом TUpdateCaption:

• ucNoChange - заголовок не изменяется;

• ucAppTitle - заголовок окна после соединения с БД образуется как значение свойства Application.title + '(' + UserName + ')';

• ucFormCaption - заголовок окна после соединения с БД образуется как Form.Caption + '(' + UserName + ')'.


UseRegistry
UseRegistry Property

Applies to

TFormStorage, TFormPlacement, TDBSecurity components

Declaration

property UseRegistry: Boolean;

Description

Свойство UseRegistry присутствует только в 32-разрядной версии (в 16-разрядной версии компонент TFormPlacement и TFormStorage присутствует только для совместимости) и определяет, будут ли сохраняться инициализационные данные в текстовом INI-файле (как в Win31), либо же в регистрационной базе данных Win32 (Registry) с помощью класса TRegIniFile. В случае использования Registry свойство IniFileName будет определять имя ключа в Registry.

Для компоненты TDBSecurity в INI-файле (либо Registry) заносится имя пользователя, последний раз соединявшегося с БД.


UsersTableName
UsersTableName Property

Applies to

TDBSecurity component

Declaration

property UsersTableName: TFileName;

Description

Задает имя таблицы в БД Database, которая содержит информацию о пользователях. Поле LoginNameField в этой таблице должно содержать входные имена или идентификаторы пользователей, по которым их можно идентифицировать.


TDBSecurity.AfterLogin
AfterLogin Event

Applies to

TDBSecurity component

Declaration

property AfterLogin: TNotifyEvent;

Description

Событие вызывается из метода Login в случае успешного соединения с базой данных.


TDBSecurity.BeforeLogin
BeforeLogin Event

Applies to

TDBSecurity component

Declaration

property BeforeLogin: TNotifyEvent;

Description

Событие вызывается из метода Login перед попыткой соединения с базой данных.


OnChangePassword
OnChangePassword Event

Examples

Applies to

TDBSecurity component

Declaration

property OnChangePassword: TChangePasswordEvent;

Description

Событие для смены пароля.

К этому моменту проверено, что оба новых пароля совпадают, а UsersTable позиционирована на запись с текущим пользователем.

Нужно проверить, что введенный старый пароль валиден и произвести изменения в таблице.


OnChangePassword example
Example

function TMainForm.SecurityChangePassword(UsersTable: TTable;

  const OldPassword, NewPassword: String): Boolean;

begin

  Result := False;

  if SecurityCheckUser(UsersTable, OldPassword) then begin

    with UsersTable do begin

      Edit;

      FieldByName('PASSWORD').AsString := CryptString(PswdKey, NewPassword);

      Post;

      Result := True;

    end;

  end;

end;


OnCheckUser
OnCheckUser Event

Examples

Applies to

TDBSecurity component

Declaration

property OnCheckUser: TCheckUserEvent;

Description

Событие для проверки прав пользователя.

К моменту вызова этого события пользователь уже найден в таблице UsersTableName по введенному им имени и полю LoginNameField, то есть таблица UsersTable позиционирована на нужную запись.

Остается прочитать нужные поля и сделать вывод о результатах проверки, не забыв вернуть нужное логическое значение. Можно также сохранить где-нибудь необходимую информацию о текущем пользователе.

Событие вызывается и в том случае, если таблица UsersTableName не задана.

В обработчике события OnCheckUser Вы можете использовать значение свойства LoggedUser, которое содержит имя пользователя, введенное им в диалоге регистрации.


OnCheckUser example
Example

function TMainForm.SecurityCheckUser(UsersTable: TTable;

  const Password: String): Boolean;

begin

  Result := False;

  with UsersTable do begin

    if CryptString(PswdKey, FieldByName('PASSWORD').AsString) = Password then begin

      Result := True;

      UserId := FieldByName('ID').AsInteger;

      UserLevel := FieldByName('USER_LEVEL').AsInteger;

    end;

  end;

end;


TDBSecurity.OnIconDblClick
OnIconDblClick Event

Applies to

TDBSecurity component

Declaration

property OnIconDblClick: TNotifyEvent;

Description

Событие возникает при двойном нажатии мыши на иконке в диалогах регистрации и разблокирования. В обработчике этого события Вы можете, например, вызвать диалог с дополнительной информацией.


OnUnlock
OnUnlock Event

Applies to

TDBSecurity component

Declaration

property OnUnlock: TCheckUnlockEvent;

Description

Событие вызывается для проверки введенного пользователем пароля при разблокировании приложения, предварительно заблокированного методом Lock.

Вы должны вернуть False из вашего обработчика события OnUnlock для того, чтобы запретить разблокирование приложения.


ChangePassword
ChangePassword Method

Applies to

TDBSecurity component

Declaration

function ChangePassword: Boolean;

Description

Вызывает диалог "Смена пароля". Важно правильно обработать событие OnChangePassword. Вы должны самостоятельно произвести в том событии все необходимые действия для смены пароля пользователя в базе данных. Например, вы можете выполнить соответствующий SQL-оператор или сделать необходимые изменения в таблицах БД.


TDBSecurity.Lock
Lock Method

Applies to

TDBSecurity component

Declaration

procedure Lock;

Description

Метод предназначен для "блокирования" приложения.

При вызове метода Lock приложение минимизируется и при попытке восстановления его размеров выводит диалог ввода пароля. Вы можете обработать введенный пользователем пароль в событии OnUnlock.


TDBSecurity.Login
Login Method

Applies to

TDBSecurity component

Declaration

function Login: Boolean;

Description

Метод вызывается после загрузки формы, которой принадлежит компонента, если свойство Active = True.

Показывает диалог регистрации, пытается открыть БД, проверяет права пользователя с помощью события OnCheckUser.

Вызывать извне требуется только в случае установки свойства Active в False.


TChangePasswordEvent Type

Unit

DBSecur

Declaration

type

TChangePasswordEvent = function(UsersTable: TTable; const OldPassword, NewPassword: string): Boolean of object;

Description

Тип определен для события OnChangePassword компоненты TDBSecurity.


TCheckUnlockEvent Type

Unit

DBSecur

Declaration

type

TCheckUnlockEvent = function(const Password: string): Boolean of object;

Description

Тип определен для события OnUnlock компоненты TDBSecurity.


TCheckUserEvent Type

Unit

DBSecur

Declaration

type

TCheckUserEvent = function(UsersTable: TTable; const Password: string): Boolean of object;

Description

Тип определен для события OnCheckUser компоненты TDBSecurity.


TUpdateCaption Type

Unit

DBSecur

Declaration

type

TUpdateCaption = (ucNoChange, ucAppTitle, ucFormCaption);

Description

Тип предназначен для значений свойства UpdateCaption компоненты TDBSecurity.


DBUtils Unit

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 DBUtils unit:

Components and objects

TLocateObject

Constants

ServerDateFmt

Procedures and functions

AssignRecord

CheckRequiredField

ConfirmDataSetCancel

ConfirmDelete

DataSetSortedSearch

FormatAnsiSQLCondition

FormatSQLCondition

FormatSQLDateRange

RefreshQuery

RestoreFields

RestoreFieldsReg

SaveFields

SaveFieldsReg

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


TLocateObject object
TLocateObject Class

Hierarchy             See also             Properties             Methods

Unit

DBUtils

Description

Класс TLocateObject предназначен для позиционирования набора данных на запись, соответствующую заданному условию. Единственный метод этого класса - функция Locate, в которую вы можете передать имя любого поля из набора данных, заданного свойством DataSet, и значение этого поля. Набор данных будет позиционирован на первую запись, удовлетворяющую этому условию.

При работе с данными через BDE всегда используйте класс TDBLocate (наследник от TLocateObject), объявленный в модуле BDEUtils.

Примечание

Класс в основном предназначен для работы в Delphi 1.0. В более старших версиях Delphi Вы можете использовать стандартный метод Locate компоненты TDataSet. Класс TLocateObject в 32-разрядной версии просто вызывает стандартный метод TDataSet.Locate.


TLocateObject See Also
See also

TDataSet

TDBLocate

TRxDBFilter


TLocateObject Hierarchy
Hierarchy

TObject


TLocateObject properties
Properties

Run-time only    [image] Key properties

DataSet	IndexSwitch


TLocateObject methods
Methods

Key methods

Create	Destroy	Locate


TLocateObject.DataSet
DataSet Property

Applies to

TLocateObject component

Declaration

property DataSet: TDataSet;

Description

Свойство DataSet задает набор данных (таблицу или результат запроса), в котором будет производиться поиск при вызове метода Locate.


TLocateObject.IndexSwitch
IndexSwitch Property

Applies to

TLocateObject component

Declaration

property IndexSwitch: Boolean;

Description

Свойство управляет тем, будет или нет переключаться активный индекс, по которому открыта таблица, при поиске (для класса TDBLocate) или при "быстром наборе" по первым буквам (для компонентов TRxDBLookupList и TRxDBLookupCombo). Если свойство IndexSwitch установлено в True (по умолчанию), набор данных (в котором производится поиск) является таблицей, и таблица имеет индекс по полю, на которое накладывается условие, то этот индекс делается активным для выполнения операции поиска. Если же свойство IndexSwitch установлено в False, то переключения индексов не происходит, и индекс используется при поиске только в том случае, если таблица уже открыта по этому индексу.

Установка значения свойства в False может быть полезна при работе с SQL-таблицами, переключение индексов для которых происходит гораздо медленнее, чем для локальных таблиц форматов dBase или Paradox.

Для объектов класса TLocateObject свойство не используется.


Locate
Locate Method

Applies to

TLocateObject, TDBLocate components

Declaration

function Locate(const KeyField, KeyValue: string; Exact, CaseSensitive: Boolean): Boolean;

Description

Метод Locate служит для поиска записи в наборе данных, определяемом свойством DataSet. В качестве параметров принимает имя любого поля из набора данных DataSet, и значение этого поля. Набор данных будет позиционирован на первую запись, удовлетворяющую заданному условию. Если параметр Exact равен True, то поиск производитсядо точного совпадения значения поля и параметра KeyValue, если False - то набор данных позиционируется на превую запись со значением поля большим или равным заданному. Параметр CaseSensitive определяет, будет ли учитываться регистр при поиске по строковым значениям полей.


ServerDateFmt Constant

Unit

DBUtils

Declaration

const

  ServerDateFmt: string[50] = '''"''mm''/''dd''/''yyyy''"''';

Description

Задает формат даты в выражениях SQL. Используется функциями FormatSQLDateRange, FormatSQLCondition и FormatAnsiSQLCondition. Вы можете переопределить значение этой константы в соответствии с форматом даты, используемым Вашим SQL-сервером.

Модуль DBUtils содержит также константы, содержащие значения, которые Вы можете присвоить переменной ServerDateFmt:

• sdfStandard16, sdfStandard32 - для работы с драйвером STANDARD (local SQL);

• sdfOracle - формат даты, используемый сервером ORACLE;

• sdfInterbase - формат даты, используемый сервером INTERBASE.


AssignRecord Procedure

Examples

Unit

DBUtils

Declaration

procedure AssignRecord(Source, Dest: TDataSet; ByName: Boolean);

Description

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

Если параметр ByName имеет значение True, то установка значений полей происходит по их именам, то есть если для поля из Dest найдено поле в Source с тем же именем, то его значение присваивается полю в Dest. Если же ByName = False, то присвоение значений полям происходит по порядку их расположения в исходных наборах данных (этот порядок совпадает с порядком в свойстве FieldDefs).


AssignRecord example
Example

  MemoryTable1.Append;

  AssignRecord(SourceDataSet, MemoryTable1, True);

  MemoryTable1.Post;


CheckRequiredField Procedure

Examples

Unit

DBUtils

Declaration

procedure CheckRequiredField(Field: TField);

Description

Процедура проверяет заполнение поля Field значением, отличным от NULL. В случае отсутствия значения в поле происходит генерация исключения (exception).


CheckRequiredField example
Example

  CheckRequiredField(InventoryTableACCOUNT_NO);


ConfirmDataSetCancel Procedure

Examples

Unit

DBUtils

Declaration

procedure ConfirmDataSetCancel(DataSet: TDataSet);

Description

Процедура проверяет, находится ли переданный набор данных DataSet в режиме вставки или замены, модифицированы ли данные текущей записи, и если да, то запрашивает, надо ли сохранять сделанные изменения. Если пользователь выбирает "сохранить", функция выполняет DataSet.Post, в противном случае вызывается DataSet.Cancel.


ConfirmDataSetCancel example
Example

procedure TForm1.FormCloseQuery(Sender: TObject; var CanClose: Boolean);

begin

  ConfirmDataSetCancel(Table1);

end;


ConfirmDelete Function

Examples

Unit

DBUtils

Declaration

function ConfirmDelete: Boolean;

Description

Функция вызывает появление диалога с запросом подтверждения на удаление записи, аналогичного диалогу, появляющемуся у TDBGrid. Возвращает True в случае, если пользователь нажал кнопку "Yes" ("Да") и False в противном случае.


ConfirmDelete example
Example

if ConfirmDelete then

  Table1.Delete;


DataSetSortedSearch Function

Examples

Unit

DBUtils

Declaration

function DataSetSortedSearch(DataSet: TDataSet; const Value: string; const FieldName: string; Unique, IgnoreCase: Boolean): Boolean;

Description

Функция пытается установить набор данных, переданный в качестве параметра DataSet, на первую от начала запись, удовлетворяющую заданному условию. Условие задается для строкового поля с именем FieldName путем передачи в функцию параметра Value - строкового представления искомого значения поля. В результате DataSet будет установлен на первую от начала запись, значение поля FieldName которой НАЧИНАЕТСЯ с символов строки Value.

Набор данных должен быть отсортирован по полю, на значение которого накладывается условие. Это может быть сделано путем открытия таблицы (TTable) по соответствующему индексу, либо заданием оператора ORDER BY для запроса (TQuery). В случае отсутствия индекса (например, для TQuery) поиск нужной записи производится с помощью алгоритма двоичного поиска. Если значения поля не могут повторяться, задайте параметр Unique равным True для минимизации действий поиска. Параметр IgnoreCase позволяет указать, нужно ли игнорировать регистр символов при поиске.


DataSetSortedSearch example
Example

  ...

  if not DataSetSortedSearch(DataSet, 'Smit', 'Client_Name', False, True) then

    MessageDlg('Record not found', mtError, [mbOk], 0);

  ...


FormatAnsiSQLCondition Function

Examples

Unit

DBUtils

Declaration

function FormatAnsiSQLCondition(const FieldName, Operator, Value: string; FieldType: TFieldType; Exact: Boolean): string;

Description

Функция сходна по назначению и результатам с FormatSQLCondition, но кроме того позволяет использовать в масках любые символы, определяя ESCAPE-символ. Может быть использована с любым SQL-сервером, поддерживающим ESCAPE-символы.


FormatAnsiSQLCondition example
Example

  rxQuery1.MacroByName('CONTRACT_NO').AsString :=

    FormatSQLCondition('CONTRACTS."CONTRACT_NO"', '', 'И%4596*',

    ftString, True);


FormatSQLCondition Function

Examples

Unit

DBUtils

Declaration

function FormatSQLCondition(const FieldName, Operator, Value: string; FieldType: TFieldType; Exact: Boolean): string;

Description

Функция возвращает строковое выражение, соответствующее записи логического условия на языке SQL. Используется, в основном, для подстановки параметров (макросов) TRxQuery.

Если Operator = '', то используется либо знак равенства, либо оператор LIKE, в зависимости от параметра Exact. Символы '*' и '?' заменяются на '%' и '_'.


FormatSQLCondition example
Example

rxQuery1.MacroByName('CONTRACT_NO').AsString :=

  FormatSQLCondition('CONTRACTS."CONTRACT_NO"', '', 'И4596',

  ftString, True);


FormatSQLDateRange Function

Examples

Unit

DBUtils

Declaration

function FormatSQLDateRange(Date1, Date2: TDateTime; const FieldName: string): string;

Description

Возвращает логическое условие для языка SQL нахождения значения поля, заданного FieldName в интервале, заданном Date1 и Date2. Учитываются особые случаи:

• Data1 = Data2 = NullDate - все время;

• Date1 = NullDate - интервал до Date2;

• Date2 = NullDate - интервал с Date1.

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


FormatSQLDateRange example
Example

FormatSQLDateRange(0, Date1, 'CONTRACTS."ACTIVE_FROM"')

Date1 = 01.01.95

Result = 'CONTRACTS."ACTIVE_FROM" < "01/01/1995"'


RefreshQuery Procedure

Examples

Unit

DBUtils

Declaration

procedure RefreshQuery(Query: TDataSet);

Description

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

  Query.Close;

  Query.Open;

Кроме того, процедура сохраняет и восстанавливает текущую позицию в наборе данных с помощью установки закладки (Bookmark).


RefreshQuery example
Example

  RefreshQuery(Query1);


RestoreFields Procedure

Examples

Unit

DBUtils

Declaration

procedure RestoreFields(DataSet: TDataSet; IniFile: TIniFile; RestoreVisible: Boolean);

Description

Процедура восстанавливает из INI-файла IniFile аттрибуты полей набора данных, заданного в DataSet.

Восстанавливается индекс поля и его отображаемая ширина в пикселях.

Используется, чтобы сохранить изменения, сделанные пользователем при просмотре данных в Grid'е (порядок полей, их ширины).


RestoreFields example
Example

  procedure RestoreLayout;

  var

    IniFile: TIniFile;

  begin

    IniFile := TIniFile.Create(FormStorage.IniFileName);

    try

      RestoreFields(DataSet, IniFile);

    finally

      IniFile.Free;

    end;

  end;


RestoreFieldsReg Procedure

Examples

Unit

DBUtils

Declaration

procedure RestoreFieldsReg(DataSet: TDataSet; IniFile: TRegIniFile; RestoreVisible: Boolean);

Description

Функция полностью аналогична RestoreFields, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).


RestoreFieldsReg example
Example

  uses Registry, Placemnt, DBUtils;

    ...

  procedure RestoreDSLayout;

  var

    RegIniFile: TRegIniFile;

  begin

    IniFile := TRegIniFile.Create(FormStorage.IniFileName);

    try

      RestoreFieldsReg(DataSet, RegIniFile);

    finally

      RegIniFile.Free;

    end;

  end;


SaveFields Procedure

Examples

Unit

DBUtils

Declaration

procedure SaveFields(DataSet: TDataSet; IniFile: TIniFile);

Description

Процедура сохраняет в INI-файле IniFile аттрибуты полей набора данных, заданного в DataSet.

Сохраняется индекс поля и его отображаемая ширина в пикселях.

Используется, чтобы сохранить изменения, сделанные пользователем при просмотре данных в Grid'е (порядок полей, их ширины).


SaveFields example
Example

procedure TGridForm.FormStorageSavePlacement(Sender: TObject);

var

  DataSet: TDataSet;

  I: Integer;

begin

  for I := 0 to TabSet.Tabs.Count - 1 do begin

    DataSet := DataSetByIndex(TabSet.TabIndex);

    if (DataSet <> nil) and (DataSet.Active) then

      SaveFields(DataSet, FormStorage.IniFile);

  end;

end;


SaveFieldsReg Procedure

Examples

Unit

DBUtils

Declaration

procedure SaveFieldsReg(DataSet: TDataSet; IniFile: TRegIniFile);

Description

Функция полностью аналогична SaveFields, но предназначена для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).


SaveFieldsReg example
Example

procedure TGridForm.FormStorageSavePlacement(Sender: TObject);

var

  DataSet: TDataSet;

  I: Integer;

begin

  for I := 0 to TabSet.Tabs.Count - 1 do begin

    DataSet := DataSetByIndex(TabSet.TabIndex);

    if (DataSet <> nil) and (DataSet.Active) then

      if FormStorage.UseRegistry then

        SaveFieldsReg(DataSet, FormStorage.RegIniFile)

      else

        SaveFields(DataSet, FormStorage.IniFile);

  end;

end;


DualList Unit

The DualList unit contains the declarations for the certain components on the RX Tools 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 DualList unit:

Components and objects

TDualListDialog

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


TDualListDialog Component

Hierarchy             See also             Properties             Methods

Unit

DualList

Description

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

По сравнению с одноименной формой из Delphi Gallery, кроме оформления в виде компоненты, добавлены возможность Drag&Drop, задания порядка внутри списка, интерфейсные улучшения.

Задайте исходное состояние списков в свойствах List1 и List2, вызовите диалог функцией Execute и считайте новый состав списков.


TDualListDialog See Also
See also

TListBox

TStrings

TTextListBox


TDualListDialog Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TDualListDialog properties
Properties

Run-time only    [image] Key properties

CancelBtnCaption	HelpContext	OkBtnCaption
ComponentCount	Label1Caption	Owner
ComponentIndex	Label2Caption	ShowHelp
Components	List1	Sorted
Ctl3D	List2	Tag
HelpBtnCaption	Name	Title


TDualListDialog methods
Methods

Key methods

Create	Execute	InsertComponent
Destroy	FindComponent	RemoveComponent


CancelBtnCaption
CancelBtnCaption Property

Applies to

TDualListDialog component

Declaration

property CancelBtnCaption: TCaption;

Description

Текст заголовка, который будет на кнопке "Отмена".


HelpBtnCaption
HelpBtnCaption Property

Applies to

TDualListDialog component

Declaration

property HelpBtnCaption: TCaption;

Description

Текст, который будет на кнопке "Справка", если она будет присутствовать.


Label1Caption
Label1Caption Property

Applies to

TDualListDialog component

Declaration

property Label1Caption: TCaption;

Description

Текст метки для левого списка.


Label2Caption
Label2Caption Property

Applies to

TDualListDialog component

Declaration

property Label2Caption: TCaption;

Description

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


List1
List1 Property

Applies to

TDualListDialog component

Declaration

property List1: TStrings;

Description

Список слева.


List2
List2 Property

Applies to

TDualListDialog component

Declaration

property List2: TStrings;

Description

Список справа.


OkBtnCaption
OkBtnCaption Property

Applies to

TDualListDialog component

Declaration

property OkBtnCaption: TCaption;

Description

Текст кнопки "ОК" в диалоге.


ShowHelp
ShowHelp Property

Applies to

TDualListDialog component

Declaration

property ShowHelp: Boolean;

Description

Показывать ли кнопку вызова Справки.


TDualListDialog.Sorted
Sorted Property

Applies to

TDualListDialog component

Declaration

property Sorted: Boolean;

Description

Должны ли быть списки отображены в отсортированном виде. Установка свойства в True запрещает перемещение элементов внутри одного списка.


TDualListDialog.Title
Title Property

Applies to

TDualListDialog component

Declaration

property Title: string;

Description

Текст заголовка диалога.


TDualListDialog.Execute
Execute Method

Applies to

TDualListDialog component

Declaration

function Execute: Boolean;

Description

Вызов диалога с двумя списками, где можно поменять элементы местами внутри списка или перенести элементы из одного списка в другой.


FileUtil Unit

The following items are declared in the FileUtil unit:

Procedures and functions

BrowseComputer

BrowseDirectory

ClearDir

CopyFile

DeleteFiles

DeleteFilesEx

DirExists

FileDateTime

FileLock

FileUnlock

GetFileSize

GetSystemDir

GetTempDir

GetWindowsDir

HasAttr

LongToShortFileName

LongToShortPath

MoveFile

NormalDir

ShortToLongFileName

ShortToLongPath

ValidFileName

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


BrowseComputer Function

Examples

Unit

FileUtil

Declaration

function BrowseComputer(var ComputerName: string; const DlgText: string; AHelpContext: THelpContext): Boolean;

Description

BrowseComputer brings up a dialog to allow the user to select a network computer name.

The name of the computer the user selects becomes the value of ComputerName parameter when the function returns. The AHelpContext parameter is the help context ID number.

The function returns True if the user selected a computer name and chose OK, and False if the user chose Cancel or closed the dialog box without selecting a computer.


BrowseComputer example
Example

const

  BROWSECOMPHELP = 1000;

procedure TForm1.Button1Click(Sender: TObject);

var

  CompName: string;

begin

  CompName := Edit1.Text;

  if BrowseComputer(CompName, 'Select a computer',

    BROWSECOMPHELP) then

    Edit1.Text := CompName;

end;


BrowseDirectory Function

Examples

Unit

FileUtil

Declaration

function BrowseDirectory(var FolderName: string; const DlgText: string; AHelpContext: THelpContext): Boolean;

Description

BrowseDirectory brings up a dialog to allow the user to select a directory name.

The directory passed to the function with the FolderName parameter appears as the currently selected directory when the dialog box appears. The name of the directory the user selects becomes the value of FolderName when the function returns. BrowseDirectory does not change the value of the current directory.

The AHelpContext parameter is the help context ID number.

The function returns True if the user selected a directory and chose OK, and False if the user chose Cancel or closed the dialog box without selecting a directory.


BrowseDirectory example
Example

const

  BROWSEDIRHELP = 1000;

procedure TForm1.Button1Click(Sender: TObject);

var

  Dir: string;

begin

  Dir := 'C:\MYDIR';

  if BrowseDirectory(Dir, 'Select a path to the target database.',

    BROWSEDIRHELP) then

    Label1.Caption := Dir;

end;


ClearDir Function

Examples

Unit

FileUtil

Declaration

function ClearDir(const Path: string; Delete: Boolean): Boolean;

Description

Функция удаляет все файлы из каталога Path и его подкаталогов. Если параметр Delete имеет значение True, то функция также удаляет сам каталог, заданный параметром Path и все его подкаталоги. При удалении файлов игнорируется аттрибут Read-Only. При успешном завершении функция возвращает значение True, в противном случае - False.


ClearDir example
Example

if ClearDir('c:\temp', True) then

  ShowMessage('Directory C:\TEMP deleted')

else

  ShowMessage('Can''t delete directory C:\TEMP');


CopyFile Procedure

Examples

Unit

FileUtil

Declaration

procedure CopyFile(const FileName, DestName: string; ProgressControl: TControl);

Description

Функция предназначена для копирования файла FileName в файл с именем DestName. Если параметр ProgressControl содержит значение, отличное от nil, то элемент управления, заданный этим параметром, (например, TGauge в 16-битной версии или TProgressBar в Win32) будет отображать процесс копирования файла.


CopyFile example
Example

  CopyFile('c:\work\unit1.pas', 'd:\test\unit1.pas',  Gauge);


DeleteFiles Function

Examples

Unit

FileUtil

Declaration

function DeleteFiles(const FileMask: string): Boolean;

Description

Удаляет все файлы, заданные маской FileMask.


DeleteFiles example
Example

  DeleteFiles('work\myproj\*.pas');


DeleteFilesEx Function

Examples

Unit

FileUtil

Declaration

function DeleteFilesEx(const FileMasks: array of string): Boolean;

Description

Удаляет все файлы, заданные масками FileMasks.


DeleteFilesEx example
Example

  DeleteFilesEx(['work\myproj\*.exe', 'work\myproj\*.dcu']);


DirExists Function

Examples

Unit

FileUtil

Declaration

function DirExists(Name: string): Boolean;

Description

The DirExists function determines whether the directory specified as the value of the Name parameter exists. If the directory exists, the function returns True. If the directory does not exist, the function returns False. If only a directory name is entered as the value of Name, DirExists searches for the directory within the current directory. If a full path name is entered, DirExists searches for the directory along the designated path.


DirExists example
Example

This example uses an edit box, a label, and a button on a form. When the user enters a directory name in the edit box and clicks the button, whether or not the directory exists is reported in the caption of the label:

 procedure TForm1.Button1Click(Sender: TObject);

 begin

   if DirExists(Edit1.Text) then

     Label1.Caption := Edit1.Text + ' exists'

   else

     Label1.Caption := Edit1.Text + ' does not exist';

 end;


FileDateTime Function

Examples

Unit

FileUtil

Declaration

function FileDateTime(const FileName: string): TDateTime;

Description

Функция возвращает дату и время создания файла FileName.


FileDateTime example
Example

  D1 := FileDateTime('unit1.pas');


FileLock Function

Examples

Unit

FileUtil

Declaration

function FileLock(Handle: Integer; Offset, LockSize: Longint): Integer;

Description

The FileLock function locks a region in an open file. Locking a region prevents other processes from accessing the region. Handle identifies the file with a region to be locked. Offset specifies the starting byte offset in the file where the lock should begin. LockSize specifies the length of the byte range to be locked.


FileLock example
Example

var

  FileHandle : Integer;

begin

  FileHandle := FileOpen(FileName, fmOpenWrite or fmShareDenyNone);

  if FileHandle > 0 then

  try

    { valid file handle }

    if FileLock(FileHandle, 0, 1024) = 0 then

    try

      { first 1024 bytes of opened file is locked }

    finally

      FileUnlock(FileHandle, 0, 1024);

    end;

  finally

    FileClose(FileHandle);

  end

  else {Open error: FileHandle = negative DOS error code};

end;


FileUnlock Function

Examples

Unit

FileUtil

Declaration

function FileUnlock(Handle: Integer; Offset, LockSize: Longint): Integer;

Description

The FileUnlock function unlocks a region in an open file. Unlocking a region enables other processes to access the region. Handle identifies a file that contains a region locked with FileLock. Offset specifies the starting byte offset in the file where the locked region begins. LockSize specifies the length of the byte range to be unlocked.


FileUnlock example
Example

var

  FileHandle : Integer;

begin

  FileHandle := FileOpen(FileName, fmOpenWrite or fmShareDenyNone);

  if FileHandle > 0 then

  try

    { valid file handle }

    if FileLock(FileHandle, 0, 1024) = 0 then

    try

      { first 1024 bytes of opened file is locked }

    finally

      FileUnlock(FileHandle, 0, 1024);

    end;

  finally

    FileClose(FileHandle);

  end

  else {Open error: FileHandle = negative DOS error code};

end;


GetFileSize Function

Examples

Unit

FileUtil

Declaration

function GetFileSize(const FileName: string): Longint;

Description

Функция возвращает размер в байтах файла, заданного параметром FileName.


GetFileSize example
Example

  FSize := GetFileSize('c:\utils\arj.exe');


GetSystemDir Function

Examples

Unit

FileUtil

Declaration

function GetSystemDir: string;

Description

The GetSystemDir function retrieves the path of the Windows system directory. The system directory contains such files as Windows libraries, drivers, and font files.

For example, if the system directory is named WINDOWS\SYSTEM on drive C, the path of the system directory retrieved by this function is C:\WINDOWS\SYSTEM.


GetSystemDir example
Example

var

  S: string;

begin

  {...}

  S := GetSystemDir;

  {...}

end;


GetTempDir Function

Examples

Unit

FileUtil

Declaration

function GetTempDir: string;

Description

The GetTempDir function retrieves the path of the directory designated for temporary files.


GetTempDir example
Example

  S := GetTempDir;

  try

    with TFileStream.Create(S, fmCreate) do

    try

      {...}

    finally

      Free;

    end;

    {...}

  finally

    DeleteFile(S);

  end;


GetWindowsDir Function

Examples

Unit

FileUtil

Declaration

function GetWindowsDir: string;

Description

The GetWindowsDir function retrieves the path of the Windows directory. The Windows directory contains such files as Windows-based applications, initialization files, and Help files.


GetWindowsDir example
Example

var

  S: string;

begin

  {...}

  S := GetWindowsDir;

  {...}

end;


HasAttr Function

Examples

Unit

FileUtil

Declaration

function HasAttr(const FileName: string; Attr: Integer): Boolean;

Description

Функция возвращает True, если файл FileName имеет аттрибут Attr.


HasAttr example
Example

if HasAttr('c:\my_file.exe', faReadOnly) then

  raise Exception.Create('Can't delete read-only file');


LongToShortFileName Function

Examples

Unit

FileUtil

Declaration

function LongToShortFileName(const LongName: string): string;

Description

Use this procedure to obtain the short version of the file name specified by LongName parameter.


LongToShortFileName example
Example

FileName := LongToShortFileName(FileName);


LongToShortPath Function

Examples

Unit

FileUtil

Declaration

function LongToShortPath(const LongName: string): string;

Description

Use this procedure to obtain the short version of the directory name specified by LongName parameter.


LongToShortPath example
Example

DirectoryName := LongToShortPath(DirectoryName);


MoveFile Procedure

Examples

Unit

FileUtil

Declaration

procedure MoveFile(const FileName, DestName: TFileName);

Description

Процедура перемещает или переименовывает файл FileName в файл с именем DestName.


MoveFile example
Example

  MoveFile(FileName, ChangeFileExt(FileName, '.BAK'));


NormalDir Function

Examples

Unit

FileUtil

Declaration

function NormalDir(const DirName: string): string;

Description

Функция служит для нормализации имени каталога. Возвращает имя каталога, при необходимости заканчивающееся символом '\', к которому можно добавить имя файла для получения допустимого полного имени файла ОС.


NormalDir example
Example

  {...}

  Result := NormalDir(DirName) + ExtractFileName(MyFileName);

  {...}


ShortToLongFileName Function

Examples

Unit

FileUtil

Declaration

function ShortToLongFileName(const ShortName: string): string;

Description

Use this procedure to obtain the long version of the file name specified by ShortName parameter.


ShortToLongFileName example
Example

FileName := ShortToLongFileName(FileName);


ShortToLongPath Function

Examples

Unit

FileUtil

Declaration

function ShortToLongPath(const ShortName: string): string;

Description

Use this procedure to obtain the long version of the directory name specified by ShortName parameter.


ShortToLongPath example
Example

DirectoryName := ShortToLongPath(DirectoryName);


ValidFileName Function

Examples

Unit

FileUtil

Declaration

function ValidFileName(const FileName: string): Boolean;

Description

Функция определяет, является ли имя, переданное как параметр FileName, допустимым именем файла.


ValidFileName example
Example

  if not ValidFileName(S) then

    ShowMessage('Invalid file name');


GIFCtrl Unit

The GIFCtrl 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 GIFCtrl unit:

Components and objects

TRxGIFAnimator

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


TRxGIFAnimator Component

Hierarchy             See also             Properties             Methods             Events

Unit

GIFCtrl

Description

Компонента предназначена для отображения в Ваших формах анимированных графических изображений формата GIF.

Рисунок, отображаемый в форме, задается свойством Image. Номер кадра, отображаемого в настоящий момент, во время выполнения можно определить по значению свойства FrameIndex. Вы можете также задать это значение в дизайнере. Если свойство Animate установлено в True, то изображение анимируется. Частота смены кадров задана в самом формате GIF и не может быть изменена.

Свойство Transparent определяет, будет ли компонента изображать GIF прозрачным, используя свойство TGIFImage.TransparentColor.

Компонета также включает в себя свойства, аналогичные свойствам TImage.


TRxGIFAnimator See Also
See also

TAnimatedImage

TGIFImage


TRxGIFAnimator Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TGraphicControl

  |

TRxImageControl


TRxGIFAnimator properties
Properties

Run-time only    [image] Key properties

Align	Enabled	ParentShowHint
Animate	FrameIndex	PopupMenu
AsyncDrawing	Height	ShowHint
AutoSize	HelpContext	Showing
Center	Hint	Stretch
ComponentCount	Image	Tag
ComponentIndex	Left	Top
Components	Loop	Transparent
Cursor	Name	Visible
DragCursor	Owner	Width
DragMode	Parent


TRxGIFAnimator events
Events

Run-time only    [image] Key events

OnChange	OnEndDrag	OnStart
OnClick	OnFrameChanged	OnStartDrag
OnDblClick	OnMouseDown	OnStop
OnDragDrop	OnMouseMove
OnDragOver	OnMouseUp


TRxGIFAnimator methods
Methods

Key methods

BeginDrag	Hide	ScreenToClient
BringToFront	Invalidate	SendToBack
ClientToScreen	Perform	SetBounds
Dragging	Refresh	Show
EndDrag	Repaint	Update


TRxGIFAnimator.Animate
Animate Property

Applies to

TRxGIFAnimator component

Declaration

property Animate: Boolean;

Description

Свойство определяет, будет ли автоматически меняться номер отображаемого кадра с интервалом, заданным в формате GIF. Если это свойство имеет значение False, то смены изображений не происходит, а номер текущего отображаемого кадра задается свойством FrameIndex.

Если свойство Loop = False, то после однократного "проигрывания" всех кадров изображения свойство Animate будет сброшено в значение False.


TRxGIFAnimator.FrameIndex
FrameIndex Property

Applies to

TRxGIFAnimator component

Declaration

property FrameIndex: Integer;

Description

Свойство определяет номер текущего отображаемого кадра в компоненте. Номер кадра должен принадлежать диапазону от 0 до максимального номера кадра в изображении GIF, заданного свойством Image (TGIFImage.Count - 1).

Когда свойство Image не задано, значение FrameIndex = -1.


TRxGIFAnimator.Image
Image Property

Applies to

TRxGIFAnimator component

Declaration

property Image: TGIFImage;

Description

Свойство Image задает графическое изображение формата GIF, которое может быть использовано для анимации.


TRxGIFAnimator.Loop
Loop Property

Applies to

TRxGIFAnimator component

Declaration

property Loop: Boolean;

Description

Свойство определяет, будет ли циклически повторяться последовательность кадров анимации, сохраненной в формате GIF. Если свойство установлено в значение True (по умолчанию), то после того, как свойство FrameIndex достигнет максимально возможного значения, оно будет сброшено в значение 0, и анимация будет продолжена. Если Loop=False, то после прохождения полного цикла анимации свойство Animate будет установлено в значение False (с вызовом события OnStop).


TRxGIFAnimator.Transparent
Transparent Property

Applies to

TRxGIFAnimator component

Declaration

property Transparent: Boolean;

Description

Свойство определяет, будет ли изображение GIF рисоваться прозрачным, используя свойство TransparentColor класса TGIFImage; или же будет использован фоновый цвет, указанный в изображении формата GIF.


OnFrameChanged
OnFrameChanged Event

Applies to

TRxGIFAnimator component

Declaration

property OnFrameChanged: TNotifyEvent;

Description

Событие происходит при каждой смене кадра изображения компоненты TRxGIFAnimator. Текущее значения номера кадра можно получить как значение свойства FrameIndex.


IcoList Unit

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 IcoList unit:

Components and objects

TIconList

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


TIconList object
TIconList Class

Hierarchy             See also             Properties             Methods             Events

Unit

IcoList

Description

Класс предназначен для хранения списков иконок (объектов класса TIcon). Вы можете добавить иконки в список с помощью методов Add, AddResource, Insert, InsertResource, LoadResource. Иконки, содержащиесяв списке, доступны через индексированное свойство Icons[Index: Integer]. При изменении содержимого списка вызывается событие OnChange.


TIconList See Also
See also

TAnimatedCursorImage

TList

TStringList

TStrings


TIconList Hierarchy
Hierarchy

TObject

  |

TPersistent


TIconList properties
Properties

Run-time only    [image] Key properties

Count	Icons


TIconList events
Events

Run-time only    [image] Key events

OnChange


TIconList methods
Methods

Key methods

Add	Create	IndexOf
AddResource	Delete	Insert
Assign	Destroy	InsertResource
BeginUpdate	EndUpdate	LoadResource
Clear	Exchange	Move


TIconList.Icons[Index: Integer]
Icons Property

Applies to

TIconList component

Declaration

property Icons[Index: Integer]: TIcon;

Description

Свойство позволяет получить доступ к иконкам, содержащимся в списке, по индексу Index.


TIconList.Add
Add Method

Applies to

TIconList component

Declaration

function Add(Icon: TIcon): Integer; virtual;

Description

Метод служит для добавления в конец списка иконки Icon.


TIconList.AddResource
AddResource Method

Applies to

TIconList component

Declaration

function AddResource(Instance: THandle; ResId: PChar): Integer; virtual;

Description

Метод загружает иконку из ресурса модуля Instance по идентификатору ResID и добавляет ее к списку иконок.


IndexOf
IndexOf Method

Applies to

TIconList component

Declaration

function IndexOf(Icon: TIcon): Integer; virtual;

Description

Метод возвращает индекс иконки Icon из списка, если такая иконка присуствует в списке. Если иконка не найдена, возвращается -1.


Insert
Insert Method

Applies to

TIconList component

Declaration

procedure Insert(Index: Integer; Icon: TIcon); virtual;

Description

Метод вставляет иконку Icon в список иконок в позицию Index.


InsertResource
InsertResource Method

Applies to

TIconList component

Declaration

procedure InsertResource(Index: Integer; Instance: THandle; ResId: PChar); virtual;

Description

Метод загружает иконку из ресурса модуля Instance по идентификатору ResID и вставляет ее в список иконок в позицию Index.


LoadResource
LoadResource Method

Applies to

TIconList component

Declaration

procedure LoadResource(Instance: THandle; const ResIds: array of PChar);

Description

Метод загружает иконки из ресурса модуля Instance по их идентификаторам, заданным массивом ResIDs и добавляет их в список иконок.


MaxMin Unit

The following items are declared in the MaxMin unit:

Procedures and functions

Max

MaxFloat

MaxInteger

MaxOf

Min

MinFloat

MinInteger

MinOf

SwapInt

SwapLong

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


Max Function

Examples

Unit

MaxMin

Declaration

function Max(A, B: Longint): Longint;

Description

Функция Max возвращает наибольшее целое число из двух целочисленных параметров A, B.


Max example
Example

  I1 := Max(I1, I2);


MaxFloat Function

Examples

Unit

MaxMin

Declaration

function MaxFloat(const Values: array of Extended): Extended;

Description

Функция MaxFloat возвращает наибольшее число из массива действительных чисел Values.


MaxFloat example
Example

MaxVal := MaxFloat([MaxVal, -1, 12.2, 3.36, 12.438]);


MaxInteger Function

Examples

Unit

MaxMin

Declaration

function MaxInteger(const Values: array of Longint): Longint;

Description

Функция MaxInteger возвращает наибольшее число из массива целых чисел Values.


MaxInteger example
Example

MaxVal := MaxInteger([MaxVal, 1, 12, 36, 43]);


MaxOf Function

Examples

Unit

MaxMin

Declaration

function MaxOf(const Values: array of Variant): Variant;

Description

Функция MaxOf возвращает наибольшее значение из массива значений Values. Типы значений в массиве должны быть совместимыми.


MaxOf example
Example

MaxVal := MaxOf([MaxVal, -1, 12.2, 3.36, 12.438]);


Min Function

Examples

Unit

MaxMin

Declaration

function Min(A, B: Longint): Longint;

Description

Функция Min возвращает наименьшее целое число из двух целочисленных параметров A, B.


Min example
Example

  I1 := Min(I1, I2);


MinFloat Function

Examples

Unit

MaxMin

Declaration

function MinFloat(const Values: array of Extended): Extended;

Description

Функция MinFloat возвращает наименьшее число из массива действительных чисел Values.


MinFloat example
Example

MinVal := MinFloat([MinVal, -1, 12.2, 3.36, 12.438]);


MinInteger Function

Examples

Unit

MaxMin

Declaration

function MinInteger(const Values: array of Longint): Longint;

Description

Функция MinInteger возвращает наименьшее число из массива целых чисел Values.


MinInteger example
Example

MinVal := MinInteger([MinVal, 1, 12, 36, 43]);


MinOf Function

Examples

Unit

MaxMin

Declaration

function MinOf(const Values: array of Variant): Variant;

Description

Функция MixOf возвращает наименьшее значение из массива значений Values. Типы значений в массиве должны быть совместимыми.


MinOf example
Example

MinVal := MinOf([MinVal, -1, 12.2, 3.36, 12.438]);


SwapInt Procedure

Examples

Unit

MaxMin

Declaration

procedure SwapInt(var Int1, Int2: Integer);

Description

Процедура взаимно заменяет значения двух аргументов Int1 и Int2 между собой.


SwapInt example
Example

SwapInt(I1, I2);


SwapLong Procedure

Examples

Unit

MaxMin

Declaration

procedure SwapLong(var Int1, Int2: Longint);

Description

Процедура взаимно заменяет значения двух аргументов Int1 и Int2 между собой.


SwapLong example
Example

SwapLong(I1, I2);


MemTable Unit

The MemTable 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.

The following items are declared in the MemTable unit:

Components and objects

TMemoryTable

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


TMemoryTable Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

MemTable

Description

Memory tables are created in RAM and deleted when you close them. They are much faster and are very useful when you need fast operations on small tables. Memory tables do not support certain features (like referntial integrity, indexes, autoincrement fields and BLOBs).

Only logical BDE field types are supported by the in-memory table. Physical field types are not supported. The table is kept in memory if possible, but it could be swapped to disk if the table becomes too big. Maximum table size is 512M with a maximum record size of 16K with a maximum of 1024 fields. Logical Autoincrement and BLOB fields are not supported.


Using the TMemoryTable Component

See also             TMemoryTable Reference

Purpose

Компонента предоставляет доступ к "таблицам в памяти", работу с которыми поддерживает BDE.

Tasks

Вы можете использовать компоненту TMemoryTable для временного хранения небольшого количества структурированных данных. При этом Вы можете обращаться с ними, как с обычным набором данных, аналогичным TTable или TQuery.

Для создания таблицы в памяти Вы должны задать ее структуру (например, добавив необходимые поля в режиме дизайна), и во время работы приложения вызвать метод Open или CreateTable для активизации таблицы в памяти. Если Вы присвоите свойству Active значение True в дизайнере, то таблица в памяти будет создана сразу при загрузке формы.

При вызове метода Close (или присвоении Active := False) таблица в памяти будет уничтожена и все данные потеряны.

Несмотря на то, что BDE не предоставляет возможность удаления записей из таблицы в памяти, компонента TMemoryTable эмулирует эту операцию (при значении свойства EnableDelete = True). Имейте в виду, что продолжительность операции удаления записи из таблицы в памяти (вызовом метода Delete) растет с ростом числа записей в таблице, поэтому не применяйте многократно подряд метод Delete.


TMemoryTable See Also
See also

Common Component Tasks


TMemoryTable See Also
See also

TDatabase

TQuery

TrxQuery

TTable


TMemoryTable Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TDataSet

  |

TBDEDataSet

  |

TDBDataSet


TMemoryTable properties
Properties

Run-time only    [image] Key properties

Active	EnableDelete	Owner
AutoCalcFields	EOF	RecNo
BOF	FieldCount	RecordCount
CanModify	FieldDefs	RecordSize
ComponentCount	Fields	SessionName
ComponentIndex	Handle	State
Components	Locale	TableName
DatabaseName	Modified	Tag
DefaultFields	Name


TMemoryTable events
Events

Run-time only    [image] Key events

AfterCancel	AfterPost	BeforeOpen
AfterClose	BeforeCancel	BeforePost
AfterDelete	BeforeClose	OnCalcFields
AfterEdit	BeforeDelete	OnNewRecord
AfterInsert	BeforeEdit
AfterOpen	BeforeInsert


TMemoryTable methods
Methods

Key methods

Append	Edit	Last
AppendRecord	EmptyTable	MoveBy
BatchMove	EnableControls	Next
Cancel	FieldByName	Open
ClearFields	FindComponent	Post
Close	FindField	Prior
CopyStructure	First	Refresh
Create	GetCurrentRecord	RemoveComponent
CreateTable	GetFieldNames	Resync
Delete	GotoRecord	SetFields
DeleteTable	Insert	SetFieldValues
Destroy	InsertComponent	UpdateRecord
DisableControls	InsertRecord


EnableDelete
EnableDelete Property

Applies to

TMemoryTable component

Declaration

property EnableDelete: Boolean;

Description

Свойство EnableDelete позволяет указать, разрешено ли удаление записей из таблицы в памяти при помощи метода Delete. Если значение этого свойства True, то метод Delete вызывает эмуляцию удаления записи из таблицы в памяти. Вы можете установить это свойство в False, если Вам не надо удалять записи из таблицы в памяти и Ваша таблица имеет значительный объем, такой, что эмуляция метода Delete занимает значительное время.


TMemoryTable.RecNo
RecNo Property

Applies to

TMemoryTable component

Declaration

property RecNo: Longint;

Description

Свойство служит для чтения текущего порядкового номера записи в таблице TMemoryTable и позиционирования на заданную запись. Вы можете также спозиционироваться на любую запись по ее порядковому номеру с помощью метода GotoRecord.


TMemoryTable.BatchMove
BatchMove Method

Applies to

TMemoryTable component

Declaration

function BatchMove(ASource: TDataSet; AMode: TBatchMode; ARecordCount: Longint): Longint;

Description

Метод аналогичен одноименному методу компоненты TTable и позволяет добавить в таблицу в памяти записи из другого набора данных ASource. Поддерживаются только два возможных режима, задаваемого параметром AMode - batCopy и batAppend. Параметр ARecordCount задает максимальное число добавляемых записей.


CopyStructure
CopyStructure Method

Applies to

TRxMemoryData, TMemoryTable components

Declaration

procedure CopyStructure(ASource: TDataSet);

Description

Метод позволяет скопировать структуру любого набора данных ASource в компоненту TMemoryTable или TRxMemoryData. После вызова метода CopyStructure для активизации таблицы в памяти вызовите метод Open или присвойте Active := True.


GotoRecord
GotoRecord Method

Applies to

TMemoryTable component

Declaration

procedure GotoRecord(RecordNo: Longint);

Description

Метод позволяет спозиционировать таблицу в памяти на запись, заданную порядковым номером RecordNo. Нумерация записей в таблице в памяти идет от 1.


SetFieldValues
SetFieldValues Method

Applies to

TMemoryTable component

Declaration

procedure SetFieldValues(const FieldNames: array of string; const Values: array of const);

Description

Метод предназначен для установки значений специфицированных параметром FieldNames полей в заданные значения Values во всех записях таблицы TMemoryTable.


MRUList Unit

The MRUList unit contains the declarations for the certain components on the RX Tools 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 MRUList unit:

Components and objects

TMRUManager

Types

TAccelDelimiter

TClickMenuEvent

TGetItemEvent

TReadItemEvent

TRecentMode

TWriteItemEvent

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


TMRUManager Component

Hierarchy             See also             Properties             Methods             Events

Unit

MRUList

Description

Компонента TMRUManager предназначена для работы со списками последних использованных элементов (More Recently Used), таких как последние открытые (закрытые) файлы, таблицы БД и т.д.

Компонента позволяет автоматически создавать подменю со списком таких элементов или добавлять их к существующему меню.

Для использования TMRUManager Вы можете задать значение свойству RecentMenu, определяющее пункт меню (главного или popup), в котором будут созданы соответствующие пункты меню. Если свойство AutoEnable установлено в True (по умолчанию), то пункт меню RecentMenu будет автоматически разрешаться или запрещаться в зависимости от количества пунктов в нем (элементов в MRU-списке).

Изменения списка строк, соответствующих MRU-элементам, осуществляются с помощью методов Add, Remove и Clear. Для добавления в список элемента вызовите метод Add. Свойство Mode определяет, в начало или в конец списка будет добавлен новый элемент. Для удаления элемента используйте метод Remove. Общая максимальная емкость списка задается свойством Capacity. Если при добавлении нового элемента будет превышена эта величина, автоматически будет удален из списка наиболее старый элемент.

Если свойство AutoUpdate = True (по умолчанию), то при каждом изменении в списке для пункта меню RecentMenu автоматически будет изменяться подменю с элементами списка. Вы можете вручную привести меню в соответствие с содержимым списка, вызвав метод UpdateRecentMenu.

При создании пунктов меню по умолчанию создаются пункты с заголовком, совпадающим со строкой из списка, которую Вы передали в методе Add. Вы можете также обработать событие OnGetItemData для изменения заголовка создаваемого пункта меню и задания его свойства ShortCut (по умолчанию scNone).

Если ShowAccelChar=True (по умолчанию), то в строку заголовка элемента меню будет добавлен "подчеркнутый" символ, соответствующий порядковому номеру элемента ('1'..'9', 'A', 'B'... и т.д.). Если значение свойства SeparateSize больше нуля, то в создаваемое подменю будут добавлены разделители между каждыми SeparateSize элементами меню.

При выборе пользователем пункта меню из созданного подменю будет вызвано событие OnClick.

Для сохранения и восстановления списка в INI-файле или (в 32-разрядной версии) в системном регистре воспользуйтесь свойством IniStorage или методами SaveToIni, LoadFromIni, SaveToRegistry, LoadFromRegistry.

Вы можете также использовать компоненту TMRUManager без подключения к меню, например, помещая список в TListBox или в TComboBox. В этом случае Вы должны сами заполнять списки этих элементов управления из списка TMRUManager, который доступен в run-time через свойство Strings.


TMRUManager See Also
See also

TMenu

TMenuItem

TStrings


TMRUManager Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TMRUManager properties
Properties

Run-time only    [image] Key properties

AccelDelimiter	Components	RemoveOnSelect
AutoEnable	IniStorage	SeparateSize
AutoUpdate	Mode	ShowAccelChar
Capacity	Name	StartAccel
ComponentCount	Owner	Strings
ComponentIndex	RecentMenu	Tag


TMRUManager events
Events

Run-time only    [image] Key events

OnChange	OnGetItemData	OnWriteItem
OnClick	OnReadItem


TMRUManager methods
Methods

Key methods

Add	InsertComponent	SaveToIni
Clear	LoadFromIni	SaveToRegistry
Create	LoadFromRegistry	UpdateRecentMenu
Destroy	Remove
FindComponent	RemoveComponent


AccelDelimiter
AccelDelimiter Property

Applies to

TMRUManager component

Declaration

property AccelDelimiter: TAccelDelimiter;

Description

Свойство определяет разделитель (символ табуляции #9 или пробел, по умолчанию - adTab) между подчеркнутым символом-акселератором и строкой пункта меню при значении свойства ShowAccelChar = True.


AutoEnable
AutoEnable Property

Applies to

TMRUManager component

Declaration

property AutoEnable: Boolean;

Description

Если свойство AutoEnable установлено в True, то пункт меню RecentMenu будет автоматически разрешаться или запрещаться в зависимости от количества пунктов в нем (элементов в MRU-списке).

Свойство обычно используется, если пункт меню RecentMenu содержит только элементы из MRU-списка.


AutoUpdate
AutoUpdate Property

Applies to

TMRUManager component

Declaration

property AutoUpdate: Boolean;

Description

Если свойство AutoUpdate = True (по умолчанию), то для пункта меню RecentMenu автоматически будет изменяться подменю с элементами списка при каждом изменении в списке. Когда список пуст, пункт меню RecentMenu будет запрещенным.

Вы можете также вручную привести меню в соответствие с содержимым списка, вызвав метод UpdateRecentMenu.


TMRUManager.Capacity
Capacity Property

Applies to

TMRUManager component

Declaration

property Capacity: Integer;

Description

Свойство задает общую максимальную емкость списка. Если при добавлении нового элемента будет превышена эта величина, автоматически будет удален из списка наиболее старый (последний) элемент. Новый элемент всегда добавляется в начало списка, если свойство Mode = rmInsert, и в конец списка, если Mode = rmAppend.


TMRUManager.Mode
Mode Property

Applies to

TMRUManager component

Declaration

property Mode: TRecentMode;

Description

Свойство определяет, как будут добавляться элементы в список компоненты TMRUManager.

Если значение свойства равно rmInsert (по умолчанию), то вновь добавляемый элемент вставляется в начало списка (или, если такой элемент уже существует, перемещается в начало списка). При значении rmAppend добавляемый элемент появляется в конце списка.


RecentMenu
RecentMenu Property

Applies to

TMRUManager component

Declaration

property RecentMenu: TMenuItem;

Description

Свойство задает пункт в меню, для которого будет создавать подменю со списком MRU-элементов. При пустом списке элемент RecentMenu запрещается, если свойство AutoEnable равно True.


RemoveOnSelect
RemoveOnSelect Property

Applies to

TMRUManager component

Declaration

property RemoveOnSelect: Boolean;

Description

Если True, то после выбора пункта меню соответствующий ему элемент из списка MRU удаляется. По умолчанию - False.


SeparateSize
SeparateSize Property

Applies to

TMRUManager component

Declaration

property SeparateSize: Word;

Description

Свойство позволяет создавать разделители на равном расстоянии между пукнтами в меню RecentMenu. Если значение свойства SeparateSize больше нуля, то в создаваемое подменю будут добавлены разделители между каждыми SeparateSize элементами меню.


ShowAccelChar
ShowAccelChar Property

Applies to

TMRUManager component

Declaration

property ShowAccelChar: Boolean;

Description

Если ShowAccelChar=True (по умолчанию), то в строку заголовка элемента меню будет добавлен "подчеркнутый" символ, соответствующий порядковому номеру элемента ('1'..'9', 'A', 'B'... и т.д.), при этом первым номером в списке считается значение свойства StartAccel.

Этот символ будет использоваться как акселератор для быстрого выбора соответствующего пункта меню.


StartAccel
StartAccel Property

Applies to

TMRUManager component

Declaration

property StartAccel: Cardinal;

Description

Если ShowAccelChar=True (по умолчанию), то в строку заголовка элемента меню будет добавлен "подчеркнутый" символ, соответствующий порядковому номеру элемента ('1'..'9', 'A', 'B'... и т.д.), при этом первым номером в списке считается значение свойства StartAccel (по умолчанию = 1).


TMRUManager.Strings
Strings Property

Applies to

TMRUManager component

Declaration

property Strings: TStrings;

Description

Свойство служит для прямого доступа к списку элементов, хранимому компонентой TMRUManager.

С помощью прямого доступа к списку Strings Вы можете, например, поместить список строк Strings в другие элементы управления, например в list-box или combo-box:

  ListBox1.Items := MRUManager1.Strings;


TMRUManager.OnChange
OnChange Event

Applies to

TMRUManager component

Declaration

property OnChange: TNotifyEvent;

Description

Событие происходит при изменениях содержимого списка MRU-элементов компоненты TMRUManager.

Используйте это событие для обновления других элементов управления, пользующихся списком строк Strings компоненты TMRUManager.


TMRUManager.OnClick
OnClick Event

Applies to

TMRUManager component

Declaration

property OnClick: TClickMenuEvent;

Description

Событие происходит при выборе пользователем пункта из подменю, созданного компонентой TMRUManager. В качестве параметров в метод-обработчик события передаются заданные при добавлении элемента в список строка RecentName и значение UserData, а также заголовок пункта меню Caption (который дополнительно может содержать символ-акселератор или может быть изменен в обработчике события OnGetItemData).


OnGetItemData
OnGetItemData Event

Applies to

TMRUManager component

Declaration

property OnGetItemData: TGetItemEvent;

Description

При создании элементов подменю в RecentMenu по умолчанию создаются пункты с заголовком, совпадающим со строкой из списка, которую Вы передали в методе Add. Вы можете также обработать событие OnGetItemData для изменения заголовка создаваемого пункта меню (параметр Caption) и задания его свойства ShortCut (по умолчанию scNone).


OnReadItem
OnReadItem Event

Applies to

TMRUManager component

Declaration

property OnReadItem: TReadItemEvent;

Description

Если задан обработчик этого события, то в нем Вы должны самостоятельно считывать информацию из специфицированного IniFile для каждого элемента списка.


OnWriteItem
OnWriteItem Event

Applies to

TMRUManager component

Declaration

property OnWriteItem: TWriteItemEvent;

Description

Если задан обработчик этого события, то в нем Вы должны самостоятельно записывать информацию в специфицированный IniFile для каждого элемента списка.


TMRUManager.Add
Add Method

Applies to

TMRUManager component

Declaration

procedure Add(const RecentName: string; UserData: Longint);

Description

Метод служит для добавления строки в список MRU-элементов.

Параметр UserData позволяет Вам ассоциировать с элементом некоторые Ваши данные. В дальнейшем этот параметр будет передаваться в обработчики событий OnClick, OnGetItemData, OnReadItem, OnWriteItem.

В зависимости от значения свойства Mode элемент будет добавлен либо в начало, либо в конец списка.


LoadFromIni
LoadFromIni Method

Applies to

TMRUManager component

Declaration

procedure LoadFromIni(Ini: TIniFile; const Section: string);

Description

Метод служит для восстановления из INI-файла списка компоненты TMRUManager, если он был сохранен там с помошью метода SaveToIni. Текущие установки не изменяются, если специфицированный INI-файл не содержит данных об установках компоненты.

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


LoadFromRegistry
LoadFromRegistry Method

Applies to

TMRUManager component

Declaration

procedure LoadFromRegistry(Ini: TRegIniFile; const Section: string);

Description

Метод служит для восстановления из системного регистра Windows списка компоненты TMRUManager, если он был сохранен там с помошью метода SaveToRegistry. Текущие установки не изменяются, если специфицированный TRegIniFile не содержит данных об установках компоненты.

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


TMRUManager.Remove
Remove Method

Applies to

TMRUManager component

Declaration

procedure Remove(const RecentName: string);

Description

Метод служит для удаления строки RecentName из списка. В качестве параметра RecentName передается та же строка, что использовалась при добавлении строки в список.

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

Вы можете, например, в приложении работы с файлами вызывать метод Remove(<FileName>) при открытии окна с файлом, и метод Add(<FileName>, <UserData>) при закрытии окна с файлом.


SaveToIni
SaveToIni Method

Applies to

TMRUManager component

Declaration

procedure SaveToIni(Ini: TIniFile; const Section: string);

Description

Метод служит для сохранения в INI-файле списка компоненты TMRUManager для последующего восстановления его с помошью метода LoadFromIni.

Список записывается в специфицированный INI-файл в секцию с именем, возвращаемым функцией GetDefaultSection.

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


SaveToRegistry
SaveToRegistry Method

Applies to

TMRUManager component

Declaration

procedure SaveToRegistry(Ini: TRegIniFile; const Section: string);

Description

Метод служит для сохранения в системном регистре Windows списка компоненты TMRUManager для последующего восстановления его с помошью метода LoadFromRegistry.

Список записывается в специфицированный TRegIniFile в секцию с именем, возвращаемым функцией GetDefaultSection.

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


UpdateRecentMenu
UpdateRecentMenu Method

Applies to

TMRUManager component

Declaration

procedure UpdateRecentMenu;

Description

Если свойство AutoUpdate = False (по умолчанию), то пункт меню RecentMenu не будет автоматически приводится в соответствие списку при каждом изменении списка. В этом случае для обновления подменю в меню RecentMenu вы должны воспользоваться методом UpdateRecentMenu. Вы можете вызвать его, например, из обработчика события OnPopup для popup-меню.


TAccelDelimiter Type

Unit

MRUList

Declaration

type

TAccelDelimiter = (adTab, adSpace);

Description

Тип определяет возможные значения свойства AccelDelimiter компоненты TMRUManager.


TClickMenuEvent Type

Unit

MRUList

Declaration

type

TClickMenuEvent = procedure (Sender: TObject; const RecentName, Caption: string; UserData: Longint) of object;

Description

Тип определяет процедуру - обработчик события OnClick компоненты TMRUManager.


TGetItemEvent Type

Unit

MRUList

Declaration

type

TGetItemEvent = procedure (Sender: TObject; var Caption: string; var ShortCut: TShortCut; UserData: Longint) of object;

Description

Тип определяет процедуру - обработчик события OnGetItemData компоненты TMRUManager.


TReadItemEvent Type

Unit

MRUList

Declaration

type

TReadItemEvent = procedure (Sender: TObject; IniFile: TObject; const Section: string; Index: Integer; var RecentName: string; var UserData: Longint) of object;

Description

Тип определяет процедуру - обработчик события OnReadItem компоненты TMRUManager.


TRecentMode Type

Unit

MRUList

Declaration

type

TRecentMode = (rmInsert, rmAppend);

Description

Тип определяет возможные значения свойства Mode компоненты TMRUManager.


TWriteItemEvent Type

Unit

MRUList

Declaration

type

TWriteItemEvent = procedure (Sender: TObject; IniFile: TObject; const Section: string; Index: Integer; const RecentName: string; UserData: Longint) of object;

Description

Тип определяет процедуру - обработчик события OnWriteItem компоненты TMRUManager.


ObjStr Unit

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 ObjStr unit:

Components and objects

THugeList

TObjectStrings

Types

TDestroyEvent

TObjectSortCompare

Constants

MaxHugeListSize

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


THugeList object
THugeList Class

Hierarchy             See also             Properties             Methods

Unit

ObjStr

Description

Класс предназначен для создания в 16-разрядной версии Delphi 1.0 списков, содержащих более 16 тыс. элементов. Он имеет все те же методы и свойства, что и стандартный класс TList, но позволяет хранить до (MaxLongint div SizeOf(Pointer)) элементов, и вместо параметров типа Integer имеет у всех методов параметры типа Longint.

Примечание

В 32-разрядной версии класс является "заглушкой" и объявлен как

  THugeList = TList;


THugeList See Also
See also

TList


THugeList Hierarchy
Hierarchy

TObject


THugeList properties
Properties

Run-time only    [image] Key properties

Capacity	Count	Items


THugeList methods
Methods

Key methods

Add	Exchange	Last
Clear	Expand	Pack
Create	First	Remove
Delete	IndexOf
Destroy	Insert


TObjectStrings object
TObjectStrings Class

Hierarchy             See also             Properties             Methods             Events

Unit

ObjStr

Description

Класс реализует список, который может содержать строки и связанные с ними объекты (аналогично своему предку TStringList), однако в отличие от TStringList  этот класс освобождает содержащиеся в списке объекты при присваивании новых значений свойству Objects или при удалении элементов списка методами Delete, Clear, а также при освобождении всего списка.

Если вы хотите удалить объект из списка, не освобождая его, используйте метод Remove.

В класса TObjectStrings реализован виртуальный метод

  procedure DestroyObject(AObject: TObject);

который вызывает AObject.Free. Для изменения выполняемых действий при освобождении объектов списка Вы можете определить обработчик события OnDestroyObject. Вы можете также перекрыть метод DestroyObject для задания дополнительных действий при осовобождении объектов.


TObjectStrings See Also
See also

TList

TObject

TStringList

TStrings


TObjectStrings Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TStrings

  |

TStringList


TObjectStrings properties
Properties

Run-time only    [image] Key properties

CommaText	Names	Strings
Count	Objects	Values
Duplicates	Sorted


TObjectStrings events
Events

Run-time only    [image] Key events

OnChange	OnChanging	OnDestroyObject


TObjectStrings methods
Methods

Key methods

Add	EndUpdate	Move
AddObject	Equals	Remove
AddStrings	GetText	SaveToFile
Assign	IndexOf	SaveToStream
BeginUpdate	IndexOfObject	SetText
Clear	Insert	Sort
Create	InsertObject	SortList
Delete	LoadFromFile
Destroy	LoadFromStream


OnDestroyObject
OnDestroyObject Event

Applies to

TObjectStrings component

Declaration

property OnDestroyObject: TDestroyEvent;

Description

Событие вызывается при освобождении объектов, сохраненных в списке TObjectStrings, при удалении элементов списка или уничтожении всего списка.

По умолчанию при освобождении объекта вызывается метод TObject.Free. Если Вы хотите изменить действия по освобождению объекта, определите их в обработчике события OnDestroyObject.


TObjectStrings.Remove
Remove Method

Applies to

TObjectStrings component

Declaration

procedure Remove(Index: Integer);

Description

Removes the item given by Index from the list. Remove does not destroy of item. If you need to delete and destroy of an item, call Delete method.


SortList
SortList Method

Applies to

TObjectStrings component

Declaration

procedure SortList(Compare: TObjectSortCompare);

Description

SortList performs a QuickSort on the list based on the comparison function Compare.

Call SortList to sort the items in the list of the TObjectStrings type. Compare is a comparison function that indicates how the items are to be ordered. Compare must return < 0 if Item1 is less than Item2, 0 if they are equal and > 0 if Item1 is greater than Item2.


MaxHugeListSize Constant

Unit

ObjStr

Declaration

const

  MaxHugeListSize = MaxLongint div SizeOf(Pointer);

Description

Константа задает максимально возможное число элементов в списке THugeList.


TDestroyEvent Type

Unit

ObjStr

Declaration

type

TDestroyEvent = procedure(Sender, AObject: TObject) of object;

Description

Тип определяет метод - обработчик события OnDestroyObject класса TObjectStrings.


TObjectSortCompare Type

Unit

ObjStr

Declaration

type

TObjectSortCompare = function (const S1, S2: string; Item1, Item2: TObject): Integer of object;

Description

Тип определяет функцию, используемую для сравнения элементов списка, при сортировке списка типа TObjectStrings методом SortList.

Эта функция должна вернуть значение < 0, если Item1 < Item2, 0 - если объекты "равны", и значение > 0, если Item1 > Item2.


Ole2Auto Unit

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 Ole2Auto unit:

Components and objects

TOleController

Procedures and functions

CreateLCID

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


TOleController object
TOleController Class

Hierarchy             See also             Properties             Methods

Unit

Ole2Auto

Description

Класс реализует автоматный контроллер OLE. До начала использования функций OLE-сервера, необходимо проинициализировать контроллер функцией CreateObject. Для вызова функций сервера используются набор методов CallFunction, CallFunctionNamedParams, CallProcedure, CallProcedureNamedParams и т.д. Для изменения свойств OLE-объекта используйте методы SetProperty и GetProperty.

Несмотря на реализацию в 32-битной версии Delphi автоматного контроллера OLE с помощью использования типа TVariant, класс TOleController иногда остается полезен, так как позволяет вызывать методы автоматного OLE-сервера, имена которых заканчиваются на символ '$'. Такие методы, например, в большом количестве присутствуют в 'Word.Basic' (например, 'GetText$'). При использовании в Delphi 2.0 типа TVariant использование таких имен вызывает ошибку компилляции.


TOleController See Also
See also

TOleContainer


TOleController Hierarchy
Hierarchy

TObject


TOleController properties
Properties

Run-time only    [image] Key properties

Locale	OleObject


TOleController methods
Methods

Key methods

AssignIDispatch	CallProcedure	CreateObject
CallFunction	CallProcedureByID	Destroy
CallFunctionByID	CallProcedureNamedParams	GetProperty
CallFunctionNamedParams	CallProcedureNoParams	GetPropertyByID
CallFunctionNoParams	CallProcedureNoParamsByID	SetProperty
CallFunctionNoParamsByID	Create	SetPropertyByID


TOleController.Locale
Locale Property

Applies to

TOleController component

Declaration

property Locale: TLCID;

Description

Свойство задает ID-код языка, который должен быть поддерживаем используемым автоматным сервером. По умолчанию задано значение LOCALE_SYSTEM_DEFAULT, что означает использование кода языка текущей системы (заданного при установке Windows). Вы можете получить значение для присвоения свойству Locale с помощью функции CreateLCID.


TOleController.OleObject
OleObject Property

Applies to

TOleController component

Declaration

property OleObject: Variant;

Description

Свойство позволяет получить прямой доступ к экземпляру OLE-объекта, созданному контроллером.


AssignIDispatch
AssignIDispatch Method

Applies to

TOleController component

Declaration

procedure AssignIDispatch(V: Variant); virtual;

Description

Метод позволяет назначить OLE-контроллеру созданный ранее сервер OLE (например, в результате вызова метода контроллера) как значение типа Variant, не создавая новый OLE-объект вызовом CreateObject.


CallFunction
CallFunction Method

Applies to

TOleController component

Declaration

function CallFunction(const AName: string; const Params: array of const): PVariant;

Description

Метод возвращает результат выполнения метода автоматного сервера OLE с именем AName. Params содержит список параметров функции OLE-сервера.


CallFunctionByID
CallFunctionByID Method

Applies to

TOleController component

Declaration

function CallFunctionByID(ID: DISPID; const Params: array of const): PVariant;

Description

Метод возвращает результат выполнения функции, обозначенной через идентификатор ID. Params содержит список параметров функции OLE-сервера.


CallFunctionNamedParams
CallFunctionNamedParams Method

Applies to

TOleController component

Declaration

function CallFunctionNamedParams(const AName: string; const Params: array of const; const Names: array of string): PVariant;

Description

Метод возвращает результат выполнения функции AName. Params содержит список параметров функции Ole сервера в том порядке, в каком их имена содержатся в списке Names.


CallFunctionNoParams
CallFunctionNoParams Method

Applies to

TOleController component

Declaration

function CallFunctionNoParams(const AName: string): PVariant;

Description

Метод возвращает результат выполнения непараметризированной функции AName.


CallFunctionNoParamsByID
CallFunctionNoParamsByID Method

Applies to

TOleController component

Declaration

function CallFunctionNoParamsByID(ID: DISPID): PVariant;

Description

Метод возвращает результат выполнения непараметризированной функции, обозначенной через идентификатор ID.


CallProcedure
CallProcedure Method

Applies to

TOleController component

Declaration

procedure CallProcedure(const AName: string; const Params: array of const);

Description

Метод выполняет процедуру AName. Params содержит список параметров процедуры или команды OLE сервера.


CallProcedureByID
CallProcedureByID Method

Applies to

TOleController component

Declaration

procedure CallProcedureByID(ID: DISPID; const Params: array of const);

Description

Метод выполняет процедуру, обозначенную через идентификатор ID. Params содержит список параметров процедуры или команды OLE сервера.


CallProcedureNamedParams
CallProcedureNamedParams Method

Applies to

TOleController component

Declaration

procedure CallProcedureNamedParams(const AName: string; const Params: array of const; const Names: array of string);

Description

Метод выполняет процедуру AName. Params содержит список параметров процедуры или команды OLE сервера в том порядке, в каком их имена содержатся в списке Names.


CallProcedureNoParams
CallProcedureNoParams Method

Applies to

TOleController component

Declaration

procedure CallProcedureNoParams(const AName: string);

Description

Метод выполняет непараметризированную процедуру или команду AName.


CallProcedureNoParamsByID
CallProcedureNoParamsByID Method

Applies to

TOleController component

Declaration

procedure CallProcedureNoParamsByID(ID: DISPID);

Description

Метод выполняет непараметризированную процедуру или команду, обозначенную через идентификатор ID.


CreateObject
CreateObject Method

Applies to

TOleController component

Declaration

procedure CreateObject(const ClassName: string);

Description

Процедура получает для автоматного контроллера интерфейс OLE-сервера по имени класса OLE-объекта ClassName.


GetProperty
GetProperty Method

Applies to

TOleController component

Declaration

function GetProperty(const AName: string): PVariant;

Description

Результатом выполнения метода будет значение переменной AName Ole сервера.


GetPropertyByID
GetPropertyByID Method

Applies to

TOleController component

Declaration

function GetPropertyByID(ID: DISPID): PVariant;

Description

Результатом выполнения метода будет значение переменной Ole сервера, обозначенного через идентификатор ID.


SetProperty
SetProperty Method

Applies to

TOleController component

Declaration

procedure SetProperty(const AName: string; const Prop: array of const);

Description

Метод устанавливает значение свойства OLE-сервера с именем AName в значение Props.


SetPropertyByID
SetPropertyByID Method

Applies to

TOleController component

Declaration

procedure SetPropertyByID(ID: DISPID; const Prop: array of const);

Description

Метод устанавливает значение свойства Ole-сервера, обозначенного через идентификатор ID, равным Props.


CreateLCID Function

Examples

Unit

Ole2Auto

Declaration

function CreateLCID(PrimaryLangID, SubLangID: Word): TLCID;

Description

Функция возвращает код языка для использования в OLE2 API. Возвращаемый код может быть использован для присвоения свойству Locale объекта класса TOleController.


CreateLCID example
Example

Задание кода языка для английского:

  OleController.Locale := CreateLCID(LANG_ENGLISH,

    SUBLANG_DEFAULT);


PageMngr Unit

The PageMngr unit contains the declarations for the certain components on the  , RX Tools pages 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 PageMngr unit:

Components and objects

TPageManager

TPageProxy

Types

TPageHistoryCommand

TPageNotifyEvent

TPageOwner

TPageRequestEvent

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


TPageManager Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

PageMngr

Description

Компонента предназначена для использования при написании многостраничных диалогов ("экспертов").

Сама компонента страниц не имеет. Она имеет ссылку на компоненту - владельца страниц (свойство PageOwner). Для управления порядком следования страниц существуют события OnGetNextPage и OnGetPriorPage. Управление событиями, происходящими при смене страниц, осуществляется с помощью "заместителей" страниц, список которых содержит свойство PageProxies. Каждый элемент имеет тип TPageProxy, и имеет события OnEnter, OnShow, OnHide и OnLeave.

Методы NextPage и PriorPage могут вызываться Вами прямо, либо автоматически компонентой TPageManager при нажатии на кнопки, заданные свойствами NextBtn и PriorBtn.


Using the TPageManager Component

See also             TPageManager Reference

Purpose

Компонента предназначена для использования при написании многостраничных диалогов ("экспертов").

Tasks

Необходимо связать компоненту с элементом управления, владельцем страниц, установив свойство PageOwner. В данной версии таким элементом могут быть только компоненты класса TNotebook.

Методы NextPage и PriorPage должны вызываться для навигации по страницам.

Порядок страниц определяется с помощью событий OnGetNextPage и OnGetPriorPage.

Каждая страница через "посредника" - класса TPageProxy - может иметь набор событий, происходящих при переходи со страницы на страницу.


TPageManager See Also
See also

Common Component Tasks


TPageManager See Also
See also

TNotebook

TPageProxy


TPageManager Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TPageManager properties
Properties

Run-time only    [image] Key properties

ComponentCount	NextEnabled	PageProxies
ComponentIndex	Owner	PriorBtn
Components	PageCount	PriorEnabled
DestroyHandles	PageHistory	SetStartPage
HistoryCommand	PageIndex	Tag
Name	PageNames	UseHistory
NextBtn	PageOwner


TPageManager events
Events

Run-time only    [image] Key events

OnCheckButtons	OnGetNextPage	OnGetPriorPage


TPageManager methods
Methods

Key methods

Create	GetPriorPageIndex	RemoveComponent
Destroy	InsertComponent	SetPage
FindComponent	NextPage
GetNextPageIndex	PriorPage


TPageManager.DestroyHandles
DestroyHandles Property

Applies to

TPageManager component

Declaration

property DestroyHandles: Boolean;

Description

Если свойство DestroyHandles установлено в True (по умолчанию - False), то компонента TPageManager будет при смене страниц уничтожать оконные объекты, относящиеся к невидимым страницам Notebook.


TPageManager.HistoryCommand
HistoryCommand Property

Applies to

TPageManager component

Declaration

property HistoryCommand: TPageHistoryCommand;

Description

Предназначено для управления изменением истории переходов между страницами. Например, история не должна изменяться при переходе на страницу, выбранную пользователем из истории.


NextBtn
NextBtn Property

Applies to

TPageManager component

Declaration

property NextBtn: TControl;

Description

Свойство определяет элемент управления - кнопку, при нажатии на которую (вызове метода Click) будет осуществляться переход на "следующую" страницу "ассистента".

При задании свойств NextBtn и PriorBtn компонента TPageManager следит за их запрещением и разрешением (управляет свойством Enabled). Вы можете обработать событие OnCheckButtons для переопределения поведения по умолчанию.


NextEnabled
NextEnabled Property

Applies to

TPageManager component

Declaration

property NextEnabled: Boolean;

Description

Отвечает, можно ли перейти на следующую страницу. True, если текущая страница не последняя, или ваш обработчик события OnGetNextPage возвращает в NewPage значение большее -1.


TPageManager.PageCount
PageCount Property

Applies to

TPageManager component

Declaration

property PageCount: Integer;

Description

Число страниц у PageOwner.


TPageManager.PageHistory
PageHistory Property

Applies to

TPageManager component

Declaration

property PageHistory: TPageHistory;

Description

PageHistory служит для сохранения истории переходов между страницами.


TPageManager.PageIndex
PageIndex Property

Applies to

TPageManager component

Declaration

property PageIndex: Integer;

Description

Индекс текущей активной страницы.

Для программного изменения активной страницы используйте методы NextPage, PriorPage и SetPage.


PageNames[Index: Integer]
PageNames Property

Applies to

TPageManager component

Declaration

property PageNames[Index: Integer]: string;

Description

Индексированное свойство с именами страниц.


PageOwner
PageOwner Property

Applies to

TPageManager component

Declaration

property PageOwner: TPageOwner;

Description

Ссылка на компоненту - владельца страниц. В данной версии может быть только TNotebook.


PageProxies
PageProxies Property

Applies to

TPageManager component

Declaration

property PageProxies: TList;

Description

Список "заместителей" страниц. Необходим для обработки событий, происходящих при смене страниц.


PriorBtn
PriorBtn Property

Applies to

TPageManager component

Declaration

property PriorBtn: TControl;

Description

Свойство определяет элемент управления - кнопку, при нажатии на которую (вызове метода Click) будет осуществляться переход на "предыдущую" страницу "ассистента".

При задании свойств NextBtn и PriorBtn компонента TPageManager следит за их запрещением и разрешением (управляет свойством Enabled). Вы можете обработать событие OnCheckButtons для переопределения поведения по умолчанию.


PriorEnabled
PriorEnabled Property

Applies to

TPageManager component

Declaration

property PriorEnabled: Boolean;

Description

Отвечает, можно ли перейти на предыдущую страницу. True, если текущая страница не первая, или ваш обработчик события OnGetPriorPage возвращает в NewPage значение, большее -1.


SetStartPage
SetStartPage Property

Applies to

TPageManager component

Declaration

property SetStartPage: Boolean;

Description

При установке значения свойства в True (по умолчанию), при загрузке формы будет установлена первая страница PageOwner, т.е. страница, соответствующая PageProxies[0].


TPageManager.UseHistory
UseHistory Property

Applies to

TPageManager component

Declaration

property UseHistory: Boolean;

Description

Свойство определяет будет ли при определении страницы, на которую нужно перейти, использоваться история переходов PageHistory.


OnCheckButtons
OnCheckButtons Event

Applies to

TPageManager component

Declaration

property OnCheckButtons: TNotifyEvent;

Description

В обработчике этого события Вы можете изменить свойство Enabled у кнопок, заданных свойствами NextBtn и PriorBtn.


OnGetNextPage
OnGetNextPage Event

Applies to

TPageManager component

Declaration

property OnGetNextPage: TPageRequestEvent;

Description

В обработчике этого события Вы должны указать какая страница является следующей. Вы дожны присвоить индекс этой страницы переменной NewPage. -1 означает запрет перехода на следующую страницу.


OnGetPriorPage
OnGetPriorPage Event

Applies to

TPageManager component

Declaration

property OnGetPriorPage: TPageRequestEvent;

Description

В обработчике этого события Вы должны указать какая страница является предыдущей. Вы дожны присвоить индекс этой страницы переменной NewPage. -1 означает запрет перехода на предыдущую страницу.


GetNextPageIndex
GetNextPageIndex Method

Applies to

TPageManager component

Declaration

function GetNextPageIndex(Page: Integer): Integer;

Description

Определение индекса следующей страницы.

Возвращает -1 в случае запрета перехода на следующую страницу.


GetPriorPageIndex
GetPriorPageIndex Method

Applies to

TPageManager component

Declaration

function GetPriorPageIndex(Page: Integer): Integer;

Description

Определение индекса предыдущей страницы.

Возвращает -1 в случае запрета перехода на предыдущую страницу.


TPageManager.NextPage
NextPage Method

Applies to

TPageManager component

Declaration

procedure NextPage;

Description

Осуществить переход на следующую страницу. "Cледующая" страница определяется с помощью события OnGetNextPage.

Может вызываться при нажатии на кнопку "Дальше" и т.п.


TPageManager.PriorPage
PriorPage Method

Applies to

TPageManager component

Declaration

procedure PriorPage;

Description

Осуществить переход на предыдущую страницу. Какая страница является предыдущей определяется с помощью события OnGetPriorPage.

Может вызываться при нажатии на кнопку Назад и т.п.


SetPage
SetPage Method

Applies to

TPageManager component

Declaration

procedure SetPage(NewPageIndex: Integer; Next: Boolean);

Description

Метод служит для непосредственной установки страницы c индексом NewPageIndex у Notebook.

При этом будут вызваны все события, связанные со сменой страниц, такие как OnEnter, OnExit, OnShow, OnHide. Параметр Next передается в обработчики этих событий, что позволяет эмулировать передвижение по "ассистенту" в прямом или обратном направлении.


TPageProxy object
TPageProxy Class

Hierarchy             See also             Properties             Methods             Events

Unit

PageMngr

Description

Компонента, заместитель страниц, предназначена для задания событий, происходящих при смене текущей страницы.


TPageProxy See Also
See also

TNotebook

TPageManager


TPageProxy Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TPageProxy properties
Properties

Run-time only    [image] Key properties

ComponentCount	Name	PageName
ComponentIndex	Owner	Tag
Components	PageManager


TPageProxy events
Events

Run-time only    [image] Key events

OnEnter	OnLeave
OnHide	OnShow


TPageProxy methods
Methods

Key methods

Create	FindComponent	RemoveComponent
Destroy	InsertComponent


PageManager
PageManager Property

Applies to

TPageProxy component

Declaration

property PageManager: TPageManager;

Description

Ссылка на владельца PageProxy. Для внутреннего использования.


PageName
PageName Property

Applies to

TPageProxy component

Declaration

property PageName: string;

Description

Этим свойством указывается соответствие между PageProxy и собственно страницей. Если вы меняете имя страницы (допустим у Notebook), то его нужно поменять и у этой компоненты.


TPageProxy.OnEnter
OnEnter Event

Applies to

TPageProxy component

Declaration

property OnEnter: TPageNotifyEvent;

Description

Происходит перед тем, как данная страница станет активной.

Параметр Next сообщает в каком направлении происходит изменение страницы. True означает переход к следующей, False - к предыдущей.


TPageProxy.OnHide
OnHide Event

Applies to

TPageProxy component

Declaration

property OnHide: TPageNotifyEvent;

Description

Происходит после того, как данная страница перестала быть активной.

Параметр Next сообщает в каком направлении произошло изменение страницы. True означает переход к следующей, False - к предыдущей.


TPageProxy.OnLeave
OnLeave Event

Applies to

TPageProxy component

Declaration

property OnLeave: TPageNotifyEvent;

Description

Происходит перед тем, как данная страница перестанет быть активной.

Параметр Next сообщает в каком направлении происходит изменение страницы. True означает переход к следующей, False - к предыдущей.


TPageProxy.OnShow
OnShow Event

Applies to

TPageProxy component

Declaration

property OnShow: TPageNotifyEvent;

Description

Происходит после того, как данная страница стала активной.

Параметр Next сообщает в каком направлении произошло изменение страницы. True означает переход к следующей, False - к предыдущей.


TPageHistoryCommand Type

Unit

PageMngr

Declaration

type

TPageHistoryCommand = (hcNone, hcAdd, hcBack, hcForward, hcGoto);

Description

Тип определяет возможные значения свойства HistoryCommand компоненты TPageManager.


TPageNotifyEvent Type

Unit

PageMngr

Declaration

type

TPageNotifyEvent = procedure(Next: Boolean) of object;

Description

Событие при смене страницы компоненты TPageManager.


TPageOwner Type

Unit

PageMngr

Declaration

type

TPageOwner =TNotebook;

Description

Тип для определения значений свойства PageOwner компоненты TPageManager.


TPageRequestEvent Type

Unit

PageMngr

Declaration

type

TPageRequestEvent = procedure(CurrentPage: Integer; var NewPage: Integer) of object;

Description

Событие запроса на порядок следования страниц компоненты TPageManager.


Parsing Unit

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 Parsing unit:

Components and objects

TRxMathParser

Types

TUserFunction

Procedures and functions

GetFormulaValue

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


TRxMathParser object
TRxMathParser Class

Hierarchy             See also             Methods

Unit

Parsing

Description

Класс TRxMathParser представляет анализатор арифметических выражений, предоставляемых в виде строки. Строка передается для анализа как параметр AFormula метода Exec. В случае ошибки вычисления возникает исключительная ситуация типа ERxParserError.

Допустимые операторы:

 + , - , * , / , ^

В выражении могут быть использованы следующие функции:

 Cos, Sin, Tan, ArcTan, ArcSin, ArcCos, Abs, Exp, Ln,

 Log, Sqrt, Sqr, Int, Fraq, Trunc, Round, Sign, Not.


TRxMathParser See Also
See also

TObject


TRxMathParser Hierarchy
Hierarchy

TObject


TRxMathParser methods
Methods

Key methods

Create	Exec	UnregisterUserFunction
Destroy	RegisterUserFunction


Exec
Exec Method

Examples

Applies to

TRxMathParser component

Declaration

function Exec(AFormula: String): Extended;

Description

Функция анализирует выражение AFormula и в случае успешного завершения возвращает результат вычислений. При ошибке возникает исключительная ситуация ERxParserError.


Exec example
Example

if rxMathParser1.Exec('2+Cos(2)') then

  Label1.Caption := 'Ok! Result = ' + FloatToStr(rxMathParser1.ResValue);


TRxMathParser.RegisterUserFunction
RegisterUserFunction Method

Examples

Applies to

TRxMathParser component

Declaration

class procedure RegisterUserFunction(const Name: string; Proc: TUserFunction);

Description

Метод регистрирует пользовательскую функцию для использования в математических выражениях, обрабатываемых объектами класса TRxMathParser.


TRxMathParserRegisterUserFunction example
Example

function GetPhase(X: Extended): Extended; far;

var

  Y: Extended;

begin

  Y := X / (2 / Pi);

  Result := (Y - Round(Y)) * (2 * Pi);

end;

procedure TForm1.FormCreate(Sender: TObject);

begin

  TRxMathParser.RegisterUserFunction('PHASE', @GetPhase);

end;


TRxMathParser.UnregisterUserFunction
UnregisterUserFunction Method

Applies to

TRxMathParser component

Declaration

class procedure UnregisterUserFunction(const Name: string);

Description

Удаляет функцию, заданную параметром Name, из списка пользовательских функций, зарегистрированных для использования с классом TRxMathParser.


TUserFunction Type

Unit

Parsing

Declaration

type

TUserFunction = function(Value: Extended): Extended;

Description

Тип определяет функцию, которая может быть зарегистрирована для использования с классом TRxMathParser. Для регистрации пользовательской функции используйте метод TRxMathParser.RegisterUserFunction.


GetFormulaValue Function

Examples

Unit

Parsing

Declaration

function GetFormulaValue(const Formula: string): Extended;

Description

Функция вычисляет результат математического выражения, заданного параметром Formula. Для вычислений используется объект типа TRxMathParser.


GetFormulaValue example
Example

 Value := GetFormulaValue('2 * Sqrt(4)');

 { here Value is 4 }


PicClip Unit

The PicClip unit contains the declarations for the certain components on the RX Tools 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 PicClip unit:

Components and objects

TPicClip

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


TPicClip Component

Hierarchy             See also             Properties             Methods             Events

Unit

PicClip

Description

Компонента TPicClip представляет собой аналог PICCLIP.VBX, поставляемого вместе с Visual Basic. TPicClip позволяет получить доступ к прямоугольному элементу изображения, предварительно разделенного на "ячейки", и затем использовать этот элемент при присвоении графическим свойствам других компонент или для рисования.

Разделение изображения на прямоугольные "ячейки" достигается за счет присвоения значений свойствам Cols и Rows. После этого любой элемент изображения доступен как объект класса TBitmap через индексированное свойство GraphicCell[Index: Integer].

Отрисовка ячейки изображения может быть осуществлена методом Draw. При этом, если свойство Masked = True (по умолчанию), то цвет, заданный свойством MaskColor будет заменяться на цвет фона ("прозрачная" отрисовка изображения).

Вы можете использовать метод Assign для занесения изображения в компоненту TPicClip, используя в качестве параметра Source объекты классов TPicture и TGraphic.

Также Вы можете использовать TPicClip в качестве параметра Source метода Assign компонент классов TPicture, TGraphic и (в 32-битной версии) TImageList.


TPicClip See Also
See also

TBitmap

TImage


TPicClip Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TPicClip properties
Properties

Run-time only    [image] Key properties

Cols	Height	Parent
ComponentCount	MaskColor	Picture
ComponentIndex	Masked	Rows
Components	Name	Tag
GraphicCell	Owner	Width


TPicClip events
Events

Run-time only    [image] Key events

OnChange


TPicClip methods
Methods

Key methods

Create	FindComponent	RemoveComponent
Destroy	InsertComponent
Draw	LoadBitmapRes


Cols
Cols Property

Applies to

TPicClip component

Declaration

property Cols: Integer;

Description

Свойство задает число колонок в сетке, определяющей разбивку графического изображения на условные "ячейки", доступ к которым осуществляется с помощью индексированного свойства GraphicCell.


GraphicCell[Index: Integer]
GraphicCell Property

Applies to

TPicClip component

Declaration

property GraphicCell[Index: Integer]: TBitmap;

Description

Свойство "только-для-чтения", позволяет получить доступ к любой "ячейке" изображения по номеру этой ячейки. Нумерация ячеек непрерывная от 0 до (Cols * Rows) - 1, слева направо и сверху вниз.


MaskColor
MaskColor Property

Applies to

TPicClip component

Declaration

property MaskColor: TColor;

Description

Если свойство Masked = True (по умолчанию), то цвет, заданный свойством MaskColor будет заменяться на цвет фона ("прозрачная" отрисовка изображения) при рисовании ячейки изображения методом Draw.


Masked
Masked Property

Applies to

TPicClip component

Declaration

property Masked: Boolean;

Description

Если свойство Masked = True (по умолчанию), то цвет, заданный свойством MaskColor будет заменяться на цвет фона ("прозрачная" отрисовка изображения) при рисовании ячейки изображения методом Draw.


Rows
Rows Property

Applies to

TPicClip component

Declaration

property Rows: Integer;

Description

Свойство задает число строк в сетке, определяющей разбивку графического изображения на условные "ячейки", доступ к которым осуществляется с помощью индексированного свойства GraphicCell.


Draw
Draw Method

Applies to

TPicClip component

Declaration

procedure Draw(Canvas: TCanvas; X, Y, Index: Integer);

Description

Метод служит для отрисовки ячейки изображения, соответствующей индексу Index, в устройстве Canvas. Координаты X, Y задают точку для верхнего левого угла изображения.

Если свойство Masked = True (по умолчанию), то изображение рисуется прозрачным, при этом в качестве "прозрачного" цвета используется цвет, заданный свойством MaskColor.


LoadBitmapRes
LoadBitmapRes Method

Applies to

TPicClip component

Declaration

procedure LoadBitmapRes(Instance: THandle; ResID: PChar);

Description

Метод предназначен для загрузки битового изображения из файла ресурса во время выполнения программы. Параметр ResID определяет имя ресурса типа BITMAP. Instance задает обработчик EXE или DLL, из ресурса которой должно быть загружено изображение. Значение HInstance определяет ресурс самого приложения, значение 0 - загрузку из "внутренних" ресурсов Windows.


PickDate Unit

The following items are declared in the PickDate unit:

Constants

PopupCalendarSize

Procedures and functions

PopupDate

SelectDate

SelectDateStr

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


PopupCalendarSize Constant

Unit

PickDate

Declaration

const

  PopupCalendarSize: TPoint = (X: 187; Y: 124);

Description

Константа задает размер выпадающего календаря, используемого компонентами TDateEdit и TDBDateEdit.


PopupDate Function

Examples

Unit

PickDate

Declaration

function PopupDate(var Date: TDateTime; Edit: TWinControl): Boolean;

Description

Функция PopupDate вызывает появление диалога выбора даты, при этом параметр Edit используется для расчета координат появления диалога - правый верхний угол диалога выбора даты будет совпадать с правым нижним углом элемента управления Edit. Функция возвращает True, если в диалоге сделан выбор, в этом случае в Date заносится выбранное значение даты; в противном случае функция возвращает False и оставляет без изменений переданное значение Date.


PopupDate example
Example

  if PopupDate(Date1,  Edit1) then

  begin

    {...}

  end;


SelectDate Function

Examples

Unit

PickDate

Declaration

function SelectDate(var Date: TDateTime; const DlgCaption: TCaption; AStartOfWeek: TDayNameOfWeek; AWeekends: TDaysOfWeek; AWeekendColor: TColor; BtnHints: TStrings): Boolean;

Description

Функция SelectDate позволяет пользователю выбрать дату, используя диалог выбора даты с календарем и кнопками навигации (следующий, предыдущий месяц, следующий, предыдущий год). Вызов функции SelectDate показывает диалог выбора даты с заголовком, определенным параметром DlgCaption. Дата, переданная в качестве параметра Date, устанавливается в календаре, когда появляется диалог. Если пользователь осуществил выбор даты и нажал в диалоге кнопку "Ok", функция возвращает True и помещает выбранное значение даты в параметр Date, в противном случае функция возвращает False.

Если вы хотите передавать дату в виде строки, используйте функцию SelectDateStr.


SelectDate example
Example

  D := SysUtils.Date; { set D to current date }

  if SelectDate(D, 'Выбор даты', Mon, [Sun], clRed, nil) then begin

    { use selected date }

  end;


SelectDateStr Function

Examples

Unit

PickDate

Declaration

function SelectDateStr(var StrDate: string; const DlgCaption: TCaption; AStartOfWeek: TDayNameOfWeek; AWeekends: TDaysOfWeek; AWeekendColor: TColor; BtnHints: TStrings): Boolean;

Description

Функция полностью аналогична функции SelectDate, за исключением того, что значение даты передается в нее в виде строки.


SelectDateStr example
Example

  SD := DateToStr(SysUtils.Date); { set SD to current date }

  if SelectDateStr(SD, 'Выбор даты', Mon, [Sun], clRed, nil) then begin

    { use selected date }

  end;


Placemnt Unit

The Placemnt unit contains the declarations for the certain components on the RX Tools 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 Placemnt unit:

Components and objects

TFormPlacement

TFormStorage

TWinMinMaxInfo

Types

TPlacementOption

TPlacementOptions

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


TFormPlacement Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

Placemnt

Description

Компонента FormPlacement сохраняет и восстанавливает размеры и положение формы, которой она принадлежит.

Компонента предназначена для работы с формами всех стилей: Normal, MDIForm, MDIChild, StayOnTop и т.д. Сохранение происходит перед уничтожением формы, а восстановление перед тем, как форма станет видимой. Необходимая информация о размерах и положении сохраняется в INI-файле. Используемый INI-файл можно задать с помощью свойства IniFileName.

Свойство Active определяет, будет ли происходить сохранение/восстановление. Свойство Options позволяет указать, какие параметры формы будут восстанавливаться при чтении из INI-файла. В большинстве случаев достаточно поместить компоненту из палитры в форму - необходимые действия будут происходить автоматически при показе/скрытии формы.


Using the TFormPlacement Component

See also             TFormPlacement Reference

Purpose

Компонента осуществляет сохранение и восстановление размеров, состояния и положения формы, которой она принадлежит.

Вы можете также использовать эту компоненту для ограничения изменения размеров формы со стилем рамки bsSizeable.

Tasks

Используйте свойство Active для включения/выключения сохранения и восстановления состояния формы.

Вы можете задать имя используемого INI-файла, если вы не хотите использовать INI-файл приложения по умолчанию.

В обработчиках событий OnSavePlacement и OnRestorePlacement вы можете записать или считать дополнительные параметры формы или других ее компонент. Из обработчиков этих событий Вы можете обратиться к свойству IniFile для доступа к объекту типа TIniFile, используемому компонентой TFormPlacement.


TFormPlacement See Also
See also

Common Component Tasks


TFormPlacement See Also
See also

GetDefaultIniName

TForm

TIniFile

TrxIniFile


TFormPlacement Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TFormPlacement properties
Properties

Run-time only    [image] Key properties

Active	IniFileObject	PreventResize
ComponentCount	IniSection	RegIniFile
ComponentIndex	MinMaxInfo	Tag
Components	Name	UseRegistry
IniFile	Options
IniFileName	Owner


TFormPlacement events
Events

Run-time only    [image] Key events

OnRestorePlacement	OnSavePlacement


TFormPlacement methods
Methods

Key methods

Create	InsertComponent	SaveFormPlacement
Destroy	RemoveComponent
FindComponent	RestoreFormPlacement


TFormPlacement.Active
Active Property

Applies to

TFormPlacement component

Declaration

property Active: Boolean;

Description

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


IniFile
IniFile Property

Applies to

TFormStorage, TFormPlacement components

Declaration

property IniFile: TIniFile;

Description

Run-time and read-only.

Свойство предназначено для доступа к объекту TIniFile, с которым работает компонента TFormPlacement, из обработчиков событий OnSavePlacement и OnRestorePlacement. Вы не можете использовать это свойство вне вышеуказанных обработчиков событий. В любое другое время свойство равно Nil. В 32-битной версии для Delphi 2.0 вы можете установить свойство UseRegistry в True. В этом случае вам необходимо будет воспользоваться свойством RegIniFile.


IniFileName
IniFileName Property

Applies to

TFormStorage, TFormPlacement, TDBSecurity components

Declaration

property IniFileName: string;

Description

С помощью этого свойства можно определить INI-файл используемый для хранения информации о размерах и положении формы (для компонент TFormPlacement, TFormStorage) или имени пользователя БД (TDBSecurity).

По умолчанию, свойство содержит пустую строку, что означает использование INI-файла приложения (имя исполнимого файла приложения, предоставляемого свойством ExeName без пути, + расширение '.INI'). Если файл не существует, то он будет создан. В некоторых случаях вы можете задать имя файла.

ПРИМЕЧАНИЕ

Если вы оставили значение свойства пустым в дизайнере Delphi, во время выполнения оно будет равно значению, возвращаемому функцией GetDefaultIniName.


IniFileObject
IniFileObject Property

Applies to

TFormStorage, TFormPlacement components

Declaration

property IniFileObject: TObject;

Description

Run-time and read-only.

Свойство предназначено для доступа к объекту TIniFile или TRegIniFile (в 32-разрядной версии), с которым работают компоненты TFormPlacement и TFormStorage, из обработчиков событий OnSavePlacement и OnRestorePlacement.

Вы не можете использовать это свойство вне вышеуказанных обработчиков событий. В любое другое время значение свойства равно Nil.

В 16-битной версии свойство всегда указывает на объект класса TIniFile.

В 32-битной версии тип свойства зависит от значения свойства UseRegistry и может быть TIniFile или TRegIniFile соответственно.


IniSection
IniSection Property

Applies to

TFormStorage, TFormPlacement components

Declaration

property IniSection: string;

Description

С помощью этого свойства можно определить секцию INI-файла, используемую для хранения информации о размерах и положении формы (для компонент TFormPlacement, TFormStorage).

По умолчанию, свойство содержит пустую строку, что означает использование секции с именем, совпадающим с именем класса формы.

ПРИМЕЧАНИЕ

Если вы оставили значение свойства пустым в дизайнере Delphi, во время выполнения оно будет равно значению, возвращаемому функцией GetDefaultSection.


MinMaxInfo
MinMaxInfo Property

Applies to

TFormStorage, TFormPlacement components

Declaration

property MinMaxInfo: TWinMinMaxInfo;

Description

Свойство MinMaxInfo предназначено для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров, а также для задания размеров и положения формы в состоянии максимизации.

Использование этого свойства имеет смысл только при значении свойства формы BorderStyle = bsSizeable.


TFormPlacement.Options
Options Property

Applies to

TFormPlacement component

Declaration

property Options: TPlacementOptions;

Description

Значения свойства Options определяют, какие параметры формы будут сохраняться/восстанавливаться компонентой TFormPlacement. Следующие значения могут быть включены в свойство Options:

fpState - состояние формы (нормальное, максимизированное, минимизированное);

fpPosition - положение и размеры формы;

fpActiveControl - активный элемент управления на форме (значение свойства ActiveControl формы-владельца).


PreventResize
PreventResize Property

Applies to

TFormStorage, TFormPlacement components

Declaration

property PreventResize: Boolean;

Description

Установка в True значения этого свойства приводит к запрещению изменения размеров формы, которой принадлежит компонента, при сохранении внешнего вида рамки окна с изменяемым размером.

Установка значения свойства PreventResize в True имеет смысл и оказывает воздействие только для форм, имеющих свойство BorderStyle = bsSizeable.


RegIniFile
RegIniFile Property

Applies to

TFormStorage, TFormPlacement components

Declaration

property RegIniFile: TRegIniFile;

Description

Run-time and read-only.

Свойство предназначено для доступа к объекту TRegIniFile, с которым работают компонента TFormPlacement и TFormStorage (при установленном в True значении свойства UseRegistry), из обработчиков событий OnSavePlacement и OnRestorePlacement. Вы не можете использовать это свойство вне вышеуказанных обработчиков событий. В любое другое время свойство равно Nil.

В случае установки свойства UseRegistry = False вы должны будете воспользоваться свойством IniFile: TIniFile.


OnRestorePlacement
OnRestorePlacement Event

Applies to

TFormStorage, TFormPlacement components

Declaration

property OnRestorePlacement: TNotifyEvent;

Description

Событие происходит после восстановления состояния формы - владельца компоненты. Обычное применение обработки данного события заключается в том, чтобы загрузить из INI-файла дополнительные параметры формы или принадлежащих ей компонент.


OnSavePlacement
OnSavePlacement Event

Applies to

TFormStorage, TFormPlacement components

Declaration

property OnSavePlacement: TNotifyEvent;

Description

Событие происходит после сохранения состояния формы - владельца компоненты. Обычное применение обработки данного события заключается в том, чтобы записать в INI-файл дополнительные параметры формы или принадлежащих ей компонент.


RestoreFormPlacement
RestoreFormPlacement Method

Applies to

TFormStorage, TFormPlacement components

Declaration

procedure RestoreFormPlacement; virtual;

Description

Восстанавливает из INI-файла, определяемого свойством IniFileName размеры и положение формы - владельца компоненты, вне зависимости от значения свойства Active.


SaveFormPlacement
SaveFormPlacement Method

Applies to

TFormStorage, TFormPlacement components

Declaration

procedure SaveFormPlacement; virtual;

Description

Сохраняет в INI-файл, определяемый с помощью свойства IniFileName размеры и положение формы-владельца компоненты, вне зависимости от значения свойства Active.


TFormStorage Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

Placemnt

Description

Компонента TFormStorage сохраняет и восстанавливает размеры и положение формы, которой она принадлежит, а также может сохранить значения любых published-свойств любых других компонент этой же формы. Компонента предназначена для работы с формами всех стилей: Normal, MDIForm, MDIChild, StayOnTop. Сохранение происходит перед уничтожением формы, а восстановление перед тем, как форма станет видимой. Необходимая информация сохраняется в INI-файле. Используемый INI-файл можно задать с помощью свойства IniFileName. Свойство Active определяет, будет ли происходить сохранение/восстановление.

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

В дизайнере Delphi Вы можете указать также список свойств других компонентов формы, которые будут сохраняться и восстанавливаться из INI-файла. Для хранения имен этих свойств служит свойство StoredProps. Заметьте, что может оказаться важным порядок следования имен сохраняемых\восстанавливаемых свойств, особенно при восстановлении их значений из INI-файла.

Если Вы хотите сохранять только размеры и положение формы, то воспользуйтесь компонентой TFormPlacement, являющейся предком TFormStorage и не содержащую методов для сохранения\восстановления значений свойств других компонентов формы.


Using the TFormStorage Component

See also             TFormStorage Reference

Purpose

Компонента служит для сохранения и восстановления в INI-файле любых published-свойств компонент, принадлежащих форме.

Tasks

Используйте TFormStorage:

- для сохранения положения перемещаемой "разделительной полоски" между компонентами TRxSplitter, в этом случае Вам надо сохранить значение ширины или высоты (свойства Width, Heigth, в зависимости от значения свойства Align) той компоненты, размерами которой непосредственно управляет TRxSplitter (эта одна из компонент, определяемых его свойствами ControlFirst, ControlSecond).

- для сохранения активной страницы компонент TNotebook, TTabbedNotebook или TPageControl путем сохранения свойства ActivePage или PageIndex.

- для сохранения и восстановления содержимого текстовых редакторов TEdit (свойство Text) или TMemo (свойство Lines), расположенных в Вашей форме.

- для сохранения состояния элементов управления, таких как TCheckBox, TRadioGroup и т.д.

- для сохранения и восстановления размеров, состояния и положения формы, а также активного элемента управления в ней.

- для ограничения изменения размеров формы со стилем рамки bsSizeable, bsSizeToolWin.


TFormStorage See Also
See also

Common Component Tasks


TFormStorage See Also
See also

TFormPlacement


TFormStorage Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TFormPlacement


TFormStorage properties
Properties

Run-time only    [image] Key properties

Active	IniFileObject	PreventResize
ComponentCount	IniSection	RegIniFile
ComponentIndex	MinMaxInfo	StoredProps
Components	Name	Tag
IniFile	Options	UseRegistry
IniFileName	Owner


TFormStorage events
Events

Run-time only    [image] Key events

OnRestorePlacement	OnSavePlacement


TFormStorage methods
Methods

Key methods

Create	InsertComponent	RestoreProperties
Destroy	RemoveComponent	SaveFormPlacement
FindComponent	RestoreFormPlacement	SaveProperties


TFormStorage.Active
Active Property

Applies to

TFormStorage component

Declaration

property Active: Boolean;

Description

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


TFormStorage.Options
Options Property

Applies to

TFormStorage component

Declaration

property Options: TPlacementOptions;

Description

Значения свойства Options определяют, какие параметры формы будут сохраняться/восстанавливаться компонентой TFormStorage. Следующие значения могут быть включены в свойство Options:

fpState - состояние формы (нормальное, максимизированное, минимизированное);

fpPosition - положение и размеры формы;

fpActiveControl - активный элемент управления на форме (значение свойства ActiveControl формы-владельца).


StoredProps
StoredProps Property

Applies to

TFormStorage component

Declaration

property StoredProps: TStrings;

Description

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

Для сохранения доступны любые published-свойства других компонент формы. Однако Вы должны четко представлть себе, что произойдет при восстановлении значений этих свойств. Заметьте, что может оказаться важным порядок восстановления значений различных свойств из INI-файла. Редактор свойства StoredProps предосталвяет Вам возможность задать порядок расположения строк в этом списке.


RestoreProperties
RestoreProperties Method

Applies to

TFormStorage component

Declaration

procedure RestoreProperties;

Description

Восстанавливает из INI-файла, определяемого свойством IniFileName свойства компонент формы-владельца, заданные свойством StoredProps, вне зависимости от значения свойства Active.


SaveProperties
SaveProperties Method

Applies to

TFormStorage component

Declaration

procedure SaveProperties;

Description

Записывает в INI-файл, определяемый свойством IniFileName, свойства компонент, заданные свойством StoredProps, вне зависимости от значения свойства Active.


TWinMinMaxInfo object
TWinMinMaxInfo Class

Hierarchy             See also             Properties             Methods

Unit

Placemnt

Description

Класс предназначен для использования компонентами TFormStorage и TFormPlacement для сохранения данных о минимальных и максимальных размерах и положении формы - владельца объектов TFormStorage и TFormPlacement.


TWinMinMaxInfo See Also
See also

TFormPlacement

TFormStorage


TWinMinMaxInfo Hierarchy
Hierarchy

TObject

  |

TPersistent


TWinMinMaxInfo properties
Properties

Run-time only    [image] Key properties

MaxPosLeft	MaxSizeWidth	MinTrackHeight
MaxPosTop	MaxTrackHeight	MinTrackWidth
MaxSizeHeight	MaxTrackWidth


TWinMinMaxInfo methods
Methods

Key methods

Assign	DefaultMinMaxInfo
Create	Destroy


MaxPosLeft
MaxPosLeft Property

Applies to

TWinMinMaxInfo component

Declaration

property MaxPosLeft: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


MaxPosTop
MaxPosTop Property

Applies to

TWinMinMaxInfo component

Declaration

property MaxPosTop: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


MaxSizeHeight
MaxSizeHeight Property

Applies to

TWinMinMaxInfo component

Declaration

property MaxSizeHeight: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


MaxSizeWidth
MaxSizeWidth Property

Applies to

TWinMinMaxInfo component

Declaration

property MaxSizeWidth: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


MaxTrackHeight
MaxTrackHeight Property

Applies to

TWinMinMaxInfo component

Declaration

property MaxTrackHeight: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


MaxTrackWidth
MaxTrackWidth Property

Applies to

TWinMinMaxInfo component

Declaration

property MaxTrackWidth: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


MinTrackHeight
MinTrackHeight Property

Applies to

TWinMinMaxInfo component

Declaration

property MinTrackHeight: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


MinTrackWidth
MinTrackWidth Property

Applies to

TWinMinMaxInfo component

Declaration

property MinTrackWidth: Integer;

Description

Свойства MinTrackHeight, MinTrackWidth, MaxTrackHeight и MaxTrackWidth предназначены для наложения ограничений на максимальный и минимальный размеры формы, которой принадлежит компонента TFormPlacement или TFormStorage, при изменении ее размеров.

Свойства MaxPosLeft и MaxPosTop задают положение левого верхнего угла формы при ее максимизации.

Свойства MaxSizeHeight и MaxSizeWidth задают размеры формы при ее максимизации.

При установке значения свойства в 0 (по умолчанию), ограничения на соответствующий размер наложено не будет.


DefaultMinMaxInfo
DefaultMinMaxInfo Method

Applies to

TWinMinMaxInfo component

Declaration

function DefaultMinMaxInfo: Boolean;

Description

Функция возвращает True, если значения всех ключевых свойств объекта TWinMinMaxInfo равны 0, то есть не должно обрабатываться сообщение WM_GETMINMAXINFO.


TPlacementOption Type

Unit

Placemnt

Declaration

type

TPlacementOption = (fpState, fpPosition, fpActiveControl);

Description

Тип определяет возможные значения свойства Options компоненты TFormPlacement.


TPlacementOptions Type

Unit

Placemnt

Declaration

type

TPlacementOptions = set of TPlacementOption;

Description

Тип определяет возможные значения свойства Options компоненты TFormPlacement.


RxCalc Unit

The RxCalc unit contains the declarations for the certain components on the RX Tools 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 RxCalc unit:

Components and objects

TRxCalculator

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


TRxCalculator Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCalc

Description

Форма для отображения простейшего калькулятора. Активизируется вызовом метода Execute. Результат вычислений содержится в свойстве Value.


TRxCalculator See Also
See also

TForm

TRxCalcEdit

TRxDBCalcEdit


TRxCalculator Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxCalculator properties
Properties

Run-time only    [image] Key properties

BeepOnError	HelpContext	Tag
ComponentCount	Memory	Title
ComponentIndex	Name	Value
Components	Owner
Ctl3D	Precision


TRxCalculator events
Events

Run-time only    [image] Key events

OnChange


TRxCalculator methods
Methods

Key methods

Create	Execute	InsertComponent
Destroy	FindComponent	RemoveComponent


TRxCalculator.Memory
Memory Property

Applies to

TRxCalculator component

Declaration

property Memory: Double;

Description

Свойство Memory содержит значение, сохраненное в "регистре памяти" калькулятора. Свойство только для чтения.


TRxCalculator.Precision
Precision Property

Applies to

TRxCalculator component

Declaration

property Precision: Byte;

Description

Свойство Precision определяет точность округления при форматировании сроки, отображаемой в калькуляторе.

Значение свойства по умолчанию - 15.

Минимально допустимое значение - 2. При установке свойства в значение, меньшее 2, при форматировании числа используется значение 2.


TRxCalculator.Title
Title Property

Applies to

TRxCalculator component

Declaration

property Title: string;

Description

Свойство Title задает заголовок диалогового окна калькулятора компоненты TRxCalculator.


TRxCalculator.Value
Value Property

Applies to

TRxCalculator component

Declaration

property Value: Double;

Description

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


RxClock Unit

The RxClock 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 RxClock unit:

Components and objects

TRxClock

Types

TRxGetTimeEvent

TShowClock

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


TRxClock Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxClock

Description

Компонента позволяет отображать время суток в цифровом или аналоговом виде (вид отображения задается с помощью свойства ShowMode).

При цифровом отображении формат времени задается комбинацией значений свойств LeadingZero, TwelveHour и ShowSeconds.

Дополнительно имеется функция будильника. При установке значения AlarmEnabled в True, при наступлении времени суток, заданного свойствами AlarmHour, AlarmMinute и AlarmSecond, происходит событие OnAlarm, в обработчике которого вы можете произвести необходимые действия.


TRxClock See Also
See also

TDateTime

TPanel

TTimer


TRxClock Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TCustomPanel


TRxClock properties
Properties

Run-time only    [image] Key properties

AlarmEnabled	Ctl3D	ParentCtl3D
AlarmHour	Cursor	ParentFont
AlarmMinute	DotsColor	ParentShowHint
AlarmSecond	DragCursor	PopupMenu
Align	DragMode	ShowHint
AutoSize	Font	Showing
BevelInner	Height	ShowMode
BevelOuter	HelpContext	ShowSeconds
BevelWidth	Hint	TabOrder
BorderStyle	LeadingZero	TabStop
BorderWidth	Left	Tag
Color	Name	Top
ComponentCount	Owner	TwelveHour
ComponentIndex	Parent	Visible
Components	ParentColor	Width


TRxClock events
Events

Run-time only    [image] Key events

OnAlarm	OnDragOver	OnMouseMove
OnClick	OnEndDrag	OnMouseUp
OnDblClick	OnGetTime	OnResize
OnDragDrop	OnMouseDown	OnStartDrag


TRxClock methods
Methods

Key methods

BeginDrag	GetTextLen	SendToBack
BringToFront	Hide	SetAlarmTime
ClientToScreen	InsertComponent	SetBounds
Create	Invalidate	SetFocus
Destroy	Perform	SetTextBuf
Dragging	Refresh	Show
EndDrag	RemoveComponent	Update
FindComponent	Repaint
GetTextBuf	ScreenToClient


AlarmEnabled
AlarmEnabled Property

Applies to

TRxClock component

Declaration

property AlarmEnabled: Boolean;

Description

При установке значения AlarmEnabled в True, при наступлении времени суток, заданного свойствами AlarmHour, AlarmMinute и AlarmSecond, происходит событие OnAlarm, в обработчике которого вы можете произвести необходимые действия.


AlarmHour
AlarmHour Property

Applies to

TRxClock component

Declaration

property AlarmHour: Byte;

Description

Свойство задает (совместно со значениями AlarmMinute и AlarmSecond) время срабатывания "будильника", т.е. время, в которое произойдет событие OnAlarm при установке в True свойства AlarmEnabled.


AlarmMinute
AlarmMinute Property

Applies to

TRxClock component

Declaration

property AlarmMinute: Byte;

Description

Свойство задает (совместно со значениями AlarmHour и AlarmSecond) время срабатывания "будильника", т.е. время, в которое произойдет событие OnAlarm при установке в True свойства AlarmEnabled.


AlarmSecond
AlarmSecond Property

Applies to

TRxClock component

Declaration

property AlarmSecond: Byte;

Description

Свойство задает (совместно со значениями AlarmHour и AlarmMinute) время срабатывания "будильника", т.е. время, в которое произойдет событие OnAlarm при установке в True свойства AlarmEnabled.


TRxClock.AutoSize
AutoSize Property

Applies to

TRxClock component

Declaration

property AutoSize: Boolean;

Description

Свойство определяет, будет ли размер автоматически изменяться размер шрифта, которым отображается время в цифровом виде (значение ShowMode равно scDigital), при изменении размера элемента управления TRxClock.


DotsColor
DotsColor Property

Applies to

TRxClock component

Declaration

property DotsColor: TColor;

Description

Свойство задает цвет для точек, обозначающих часы. Имеет смысл при значениях свойств ShowMode = scAnalog и Ctl3D = True.


LeadingZero
LeadingZero Property

Applies to

TRxClock component

Declaration

property LeadingZero: Boolean;

Description

Свойство определяет, будут ли добавляться лидирующие нули при форматировании времени (только для значения часов), если задано цифровое отображение часов (свойство ShowMode = scDigital).


ShowMode
ShowMode Property

Applies to

TRxClock component

Declaration

property ShowMode: TShowClock;

Description

Свойство управляет режимом отображения времени в компоненте TRxClock. Значение scDigital задает цифровое отображение времени шрифтом, заданным свойством Font, значение scAnalog задает аналоговый вид часов.

При цифровом отображении времени формат времени задается комбинацией значений свойств LeadingZero, TwelveHour и ShowSeconds.

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


ShowSeconds
ShowSeconds Property

Applies to

TRxClock component

Declaration

property ShowSeconds: Boolean;

Description

Свойство задает, будут ли отображаться секунды при цифровом изображении часов (при значении свойства ShowMode = scDigital) или секундная стрелка - при аналоговом.


TwelveHour
TwelveHour Property

Applies to

TRxClock component

Declaration

property TwelveHour: Boolean;

Description

Свойство определяет, как будет форматироваться время, если задано цифровое отображение часов (свойство ShowMode = scDigital). При значении TwelveHour = False (по умолчанию) диапазон значений часов 0..23; при значении True часы принимают значения 1..12 и при форматировании времени используются значения глобальных переменных модуля SysUtils TimeAMString и TimePMString.


OnAlarm
OnAlarm Event

Applies to

TRxClock component

Declaration

property OnAlarm: TNotifyEvent;

Description

Событие OnAlarm происходит при наступлении времени суток, заданного свойствами AlarmHour, AlarmMinute и AlarmSecond, если свойство AlarmEnabled установлено в значение True.


TRxClock.OnGetTime
OnGetTime Event

Applies to

TRxClock component

Declaration

property OnGetTime: TRxGetTimeEvent;

Description

Событие возникает каждый раз, когда компонента TRxClock определяет значение времени для отображения.

По умолчанию компонента отображает текущее значение системного времени. Вы можете написать обработчик этого события для того, чтобы отобразить в компоненте TRxClock время, отличное от системного, например, время другого часового пояса.


SetAlarmTime
SetAlarmTime Method

Applies to

TRxClock component

Declaration

procedure SetAlarmTime(AlarmTime: TDateTime);

Description

Процедура устанавливает время срабатывания будильника в часах, минутах и секундах. Вызов этого метода равносилен присвоению соответствующих значений свойствам AlarmHour, AlarmMinute и AlarmSecond.


TRxGetTimeEvent Type

Unit

RxClock

Declaration

type

TRxGetTimeEvent = procedure (Sender: TObject; var ATime: TDateTime) of object;

Description

Тип определяет обработчик события OnGetTime компоненты TRxClock.


TShowClock Type

Unit

RxClock

Declaration

type

TShowClock = (scDigital, scAnalog);

Description

Тип служит для задания допустимых значений режима отображения компоненты TRxClock (значение свойства ShowMode).


RxCombos Unit

The RxCombos 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 RxCombos unit:

Components and objects

TColorComboBox

TFontComboBox

Types

TFontDevice

TFontListOption

TFontListOptions

TOwnerDrawComboStyle

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


TColorComboBox Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCombos

Description

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


TColorComboBox See Also
See also

TComboBox

TFontComboBox


TColorComboBox Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomComboBox


TColorComboBox properties
Properties

Run-time only    [image] Key properties

Color	Enabled	ParentShowHint
ColorNames	Font	PopupMenu
ColorValue	Height	ShowHint
ComponentCount	HelpContext	Showing
ComponentIndex	Hint	Style
Components	Left	TabOrder
Ctl3D	Name	TabStop
Cursor	Owner	Tag
DisplayNames	Parent	Text
DragCursor	ParentColor	Top
DragMode	ParentCtl3D	Visible
DroppedDown	ParentFont	Width


TColorComboBox events
Events

Run-time only    [image] Key events

OnChange	OnDropDown	OnKeyPress
OnClick	OnEndDrag	OnKeyUp
OnDblClick	OnEnter	OnStartDrag
OnDragDrop	OnExit
OnDragOver	OnKeyDown


TColorComboBox methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TColorComboBox.ColorNames
ColorNames Property

Applies to

TColorComboBox component

Declaration

property ColorNames: TStrings;

Description

ColorNames provides a way to customize the display color's names for the items in the drop-down list of color combo box.

Use the ColorNames property to supply color names of your choosing for the individual color items. Each color has a default english name. ColorNames allow the values of any or all of these default names to be replaced by customized names.

ColorNames is a string list. Each name is a string. The first string in the string list becomes the name for the first item on the list (clBlack). The 16-th string becomes the name for the 16-th item (clWhite).

When specifying names at runtime, enter an empty string ('') for any name that should keep the default value. Simply leave the line blank when using the string list property editor of the Object Inspector for the ColorNames property.


ColorValue
ColorValue Property

Applies to

TColorComboBox component

Declaration

property ColorValue: TColor;

Description

Свойство определяет значение одного из 16 цветов, выбранное в настоящий момент в компоненте TColorComboBox.


DisplayNames
DisplayNames Property

Applies to

TColorComboBox component

Declaration

property DisplayNames: Boolean;

Description

Свойство задает, будут ли отображаться названия цветов (Black, Red и т.д.) в списке цветов. По умолчанию (True) названия отображаются.


TColorComboBox.Style
Style Property

Applies to

TColorComboBox component

Declaration

property Style: TOwnerDrawComboStyle;

Description

The Style property determines how a combo box displays its items. By default, Style is csDropDownList, meaning that the combo box displays each item as a string in a drop-down list, with no attached edit box. You can set Style to any of the following values:

• csDropDown - Creates a drop-down list with an edit box in which the user can enter text.

• csSimple - Creates an edit box with no list.

• csDropDownList - Creates a drop-down list with no attached edit box, so the user can't edit an item or type in a new item.


TFontComboBox Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCombos

Description

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

Набор шрифтов, отображаемый списком, зависит от значений свойств Device и Options.


TFontComboBox See Also
See also

TColorComboBox

TComboBox

TDriveComboBox


TFontComboBox Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomComboBox


TFontComboBox properties
Properties

Run-time only    [image] Key properties

Color	Height	PopupMenu
ComponentCount	HelpContext	ShowHint
ComponentIndex	Hint	Showing
Components	Left	Style
Ctl3D	Name	TabOrder
Cursor	Options	TabStop
Device	Owner	Tag
DragCursor	Parent	Text
DragMode	ParentColor	Top
Enabled	ParentCtl3D	TrueTypeOnly
Font	ParentFont	Visible
FontName	ParentShowHint	Width


TFontComboBox events
Events

Run-time only    [image] Key events

OnChange	OnDropDown	OnKeyPress
OnClick	OnEndDrag	OnKeyUp
OnDblClick	OnEnter	OnStartDrag
OnDragDrop	OnExit
OnDragOver	OnKeyDown


TFontComboBox methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


Device
Device Property

Applies to

TFontComboBox component

Declaration

property Device: TFontDevice;

Description

Свойство определяет, какие шрифты из доступных в системе на момент выполнения программы будут отображаться в списке выбора компоненты TFontComboBox. Допустимые значения для свойства Device:

fdScreen - экранные шрифты;

fdPrinter - принтерные шрифты;

fdBoth - экранные и принтерные шрифты.


TFontComboBox.FontName
FontName Property

Applies to

TFontComboBox component

Declaration

property FontName: string;

Description

Свойство определяет, какой шрифт отображается в строке редактора компоненты TFontComboBox. Когда пользователь выбирает в выпадающем списке новый шрифт, выбранный шрифт становится значением свойства FontName. Значение свойства Text также изменяется и становится равным имени выбранного шрифта.


TFontComboBox.Options
Options Property

Applies to

TFontComboBox component

Declaration

property Options: TFontListOptions;

Description

These are the possible values that can be included in the Options set for the TFontComboBox:

- foAnsiOnly - If True, the user can select fonts that use the Windows character set only; that is, the user can't choose a font that contains only symbols because they aren't displayed in the Font combo box.

- foTrueTypeOnly - If True, only TrueType fonts are displayed in the Font combo box.

- foFixedPitchOnly - If True, only monospaced fonts are displayed in the Font combo box.

- foNoOEMFonts - If True, only fonts that aren't vector fonts are displayed in the Font combo box.

- foOEMFontsOnly - If True, only OEM fonts are displayed in the Font combo box.

- foScalableOnly - If True, only fonts that can be scaled are displayed in the Font combo box.

The default value is [].


TFontComboBox.Style
Style Property

Applies to

TFontComboBox component

Declaration

property Style: TOwnerDrawComboStyle;

Description

The Style property determines how a combo box displays its items. By default, Style is csDropDownList, meaning that the combo box displays each item as a string in a drop-down list, with no attached edit box. You can set Style to any of the following values:

• csDropDown - Creates a drop-down list with an edit box in which the user can enter text.

• csSimple - Creates an edit box with no list.

• csDropDownList - Creates a drop-down list with no attached edit box, so the user can't edit an item or type in a new item.


TrueTypeOnly
TrueTypeOnly Property

Applies to

TFontComboBox component

Declaration

property TrueTypeOnly: Boolean;

Description

Свойство определяет, будут ли в списке выбора шрифтов компоненты TFontComboBox отображаться только масштабируемые шрифты TrueType (при значение свойства TrueTypeOnly = True), либо все шрифты, доступные для выбранного устройства (значение False). Выбор устройства задается свойством Device.

В настоящей версии библиотеки RX свойство TrueTypeOnly устарело, используйте вместо него установку значения свойства Options.


TFontDevice Type

Unit

RxCombos

Declaration

type

TFontDevice = (fdScreen, fdPrinter, fdBoth);

Description

Тип TFontDevice задает возможные значения свойства Device компоненты TFontComboBox.


TFontListOption Type

Unit

RxCombos

Declaration

type

TFontListOption = (foAnsiOnly, foTrueTypeOnly, foFixedPitchOnly, foNoOEMFonts, foOEMFontsOnly, foScalableOnly);

Description

Тип определяет возможные значения свойства Options компоненты TFontComboBox.


TFontListOptions Type

Unit

RxCombos

Declaration

type

TFontListOptions = set of TFontListOption;

Description

Тип определяет возможные значения свойства Options компоненты TFontComboBox.


TOwnerDrawComboStyle Type

Unit

RxCombos

Declaration

type

TOwnerDrawComboStyle = csDropDown..csDropDownList;

Description

Тип определет возможные значения свойства Style компонент TFontComboBox и TColorComboBox.


RxCtrls Unit

The RxCtrls 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 RxCtrls unit:

Components and objects

TRxCheckListBox

TRxLabel

TRxSpeedButton

TSecretPanel

TTextListBox

Types

TChangeStateEvent

TCheckKind

TGetItemWidthEvent

TGlyphLayout

TPanelDrawEvent

TRxButtonState

TRxDropDownMenuPos

TRxNumGlyphs

TScrollDirection

TShadowPosition

TTextLayout

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


TRxCheckListBox Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCtrls

Description

Как и TListBox, компонента предназначена для хранения и отображения списка строк, и имеет дополнительную возможность помечать каждую строку в списке, что отражается свойствами Checked и State. Строка в списке может быть помечена как активная через индексированное свойство EnabledItem, что даст возможность изменения свойства Checked пользователем мышью во время выполнения программы.

Для отметки строк в списке могут быть использованы как изображения, используемые в check-boxes, так и изображения radio-buttons, в зависимости от значения свойства CheckKind. Во втором случае одновременно может быть помечен только один элемент в списке (как в TRadioGroup).

Доступны все свойства и методы компонент TListBox, TTextListBox.

При свойстве AutoScroll=True происходит автоматическая установка горизонтальной полосы скроллинга списка по максимальной длине строки. Если при этом список имеет стиль lbOwnerDrawVariable или lbOwnerDraFixed, то Вы можете задать диапазон скроллинга через обработчик события OnGetItemWidth.


TRxCheckListBox See Also
See also

TListBox

TTextListBox


TRxCheckListBox Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TRxCustomListBox


TRxCheckListBox properties
Properties

Run-time only    [image] Key properties

Align	ExtendedSelect	ParentShowHint
AllowGrayed	Font	PopupMenu
AutoScroll	Height	SelCount
BorderStyle	HelpContext	Selected
Checked	Hint	ShowHint
CheckedIndex	IniStorage	Showing
CheckKind	IntegralHeight	Sorted
Color	ItemHeight	State
Columns	ItemIndex	TabOrder
ComponentCount	Items	TabStop
ComponentIndex	Left	TabWidth
Components	MultiSelect	Tag
Ctl3D	Name	Top
Cursor	Owner	TopIndex
DragCursor	Parent	Visible
DragMode	ParentColor	Width
Enabled	ParentCtl3D
EnabledItem	ParentFont


TRxCheckListBox events
Events

Run-time only    [image] Key events

OnClick	OnEnter	OnMouseDown
OnClickCheck	OnExit	OnMouseMove
OnDblClick	OnGetItemWidth	OnMouseUp
OnDragDrop	OnKeyDown	OnStartDrag
OnDragOver	OnKeyPress	OnStateChange
OnEndDrag	OnKeyUp


TRxCheckListBox methods
Methods

Key methods

ApplyState	GetTextBuf	ScreenToClient
BeginDrag	GetTextLen	SendToBack
BringToFront	Hide	SetBounds
Clear	Invalidate	SetFocus
ClientToScreen	ItemAtPos	SetTextBuf
Create	ItemRect	Show
Destroy	Perform	Update
Dragging	Refresh
EndDrag	Repaint


TRxCheckListBox.AllowGrayed
AllowGrayed Property

Applies to

TRxCheckListBox component

Declaration

property AllowGrayed: Boolean;

Description

Определяет количество состояний при изменении значения Items.State во время выполнения. При значении True добавляет в список таких состояний cbGrayed.


AutoScroll
AutoScroll Property

Applies to

TRxCheckListBox component

Declaration

property AutoScroll: Boolean;

Description

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


TRxCheckListBox.Checked[Index: Integer]
Checked Property

Applies to

TRxCheckListBox component

Declaration

property Checked[Index: Integer]: Boolean;

Description

Индексированное свойство Checked предназначено для хранения отметок о "помеченности" строк Items. В режиме дизайна формы это свойство доступно через редактор свойства Items.


CheckedIndex
CheckedIndex Property

Applies to

TRxCheckListBox component

Declaration

property CheckedIndex: Integer;

Description

Свойство имеет смысл только при значении свойства CheckKind = ckRadioButtons и определяет номер отмеченного элемента в списке.


CheckKind
CheckKind Property

Applies to

TRxCheckListBox component

Declaration

property CheckKind: TCheckKind;

Description

Определяет вид изображений, отображающих пометку элемента в списке и поведение списка TRxCheckListBox.

Изображения могут быть теми же, что используется в Check-Boxes (в этом случае может быть помечено сколько угодно строк списка) или же теми, что используются в Radio-Buttons (при этом может быть помечен только один элемент списка). При значении свойства ckRadioButtons номер отмеченного элемента в списке задается свойством CheckedIndex.


EnabledItem[Index: Integer]
EnabledItem Property

Applies to

TRxCheckListBox component

Declaration

property EnabledItem[Index: Integer]: Boolean;

Description

Индексированное свойство EnabledItem предназначено для хранения отметок об активности (разрешенности) строк Items. В режиме дизайна формы это свойство доступно через редактор свойства Items.


TRxCheckListBox.State[Index: Integer]
State Property

Applies to

TRxCheckListBox component

Declaration

property State[Index: Integer]: TCheckBoxState;

Description

Свойство аналогично по действию свойству State компоненты TCheckBox и имеет смысл для конкретного элемента в списке.

При значении свойства CheckKind = ckRadioButtons только один элемент в списке может быть отмеченным (иметь состояние cbChecked).


TRxCheckListBox.OnClickCheck
OnClickCheck Event

Applies to

TRxCheckListBox component

Declaration

property OnClickCheck: TNotifyEvent;

Description

Событие возникает после изменения значения свойства State с клавиатуры или мышью у отдельного элемента списка. При изменении состояния сразу всех элементов вызывается событие OnStateChange.


OnGetItemWidth
OnGetItemWidth Event

Applies to

TRxCheckListBox component

Declaration

property OnGetItemWidth: TGetItemWidthEvent;

Description

Событие вызывается при стиле lbOwnerDrawVariable или lbOwnerDraFixed и установленном в True значении свойства AutoScroll для определения диапазона горизонтального скроллинга компоненты TRxCheckListBox. В обработчике события Вы можете задать соотвествующую ширину, присвоив значение параметру Width.


OnStateChange
OnStateChange Event

Applies to

TRxCheckListBox component

Declaration

property OnStateChange: TChangeStateEvent;

Description

Событие вызывается при любом (программном или пользователем) изменении состояния State элементов списка. При "пакетном" изменении состояния сразу многих элементов (например, из метода ApplyState), событие будет вызвано для каждого элемента отдельно.


ApplyState
ApplyState Method

Applies to

TRxCheckListBox component

Declaration

procedure ApplyState(AState: TCheckBoxState; EnabledOnly: Boolean);

Description

Метод ApplyState позволяет установить состояние AState всем либо только разрешенным (Enabled) строкам списка.


TRxLabel Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCtrls

Description

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

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


TRxLabel See Also
See also

TLabel


TRxLabel Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TGraphicControl

  |

TRxCustomLabel


TRxLabel properties
Properties

Run-time only    [image] Key properties

Align	Height	ShadowSize
Alignment	HelpContext	ShowAccelChar
AutoSize	Hint	ShowFocus
Canvas	Layout	ShowHint
Caption	Left	Showing
Color	Name	TabOrder
ComponentCount	Owner	TabStop
ComponentIndex	Parent	Tag
Components	ParentColor	Top
Cursor	ParentFont	Transparent
DragCursor	ParentShowHint	Visible
DragMode	PopupMenu	Width
FocusControl	ShadowColor	WordWrap
Font	ShadowPos


TRxLabel events
Events

Run-time only    [image] Key events

OnClick	OnEndDrag	OnMouseMove
OnDblClick	OnMouseDown	OnMouseUp
OnDragDrop	OnMouseEnter	OnStartDrag
OnDragOver	OnMouseLeave


TRxLabel methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TRxLabel.Layout
Layout Property

Applies to

TRxLabel component

Declaration

property Layout: TTextLayout;

Description

Свойство определяет вертикальное расположение текста внутри компоненты TRxLabel при значении AutoSize = False.

Возможные значения:

- tlTop: выравнивание текста по верхнему краю компоненты.

- tlCenter: расположение текста по центру компоненты по вертикали.

- tlBottom: выравнивание текста по нижнему краю компоненты.


ShadowColor
ShadowColor Property

Applies to

TRxLabel, TDBStatusLabel components

Declaration

property ShadowColor: TColor;

Description

Свойство задает цвет "тени" букв текста статического элемента управления TRxLabel.


ShadowPos
ShadowPos Property

Applies to

TRxLabel, TDBStatusLabel components

Declaration

property ShadowPos: TShadowPosition;

Description

Свойство задает расположение "тени" букв текста статического элемента управления TrxLabel.


ShadowSize
ShadowSize Property

Applies to

TRxLabel, TDBStatusLabel components

Declaration

property ShadowSize: Byte;

Description

Свойство задает толщину "тени" букв текста статического элемента управления TrxLabel.


TRxLabel.ShowFocus
ShowFocus Property

Applies to

TRxLabel component

Declaration

property ShowFocus: Boolean;

Description

Свойство ShowFocus при установленном значении True позволяет отображать вокруг метки пунктирную рамку (focus rect), если в настоящее время активен элемент управления, заданный свойством FocusControl компоненты TrxLabel.


OnMouseEnter
OnMouseEnter Event

Applies to

TSpeedItem, TRxSpeedButton, TRxLabel components

Declaration

property OnMouseEnter: TNotifyEvent;

Description

Событие происходит, когда пользователь перемещает курсор мыши в область, находящуюся над элементом управления.


OnMouseLeave
OnMouseLeave Event

Applies to

TSpeedItem, TRxSpeedButton, TRxLabel components

Declaration

property OnMouseLeave: TNotifyEvent;

Description

Событие происходит, когда пользователь уводит курсор мыши из области, находящейся над элементом управления.


TRxSpeedButton Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCtrls

Description

Компонента аналогична стандартной компоненте TSpeedButton, но имеет некоторые дополнительные возможности.

Она может быть прозрачной (свойство Transparent) и "всплывающей" (свойство Flat), что позволяет создавать кнопки, аналогичные используемым в панели инструментов Microsoft Internet Explorer 3.x. При установленном значении свойств GrayedInactive и Flat битовое изображение "неактивной" кнопки будет изменяться по сравнению с обычным вариантом.

При установке свойства AllowTimer в значение True, кнопка будет генерировать повторяющиеся события OnClick при нажатии на кнопку до тех пор, пока кнопка находится в нажатом состоянии. Вы можете регулировать интервал между событиями OnClick с помощью свойств InitPause и RepeatInterval.

Кроме того, Вы можете задать выпадающее меню (с помощью свойства DropDownMenu), которое будет появляться при нажатии на кнопку.

Остальные свойства и методы компоненты TRxSpeedButton те же, что и у TSpeedButton.


TRxSpeedButton See Also
See also

TButton

TSpeedBar

TSpeedButton


TRxSpeedButton Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TGraphicControl


TRxSpeedButton properties
Properties

Run-time only    [image] Key properties

Alignment	GrayedInactive	Parent
AllowAllUp	GroupIndex	ParentFont
AllowTimer	Height	ParentShowHint
Caption	Hint	RepeatInterval
ComponentCount	InitPause	ShowHint
ComponentIndex	Layout	Showing
Components	Left	Spacing
Cursor	Margin	Tag
Down	MarkDropDown	Top
DropDownMenu	MenuPosition	Transparent
Enabled	ModalResult	Visible
Flat	Name	Width
Font	NumGlyphs	WordWrap
Glyph	Owner


TRxSpeedButton events
Events

Run-time only    [image] Key events

OnClick	OnMouseEnter	OnMouseUp
OnDblClick	OnMouseLeave
OnMouseDown	OnMouseMove


TRxSpeedButton methods
Methods

Key methods

BringToFront	GetTextBuf	ScreenToClient
ButtonClick	GetTextLen	SendToBack
CheckBtnMenuDropDown	Hide	SetBounds
Click	Invalidate	SetTextBuf
ClientToScreen	Perform	Show
Create	Refresh	Update
Destroy	Repaint


TRxSpeedButton.Alignment
Alignment Property

Applies to

TRxSpeedButton component

Declaration

property Alignment: TAlignment;

Description

Alignment specifies how caption text is aligned within the button (TRxSpeedButton).


AllowTimer
AllowTimer Property

Applies to

TSpeedItem, TRxSpeedButton components

Declaration

property AllowTimer: Boolean;

Description

Когда свойство AllowTimer установлено в значение True, кнопка будет генерировать повторяющиеся события OnClick при нажатии на кнопку до тех пор, пока кнопка находится в нажатом состоянии. Вы можете регулировать интервал между событиями OnClick с помощью свойств InitRepeatPause и RepeatPause.


DropDownMenu
DropDownMenu Property

Applies to

TSpeedItem, TRxSpeedButton components

Declaration

property DropDownMenu: TPopupMenu;

Description

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


TRxSpeedButton.Flat
Flat Property

Applies to

TRxSpeedButton component

Declaration

property Flat: Boolean;

Description

При установленном в True значении этого свойства (по умолчанию - False) кнопка будет "всплывающей", то есть ее границы будут отображаться только когда над ней находится указатель мыши. Неактивная кнопка может изменять битовое изображение на ней при установленном в True значении свойства GrayedInactive.


GrayedInactive
GrayedInactive Property

Applies to

TRxSpeedButton component

Declaration

property GrayedInactive: Boolean;

Description

При установленном в True значении свойств GrayedInactive и Flat битовое изображение "неактивной" кнопки (над которой в данный момент не находится указатель мыши) будет изменяться по сравнению с обычным. Вы можете задать это изображение, поместив в свойство Glyph картинку с пятью изображениями (Normal, Disabled, Down, Stay Down, Inactive) - пятое изображение при GrayedInactive = True используется для изображения неактивной кнопки. Если свойство Glyph содержит картинку менее чем с пятью изображениями, а свойство GrayedInactive = True, то соотвествующее "серое" изображение будет создано автоматически.


InitPause
InitPause Property

Applies to

TRxSpeedButton component

Declaration

property InitPause: Word;

Description

Свойство позволяет задать интервал (в миллисекундах) перед первым событием OnClick, вызывающемся при нажатии кнопки, если свойство AllowTimer установлено в значение True.


MarkDropDown
MarkDropDown Property

Applies to

TSpeedItem, TRxSpeedButton components

Declaration

property MarkDropDown: Boolean;

Description

При установленном в True значении свойства MarkDropDown в кнопке, имеющей выпадающее меню (свойство DropDownMenu), будет дополнительно изображаться специальный символ в виде обращенного вниз треугольника.


TRxSpeedButton.MenuPosition
MenuPosition Property

Applies to

TRxSpeedButton component

Declaration

property MenuPosition: TRxDropDownMenuPos;

Description

MenuPosition determines where the drop-down menu is displayed.

The possible values for MenuPosition are:

• dmpBottom (default) - the drop-down menu is below the button and even with the left or right side of the button, depending on menu Alignment property.

• dmpRight - the drop-down menu is at the right or left of the button (depending on menu Alignment property) and even with the top of the button.


TRxSpeedButton.ModalResult
ModalResult Property

Applies to

TRxSpeedButton component

Declaration

property ModalResult: TModalResult;

Description

Determines whether and how the button closes its (modal) parent form.

Setting the TRxSpeedButton component’s ModalResult property is an easy way to make clicking the button close a modal form. When a button is clicked, the ModalResult property of its parent form is set to the same value as the button’s ModalResult property.


RepeatInterval
RepeatInterval Property

Applies to

TRxSpeedButton component

Declaration

property RepeatInterval: Word;

Description

Свойство позволяет задать интервал (в миллисекундах) между повторяющимися вызовами события OnClick, если кнопка нажата и свойство AllowTimer = True.


TRxSpeedButton.Transparent
Transparent Property

Applies to

TRxSpeedButton component

Declaration

property Transparent: Boolean;

Description

Свойство позволяет сделать кнопку прозрачной (по умолчанию - False).


TRxSpeedButton.ButtonClick
ButtonClick Method

Applies to

TRxSpeedButton component

Declaration

procedure ButtonClick;

Description

Метод позволяет эмулировать нажатие на кнопку TRxSpeedButton.


CheckBtnMenuDropDown
CheckBtnMenuDropDown Method

Applies to

TSpeedItem, TRxSpeedButton components

Declaration

function CheckBtnMenuDropDown: Boolean;

Description

Метод предназначен для вызова выпадающего меню, определенного свойством DropDownMenu, компонент TRxSpeedButton и TSpeedItem. Меню вызывается независимо от значения его свойства AutoPopup.


TSecretPanel Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCtrls

Description

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

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

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


TSecretPanel See Also
See also

TBitmap

TPanel

TStrings


TSecretPanel Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TCustomPanel


TSecretPanel properties
Properties

Run-time only    [image] Key properties

Active	Cycled	ParentColor
Align	DragCursor	ParentCtl3D
Alignment	DragMode	ParentFont
AsyncDrawing	Font	ParentShowHint
BevelInner	Glyph	PopupMenu
BevelOuter	GlyphLayout	ScrollDirection
BevelWidth	Height	ShowHint
BorderStyle	HelpContext	Showing
BorderWidth	Hint	TabOrder
Color	Interval	TabStop
ComponentCount	Left	Tag
ComponentIndex	Lines	TextStyle
Components	Name	Top
Ctl3D	Owner	Visible
Cursor	Parent	Width


TSecretPanel events
Events

Run-time only    [image] Key events

OnClick	OnEnter	OnPaintClient
OnDblClick	OnExit	OnResize
OnDragDrop	OnMouseDown	OnStartDrag
OnDragOver	OnMouseMove	OnStartPlay
OnEndDrag	OnMouseUp	OnStopPlay


TSecretPanel methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TSecretPanel.Active
Active Property

Applies to

TSecretPanel component

Declaration

property Active: Boolean;

Description

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

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


TSecretPanel.AsyncDrawing
AsyncDrawing Property

Applies to

TSecretPanel component

Declaration

property AsyncDrawing: Boolean;

Description

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

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

Внимание

Свойство доступно только в версиях Delphi 3.0 и выше или C++Builder 3.0 и выше.


TSecretPanel.Cycled
Cycled Property

Applies to

TSecretPanel component

Declaration

property Cycled: Boolean;

Description

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


GlyphLayout
GlyphLayout Property

Applies to

TSecretPanel component

Declaration

property GlyphLayout: TGlyphLayout;

Description

Свойство задает расположение битового изображения, заданного свойством Glyph и отображаемого при прокрутке скрытого текста компонентой TSecretPanel.


TSecretPanel.Lines
Lines Property

Applies to

TSecretPanel component

Declaration

property Lines: TStrings;

Description

Свойство задает набор текстовых строк, которые не отображаются компонентой TSecretPanel в нормальном ее состоянии, но могут быть "прокручены" (одновременно с отображением битового изображения, заданного свойством Glyph) при установке в True значения свойства Active.


TSecretPanel.ScrollDirection
ScrollDirection Property

Applies to

TSecretPanel component

Declaration

property ScrollDirection: TScrollDirection;

Description

Свойство определяет направление прокрутки срок текста при значении Active=True.

Возможные значения свойства ScrollDirection:

• sdVertical - текст прокручивается снизу вверх.

• sdHorizontal - прокрутка текста осуществляется в направлении справа налево.


TextStyle
TextStyle Property

Applies to

TSecretPanel component

Declaration

property TextStyle: TPanelBevel;

Description

Свойство задает стиль отображения текста при его прокрутке в компоненте TSecretPanel. При значении этого свойства, отличном от bvNone, текст выглядит либо "продавленным" (bvLowered), либо "выпуклым" (bvRaised).


OnPaintClient
OnPaintClient Event

Examples

Applies to

TSecretPanel component

Declaration

property OnPaintClient: TPanelDrawEvent;

Description

Событие возникает при перерисовке панели как в активном состоянии (Active=True) при прокрутке текста, так и в неактивном.

Вы можете использовать это событие для создания всевозможных эффектов при отрисовке панели.

Внимание

Имейте в виду, что при наличии обработчика события OnPaintClient компонента TSecretPanel не отрисовывает область, заданную параметром Rect, следовательно, при написании обработчика этого события вы должны как минимум заполнить указанную область, например вызовом метода FillRect.


OnPaintClient example
Example

procedure TForm1.SecretPanel1PaintClient(Sender: TObject; Canvas: TCanvas;

  Rect: TRect);

begin

  if not (Sender as TSecretPanel).Active then

    Canvas.FillRect(Rect)

  else

    GradientFillRect(Canvas, Rect, clYellow, clWhite, fdBottomToTop, 64);

end;


OnStartPlay
OnStartPlay Event

Applies to

TSecretPanel component

Declaration

property OnStartPlay: TNotifyEvent;

Description

Событие происходит перед началом прокрутки скрытого текста компонентой TSecretPanel при установке значения свойства Active в True.


OnStopPlay
OnStopPlay Event

Applies to

TSecretPanel component

Declaration

property OnStopPlay: TNotifyEvent;

Description

Событие происходит по окончании прокрутки скрытого текста компонентой TSecretPanel при установке значения свойства Active в False.


TTextListBox Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxCtrls

Description

Компонента TTextListBox предназначена для организации списков текстовых строк на основе стандартного элемента управления Windows (ListBox), и позволяет пользователю осуществить выбор одного или более элементов из этого списка.

В отличие от компоненты TListBox, TTextListBox предназначен только для текстовых строк, но он автоматически устанавливает горизонтальную полосу прокрутки при изменении содержимого свойства Items.


TTextListBox See Also
See also

TListBox


TTextListBox Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomListBox


TTextListBox properties
Properties

Run-time only    [image] Key properties

Align	HelpContext	ParentShowHint
BorderStyle	Hint	PopupMenu
Color	IntegralHeight	ShowHint
ComponentCount	ItemHeight	Showing
ComponentIndex	ItemIndex	Sorted
Components	Items	TabOrder
Ctl3D	Left	TabStop
Cursor	MultiSelect	TabWidth
DragCursor	Name	Tag
DragMode	Owner	Top
Enabled	Parent	Visible
ExtendedSelect	ParentColor	Width
Font	ParentCtl3D
Height	ParentFont


TTextListBox events
Events

Run-time only    [image] Key events

OnClick	OnEnter	OnMouseDown
OnDblClick	OnExit	OnMouseMove
OnDragDrop	OnKeyDown	OnMouseUp
OnDragOver	OnKeyPress	OnStartDrag
OnEndDrag	OnKeyUp


TTextListBox methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TChangeStateEvent Type

Unit

RxCtrls

Declaration

type

TChangeStateEvent = procedure (Sender: TObject; Index: Integer) of object;

Description

Тип определяет обработчик события OnChangeState компоненты TRxCheckListBox.


TCheckKind Type

Unit

RxCtrls

Declaration

type

TCheckKind = (ckCheckBoxes, ckRadioButtons);

Description

Тип описывает возможные значения свойства CheckKind компоненты TRxCheckListBox.


TGetItemWidthEvent Type

Unit

RxCtrls

Declaration

type

TGetItemWidthEvent = procedure(Control: TWinControl; Index: Integer; var Width: Integer) of object;

Description

Тип определяет обработчик события OnGetItemWidth компоненты TRxCheckListBox.


TGlyphLayout Type

Unit

RxCtrls

Declaration

type

TGlyphLayout = (glGlyphLeft, glGlyphRight, glGlyphTop, glGlyphBottom);

Description

Тип TGlyphLayout задает возможные значения свойства GlyphLayout компоненты TSecretPanel.


TPanelDrawEvent Type

Unit

RxCtrls

Declaration

type

TPanelDrawEvent = procedure(Sender: TObject; Canvas: TCanvas; Rect: TRect) of object;

Description

Тип определяет метод - обработчик события OnPaintClient компоненты TSecretPanel.


TRxButtonState Type

Unit

RxCtrls

Declaration

type

TRxButtonState = (rbsUp, rbsDisabled, rbsDown, rbsExclusive, rbsInactive);

Description

Тип определяет возможные состояния кнопки для компоненты TRxSpeedButton.


TRxDropDownMenuPos Type

Unit

RxCtrls

Declaration

type

TRxDropDownMenuPos = (dmpBottom, dmpRight);

Description

Тип описывает допустимые значения свойства MenuPosition компоненты TRxSpeedButton.


TRxNumGlyphs Type

Unit

RxCtrls

Declaration

type

TRxNumGlyphs = 1..5;

Description

Тип задает диапазон возможных значений свойства NumGlyphs компоненты TRxSpeedButton.


TScrollDirection Type

Unit

RxCtrls

Declaration

type

TScrollDirection = (sdVertical, sdHorizontal);

Description

Тип определяет возможные значения свойства ScrollDirection компоненты TSecretPanel.


TShadowPosition Type

Unit

RxCtrls

Declaration

type

TShadowPosition = (spLeftTop, spLeftBottom, spRightBottom, spRightTop);

Description

Тип TShadowPosition задает возможные допустимые значения для свойства ShadowPos компоненты TrxLabel, задающего положение "тени" статического элемента управления.


TTextLayout Type

Unit

RxCtrls

Declaration

type

TTextLayout = (tlTop, tlCenter, tlBottom);

Description

Тип определяет возможные значения для свойства Layout компоненты TRxLabel.


RxDBComb Unit

The RxDBComb 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.

The following items are declared in the RxDBComb unit:

Components and objects

TRxDBComboBox

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


TRxDBComboBox Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxDBComb

Description

Компонента TRxDBComboBox почти полностью аналогична стандартной компоненте из VCL TDBComboBox и имеет те же самые свойства, методы и события. Однако по сравнению с TDComboBox у этой компоненты есть некоторые дополнительные возможности и свойства.

TRxDBComboBox позволяет использовать в качестве значений для поля FieldName значения из дополнительного списка Values. Для того, чтобы это работало, необходимо установить свойство EnabledValues в True. В противном случае функциональность этой компоненты ничем не будет отличаться от TDBComboBox.


TRxDBComboBox See Also
See also

TComboBox

TDBComboBox


TRxDBComboBox Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomComboBox

  |

TCustomDBComboBox


TRxDBComboBox properties
Properties

Run-time only    [image] Key properties

Canvas	Font	ReadOnly
Color	Height	ShowHint
ComponentCount	HelpContext	Showing
ComponentIndex	Hint	Sorted
Components	ItemHeight	Style
Ctl3D	Items	TabOrder
Cursor	Left	TabStop
DataField	Name	Tag
DataSource	Owner	Text
DragCursor	Parent	Top
DragMode	ParentColor	Values
DropDownCount	ParentCtl3D	Visible
Enabled	ParentFont	Width
EnableValues	ParentShowHint
Field	PopupMenu


TRxDBComboBox events
Events

Run-time only    [image] Key events

OnChange	OnDrawItem	OnKeyDown
OnClick	OnDropDown	OnKeyPress
OnDblClick	OnEndDrag	OnKeyUp
OnDragDrop	OnEnter	OnMeasureItem
OnDragOver	OnExit	OnStartDrag


TRxDBComboBox methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TRxDBComboBox.EnableValues
EnableValues Property

Applies to

TRxDBComboBox component

Declaration

property EnableValues: Boolean;

Description

Если значение EnabledValues установлено в True, то значения для текущего FieldName будут устанавливаться из списка Values. В противном случае значения, как и в стандартном TDBComboBox, будут браться из Items.


Values
Values Property

Applies to

TRxDBComboBox component

Declaration

property Values: TStrings;

Description

Список значений, используемых компонентой TRxDBComboBox при установленном в True значении свойства EnableValues.


RxDBCtrl Unit

The RxDBCtrl 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.

The following items are declared in the RxDBCtrl unit:

Components and objects

TDBDateEdit

TDBStatusLabel

TRxDBCalcEdit

TRxDBComboEdit

TRxDBGrid

Types

TBookmarkList

TCheckTitleBtnEvent

TDBLabelOptions

TDBLabelStyle

TGetBtnParamsEvent

TGetCellParamsEvent

TGetCellPropsEvent

TGetStringEvent

TGlyphAlign

TSortMarker

TTitleClickEvent

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


TDBDateEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxDBCtrl

Description

Компонента TDBDateEdit - ориентированная на работу с базами данных компонента для редактирования даты. Установленное значение свойства Date становится новым значением поля в БД, если значение свойства ReadOnly компоненты TDBDateEdit - False.

TDBDateEdit является наследником TDateEdit и имеет все те же свойства и методы, и дополнительно имеет свойства, необходимые для работы с полями базы данных.

Компонента TDBDateEdit может быть применена к тем полям наборов данных, которые позволяют чтение и присвоение значений через свойство AsDateTime.


TDBDateEdit See Also
See also

TDateEdit

TDBEdit

TMaskEdit


TDBDateEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit

  |

TCustomDateEdit


TDBDateEdit properties
Properties

Run-time only    [image] Key properties

AutoSelect	DirectInput	ParentShowHint
BlanksChar	DragCursor	PopupAlign
BorderStyle	DragMode	PopupColor
ButtonHint	Enabled	PopupMenu
ButtonWidth	Field	PopupVisible
CalendarHints	Font	ReadOnly
CalendarStyle	Glyph	ShowHint
CheckOnExit	GlyphKind	Showing
ClickKey	Height	StartOfWeek
Color	HelpContext	TabOrder
ComponentCount	Hint	TabStop
ComponentIndex	Left	Tag
Components	MaxLength	Text
Ctl3D	Name	Top
Cursor	NumGlyphs	Visible
DataField	Owner	WeekendColor
DataSource	Parent	Weekends
Date	ParentColor	Width
DefaultToday	ParentCtl3D
DialogTitle	ParentFont


TDBDateEdit events
Events

Run-time only    [image] Key events

OnChange	OnEndDrag	OnKeyUp
OnClick	OnEnter	OnMouseDown
OnDblClick	OnExit	OnMouseMove
OnDragDrop	OnKeyDown	OnMouseUp
OnDragOver	OnKeyPress	OnStartDrag


TDBDateEdit methods
Methods

Key methods

BeginDrag	FindComponent	RemoveComponent
BringToFront	GetDateMask	Repaint
CheckValidDate	GetTextBuf	ScreenToClient
ClientToScreen	GetTextLen	SelectAll
CopyToClipboard	Hide	SendToBack
Create	InsertComponent	SetBounds
CutToClipboard	Invalidate	SetFocus
Destroy	PasteFromClipboard	SetTextBuf
Dragging	Perform	Show
EndDrag	Refresh	Update


BlanksChar
BlanksChar Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property BlanksChar: Char;

Description

Свойство задает символ, используемый в маске даты для заполнения пустых знакомест. По умолчанию - пробел (#32).


CalendarHints
CalendarHints Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property CalendarHints: TStrings;

Description

CalendarHints provides a way to customize the Help Hints for the buttons on popup-calendar or calendar dialog.

Each button on calendar (prev year, prev month, next month, next year) has a default Help Hint. CalendarHints allow the values of any or all of these default Help Hints to be replaced by customized hints.

CalendarHints is a string list. Each hint is a string. The first string in the string list becomes the Help Hint for the first button on the calendar (the "Prev Year" button). The 4-th hint becomes the Help Hint for the last 4-th button (the "Next Year" button).

When specifying CalendarHints at runtime, enter an empty string ('') for any Help Hint that should keep the default value. Simply leave the line blank when using the string list property editor of the Object Inspector for the CalendarHints property.


CalendarStyle
CalendarStyle Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property CalendarStyle: TCalendarStyle;

Description

Свойство задает тип используемого компонентой календаря. Значение csPopup задает выпадающий календарь, наподобие выпадающего списка у TComboBox, при этом размер выпадающего календаря Вы можете регулировать константой PopupCalendarSize из модуля PickDate; значение csDialog задает использование модального диалога для выбора даты.

Значение по умолчанию для данного свойства зависит от DEFINE в RX.INC.


CheckOnExit
CheckOnExit Property

Applies to

TRxDBCalcEdit, TRxCalcEdit, TDBDateEdit, TDateEdit, TCurrencyEdit components

Declaration

property CheckOnExit: Boolean;

Description

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

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


Date
Date Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property Date: TDateTime;

Description

Свойство Date доступно во время выполнения программы и позволяет задать либо прочитать значение даты в компоненте TDateEdit в формате TDateTime.


DefaultToday
DefaultToday Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property DefaultToday: Boolean;

Description

Если свойство DefaultToday = True, то при ошибках ввода значения даты, либо при пустой строке редактирования, свойство Date будет возвращать значение текущей даты.


DialogTitle
DialogTitle Property

Applies to

TFilenameEdit, TDBDateEdit, TDateEdit components

Declaration

property DialogTitle: string;

Description

Свойство DialogTitle задает заголовок диалогового окна, появляющегося при нажатии на кнопку компоненты TFilenameEdit (TOpenDialog) или TDateEdit, TDBDateEdit (диалог выбора даты).


PopupColor
PopupColor Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property PopupColor: TColor;

Description

Свойство задает цвет фона выпадающего календаря, если свойство CalendarStyle установлено в значение csPopup.


PopupVisible
PopupVisible Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property PopupVisible: Boolean;

Description

Свойство (read-only and runtime-only) имеет значение True, если в настоящее время "развернут" выпадающий календарик (используемый при значении свойства CalendarStyle = csPopup), False - в противном случае.


StartOfWeek
StartOfWeek Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property StartOfWeek: TDayOfWeekName;

Description

StartOfWeek determines the day of the week that begins a week. This property determines which day of the week is drawn in the left column of the pop-up calendar.


WeekendColor
WeekendColor Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property WeekendColor: TColor;

Description

WeekendColor determines the colors used for the pop-up calendar. It is the color set for the "free" days (weekends) in the month.


Weekends
Weekends Property

Applies to

TDBDateEdit, TDateEdit components

Declaration

property Weekends: TDaysOfWeek;

Description

Свойство задает "выходные" дни недели, которые отображаются в выпадающем календаре цветом WeekendColor. Значение по умолчанию - [Sun].


TDBStatusLabel Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxDBCtrl

Description

Компонента TDBStatusLabel представляет собой статический элемент управления, позволяющий отображать в текстовом виде текущее состояние связанного с ним через свойство DataSource набора данных. В зависимости от текущего состояния набора данных (просмотр, редактирование, поиск и т.д.) текст компоненты TDBStatusLabel изменяется, в соответствии с форматом:

  <Имя_набора_данных>: <состояние_набора_данных>.

Если свойство Style установлено в значение lsRecordNo, то компонента отображает текущую позицию в наборе данных в формате:

  <номер_текущей_записи>:<полное_число_записей>.

Информация о номере записи может быть отображена только для драйверов DBase и Paradox и таблиц в памяти (TMemoryTable). В версии для Delphi 3 и выше отображение номера записи определяется возвращаемым значением метода IsSequenced соответствующего набора данных.

Если свойство Style установлено в значение lsRecordSize, то компонента отображает размер записи в наборе данных.

Если свойство SQLCount установлено в False (по умолчанию), то подсчет числа записей тоже не ведется для SQL-данных, а только для данных dBase и Paradox.

Имя набора данных задается свойством DataSetName, и может быть изменено обработчиком события OnGetDataName. Строки, задающие состояние набора данных, как и все остальные константы библиотеки RX Library, хранятся в ресурсе типа STRINGTABLE.


TDBStatusLabel See Also
See also

TDataSetState

TDataSource

TLabel

TQBEQuery

TQuery

TTable


TDBStatusLabel Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TGraphicControl

  |

TRxCustomLabel


TDBStatusLabel properties
Properties

Run-time only    [image] Key properties

Align	GlyphAlign	ShadowSize
Alignment	Height	ShowHint
AutoSize	HelpContext	Showing
Captions	Hint	ShowOptions
Color	Layout	SQLCount
ComponentCount	Left	Style
ComponentIndex	Name	TabOrder
Components	Owner	TabStop
Cursor	Parent	Tag
DataSetName	ParentColor	Top
DataSource	ParentFont	Transparent
DragCursor	ParentShowHint	Visible
DragMode	PopupMenu	Width
EditColor	ShadowColor	WordWrap
Font	ShadowPos


TDBStatusLabel events
Events

Run-time only    [image] Key events

OnClick	OnEndDrag	OnMouseUp
OnDblClick	OnGetDataName	OnStartDrag
OnDragDrop	OnMouseDown
OnDragOver	OnMouseMove


TDBStatusLabel methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TDBStatusLabel.Captions
Captions Property

Applies to

TDBStatusLabel component

Declaration

property Captions: TStrings;

Description

Свойство позволяет изменить заданные по умолчанию текстовые строки, описывающие состояние набора данных и отображаемые как свойство Caption компоненты TDBStatusLabel. Captions представляет собой список строк, следующих в таком порядке (по состоянию набора данных):

dsInactive

dsBrowse

dsEdit

dsInsert

dsSetKey

dsCalcFields. Если Вы не хотите изменять какую либо из строк, просто оставьте ее пустой в списке Captions.


DataSetName
DataSetName Property

Applies to

TDBStatusLabel component

Declaration

property DataSetName: string;

Description

Свойство задает имя для набора данных, используемое при отображении состояния этого набора данных компонентой TDBStatusLabel. Если в режиме дизайна формы вы зададите значение этого свойства равным пустой строке, то при выполнении приложения (run time) значением этого свойства будет DataSource.DataSet.Name.


EditColor
EditColor Property

Applies to

TDBStatusLabel component

Declaration

property EditColor: TColor;

Description

Свойство задает цвет шрифта, которым отображается текст компоненты TDBStatusLabel при состоянии связанного набора данных dsEdit или dsInsert, если свойство Style = lsState.


GlyphAlign
GlyphAlign Property

Applies to

TDBStatusLabel component

Declaration

property GlyphAlign: TGlyphAlign;

Description

Свойство задает положение графического изображения, которое рисуется в компоненте TDBStatusLabel при значении свойства ShowOptions = doBoth. Рисунок может быть изображен слева (по умолчанию) или справа от текста.


TDBStatusLabel.Layout
Layout Property

Applies to

TDBStatusLabel component

Declaration

property Layout: TTextLayout;

Description

Свойство определяет вертикальное расположение текста внутри компоненты TDBStatusLabel при значении AutoSize = False.

Возможные значения:

- tlTop: выравнивание текста по верхнему краю компоненты.

- tlCenter: расположение текста по центру компоненты по вертикали.

- tlBottom: выравнивание текста по нижнему краю компоненты.


TDBStatusLabel.ShowOptions
ShowOptions Property

Applies to

TDBStatusLabel component

Declaration

property ShowOptions: TDBLabelOptions;

Description

Свойство позволяет указать, будет ли компонента TDBStatusLabel отображать только текст, только битовое символическое изображение, или и то, и другое. При значении свойства doBoth вы можете задать взаимное распольжение текста и рисунка с помощью свойства GlyphAlign.


SQLCount
SQLCount Property

Applies to

TDBStatusLabel component

Declaration

property SQLCount: Boolean;

Description

Свойство определяет, будет ли осуществляться подсчет полного числа записей при значении свойства Style = lsRecordNo, если набор данных относится к SQL-базе данных. По умолчанию свойство равно False. При больших размерах выборки из SQL-таблиц подсчет числа записей может занять значительное время.


TDBStatusLabel.Style
Style Property

Applies to

TDBStatusLabel component

Declaration

property Style: TDBLabelStyle;

Description

Свойство задает тип отображаемого компонентой текста. Если значение этого свойства равно lsState (по умолчанию), компонента отображает состояние набора данных (вставка, редактирование и т.д.). При значении lsRecordNo компонента может отображать для таблиц DBase и Paradox (или результатов запросов на таблицах DBase и Paradox) текущую позицию в наборе данных (номер текущей записи и полное число записей). Если значение свойства равно lsRecordSize, то компонента отображает размер одной записи набора данных в байтах.


OnGetDataName
OnGetDataName Event

Applies to

TDBStatusLabel component

Declaration

property OnGetDataName: TGetStringEvent;

Description

Событие происходит, когда необходимо изменить текст компоненты TDBStatusLabel при изменении состояния связанного с ней набора данных. Если обработчик этого события определен, то возвращаемое им значение используется вместо значение свойства DataSetName.


TRxDBCalcEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxDBCtrl

Description

Компонента TRxDBCalcEdit - ориентированная на работу с базами данных компонента для редактирования чисел с возможностью импользования выпадающего калькулятора. Установленное значение свойства Value становится новым значением поля в БД, если значение свойства ReadOnly - False.

TRxDBCalcEdit является наследником TDBCalcEdit и имеет все те же свойства и методы, и дополнительно имеет свойства, необходимые для работы с полями базы данных.

Компонента TRxDBCalcEdit может быть применена к тем полям данных, которые позволяют чтение и присвоение значений через свойства AsFloat, AsInteger.


TRxDBCalcEdit See Also
See also

TComboEdit

TDBDateEdit

TDBEdit

TRxCalcEdit

TRxDBComboEdit


TRxDBCalcEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit

  |

TCustomNumEdit

  |

TRxCustomCalcEdit


TRxDBCalcEdit properties
Properties

Run-time only    [image] Key properties

Alignment	DisplayText	Parent
AsInteger	DragCursor	ParentColor
AutoSelect	DragMode	ParentCtl3D
BeepOnError	Enabled	ParentFont
BorderStyle	Field	ParentShowHint
ButtonHint	Font	PopupAlign
ButtonWidth	FormatOnEditing	PopupMenu
CheckOnExit	Glyph	ReadOnly
ClickKey	GlyphKind	ShowHint
Color	Height	Showing
ComponentCount	HelpContext	TabOrder
ComponentIndex	HideSelection	TabStop
Components	Hint	Tag
Ctl3D	Left	Text
Cursor	MaxLength	Top
DataField	MaxValue	Value
DataSource	MinValue	Visible
DecimalPlaces	Name	Width
DirectInput	NumGlyphs	ZeroEmpty
DisplayFormat	Owner


TRxDBCalcEdit events
Events

Run-time only    [image] Key events

OnButtonClick	OnEndDrag	OnMouseDown
OnChange	OnEnter	OnMouseMove
OnClick	OnExit	OnMouseUp
OnDblClick	OnKeyDown	OnStartDrag
OnDragDrop	OnKeyPress
OnDragOver	OnKeyUp


TRxDBCalcEdit methods
Methods

Key methods

BeginDrag	GetTextBuf	SelectAll
BringToFront	GetTextLen	SendToBack
Clear	Hide	SetBounds
ClientToScreen	Invalidate	SetFocus
CopyToClipboard	PasteFromClipboard	SetTextBuf
CutToClipboard	Perform	Show
DoClick	Refresh	Update
Dragging	Repaint
EndDrag	ScreenToClient


TRxDBCalcEdit.Value
Value Property

Applies to

TRxDBCalcEdit component

Declaration

property Value: Extended;

Description

Свойство позволяет установить или получить численную величину значения, отображаемого в строке ввода. В случае пустой строки возвращается значение 0.


TRxDBComboEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxDBCtrl

Description

Data-aware version of TComboEdit control. Provides standard DataField and DataSource properties for connecting to a column in a database table.


TRxDBComboEdit See Also
See also

TComboEdit

TDBEdit


TRxDBComboEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit


TRxDBComboEdit properties
Properties

Run-time only    [image] Key properties

AutoSelect	DragMode	ParentColor
BorderStyle	EditText	ParentCtl3D
Button	Enabled	ParentFont
ButtonHint	Field	ParentShowHint
ButtonWidth	Font	PopupMenu
CharCase	Glyph	ReadOnly
ClickKey	GlyphKind	ShowHint
Color	Height	Showing
ComponentCount	HelpContext	TabOrder
ComponentIndex	HideSelection	TabStop
Components	Hint	Tag
Ctl3D	Left	Text
Cursor	MaxLength	Top
DataField	Name	Visible
DataSource	NumGlyphs	Width
DirectInput	Owner
DragCursor	Parent


TRxDBComboEdit events
Events

Run-time only    [image] Key events

OnButtonClick	OnEndDrag	OnMouseDown
OnChange	OnEnter	OnMouseMove
OnClick	OnExit	OnMouseUp
OnDblClick	OnKeyDown	OnStartDrag
OnDragDrop	OnKeyPress
OnDragOver	OnKeyUp


TRxDBComboEdit methods
Methods

Key methods

BeginDrag	Dragging	Repaint
BringToFront	EndDrag	ScreenToClient
Clear	GetTextBuf	SelectAll
ClientToScreen	GetTextLen	SendToBack
CopyToClipboard	Hide	SetBounds
Create	Invalidate	SetFocus
CutToClipboard	PasteFromClipboard	SetTextBuf
Destroy	Perform	Show
DoClick	Refresh	Update


ClickKey
ClickKey Property

Applies to

TRxLookupEdit, TRxDBComboEdit, TRxDBCalcEdit, TRxCalcEdit, TFilenameEdit, TDirectoryEdit, TDBDateEdit, TDateEdit, TComboEdit components

Declaration

property ClickKey: TShortCut;

Description

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


DirectInput
DirectInput Property

Applies to

TRxLookupEdit, TRxDBComboEdit, TRxDBCalcEdit, TRxCalcEdit, TFilenameEdit, TDirectoryEdit, TDBDateEdit, TDateEdit, TComboEdit components

Declaration

property DirectInput: Boolean;

Description

Свойство управляет тем, будет ли разрешен прямой ввод данных в строку редактирования компоненты TComboEdit (или унаследованных от нее компонент). Если свойство DirectInput = False, то прямой ввод данных в строку запрещен, и пользователь должен использовать кнопку для вызова диалога (или других определенных разработчиком действий) для внесения изменений в данные компоненты.


TRxDBGrid Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

RxDBCtrl

Description

Компонента TRxDBGrid предназначена, как и стандартная компонента TDBGrid, для отображения данных таблиц БД или результатов запросов в табличной форме. Являясь наследником TDBGrid, компонента TRxDBGrid имеет все те же свойства и методы, и, кроме того, некоторые свойства, находящиеся у TDBGrid в секции protected, вынесены в секцию public. Это такие свойства, как Col, Row, LeftCol, Canvas.

Другие отличия от TDBGrid:

- BLOB-поля базы данных, такие как графические изображения, текстовые мемо-поля, другие BLOB'ы могут отображаться в таблице в виде пиктограмм при установленном в True значении свойства ShowGlyphs;

- вы можете изменить цвет шрифта и фона любой ячейки таблицы (либо любой ее строки или столбца) в зависимости от значения поля или имени поля набора данных, определив обработчик события OnGetCellParams;

- имеются методы SaveLayout и RestoreLayout для сохранения и восстановления порядка и ширин столбцов компоненты TRxDBGrid в INI-файле (или в Registry для Delphi 2.0). Вы можете также автоматически сохранять и восстанавливать эти параметры, присвоив значение свойству IniStorage.

- как в 32-битной, так и в 16-битной версии компонента поддерживает выбор нескольких записей в таблице при значении свойства MultiSelect = True.

- заголовки колонок Grid-а могут быть с помощью свойства TitleButtons использованы как кнопки, например, для изменения порядка сортировки отображаемых данных.

- вы можете зафиксировать несколько первых колонок в Grid-е с помощью свойства FixedCols.


Using the TRxDBGrid Component

See also             TRxDBGrid Reference

Purpose

Вы можете использовать компоненту TRxDBGrid во всех случаях, когда вам нужно отображать данные из БД в табличном виде, вместо стандартной компоненты TDBGrid. Использование компоненты TRxDBGrid позволит вам изменять цвет и характеристики шрифта для любой ячейки таблицы в зависимости от отображаемых данных.

Tasks

Например, вы хотите отобразить таблицу заказчиков (в каталоге \DELPHI\DEMOS\DATA есть таблица CUSTOMER.DB) таким образом, чтобы выделить название компании-заказчика жирным шрифтом, колонку с именами сотрудников, отвечающих за контакт, выделить желтым цветом фона, строки содержащие данные о заказчиках, не имевших с вами дела более 5 лет - светло-зеленым цветом фона, а тех, с кем у вас были контакты в этом году, наоборот, шрифтом красного цвета. Никаких проблем! Используйте обработку события OnGetCellParams:

 procedure TForm1.rxDBGrid1GetCellParams(Sender: TObject; Field: TField;

   AFont: TFont; var Background: TColor; Highlight: Boolean);

 var

   OldDate, NewDate: TDateTime;

   DataSet: TDataSet;

 begin

   if Field.FieldName = 'Company' then

     AFont.Style := AFont.Style + [fsBold]

   else if Field.FieldName = 'Contact' then

     if not Highlight then Background := clYellow;

   if not Highlight then begin

     OldDate := EncodeDate(1990, 1, 1);

     NewDate := EncodeDate(1995, 1, 1);

     DataSet := (Sender as TrxDBGrid).DataSource.DataSet;

     if DataSet.FieldByName('LastInvoiceDate').AsDateTime < OldDate then

       Background := clLime  { oldest }

     else if DataSet.FieldByName('LastInvoiceDate').AsDateTime >= NewDate then

       AFont.Color := clRed;  { newest }

   end;

 end;


TRxDBGrid See Also
See also

Common Component Tasks


TRxDBGrid See Also
See also

TDataSet

TDataSource

TDBGrid

TQBEQuery

TQuery

TTable


TRxDBGrid Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TCustomGrid

  |

TCustomDBGrid

  |

TDBGrid


TRxDBGrid properties
Properties

Run-time only    [image] Key properties

Align	FixedColor	PopupMenu
BorderStyle	FixedCols	ReadOnly
Canvas	Font	Row
ClearSelection	Height	SelectedField
Col	HelpContext	SelectedIndex
Color	Hint	SelectedRows
Columns	IniStorage	ShowGlyphs
ComponentCount	InplaceEditor	ShowHint
ComponentIndex	Left	Showing
Components	LeftCol	TabOrder
Ctl3D	MultiSelect	TabStop
Cursor	Name	Tag
DataSource	Options	TitleButtons
DefaultDrawing	Owner	TitleFont
DragCursor	Parent	Top
DragMode	ParentColor	Visible
Enabled	ParentCtl3D	Width
FieldCount	ParentFont
Fields	ParentShowHint


TRxDBGrid events
Events

Run-time only    [image] Key events

OnCheckButton	OnEditButtonClick	OnKeyPress
OnColEnter	OnEditChange	OnKeyUp
OnColExit	OnEndDrag	OnMouseDown
OnColumnMoved	OnEnter	OnMouseMove
OnDblClick	OnExit	OnMouseUp
OnDragDrop	OnGetBtnParams	OnStartDrag
OnDragOver	OnGetCellParams	OnTitleBtnClick
OnDrawColumnCell	OnGetCellProps
OnDrawDataCell	OnKeyDown


TRxDBGrid methods
Methods

Key methods

BeginDrag	InsertComponent	SaveLayoutReg
BringToFront	Invalidate	ScreenToClient
ClientToScreen	MouseToCell	SelectAll
Create	Perform	SendToBack
Destroy	Refresh	SetBounds
Dragging	RemoveComponent	SetFocus
EndDrag	Repaint	Show
FindComponent	RestoreLayout	ToggleRowSelection
GotoSelection	RestoreLayoutReg	UnselectAll
Hide	SaveLayout	Update


ClearSelection
ClearSelection Property

Applies to

TRxDBGrid component

Declaration

property ClearSelection: Boolean;

Description

При значении этого свойства True (по умолчанию) и значении свойства MultiSelect = True, при любых перемещениях по строкам таблицы при помощи клавиатуры происходит снятие выделения с отмеченных строк. Это поведение совпадает с поведением стандартной компоненты TDBGrid в 32-разрядной версии Delphi при наличии флажка dgMultiSelect в свойстве Options.

Если Вы хотите сохранять выделение записей при перемещении по таблице с помощью клавиатуры, установите это свойство в значение False.


TRxDBGrid.FixedCols
FixedCols Property

Applies to

TRxDBGrid component

Declaration

property FixedCols: Integer;

Description

The FixedCols property can be used to specify a number of fixed columns in the grid. The number of fixed columns must always be less than the total number of columns or fields in the grid. Fixed columns are always read-only when adding or editing records. This allows program or database generated fields such as record keys to be locked from user update. Values can be added to these fields by the DBMS when posting a record; in the AfterInsert event, in the OnNewRecord or in the BeforePost event of the linked dataset.

The value can be set from 0 to one less than the total number of columns (or fields in the dataset).

Associated with the FixedCols property is a FixedColor property which allows you to change the color of the fixed columns.


InplaceEditor
InplaceEditor Property

Applies to

TRxDrawGrid, TRxDBGrid components

Declaration

property InplaceEditor: TInplaceEditor;

Description

Runtime only. InplaceEditor is the default editor used by the grid to edit a cell’s value. You may wish to reference this property if you need to access the currently edited value or dynamically manipulate the editor. For instance, if you wish to change the color of the editor when it has an invalid value.


TRxDBGrid.MultiSelect
MultiSelect Property

Applies to

TRxDBGrid component

Declaration

property MultiSelect: Boolean;

Description

When True, the user can select multiple, non-contiguous rows using Ctrl+click or Shift+arrow keys. The behavior is similar to a multi-select list box.

The records you select are represented as bookmarks and are stored in the SelectedRows property. The SelectedRows property is an object of type TBookmarkList.


SelectedRows
SelectedRows Property

Applies to

TRxDBGrid component

Declaration

property SelectedRows: TBookmarkList;

Description

Свойство предназначено для доступа к отмеченным записям из набора данных, отображаемого компонентой TRxDBGrid, при установленном в True значении свойства MultiSelect.

Это свойство имеет тип TBookmarkList - список "закладок" (bookmarks) на каждую выделенную запись. Имейте в виду, что в 16-разрядной версии значения свойства Items типа TBookmarkList имеют тип TBookmark, а в 32-разрядной - TBookmarkStr. Поэтому для доступа к отдельным выделенным записям Вы должны спозиционироваться на них, используя значения свойства SelectedRows, методом GotoBookmark или процедурой SetToBookmark в 16 разрядной версии Delphi, и установкой значения свойства Bookmark в 32-разрядной версии.

Для совместимости 16-ти и 32-разрядной версий компонента TRxDBGrid имеет метод GotoSelection, параметром которого является индекс элемента в списке SelectedRows.


ShowGlyphs
ShowGlyphs Property

Applies to

TRxDBGrid component

Declaration

property ShowGlyphs: Boolean;

Description

BLOB-поля базы данных, такие как графические изображения, текстовые мемо-поля, другие BLOB'ы могут отображаться в таблице в виде пиктограмм при установленном в True значении свойства ShowGlyphs.

Если Вы задали для поля обработчики событий OnGetText и OnSetText одновременно, то картинки для него отображаться не будут, несмотря на значение свойства ShowGlyphs.


TitleButtons
TitleButtons Property

Applies to

TRxDBGrid component

Declaration

property TitleButtons: Boolean;

Description

Свойство определяет, могут ли заголовки колонок в Grid-е быть использованы как кнопки. По умолчанию - False.

При установке свойства в значение True Вы можете обработать события OnTitleBtnClick для обработки нажатия на такую кнопку и OnCheckButton, OnGetBtnParams для установки свойств кнопок в заголовке.


TRxDBGrid.OnCheckButton
OnCheckButton Event

Applies to

TRxDBGrid component

Declaration

property OnCheckButton: TCheckTitleBtnEvent;

Description

Событие позволяет запретить или разрешить использование заголовков отдельных колонок как кнопок при установленном в True значении свойства TitleButtons.

В обработчик события передаются в качестве параметров номер колонки ACol и поле Field, соответствующее данной колонке. Вы можете запретить нажатие на кнопку, утановив параметр Enabled в значение False. Это может понадобиться, например, если нажатие на кнопку в заголовке меняет порядок сортировки компоненты TTable, и Вы хотите разрешить сортировку только по индексированным полям.


OnGetBtnParams
OnGetBtnParams Event

Applies to

TRxDBGrid component

Declaration

property OnGetBtnParams: TGetBtnParamsEvent;

Description

Событие происходит при перерисовке кнопки в заголовке колонки компоненты TRxDBGrid при установленном в True значении свойства TitleButtons. В обработчике события Вы можете изменить шрифт, которым отображается текст, фоновый цвет заголовка колонки или установить индикатор сортировки (параметр SortMarker).


OnGetCellParams
OnGetCellParams Event

Applies to

TRxDBGrid component

Declaration

property OnGetCellParams: TGetCellParamsEvent;

Description

Событие происходит при перерисовке ячейки компоненты TrxDBGrid. В обработчике события вы можете проверить имя и значение поля БД, передаваемого в качестве параметра Field, а также значения любых других полей из текущей записи набора данных (dataset), к которым Вы можете обратиться, например, так:

  N := (Sender as TrxDBGrid).DataSource.DataSet.FieldByName('CustNo').AsInteger;

В результате вы можете изменить, в зависимости от значений в текущей записи либо от имен полей, характеристики шрифта, используемого для отрисовки ячейки (или строки либо столбца), использовав параметр AFont; либо цвет фона ячейки, используя параметр Background. Параметр Highlight определяет, является ли отрисовываемая ячейка выделенной ("подсвеченной").


OnGetCellProps
OnGetCellProps Event

Applies to

TRxDBGrid component

Declaration

property OnGetCellProps: TGetCellPropsEvent;

Description

Событие происходит при перерисовке ячейки компоненты TRxDBGrid.

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


OnTitleBtnClick
OnTitleBtnClick Event

Applies to

TRxDBGrid component

Declaration

property OnTitleBtnClick: TTitleClickEvent;

Description

Событие происходит при нажатии пользователем на кнопку в заголовке колонки компоненты TRxDBGrid при установленном в True значении свойства TitleButtons. В обработчик события в качестве параметров передаются номер колонки ACol и поле Field, соответствующее данной колонке.


GotoSelection
GotoSelection Method

Applies to

TRxDBGrid component

Declaration

procedure GotoSelection(Index: Integer);

Description

Метод предназначен для установки набора данных, отображаемого в компоненте TRxDBGrid, на строку, заданную индексом Index в списке выделенных строк SelectedRows, при значении свойства MultiSelect = True.

Использование этого метода позволяет избежать изменений при переносе приложений из Delphi 1.0 в 32-разрядную версию Delphi, связанных с разными типами элементов списка SelectedRows в этих версиях.


RestoreLayout
RestoreLayout Method

Applies to

TSpeedbar, TRxDBGrid components

Declaration

procedure RestoreLayout(IniFile: TIniFile);

Description

Метод служит для восстановления из INI-файла установок компонентов TRxDBGrid (таких как порядок и ширины столбцов) и TSpeedbar (набор и расположение кнопок на панели инструментов), если они были сохранены там с помошью метода SaveLayout.

Текущие установки не изменяются, если специфицированный INI-файл не содержит данных об установках компоненты.

Если Вы задали значение свойству IniStorage, то настройки могут сохраняться и восстанавливаться автоматически.


RestoreLayoutReg
RestoreLayoutReg Method

Applies to

TSpeedbar, TRxDBGrid components

Declaration

procedure RestoreLayoutReg(IniFile: TRegIniFile);

Description

Метод полностью аналогичен RestoreLayout, но предназначен для использования с классом TRegIniFile Delphi 2.0 для чтения/записи данных из регистрационной базы данных Windows (Registry).

Если Вы задали значение свойству IniStorage, то настройки могут сохраняться и восстанавливаться автоматически.


SaveLayout
SaveLayout Method

Applies to

TSpeedbar, TRxDBGrid components

Declaration

procedure SaveLayout(IniFile: TIniFile);

Description

Метод служит для сохранения в INI-файле установок компонентов TRxDBGrid (таких как порядок и ширины столбцов) и TSpeedbar (набор и расположение кнопок на панели инструментов), для последующего восстановления с помошью метода RestoreLayout.

Данные о текущих установках компоненты записываются в специфицированный INI-файл в секцию с именем, возвращаемым функцией GetDefaultSection.

Если Вы задали значение свойству IniStorage, то настройки могут сохраняться и восстанавливаться автоматически.


SaveLayoutReg
SaveLayoutReg Method

Applies to

TSpeedbar, TRxDBGrid components

Declaration

procedure SaveLayoutReg(IniFile: TRegIniFile);

Description

Метод полностью аналогичен SaveLayout, но предназначен для использования с классом TRegIniFile Delphi 2.0 (или старше) для чтения/записи данных из регистрационной базы данных Windows (Registry).

Если Вы задали значение свойству IniStorage, то настройки могут сохраняться и восстанавливаться автоматически.


TRxDBGrid.SelectAll
SelectAll Method

Applies to

TRxDBGrid component

Declaration

procedure SelectAll;

Description

Метод предназначен для отметки (выделения) всех записей в компоненте TRxDBGrid при значении свойства MultiSelect=True.


ToggleRowSelection
ToggleRowSelection Method

Applies to

TRxDBGrid component

Declaration

procedure ToggleRowSelection;

Description

Метод служит для программного изменения выделения текущей строки DBGrid'а при значении свойства MultiSelect = True. Вы можете использовать вызов этого метода, например, для переключения выделения строки при нажатии пользователем определенной клавиши.


TRxDBGrid.UnselectAll
UnselectAll Method

Applies to

TRxDBGrid component

Declaration

procedure UnselectAll;

Description

Метод предназначен для снятия отметки (выделения) со всех записей в компоненте TRxDBGrid при значении свойства MultiSelect=True.


TBookmarkList Type

Unit

RxDBCtrl

Declaration

type

TBookmarkList = class;

Description

When you set MultiSelect property of a TRxDBGrid to True, you give yourself the ability to select multiple records within the grid. The records you select are represented as bookmarks and are stored in the SelectedRows property. The SelectedRows property is an object of type TBookmarkList. The properties and methods are described below.

The Items property is a List of TBookmark. The Count property returns the number of currently selected items in the DBGrid

The Clear method will free all the selected records within the DBGrid

The Delete method will delete all the selected rows from the dataset

The Find method determines whether a bookmark is in the selected list. Use the Find method to locate the position of the bookmarked record within the selected list in the DBGrid.

The IndexOf method returns the index of the bookmark within the Items property.

The Refresh method returns a boolean value to notify whether any orphans were dropped (deleted) during the time the record has been selected in the grid. The Refresh method can be used to update the selected list to minimize the possibility of accessing a deleted record.

The CurrentRowSelected property returns a boolean value and determines whether the current row is selected or not.

NOTE

In 32-bit version Delphi this class is declared in DBGRIDS.PAS unit.


TCheckTitleBtnEvent Type

Unit

RxDBCtrl

Declaration

type

TCheckTitleBtnEvent = procedure (Sender: TObject; ACol: Longint; Field: TField; var Enabled: Boolean) of object;

Description

Тип определяет обработчик события OnCheckButton компоненты TRxDBGrid.


TDBLabelOptions Type

Unit

RxDBCtrl

Declaration

type

TDBLabelOptions = (doCaption, doGlyph, doBoth);

Description

Тип задает возможные значения свойства ShowOptions компоненты TDBStatusLabel.


TDBLabelStyle Type

Unit

RxDBCtrl

Declaration

type

TDBLabelStyle = (lsState, lsRecordNo, lsRecordSize);

Description

Тип задает возможные значения свойства Style компоненты TDBStatusLabel.


TGetBtnParamsEvent Type

Unit

RxDBCtrl

Declaration

type

TGetBtnParamsEvent = procedure (Sender: TObject; Field: TField; AFont: TFont; var Background: TColor; var SortMarker: TSortMarker; IsDown: Boolean) of object;

Description

Тип определяет обработчик события OnGetBtnParams компоненты TRxDBGrid.


TGetCellParamsEvent Type

Unit

RxDBCtrl

Declaration

type

TGetCellParamsEvent = procedure (Sender: TObject; Field: TField; AFont: TFont; var Background: TColor; Highlight: Boolean) of object;

Description

Тип определяет процедурный тип для методов - обработчиков события OnGetCellParams компоненты TrxDBGrid.


TGetCellPropsEvent Type

Unit

RxDBCtrl

Declaration

type

TGetCellPropsEvent = procedure (Sender: TObject; Field: TField; AFont: TFont; var Background: TColor) of object;

Description

Тип определяет процедурный тип для методов - обработчиков события OnGetCellProps компоненты TrxDBGrid.


TGetStringEvent Type

Unit

RxDBCtrl

Declaration

type

TGetStringEvent = function(Sender: TObject): string of object;

Description

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

Тип используется, например, в событии OnGetDataName компоненты TDBStatusLabel.


TGlyphAlign Type

Unit

RxDBCtrl

Declaration

type

TGlyphAlign = glGlyphLeft..glGlyphRight;

Description

Тип задает возможные значения свойства GlyphAlign компоненты TDBStatusLabel.


TSortMarker Type

Unit

RxDBCtrl

Declaration

type

TSortMarker = (smNone, smDown, smUp);

Description

Тип задает возможные значения параметра SortMarker метода - обработчика события OnGetBtnParams компоненты TRxDBGrid.

Возможные значения:

• smNone - не рисовать индикатор сортировки

• smDown - индикатор в виде стрелки вниз

• smUp - индикатор в виде стрелки вверх.


TTitleClickEvent Type

Unit

RxDBCtrl

Declaration

type

TTitleClickEvent = procedure (Sender: TObject; ACol: Longint; Field: TField) of object;

Description

Тип определяет обработчик события OnTitleClick компоненты TRxDBGrid.


RxDice Unit

The RxDice 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 RxDice unit:

Components and objects

TRxDice

Types

TrxDiceValue

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


TRxDice Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxDice

Description

Компонента из числа "безделушек", позволяющая вам использовать в формах изображения игральных костей в различных положениях. Текущее состояние компоненты (положение игральной кости) задается свойством Value, которое может изменяться от 1 до 6. Вы можете установить свойство Value в случайное значение, вызвав метод RandomValue. Если вы установите свойство Rotate в значение True, изображение игральной кости начнет случайным образом "вращаться", изменяя значение Value, с частотой, задаваемой свойством Interval. Остановить вращение можно, присвоив значение False свойству Rotate. Если свойство AutoStopInterval отлично от 0, то по прошествии этого времени вращение будет остановлено автоматически. При изменении значения Value происходит событие OnChange.


TRxDice See Also
See also

TRxSwitch


TRxDice Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl


TRxDice properties
Properties

Run-time only    [image] Key properties

AutoSize	Hint	ShowHint
AutoStopInterval	Interval	Showing
Color	Left	TabOrder
ComponentCount	Name	TabStop
ComponentIndex	Owner	Tag
Components	Parent	Top
Cursor	ParentColor	Value
DragCursor	ParentShowHint	Visible
DragMode	PopupMenu	Width
Height	Rotate
HelpContext	ShowFocus


TRxDice events
Events

Run-time only    [image] Key events

OnChange	OnEndDrag	OnMouseMove
OnClick	OnKeyDown	OnMouseUp
OnDblClick	OnKeyPress	OnStart
OnDragDrop	OnKeyUp	OnStartDrag
OnDragOver	OnMouseDown	OnStop


TRxDice methods
Methods

Key methods

BeginDrag	Hide	ScreenToClient
BringToFront	InsertComponent	SendToBack
ClientToScreen	Invalidate	SetBounds
Create	Perform	SetFocus
Destroy	RandomValue	Show
Dragging	Refresh	Update
EndDrag	RemoveComponent
FindComponent	Repaint


TRxDice.AutoStopInterval
AutoStopInterval Property

Applies to

TRxDice component

Declaration

property AutoStopInterval: Cardinal;

Description

Свойство задает интервал (в мсек), по прошествии которого после установки свойства Rotate в значение True вращение игральной кости будет остановлено.

Если значение AutoStopInterval = 0, то вращение автоматически не останавливается и может быть прекращено присваиванием Rotate = False.


Rotate
Rotate Property

Applies to

TRxDice component

Declaration

property Rotate: Boolean;

Description

Если вы установите свойство Rotate в значение True, изображение игральной кости начнет случайным образом "вращаться", изменяя значение Value, с частотой, задаваемой свойством Interval. Остановить вращение можно, присвоив свойству Rotate значение False.


ShowFocus
ShowFocus Property

Applies to

TRxSwitch, TRxDice components

Declaration

property ShowFocus: Boolean;

Description

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


TRxDice.Value
Value Property

Applies to

TRxDice component

Declaration

property Value: TrxDiceValue;

Description

Свойство задает текущее состояние (положение игральной кости) для компоненты TRxDice.


RandomValue
RandomValue Method

Applies to

TRxDice component

Declaration

procedure RandomValue;

Description

Вызов метода RandomValue позволяет установить значение свойства Value компоненты TrxDice случайным образом (в диапазоне целых чисел от 1 до 6).


TrxDiceValue Type

Unit

RxDice

Declaration

type

TrxDiceValue = 1..6;

Description

Тип TRxDiceValue задает допустимые значения параметра Value компоненты TRxDice.


RxGIF Unit

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 RxGIF unit:

Components and objects

TGIFFrame

TGIFImage

Types

TDisposalMethod

TGIFVersion

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


TGIFFrame object
TGIFFrame Class

Hierarchy             See also             Properties             Methods

Unit

RxGIF

Description

Класс предназначен для доступа к графическим изображениям из файла формата GIF. GIF-файл может содержать более одного изображения (animated GIF). Предоставляет доступ к характеристикам изображения, таким как AnimateInterval, DisposalMethod, TransparentColor и Origin; а также позволяет нарисовать изображение методом Draw.


TGIFFrame See Also
See also

TBitmap

TGIFImage

TGraphic


TGIFFrame Hierarchy
Hierarchy

TObject

  |

TPersistent


TGIFFrame properties
Properties

Run-time only    [image] Key properties

AnimateInterval	DisposalMethod	Origin
Bitmap	Height	TransparentColor
Corrupted	Interlaced	Width


TGIFFrame methods
Methods

Key methods

Assign	Destroy
Create	Draw


TGIFFrame.AnimateInterval
AnimateInterval Property

Applies to

TGIFFrame component

Declaration

property AnimateInterval: Word;

Description

Specifies the amount of time, in milliseconds, that the image displays during the animation.


TGIFFrame.Bitmap
Bitmap Property

Applies to

TGIFFrame component

Declaration

property Bitmap: TBitmap;

Description

An internal bitmap that contains the GIF frame's image. Protected.


TGIFFrame.Corrupted
Corrupted Property

Applies to

TGIFFrame component

Declaration

property Corrupted: Boolean;

Description

Read-only property. Indicates if the image frame is corrupted and has not been loaded properly.


DisposalMethod
DisposalMethod Property

Applies to

TGIFFrame component

Declaration

property DisposalMethod: TDisposalMethod;

Description

DisposalMethod indicates how frames display in the animation from the following choices:

• dmUndefined - Directs the viewer (animator) to do nothing to the background before displaying the next image.

• dmLeave - Directs the viewer to leave the previous graphic image as the next is drawn. This choice can create a shadowing effect.

• dmRestoreBackground - Directs the viewer to redraw the original background as the current image is drawn.

• dmRestorePrevious - Directs the viewer to redraw the previous image as the current image is drawn.


TGIFFrame.Height
Height Property

Applies to

TGIFFrame component

Declaration

property Height: Integer;

Description

Height indicates the vertical size in pixels of the GIF-frame image.


TGIFFrame.Interlaced
Interlaced Property

Applies to

TGIFFrame component

Declaration

property Interlaced: Boolean;

Description

Read-only property. Indicates if the image is interlaced. An image is interlaced in a four-pass interlace pattern (see the GIF89a Specification for details).


TGIFFrame.Origin
Origin Property

Applies to

TGIFFrame component

Declaration

property Origin: TPoint;

Description

Origin indicates the position of the left and top edges of the image, with respect to the left edge of the Logical Screen. Leftmost column of the Logical Screen is 0. Top row of the Logical Screen is also 0.


TGIFFrame.TransparentColor
TransparentColor Property

Applies to

TGIFFrame component

Declaration

property TransparentColor: TColor;

Description

TransparentColor is a color that will treat as the transparent portion of the GIF image.


TGIFFrame.Width
Width Property

Applies to

TGIFFrame component

Declaration

property Width: Integer;

Description

Width indicates the horizontal size in pixels of the GIF-frame image.


TGIFFrame.Draw
Draw Method

Applies to

TGIFFrame component

Declaration

procedure Draw(ACanvas: TCanvas; X, Y: Integer);

Description

Draw the GIF frame on the canvas specified by the ACanvas parameter at the location given by the coordinates (X, Y).


TGIFImage object
TGIFImage Class

Hierarchy             See also             Properties             Methods             Events

Unit

RxGIF

Description

TGIFImage позволяет Вам читать и записывать графические данные в формате GIF. Свойства класса TGIFImage предоставляют Вам доступ к данным о размере изображения и др. его характеристикам. Класс TGIFImage поддерживает изображения, содержащие до 256 цветов, форматов GIF 87a и GIF 89a (Вы можете определить формат загруженного изображения по свойству Version), включая графические расширения (graphic control extensions), такие как анимированное изображение, прозрачность и т.д. и комментарии (comment extensions). Текстовое расширение (plain-text extensions) формата GIF не поддерживается - блоки, содержащие такие расширения, игнорируются. В случае наличия нескольких изображений, Вы можете получить доступ к каждому из них через индексированное свойство Frames. TGIFImage содержит внутреннее изображение формата "bitmap" для каждого "кадра".

Класс TGIFImage:

• не имеет канвы (canvas), т.е. Вы не можете рисовать в изображении формата GIF.

• будучи наследником TGraphic, TGIFImage реализует protected-метод Draw, т.е. вы можете рисовать изображения GIF методом Canvas.Draw. В случае анимированного GIF-изображения метод Draw будет рисовать тот "кадр" изображения, который задан свойством FrameIndex.

• Экземпляры TGIFImage и TGIFFrame могут быть скопированы в объект класса TBitmap (методом TBitmap.Assign). Также Вы можете скопировать TBitmap в объекты TGIFImage и TGIFFrame. Таким образом, Вы можете создать объект TGIFImage, скопировать в него битовое изображение методом Assign, и затем сохранить в формате GIF.


TGIFImage See Also
See also

TBitmap

TGIFFrame

TGraphic


TGIFImage Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TGraphic


TGIFImage properties
Properties

Run-time only    [image] Key properties

BackgroundColor	Frames	ScreenHeight
Comment	Height	ScreenWidth
Count	Looping	TransparentColor
Empty	Palette	Version
FrameIndex	RepeatCount	Width


TGIFImage events
Events

Run-time only    [image] Key events

OnChange	OnProgress


TGIFImage methods
Methods

Key methods

Assign	LoadFromFile	SaveToStream
Create	LoadFromStream
Destroy	SaveToFile


BackgroundColor
BackgroundColor Property

Applies to

TGIFImage component

Declaration

property BackgroundColor: TColor;

Description

The BackgroundColor property determines which background color stored in the GIF file to use when drawing a GIF image.

The background color is the color used for those pixels on the screen that are not covered by an image.


TGIFImage.Comment
Comment Property

Applies to

TGIFImage component

Declaration

property Comment: TStrings;

Description

Свойство предоставляет доступ к комментарию, сохраненному в файле формата GIF как "comment extension".


TGIFImage.Count
Count Property

Applies to

TGIFImage component

Declaration

property Count: Integer;

Description

Свойство определяет число отдельных "кадров", присутствующих в изображении формата GIF (animated GIF). Доступ к каждому изображению осуществляется с помощью свойства Frames.


TGIFImage.FrameIndex
FrameIndex Property

Applies to

TGIFImage component

Declaration

property FrameIndex: Integer;

Description

Для GIF-файла, содержащего несколько изображений (animated GIF), данное свойство определяет индекс изображения ("кадра"), которое будет рисоваться методом Draw объекта TCanvas.


TGIFImage.Frames[Index: Integer]
Frames Property

Applies to

TGIFImage component

Declaration

property Frames[Index: Integer]: TGIFFrame;

Description

Свойство позволяет получить доступ к отдельным "кадрам" изображения формата GIF (если файл содержит несколько изображений в случае animated GIF), как к объектам класса TGIFFrame.


TGIFImage.Height
Height Property

Applies to

TGIFImage component

Declaration

property Height: Integer;

Description

Height specifies the vertical size in pixels of the current frame (specified by FrameIndex property) of the GIF image.


TGIFImage.Looping
Looping Property

Applies to

TGIFImage component

Declaration

property Looping: Boolean;

Description

Свойство определяет, будет ли анимация, содержащаяся в изображении формата GIF, повторяться после однократной прокрутки всех кадров. Число повторов определяется свойством RepeatCount.


TGIFImage.Palette
Palette Property

Applies to

TGIFImage component

Declaration

property Palette: HPALETTE;

Description

Palette indicates the color palette of the graphical GIF image.

Use Palette to get the color palette of a GIF image.


TGIFImage.RepeatCount
RepeatCount Property

Applies to

TGIFImage component

Declaration

property RepeatCount: Integer;

Description

Свойство определяет число повторных "прокруток" анимации при значении свойства Looping = True. Значение 0 (ноль) задает неограниченное число повторов.


TGIFImage.ScreenHeight
ScreenHeight Property

Applies to

TGIFImage component

Declaration

property ScreenHeight: Integer;

Description

Свойство содержит значение вертикального размера изображения формата GIF. Это значение может не совпадать со значением свойства Height, определяющим высоту текущего выбранного "кадра" (frame) изображения (свойство FrameIndex). Значение ScreenHeight используется при отображении анимированного GIF-изображения и определяет полную высоту прямоугольника, внутри которого изображаются все "кадры" рисунка.


TGIFImage.ScreenWidth
ScreenWidth Property

Applies to

TGIFImage component

Declaration

property ScreenWidth: Integer;

Description

Свойство содержит значение горизонтального размера изображения формата GIF. Это значение может не совпадать со значением свойства Width, определяющим ширину текущего выбранного "кадра" (frame) изображения (свойство FrameIndex). Значение ScreenWidth используется при отображении анимированного GIF-изображения и определяет полную ширину прямоугольника, внутри которого изображаются все "кадры" рисунка.


TGIFImage.TransparentColor
TransparentColor Property

Applies to

TGIFImage component

Declaration

property TransparentColor: TColor;

Description

TransparentColor determines which color of the GIF image is to be transparent when the GIF image is drawn.


TGIFImage.Version
Version Property

Applies to

TGIFImage component

Declaration

property Version: TGIFVersion;

Description

Свойство определяет версию изображения формата GIF: 87a или 89a.


TGIFImage.Width
Width Property

Applies to

TGIFImage component

Declaration

property Width: Integer;

Description

Width specifies the horizontal size in pixels of the current frame (specified by FrameIndex property) of the GIF image.


TGIFImage.OnProgress
OnProgress Event

Applies to

TGIFImage component

Declaration

property OnProgress: TProgressEvent;

Description

OnProgress occurs when a graphical image is in the process of changing. OnProgress is a generic progress indicator event that propagates out to the TGIFImage OnProgress events.


TDisposalMethod Type

Unit

RxGIF

Declaration

type

TDisposalMethod = (dmUndefined, dmLeave, dmRestoreBackground, dmRestorePrevious, dmReserved4, dmReserved5, dmReserved6, dmReserved7);

Description

TDisposalMethod is the type of available values for the DisposalMethod property of the TGIFFrame object.


TGIFVersion Type

Unit

RxGIF

Declaration

type

TGIFVersion = (gvUnknown, gv87a, gv89a);

Description

Тип задает возможные значения для версии файла с изображением в формате GIF.


RxGraph Unit

The following items are declared in the RxGraph unit:

Types

TMappingMethod

Procedures and functions

BitmapToMemory

GetBitmapPixelFormat

GrayscaleBitmap

SaveBitmapToFile

SetBitmapPixelFormat

TileImage

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


TMappingMethod Type

Unit

RxGraph

Declaration

type

TMappingMethod = (mmQuantize, mmTrunc784, mmTrunc666, mmTripel, mmGrayscale);

Description

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


BitmapToMemory Function

Examples

Unit

RxGraph

Declaration

function BitmapToMemory(Bitmap: TBitmap; Colors: Integer): TStream;

Description

Функция создает поток в памяти и записывает туда данные графического изображения Bitmap, при этом уменьшая число цветов в изображении до значения, заданного параметром Colors.

Возвращает указатель на созданный поток с сохраненным в нем графическим изображением или nil, если произошла ошибка. Вы должны освободить созданный поток методом Free.


BitmapToMemory example
Example

Уменьшение числа цветов битового изображения в компоненте TImage до 16:

 var

   S: TStream;

 begin

   S := BitmapToMemory(Picture.Bitmap, 16);

   try

     Picture.Graphic.LoadFromStream(S);

   finally

     S.Free;

   end;

 end;


GetBitmapPixelFormat Function

Examples

Unit

RxGraph

Declaration

function GetBitmapPixelFormat(ABitmap: TBitmap): TPixelFormat;

Description

Функция определяет формат пикселя (число бит на пиксель), используемый при отрисовке ьитового изображения ABitmap.


GetBitmapPixelFormat example
Example

if GetBitmapPixelFormat(Image.Bitmap) > pf8bit then

  SetBitmapPixelFormat(Image.Bitmap, pf8bit, mmQuantize);


GrayscaleBitmap Procedure

Examples

Unit

RxGraph

Declaration

procedure GrayscaleBitmap(Bitmap: TBitmap);

Description

This procedure transforms a color bitmap image into grayscale. Each pixel is transformed into the gray pixel (Red = Green = Blue) with the (approximate) same luminosity.


GrayscaleBitmap example
Example

 GrayscaleBitmap(Image1.Bitmap);


SaveBitmapToFile Procedure

Examples

Unit

RxGraph

Declaration

procedure SaveBitmapToFile(const FileName: string; Bitmap: TBitmap; Colors: Integer);

Description

Процедура позволяет сохранить графическое изображение объекта Bitmap в файле FileName формата *.BMP, аналогично методу SaveToFile класса TBitmap. Отличие этой процедуры от метода заключается в том, что вы можете задать число цветов Colors, с которым будет сохранено графическое изображение. Вы можете использовать эту процедуру, например, если хотите при сохранении уменьшить количество цветов 256-цветного битового изображения до 16.


SaveBitmapToFile example
Example

 var

   Bmp: TBitmap;

 begin

   {...}

   Bmp.Assign(Clipboard);

   SaveBitmapToFile(SaveDialog1.FileName, Bmp, 16);

   {...}

 end;


SetBitmapPixelFormat Procedure

Examples

Unit

RxGraph

Declaration

procedure SetBitmapPixelFormat(ABitmap: TBitmap; PixelFormat: TPixelFormat; Method: TMappingMethod);

Description

Процедура позволяет изменить число цветов (бит на пиксель), используемое для отрисовки битового изображения ABitmap. Вы можете указать один из методов, используемый для уменьшения числа цветов, с помощью параметра Method. Этот параметр игнорируется при увеличении числа цветов.

Допустимые значения для параметра PixelFormat: pf1bit, pf4bit, pf8bit, pf24bit.


SetBitmapPixelFormat example
Example

  SetBitmapPixelFormat(Image.Bitmap, pf8bit, mmQuantize);


TileImage Procedure

Examples

Unit

RxGraph

Declaration

procedure TileImage(Canvas: TCanvas; Rect: TRect; Image: TGraphic);

Description

Процедура отрисовывает графическое изображение Image "мозаикой" до полного заполнения прямоугольной области, заданной параметром Rect.


TileImage example
Example

procedure TForm1.PaintBox1Paint(Sender: TObject);

begin

  with Sender as TPaintBox do begin

    TileImage(Canvas, ClientRect, PicClip1.GraphicCell[4]);

  end;

end;


RxGrdCpt Unit

The RxGrdCpt unit contains the declarations for the certain components on the RX Tools 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 RxGrdCpt unit:

Components and objects

TRxCaption

TRxCaptionList

TRxGradientCaption

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


TRxCaption object
TRxCaption Class

Hierarchy             See also             Properties             Methods

Unit

RxGrdCpt

Description

Класс TRxCaption используется для задания свойств отдельных "подзаголовков" в заголовке формы при использовании компоненты TRxGradientCaption.

Компонента TRxGradientCaption имеет свойство Captions, содержащее список (коллекцию) объектов TRxCaption. Используйте объекты TRxCaption для добавления текстовых строк в заголовок формы, отображаемых разными шрифтами или разным цветом.


TRxCaption See Also
See also

TCollection

TCollectionItem

TRxCaptionList

TRxGradientCaption


TRxCaption Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TCollectionItem


TRxCaption properties
Properties

Run-time only    [image] Key properties

Caption	Font	ParentFont
Collection	Index	Visible


TRxCaption methods
Methods

Key methods

Create	Destroy


TRxCaptionList object
TRxCaptionList Class

Hierarchy             See also             Properties             Methods

Unit

RxGrdCpt

Description

Класс TRxCaptionList реализует список (коллекцию) объектов TRxCaption и используется в компоненте TRxGradientCaption.

Для доступа к отдельным объектам списка TRxCaptionList имеет свойство Items. Свойство Count содержит число объектов в списке. В режиме дизайна формы (design time) используйте редактор компоненты TRxGradientCaption или редактор ее свойства Captions для создания, удаления или изменения элементов коллекции TRxCaptionList.


TRxCaptionList See Also
See also

TCollection

TRxCaption

TRxGradientCaption


TRxCaptionList Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TCollection


TRxCaptionList properties
Properties

Run-time only    [image] Key properties

Count	Items
ItemClass	Parent


TRxCaptionList methods
Methods

Key methods

BeginUpdate	Create	EndUpdate
Clear	Destroy	FindItemID


TRxCaptionList.Items[Index: Integer]
Items Property

Applies to

TRxCaptionList component

Declaration

property Items[Index: Integer]: TRxCaption default;

Description

Свойство предназначено для осуществления индексированного доступа к элементам списка объектов типа TRxCaption.


TRxCaptionList.Parent
Parent Property

Applies to

TRxCaptionList component

Declaration

property Parent: TRxGradientCaption;

Description

Свойство (read-only) определяет компоненту класса TRxGradientCaption, которая является владельцем списка заголовков TRxCaptionList.


TRxGradientCaption Component

Hierarchy             See also             Properties             Methods

Unit

RxGrdCpt

Description

Компонента предназначена для создания визуальных эффектов в заголовке окна (формы).

Вы можете заполнить прямоугольник заголовка окна цветовым переходом (gradient fill) и отображать дополнительные текстовые строки в заголовке с использованием разных шрифтов.

Используйте свойства GradientActive и GradientInactive для того, чтобы разрешить или запретить заполнение прямоугольника заголовка окна плавным переходом цветов.

Свойство Captions позволяет задать дополнительные текстовые строки для заголовка окна.

Внимание

При использовании этой компоненты, если ее свойство Active установлено в значение True, не присваивайте напрямую значение свойства Caption формы-владельца компоненты. Используйте для этого свойство FormCaption чтобы избежать мелькания при перерисовке заголовка окна.


TRxGradientCaption See Also
See also

TRxCaption

TRxCaptionList


TRxGradientCaption Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxGradientCaption properties
Properties

Run-time only    [image] Key properties

Active	GradientActive	PopupMenu
Captions	GradientInactive	Tag
DefaultFont	Name
Font	Owner


TRxGradientCaption methods
Methods

Key methods

Create	Destroy	Update


TRxGradientCaption.Active
Active Property

Applies to

TRxGradientCaption component

Declaration

property Active: Boolean;

Description

Свойство Active определяет состояние активности компоненты TRxGradientCaption. Когда свойство Active=True (по умолчанию), все возможности компоненты могут быть задействованы (в зависимости от значений других свойств, таких как Captions, Font, GradientActive и т.д.) При значении Active=False все события, поступающие в оконную функцию формы-владельца, обрабатываются обработчиком формы по умолчанию, и никакие возможности компоненты TRxGradientCaption не могут быть использованы.


TRxGradientCaption.Captions
Captions Property

Applies to

TRxGradientCaption component

Declaration

property Captions: TRxCaptionList;

Description

Свойство определяет список объектов класса TRxCaption, которые будут использованы при рисовании заголовка формы - владельца компонента TRxGradientCaption. Используйте это свойство для задания видимых аттрибутов отображаемых в заголовке текстовых строк.

Каждому объекту из списка Captions Вы можете отдельно установить текст, шрифт, цвет текста для неактивного состояния формы, видимость и т.д. При значении свойства Active=True тексты всех заголовков из списка Captions, имеющих свойство Visible=True, будут отображаться последовательно в заголовке формы.


TRxGradientCaption.DefaultFont
DefaultFont Property

Applies to

TRxGradientCaption component

Declaration

property DefaultFont: Boolean;

Description

При установке DefaultFont в значение True компонент TRxGradientCaption использует для рисования текста в заголовке окна шрифт Windows по умолчанию, независимо от значения свойства Font.


TRxGradientCaption.GradientActive
GradientActive Property

Applies to

TRxGradientCaption component

Declaration

property GradientActive: Boolean;

Description

Свойство определяет, будет ли заполняться прямоугольник заголовка формы переходом цветов от StartColor до clActiveCaption, когда форма-владелец активна.


TRxGradientCaption.GradientInactive
GradientInactive Property

Applies to

TRxGradientCaption component

Declaration

property GradientInactive: Boolean;

Description

Свойство определяет, будет ли заполняться прямоугольник заголовка формы переходом цветов от StartColor до clInactiveCaption, когда форма-владелец неактивна.


TRxGradientCaption.Update
Update Method

Applies to

TRxGradientCaption component

Declaration

procedure Update;

Description

Метод вызывает перерисовку заголовка формы - владельца компоненты TRxGradientCaption.


RxGrids Unit

The RxGrids 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 RxGrids unit:

Components and objects

TRxDrawGrid

Types

TAcceptKeyEvent

TEditAlignEvent

TEditLimitEvent

TEditShowEvent

TEditStyleEvent

TFixedCellCheckEvent

TFixedCellClickEvent

TInplaceEditStyle

TPicklistEvent

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


TRxDrawGrid Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxGrids

Description

Компонента TRxDrawGrid, являясь наследником TDrawGrid, наследует все свойства и методы этой компоненты, и имеет некоторые дополнительные возможности.

Так, при редактировании текста в строке редактирования ячейки таблицы, событие OnSetEditText вызывается не при каждом изменении содержимого строки ввода, а только при выходе из режима редактирования. Во время заполнения текста в строке редактирования вызываются события OnAcceptEditKey и OnEditChange, позволяющие разрешить или запретить ввод определенных символов в строку редактирования.

В 32-разрядной реализации компоненты Вы можете указать стиль строки редактирования для каждой ячейки (например, задав выпадающий список для редактора или определив событие на нажатие кнопки справа от строки редактора) с помощью события OnGetEditStyle.

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

Компонента имеет дополнительные методы DrawStr, DrawMultiline, DrawPicture и DrawMasked для рисования в ячейках таблицы (grid) текста, картинок и "прозрачных" битовых изображений.


TRxDrawGrid See Also
See also

TDrawGrid

TStringGrid


TRxDrawGrid Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TCustomGrid

  |

TDrawGrid


TRxDrawGrid properties
Properties

Run-time only    [image] Key properties

Canvas	FixedColor	Parent
Col	FixedCols	Row
ColCount	FixedRows	RowCount
ColWidths	GridHeight	RowHeights
ComponentCount	GridLineWidth	ScrollBars
ComponentIndex	GridWidth	Selection
Components	Height	Showing
Ctl3D	HelpContext	TabOrder
Cursor	Hint	TabStop
DefaultColWidth	IniStorage	TabStops
DefaultDrawing	InplaceEditor	Tag
DefaultRowHeight	Left	Top
DragCursor	LeftCol	TopRow
EditorMode	Name	Visible
Enabled	Options	Width
FixedButtons	Owner


TRxDrawGrid events
Events

Run-time only    [image] Key events

OnAcceptEditKey	OnEditChange	OnKeyPress
OnCancelEdit	OnEndDrag	OnKeyUp
OnChangeFocus	OnEnter	OnMouseDown
OnCheckButton	OnExit	OnMouseMove
OnClick	OnFixedCellClick	OnMouseUp
OnColumnMoved	OnGetEditAlign	OnRowMoved
OnColumnSized	OnGetEditLimit	OnRowSized
OnDblClick	OnGetEditMask	OnSelectCell
OnDragDrop	OnGetEditStyle	OnSetEditText
OnDragOver	OnGetEditText	OnShowEditor
OnDrawCell	OnGetPicklist	OnStartDrag
OnEditButtonClick	OnKeyDown	OnTopLeftChanged


TRxDrawGrid methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
CellRect	Hide	SendToBack
ClientToScreen	Invalidate	SetBounds
Dragging	InvalidateCell	SetFocus
DrawMasked	InvalidateCol	SetTextBuf
DrawMultiline	InvalidateRow	Show
DrawPicture	MouseToCell	Update
DrawStr	Perform
EndDrag	Refresh


FixedButtons
FixedButtons Property

Applies to

TRxDrawGrid component

Declaration

property FixedButtons: Boolean;

Description

Свойство определяет, могут ли фиксированные (fixed) ячейки в Grid-е быть использованы как кнопки. По умолчанию - False.

При установке свойства в значение True Вы можете обработать события OnFixedCellClick для обработки нажатия на такую кнопку и OnCheckButton для установки свойств (разрешения нажатия) кнопок в заголовке.


OnAcceptEditKey
OnAcceptEditKey Event

Applies to

TRxDrawGrid component

Declaration

property OnAcceptEditKey: TAcceptKeyEvent;

Description

Событие OnAcceptEditKey происходит, если свойство Options содержит значение goEditing и пользователь редактирует текст в ячейке таблицы (компоненты TRxDrawGrid) при нажатии символьных клавиш на клавиатуре. Вы можете обработать это событие для того, чтобы запретить, например, ввод определенных символов в строку редактирования и т.д.


TRxDrawGrid.OnCancelEdit
OnCancelEdit Event

Applies to

TRxDrawGrid component

Declaration

property OnCancelEdit: TNotifyEvent;

Description

Событие возникает при отмене редактирования текста в редакторе ячейки компоненты TRxDrawGrid. Это происходит при нажатии пользователем клавиши ESCAPE в режиме редактирования текста ячейки. Строка редактирования в это время скрывается (если не задан флаг goAlwaysShowEditor в свойстве Options), но событие OnSetEditText не вызывается.


TRxDrawGrid.OnChangeFocus
OnChangeFocus Event

Applies to

TRxDrawGrid component

Declaration

property OnChangeFocus: TNotifyEvent;

Description

Событие происходит при получении и при потере компонентой TRxDrawGrid фокуса ввода. В отличие от событий OnEnter и OnExit это событие возникает и при переключении между формами или между приложениями Windows. В обработчике этого события вы можете проверить состояние компоненты по значению, возвращаемому методом Focused.


TRxDrawGrid.OnCheckButton
OnCheckButton Event

Applies to

TRxDrawGrid component

Declaration

property OnCheckButton: TFixedCellCheckEvent;

Description

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

В обработчик события передаются в качестве параметров номер колонки ACol и строки ARow. Вы можете запретить нажатие на кнопку, утановив параметр Enabled в значение False.


OnColumnSized
OnColumnSized Event

Applies to

TRxDrawGrid component

Declaration

property OnColumnSized: TNotifyEvent;

Description

OnColumnSized occurs immediately after the width of a column changes.

Write an OnColumnSized event handler to provide special processing whenever a column in the grid changes width. Columns can be sized programmatically or by user manipulation.

OnColumnSized does not occur unless the Options property includes goColSizing.


TRxDrawGrid.OnEditButtonClick
OnEditButtonClick Event

Applies to

TRxDrawGrid component

Declaration

property OnEditButtonClick: TNotifyEvent;

Description

OnEditButtonClick occurs when the user presses the ellipsis button in a grid cell.

Write an OnEditButtonClick event handler to bring up an appropriate list or dialog when the user presses the ellipsis button in a grid cell. The OnEditButtonClick event handler can set the value assotiated with the cell based on the user response to the list or dialog. Use Col and Row properties to access the data assotiated with the current grid cell.


OnEditChange
OnEditChange Event

Applies to

TRxDrawGrid, TRxDBGrid components

Declaration

property OnEditChange: TNotifyEvent;

Description

Событие возникает при изменении текста в редакторе компоненты TRxDrawGrid в режиме редактирования содержимого ячейки.

Вы можете обработать событие OnEditChange, например, для проверки правильности ввода данных в строке редактирования.


OnFixedCellClick
OnFixedCellClick Event

Applies to

TRxDrawGrid component

Declaration

property OnFixedCellClick: TFixedCellClickEvent;

Description

Событие происходит при нажатии пользователем на кнопку в фиксированной ячейке компоненты TRxDrawGrid при установленном в True значении свойства FixedButtons. В обработчик события в качестве параметров передаются номер колонки ACol и строки ARow, соответствующие данной ячейке.


OnGetEditAlign
OnGetEditAlign Event

Applies to

TRxDrawGrid component

Declaration

property OnGetEditAlign: TEditAlignEvent;

Description

OnGetEditAlign occurs when the in-place editor requests an edit alignment.

Write an OnGetEditAlign event handler to provide the in-place editor with an alignment that describes the way the text is formatted by the in-place editor. Set the Alignment parameter to the value that describes the edit alignment for the cell specified by the ACol and ARow parameters.

OnGetEditAlign does not occur unless the Options property includes goEditing.


OnGetEditLimit
OnGetEditLimit Event

Applies to

TRxDrawGrid component

Declaration

property OnGetEditLimit: TEditLimitEvent;

Description

Событие позволяет установить мексимально возможную длину строки при редактировании текста в ячейке компоненты TRxDrawGrid.

Максимально допустимая длина задается параметром MaxLength. Если этот параметр задан равным 0 (нулю), то это означает, что длина вводимого в ячейку текста не органичивается.


OnGetEditStyle
OnGetEditStyle Event

Applies to

TRxDrawGrid component

Declaration

property OnGetEditStyle: TEditStyleEvent;

Description

OnGetEditStyle occurs when the in-place editor requests an edit style.

The Style parameter determines how users can edit the data of a grid cell. These are the possible values of Style:

- ieSimple - No combo box or ellipsis button is provided. The user cannot select the cell's content from a list.

- iePicklist - The grid displays a combo box in the column, and the user can choose a value from the drop-down list. You must specify contents of a pick-list by handling OnGetPicklist event.

- ieEllipsis - The column displays an ellipsis button that the user can click to choose a value. Clicking the ellipsis button triggers an OnEditButtonClick event.

OnGetEditStyle does not occur unless the Options property includes goEditing.


OnGetPicklist
OnGetPicklist Event

Applies to

TRxDrawGrid component

Declaration

property OnGetPicklist: TPicklistEvent;

Description

OnGetPicklist occurs when the in-place editor requests a pick-list for its drop-down control.

You must fill contents of string-list specified by PickList parameter by adding lines (and possible objects) to the string-list.

OnGetPicklist does not occur unless the Options property includes goEditing and your custom OnGetEditStyle event handler set Style parameter to iePicklist.


OnRowSized
OnRowSized Event

Applies to

TRxDrawGrid component

Declaration

property OnRowSized: TNotifyEvent;

Description

OnRowSized occurs immediately after the height of a row changes.

Write an OnRowSized event handler to provide special processing whenever a row in the grid changes height. Rows can be sized programmatically or by user manipulation.

OnRowSized does not occur unless the Options property includes goRowSizing.


TRxDrawGrid.OnShowEditor
OnShowEditor Event

Applies to

TRxDrawGrid component

Declaration

property OnShowEditor: TEditShowEvent;

Description

Событие возникает при переводе компоненты TRxDrawGrid в режим редактирования содержимого ячейки.

Вы можете обработать это событие для того, чтобы запретить редактирование текста (отображение редактора) в конкретной ячейке, присвоив значение False параметру AllowEdit.


DrawMasked
DrawMasked Method

Applies to

TRxDrawGrid component

Declaration

procedure DrawMasked(ARect: TRect; Graphic: TBitmap);

Description

Метод предназначен для отрисовки "прозрачного" битового изображения (Bitmap) в ячейке таблицы. Изображение рисуется в центре переданного прямоугольника ARect. В качестве "прозрачного" цвета используется цвет левого нижнего пикселя битового изображения.

Вы можете вызвать этот метод в обработчике события OnDrawCell.


DrawMultiline
DrawMultiline Method

Applies to

TRxDrawGrid component

Declaration

procedure DrawMultiline(ARect: TRect; const S: string; Align: TAlignment);

Description

Метод предназначен для отрисовки строки текста в ячейке таблицы (в несколько строк, если весь текст не входит по ширине в ячейку) с заданным выравниванием (Align).

Вы можете вызвать этот метод в обработчике события OnDrawCell.


DrawPicture
DrawPicture Method

Applies to

TRxDrawGrid component

Declaration

procedure DrawPicture(ARect: TRect; Graphic: TGraphic);

Description

Метод предназначен для отрисовки графического изображения в ячейке таблицы. Изображение рисуется в центре переданного прямоугольника ARect.

Вы можете вызвать этот метод в обработчике события OnDrawCell.


DrawStr
DrawStr Method

Applies to

TRxDrawGrid component

Declaration

procedure DrawStr(ARect: TRect; const S: string; Align: TAlignment);

Description

Метод предназначен для отрисовки строки в ячейке таблицы (в одну строку) с заданным выравниванием (Align).

Вы можете вызвать этот метод в обработчике события OnDrawCell.


TRxDrawGrid.InvalidateCell
InvalidateCell Method

Applies to

TRxDrawGrid component

Declaration

procedure InvalidateCell(ACol, ARow: Longint);

Description

The InvalidateCell method causes the visible portion of a grid cell to repaint. Nothing is repainted if the cell is not visible on screen. The ACol and ARow parameters specify the column and row of the cell.


TRxDrawGrid.InvalidateCol
InvalidateCol Method

Applies to

TRxDrawGrid component

Declaration

InvalidateCol

Description

Invalidates the region occupied by a column so that it will be repainted with the next Windows paint message.

Call InvalidateCol when a column changes so that the area it occupies will need to be repainted. The ACol parameter is the column index.


TRxDrawGrid.InvalidateRow
InvalidateRow Method

Applies to

TRxDrawGrid component

Declaration

procedure InvalidateRow(ARow: Longint);

Description

InvalidateRow invalidates the region occupied by a row so that it will be repainted with the next Windows paint message.

Call InvalidateRow when a row changes so that the area it occupies will need to be repainted. The ARow parameter is the row index.


TAcceptKeyEvent Type

Unit

RxGrids

Declaration

type

TAcceptKeyEvent = function (Sender: TObject; var Key: Char): Boolean of object;

Description

Тип предназначен для определения методов - обработчиков события OnAcceptEditKey компоненты TRxDrawGrid.


TEditAlignEvent Type

Unit

RxGrids

Declaration

type

TEditAlignEvent = procedure (Sender: TObject; ACol, ARow: Longint; var Alignment: TAlignment) of object;

Description

Тип предназначен для определения методов - обработчиков события OnGetEditAlign компоненты TRxDrawGrid.


TEditLimitEvent Type

Unit

RxGrids

Declaration

type

TEditLimitEvent = procedure (Sender: TObject; var MaxLength: Integer) of object;

Description

Тип предназначен для определения методов - обработчиков события OnGetEditLimit компоненты TRxDrawGrid.


TEditShowEvent Type

Unit

RxGrids

Declaration

type

TEditShowEvent = procedure (Sender: TObject; ACol, ARow: Longint; var AllowEdit: Boolean) of object;

Description

Тип предназначен для определения методов - обработчиков события OnShowEditor компоненты TRxDrawGrid.


TEditStyleEvent Type

Unit

RxGrids

Declaration

type

TEditStyleEvent = procedure (Sender: TObject; ACol, ARow: Longint; var Style: TInplaceEditStyle) of object;

Description

Тип предназначен для определения методов - обработчиков события OnGetEditStyle компоненты TRxDrawGrid.


TFixedCellCheckEvent Type

Unit

RxGrids

Declaration

type

TFixedCellCheckEvent = procedure (Sender: TObject; ACol, ARow: Longint; var Enabled: Boolean) of object;

Description

Тип определяет обработчик события OnCheckButton компоненты TRxDrawGrid.


TFixedCellClickEvent Type

Unit

RxGrids

Declaration

type

TFixedCellClickEvent = procedure (Sender: TObject; ACol, ARow: Longint) of object;

Description

Тип определяет обработчик события OnFixedCellClick компоненты TRxDrawGrid.


TInplaceEditStyle Type

Unit

RxGrids

Declaration

type

TInplaceEditStyle = (ieSimple, ieEllipsis, iePickList);

Description

Тип TInplaceEditStyle задает возможные значения параметра Style в обработчике события OnGetEditStyle компоненты TRxDrawGrid.


TPicklistEvent Type

Unit

RxGrids

Declaration

type

TPicklistEvent = procedure (Sender: TObject; ACol, ARow: Longint; PickList: TStrings) of object;

Description

Тип предназначен для определения методов - обработчиков события OnGetPicklist компоненты TRxDrawGrid.


RxHook Unit

The RxHook unit contains the declarations for the certain components on the RX Tools 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 RxHook unit:

Components and objects

TRxWindowHook

Types

THookMessageEvent

Procedures and functions

FindVirtualMethodIndex

GetVirtualMethodAddress

SetVirtualMethodAddress

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


TRxWindowHook Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxHook

Description

Компонента TRxWindowHook предназначена для обработки оконных сообщений, приходящих элементам - наследникам TWinControl (которые являются окнами в смысле Windows), без создания компоненты - наследника.

Вы можете задать элемент управления, сообщения которого хотите обрабатывать, с помощью свойства WinControl. Обработка оконных сообщений осуществляется с помощью событий BeforeMessage и AfterMessage.


TRxWindowHook See Also
See also

TApplication

TForm

TWinControl


TRxWindowHook Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxWindowHook properties
Properties

Run-time only    [image] Key properties

Active	Owner	WinControl
Name	Tag


TRxWindowHook events
Events

Run-time only    [image] Key events

AfterMessage	BeforeMessage


TRxWindowHook methods
Methods

Key methods

Create	Destroy


WinControl
WinControl Property

Applies to

TRxWindowHook component

Declaration

property WinControl: TWinControl;

Description

Свойство задает любой оконный элемент - наследник TWinControl, для которого устанавливается перехват сообщений.


AfterMessage
AfterMessage Event

Applies to

TRxWindowHook component

Declaration

property AfterMessage: THookMessageEvent;

Description

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

Параметр Handled в этом событии значения не имеет и предназначен только для обработчика события BeforeMessage.


BeforeMessage
BeforeMessage Event

Applies to

TRxWindowHook component

Declaration

property BeforeMessage: THookMessageEvent;

Description

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

После обработки сообщения Вы можете запретить вызов обработчика по умолчанию, установив параметр Handled в значение True.


THookMessageEvent Type

Unit

RxHook

Declaration

type

THookMessageEvent = procedure (Sender: TObject; var Msg: TMessage; var Handled: Boolean) of object;

Description

Тип определяет процедуру - обработчик для событий BeforeMessage и AfterMessage компоненты TRxWindowHook.

Параметр Handled имеет смысл только  для события BeforeMessage.


FindVirtualMethodIndex Function

Examples

Unit

RxHook

Declaration

function FindVirtualMethodIndex(AClass: TClass; MethodAddr: Pointer): Integer;

Description

Функция находит индекс виртуального метода объекта класса AClass по адресу метода MethodAddr.

Деструктор Destroy имеет индекс 0, первый последующий определенный у наследника TObject виртуальный метод имеет индекс 1, и т.д.

Вместе с функциями GetVirtualMethodAddress и SetVirtualMethodAddress может служить для подмены виртуальных методов у созданных экземпляров классов.


FindVirtualMethodIndex example
Example

type

  THookForm = class(TForm)

  protected

    procedure WndProc(var Message: TMessage); override;

  end;

{...}

  WndProcSeq := FindVirtualMethodIndex(THookForm,

    @THookForm.WndProc);

{...}


GetVirtualMethodAddress Function

Examples

Unit

RxHook

Declaration

function GetVirtualMethodAddress(AClass: TClass; AIndex: Integer): Pointer;

Description

Функция возвращает адрес виртуального метода класса AClass по его индексу Index.

Вместе с функциями FindVirtualMethodIndex и SetVirtualMethodAddress может служить для подмены виртуальных методов у созданных экземпляров классов (см. пример к функции SetVirtualMethodAddress).


GetVirtualMethodAddress example
Example

  Method := GetVirtualMethodAddress(TForm1, 1);


SetVirtualMethodAddress Function

Examples

Unit

RxHook

Declaration

function SetVirtualMethodAddress(AClass: TClass; AIndex: Integer; NewAddress: Pointer): Pointer;

Description

Функция меняет адрес виртуальныго метода, заданного индексом Index, в таблице виртуальных методов (VMT) класса AClass на адрес NewAddress, который должен указывать на виртуальный метод объектного класса, совпадающий с заменяемым по описанию.

Возвращается адрес старого метода.

Вместе с функциями FindVirtualMethodIndex и GetVirtualMethodAddress может служить для подмены виртуальных методов у созданных экземпляров классов без создания наследников классов.

ВНИМАНИЕ

Функцию надо использовать очень осторожно, так как подмена адреса в таблице VMT может привести к непредсказуемым последствиям!


SetVirtualMethodAddress example
Example

Следующий пример показывает подмену метода WndProc для формы (класса - наследника TForm).

Сначала необходимо объявить класс - наследник TForm (того же класса, который является предком для подменяемого объекта):

{ THookForm }

type

  THookForm = class(TForm)

  protected

    procedure WndProc(var Message: TMessage); override;

  end;

procedure THookForm.WndProc(var Message: TMessage);

var

  I: Integer;

begin

  inherited WndProc(Message);

  if (Message.Msg = WM_NCHITTEST) then

    try

      { your specific event handler }

    except

      Application.HandleException(Self);

    end;

end;

Затем в нужном месте можно подменить обработчик, и при необходимости восстановить его:

type

  PClass = ^TClass;

var

  SaveMethod: TWndMethod;

procedure SetHook(AForm: TForm);

var

  MethodIndex: Integer;

begin

  MethodIndex := FindVirtualMethodIndex(THookForm, @THookForm.WndProc);

  @SaveMethod := SetVirtualMethodAddress(PClass(Form)^,

    MethodIndex, @THookForm.WndProc);

end;

procedure ReleaseHook(AForm: TForm);

var

  MethodIndex: Integer;

begin

  if Assigned(SaveMethod) then begin

    MethodIndex := FindVirtualMethodIndex(THookForm, @THookForm.WndProc);

    SetVirtualMethodAddress(PClass(Form)^, MethodIndex, @SaveMethod);

    SaveMethod := nil;

  end;

end;


RxIni Unit

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 RxIni unit:

Components and objects

TRxIniFile

Types

TReadObjectEvent

TWriteObjectEvent

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


TRxIniFile object
TRxIniFile Class

Hierarchy             See also             Properties             Methods             Events

Unit

RxIni

Description

Класс TRxIniFile, являясь наследником TIniFile, предназначен для чтения и записи данных в INI-файлы. Помимо свойств и методов, унаследованных от TIniFile, класс TRxIniFile имеет методы для чтения и записи в INI-файлы таких характеристик, как координаты точки (ReadPoint, WritePoint), координаты прямоугольника (ReadRect, WriteRect), шрифт (ReadFont, WriteFont), цвет (ReadColor, WriteColor) и списки строк (ReadList, ReadClearList, WriteList). При чтении-записи списков строк в INI-файл могут быть дополнительно записаны данные об объектах, сохраненных в списке (свойство Objects классов TStrings, TStringList). Для этого предусмотрены обработчики событий OnReadObject и OnWriteObject, а также свойство ListItemName.


TRxIniFile See Also
See also

TIniFile


TRxIniFile Hierarchy
Hierarchy

TObject

  |

TIniFile


TRxIniFile properties
Properties

Run-time only    [image] Key properties

FileName	ListItemName


TRxIniFile events
Events

Run-time only    [image] Key events

OnReadObject	OnWriteObject


TRxIniFile methods
Methods

Key methods

Create	ReadList	WriteFont
EraseSection	ReadPoint	WriteInteger
Flush	ReadRect	WriteList
ReadBool	ReadSection	WritePoint
ReadClearList	ReadSectionValues	WriteRect
ReadColor	ReadString	WriteString
ReadFont	WriteBool
ReadInteger	WriteColor


ListItemName
ListItemName Property

Applies to

TRxIniFile component

Declaration

property ListItemName: string;

Description

Свойство ListItemName определяет идентификатор, с которым будут записаны в INI-файл элементы списка строк с помощью метода WriteList. Значение по умолчанию - "Item". Например, при сохранении списка класса TStrings в секцию, указанную в качестве параметра метода WriteList, будут занесены строки следующего вида:

 Item0=FirstString

 Item1=SecondString

 ...

 ItemXXX=LastString.

где имя ключа INI-файла определяется свойством ListItemName и номером элемента в списке.


OnReadObject
OnReadObject Event

Applies to

TRxIniFile component

Declaration

property OnReadObject: TReadObjectEvent;

Description

Событие происходит при чтении из INI-файла элементов списка строк с помощью метода ReadList. Обработав это событие, вы можете считать данные об объектах, ассоциированных с элементами списка, если они были сохранены в INI-файле с помощью обработчика события OnWriteObject.


OnWriteObject
OnWriteObject Event

Applies to

TRxIniFile component

Declaration

property OnWriteObject: TWriteObjectEvent;

Description

Событие происходит при записи в INI-файл элементов списка строк с помощью метода WriteList. Обработав это событие, вы можете записать в INI-файл данные об объектах, ассоциированных с элементами списка.


TRxIniFile.Flush
Flush Method

Applies to

TRxIniFile component

Declaration

procedure Flush;

Description

Windows 95 и Windows NT кэшируют запись в INI-файлы для повышения производительности.

Метод позволяет произвести немедленную запись на диск всех изменений, произведенных в INI-файле.


ReadClearList
ReadClearList Method

Applies to

TRxIniFile component

Declaration

function ReadClearList(const Section: string; List: TStrings): TStrings;

Description

Метод ReadClearList служит для чтения из INI-файла списков строк, сохраненных там с помощью метода WriteList. Вы можете воспользоваться событием OnReadObject для чтения из INI-файла данных об объектах, ассоциированных с элементами списка, если они были сохранены с использованием события OnWriteObject.

Параметр Section идентифицирует секцию INI-файла, в которой будет производиться поиск данных. Параметр List задает ссылку на объект класса TStrings, в который будет произведена запись элементов, считанных из INI-файла.

Перед чтением данных из INI-файла список List будет очищен вызовом метода Clear. Если вам необходимо добавить считанные элементы списка к тем, которые уже занесены в список, используйте метод ReadList.


ReadColor
ReadColor Method

Applies to

TRxIniFile component

Declaration

function ReadColor(const Section, Ident: string; Default: TColor): TColor;

Description

Метод ReadColor считывает величину типа TColor из INI-файла.

Параметр Section идентифицирует секцию INI-файла, в которой будет производиться поиск ключа. Параметр Ident является именем ключа, значение которого вы хотите считать. Параметр Default задает значение по умолчанию.


ReadFont
ReadFont Method

Applies to

TRxIniFile component

Declaration

function ReadFont(const Section, Ident: string; Font: TFont): TFont;

Description

Метод ReadFont служит для чтения характеристик шрифта из INI-файла. Данные шрифта могут быть записаны в INI-файл с помощью метода WriteFont.

Параметр Section идентифицирует секцию INI-файла, в которой будет производиться поиск ключа. Параметр Ident является именем ключа, значение которого вы хотите считать. Метод ReadFont получает также в качестве параметра ссылку на объект класса TFont, свойства которого будут изменены в соответствии со значениями, считанными из INI-файла.


ReadList
ReadList Method

Applies to

TRxIniFile component

Declaration

function ReadList(const Section: string; List: TStrings): TStrings;

Description

Метод ReadList служит для чтения из INI-файла списков строк, сохраненных там с помощью метода WriteList. Вы можете воспользоваться событием OnReadObject для чтения из INI-файла данных об объектах, ассоциированных с элементами списка, если они были сохранены с использованием события OnWriteObject.

Параметр Section идентифицирует секцию INI-файла, в которой будет производиться поиск данных. Параметр List задает ссылку на объект класса TStrings, в который будет произведена запись элементов, считанных из INI-файла. Элементы будут добавлены к тем, которые уже занесены в список List. Если вам необходимо перед чтением данных очистить список, используйте метод ReadClearList.


ReadPoint
ReadPoint Method

Applies to

TRxIniFile component

Declaration

function ReadPoint(const Section, Ident: string; const Default: TPoint): TPoint;

Description

Метод ReadPoint служит для чтения из INI-файла величин типа TPoint.

Параметр Section идентифицирует секцию INI-файла, в которой будет производиться поиск ключа. Параметр Ident является именем ключа, значение которого вы хотите считать. Параметр Default задает значение по умолчанию.


ReadRect
ReadRect Method

Applies to

TRxIniFile component

Declaration

function ReadRect(const Section, Ident: string; const Default: TRect): TRect;

Description

Метод ReadRect служит для чтения из INI-файла величин типа TRect.

Параметр Section идентифицирует секцию INI-файла, в которой будет производиться поиск ключа. Параметр Ident является именем ключа, значение которого вы хотите считать. Параметр Default задает значение по умолчанию.


WriteColor
WriteColor Method

Applies to

TRxIniFile component

Declaration

procedure WriteColor(const Section, Ident: string; Value: TColor);

Description

Метод WriteColor записывает в INI-файл величину типа TColor.

Параметр Section идентифицирует секцию INI-файла, в которую будет произведена запись ключа. Параметр Ident является именем ключа, значение которого вы хотите записать. Параметр Value задает значение ключа для записи в INI-файл.


WriteFont
WriteFont Method

Applies to

TRxIniFile component

Declaration

procedure WriteFont(const Section, Ident: string; Font: TFont);

Description

Метод WriteFont служит для записи характеристик шрифта в INI-файл.

Параметр Section идентифицирует секцию INI-файла, в которую будет произведена запись ключа. Параметр Ident является именем ключа, значение которого вы хотите записать. Параметр Font задает ссылку на объект класса TFont, характеристики которого необходимо записать.


WriteList
WriteList Method

Applies to

TRxIniFile component

Declaration

procedure WriteList(const Section: string; List: TStrings);

Description

Метод WriteList служит для записи в INI-файл списков строк для последующего чтения их с помощью метода WriteList. Вы можете воспользоваться событием OnWriteObject для записи в INI-файл данных об объектах, ассоциированных с элементами списка.

Параметр Section идентифицирует секцию INI-файла, в которую будет производиться запись данных. Параметр List задает ссылку на объект класса TStrings, элементы которого будут записаны в INI-файл. Данные записываются в INI-файл в следующем формате: в секцию Section записывается ключ для сохранения числа элементов списка, например

   Count=10,

затем для каждого элемента списка записывется ключ с именем, формируемым с использованием свойства ItemName, и значением, совпадающим со строкой из списка, например

   Item8=MyString.

Кроме того, при записи каждого элемента списка происходит событие OnWriteObject, обработав которое вы можете занести в INI-файл данные об объектах, ассоциированных с элементами списка строк.

Перед записью списка строк в INI-файл метод WriteList обнуляет содержимое секции Section вызовом метода EraseSection.


WritePoint
WritePoint Method

Applies to

TRxIniFile component

Declaration

procedure WritePoint(const Section, Ident: string; const Value: TPoint);

Description

Метод WritePoint служит для записи в INI-файл значений типа TPoint.

Параметр Section идентифицирует секцию INI-файла, в которую будет произведена запись ключа. Параметр Ident является именем ключа, значение которого вы хотите записать. Параметр Value задает значение ключа для записи в INI-файл.


WriteRect
WriteRect Method

Applies to

TRxIniFile component

Declaration

procedure WriteRect(const Section, Ident: string; const Value: TRect);

Description

Метод WriteRect служит для записи в INI-файл значений типа TRect.

Параметр Section идентифицирует секцию INI-файла, в которую будет произведена запись ключа. Параметр Ident является именем ключа, значение которого вы хотите записать. Параметр Value задает значение ключа для записи в INI-файл.


TReadObjectEvent Type

Unit

RxIni

Declaration

type

TReadObjectEvent = function(Sender: TObject; const Section, Item, Value: string): TObject of object;

Description

Определяет процедурный тип для обработчика события OnReadObject класса TRxIniFile.


TWriteObjectEvent Type

Unit

RxIni

Declaration

type

TWriteObjectEvent = procedure(Sender: TObject; const Section, Item: string; Obj: TObject) of object;

Description

Определяет процедурный тип для обработчика события OnWriteObject класса TRxIniFile.


RxLookup Unit

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.

The following items are declared in the RxLookup unit:

Components and objects

TRxDBLookupCombo

TRxDBLookupList

TRxLookupEdit

Types

TGetImageEvent

TLookupListStyle

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


TRxDBLookupCombo Component

Hierarchy             See also             Properties             Methods             Events

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.


TRxDBLookupCombo See Also
See also

TDBGrid

TDBLocate

TDBLookupCombo

TDBLookupList

TLocateObject

TRxDBGrid

TRxDBLookupList

TRxLookupEdit


TRxDBLookupCombo Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TRxLookupControl


TRxDBLookupCombo properties
Properties

Run-time only    [image] Key properties

AutoSelect	Enabled	Owner
BorderStyle	EscapeClear	Parent
Color	FieldsDelimiter	ParentColor
ComponentCount	Font	ParentCtl3D
ComponentIndex	Height	ParentFont
Components	HelpContext	ParentShowHint
Ctl3D	Hint	PopupMenu
Cursor	IgnoreCase	ReadOnly
DataField	IndexSwitch	ShowHint
DataSource	ItemHeight	Showing
DisplayAllFields	KeyValue	TabOrder
DisplayEmpty	Left	TabStop
DisplayValue	ListStyle	Tag
DragCursor	ListVisible	Text
DragMode	LookupDisplay	Top
DropDownAlign	LookupDisplayIndex	Value
DropDownCount	LookupField	Visible
DropDownWidth	LookupSource	Width
EmptyItemColor	MaxLength
EmptyValue	Name


TRxDBLookupCombo events
Events

Run-time only    [image] Key events

OnChange	OnDropDown	OnKeyPress
OnClick	OnEndDrag	OnKeyUp
OnCloseUp	OnEnter	OnMouseDown
OnDblClick	OnExit	OnMouseMove
OnDragDrop	OnGetImage	OnMouseUp
OnDragOver	OnKeyDown	OnStartDrag


TRxDBLookupCombo methods
Methods

Key methods

BringToFront	Hide	ScreenToClient
ClientToScreen	InsertComponent	SendToBack
CloseUp	Invalidate	SetBounds
Create	IsDropDown	SetFocus
Destroy	Perform	SetTextBuf
DropDown	Refresh	Show
FindComponent	RemoveComponent	Update
GetTextBuf	Repaint
GetTextLen	ResetField


DisplayAllFields
DisplayAllFields Property

Applies to

TRxDBLookupCombo component

Declaration

property DisplayAllFields: Boolean;

Description

Свойство DisplayAllFields определяет, какие поля будут отображаться в строке компоненты TRxDBLookupCombo, когда свойство LookupDisplay определяет несколько полей из набора данных LookupSource.

По умолчанию свойство имеет значение False и в строке отображается значение только одного поля, определяемого свойством LookupDisplayIndex. Если DisplayAllFields = True, то все поля, включенные в список LookupDisplay, отображаются в строке компоненты.


DisplayEmpty
DisplayEmpty Property

Applies to

TRxDBLookupList, TRxDBLookupCombo components

Declaration

property DisplayEmpty: string;

Description

Свойство задает значение DisplayValue в том случае, если никакого выбора не сделано и значение Value равно значению свойства EmptyValue (по умолчанию - пустой строке). В списке отображается дополнительной строкой в верхней части списка с использованием цвета EmptyItemColor и не скролируется (остается всегда видимым и доступным для выбора).


TRxDBLookupCombo.DropDownWidth
DropDownWidth Property

Applies to

TRxDBLookupCombo component

Declaration

property DropDownWidth: Integer;

Description

DropDownWidth is the width, in pixels, of the drop-down list.

Use DropDownWidth to customize the width of the drop-down list. If DropDownWidth is 0 (the default), the drop-down list is the same width as the combo box. If DropDownWidth is less then 0 (negative value), the drop-down list calculates its width to accommodate all lookup fields by using their DisplayWidth property.

DropDownWidth is useful when displaying multiple lookup fields, and therefore, multiple columns in the database lookup combo box.


EmptyValue
EmptyValue Property

Applies to

TRxDBLookupList, TRxDBLookupCombo components

Declaration

property EmptyValue: string;

Description

Свойство задает значение, присвоение которого свойству Value будет восприниматься как присвоение "пустого" значения и приведет к очистке DataField. По умолчанию значение свойства есть пустая строка.


EscapeClear
EscapeClear Property

Applies to

TRxDBLookupCombo component

Declaration

property EscapeClear: Boolean;

Description

Свойство определяет поведение компоненты при нажатии клавиши "ESCAPE". По умолчанию (EscapeClear = True), нажатие "Escape" очищает значение Value (вызовом ResetField), при значении False нажатие "Escape" не обрабатывается компонентой TRxDBLookupCombo.


FieldsDelimiter
FieldsDelimiter Property

Applies to

TRxDBLookupList, TRxDBLookupCombo components

Declaration

property FieldsDelimiter: Char;

Description

Свойство определяет разделитель между полями, отображаемыми в списке, при значении свойства ListStyle = lsDelimited. По умолчанию - запятая (',').


IgnoreCase
IgnoreCase Property

Applies to

TRxDBLookupList, TRxDBLookupCombo components

Declaration

property IgnoreCase: Boolean;

Description

Свойство определяет, будет ли учитываться регистр вводимых символов при поиске термина путем набора его первых букв (см. описание компоненты TrxDBLookupCombo). Если значение свойства True (по умолчанию), то регистр не учитывается.

ВНИМАНИЕ

При работе с некоторыми SQL-серверами БД установка этого свойства в значение True может приводить к неожиданному поведению компоненты. В этом случае постарайтесь добиться "правильного" поведения за счет комбинирования разных значений свойств IgnoreCase и IndexSwitch.


KeyValue
KeyValue Property

Applies to

TRxDBLookupList, TRxDBLookupCombo components

Declaration

property KeyValue: Variant;

Description

Use KeyField to determine the value represented by the lookup control (not the value displayed by the lookup control). When KeyValue is set, the lookup control attempts to find a record from the LookupSource's dataset where the value of LookupField matches KeyValue. If such a match is found, the lookup control displays the value of LookupDisplay on that record.


ListVisible
ListVisible Property

Applies to

TRxDBLookupCombo component

Declaration

property ListVisible: Boolean;

Description

Свойство возвращает True, если в настоящее время "развернут" выпадающий список выбора, False - в противном случае.


TRxDBLookupCombo.Value
Value Property

Applies to

TRxDBLookupCombo component

Declaration

property Value: string;

Description

Run-time only. The value of the Value property is the contents of the DataField for the current record in the primary dataset. As the user moves through the primary dataset, the value of the Value property changes.

By explicitly changing the Value property value at run time, you change the contents of the field.


OnCloseUp
OnCloseUp Event

Applies to

TRxLookupEdit, TRxDBLookupCombo components

Declaration

property OnCloseUp: TNotifyEvent;

Description

Событие происходит при закрытии выпадающего списка выбора.


CloseUp
CloseUp Method

Applies to

TRxDBLookupCombo component

Declaration

procedure CloseUp(Accept: Boolean);

Description

The CloseUp method closes an opened or "dropped-down" database lookup combo box. The Accept parameter determines whether to modify the DataField with the selected value in the combo box.


IsDropDown
IsDropDown Method

Applies to

TRxDBLookupCombo component

Declaration

function IsDropDown: Boolean;

Description

Функция возвращает True, если в настоящее время "развернут" выпадающий список выбора, False - в противном случае.


ResetField
ResetField Method

Applies to

TRxDBLookupCombo component

Declaration

procedure ResetField;

Description

Метод осуществляет "очистку" компоненты, то есть отменяет сделанный ранее выбор какого-либо корректного значения и устанавливает свойство Value в EmptyValue и DisplayValue в значение DisplayEmpty (по умолчанию оба - пустая строка).


TRxDBLookupList Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxLookup

Description

Компонента TRxDBLookupList почти полностью аналогична стандартной компоненте из VCL TDBLookupList и имеет те же самые свойства, методы и события. Однако по сравнению с TDBLookupList у этой компоненты есть некоторые дополнительные возможности и свойства.

TRxDBLookupList позволяет использовать в качестве LookupSource любой источник данных - как TTable, так и TQuery, при этом свойство LookupField не обязательно должно быть индексированным полем. Компонента TRxDBLookupList позволяет также производить поиск нужного термина при наборе первых букв этого термина. (См. описание компоненты TRxDBLookupCombo).

Компонента также позволяет задать изображения для рисования в левой части каждой строки списка, в зависимости от содержимого полей БД, с помощью события OnGetImage.

В остальном компонента TRxDBLookupList полностью аналогична компоненте TDBLookupList.

ВНИМАНИЕ

При присвоении значений свойству Value или DisplayValue компонент TRxDBLookupCombo или TRxDBLookupList безошибочное позиционирование на соответствующую запись в списке произойдет только в том случае, если соответствующее поле в подмножестве записей, заданном источником данных DataSource, имеет только уникальные неповторяющиеся значения. В противном случае Вы получите несколько "выбранных" элементов в списке (причем реально будет выбран только один самый первый), значения полей в которых равны заданному. Избегайте таких ситуаций!

При работе с некоторыми SQL-серверами БД установка свойств IndexSwitch или IgnoreCase в значение True может приводить к неожиданному поведению компоненты. В этом случае постарайтесь добиться "правильного" поведения за счет комбинирования разных значений свойств IgnoreCase и IndexSwitch.


TRxDBLookupList See Also
See also

TDBGrid

TDBLocate

TDBLookupCombo

TDBLookupList

TrxDBLookupCombo


TRxDBLookupList Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TRxLookupControl


TRxDBLookupList properties
Properties

Run-time only    [image] Key properties

Align	FieldsDelimiter	Parent
BorderStyle	Font	ParentColor
Color	Height	ParentCtl3D
ComponentCount	HelpContext	ParentFont
ComponentIndex	Hint	ParentShowHint
Components	IgnoreCase	PopupMenu
Ctl3D	IndexSwitch	ReadOnly
Cursor	ItemHeight	RowCount
DataField	KeyValue	ShowHint
DataSource	Left	Showing
DisplayEmpty	ListStyle	TabOrder
DisplayValue	LookupDisplay	TabStop
DragCursor	LookupDisplayIndex	Tag
DragMode	LookupField	Top
EmptyItemColor	LookupSource	Value
EmptyValue	Name	Visible
Enabled	Owner	Width


TRxDBLookupList events
Events

Run-time only    [image] Key events

OnClick	OnEndDrag	OnKeyDown
OnDblClick	OnEnter	OnKeyPress
OnDragDrop	OnExit	OnKeyUp
OnDragOver	OnGetImage	OnStartDrag


TRxDBLookupList methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


EmptyItemColor
EmptyItemColor Property

Applies to

TRxDBLookupList, TRxDBLookupCombo components

Declaration

property EmptyItemColor: TColor;

Description

Свойство задает значение цвета, которым будет рисоваться дополнительный нескролируемый элемент списка для "пустого" значения (т.е. которое совпадает с DisplayEmpty).


IndexSwitch
IndexSwitch Property

Applies to

TRxDBLookupList, TRxDBLookupCombo, TDBLocate components

Declaration

property IndexSwitch: Boolean;

Description

Свойство IndexSwitch определяет, будет ли при необходимости производиться переключение индексов таблицы (если источником данных служит таблица BDE, а не результат запроса). В случае использования больших SQL-таблиц переключение индексов может занять длительное время, поэтому в таких случаях свойство желательно устанавливать в значение False.

ВНИМАНИЕ

При работе с некоторыми SQL-серверами БД установка этого свойства в значение True может приводить к неожиданному поведению компонент TRxDBLookupList и TRxDBLookupCombo. В этом случае постарайтесь добиться "правильного" поведения за счет комбинирования разных значений свойств IgnoreCase и IndexSwitch.


ListStyle
ListStyle Property

Applies to

TRxLookupEdit, TRxDBLookupList, TRxDBLookupCombo components

Declaration

property ListStyle: TLookupListStyle;

Description

Свойство определяет стиль отображения списка при наличии в нем нескольких колонок (полей таблицы или запроса БД).

Значение lsFixed (по умолчанию) задает отображение колонок с фиксированной шириной, определяемой свойством DisplayWidth соответствующих полей БД.

Значение lsDelimited задает отображение значений из нескольких полей последовательно через разделитель, определенный свойством FieldsDelimiter.


LookupDisplayIndex
LookupDisplayIndex Property

Applies to

TRxLookupEdit, TRxDBLookupList, TRxDBLookupCombo components

Declaration

property LookupDisplayIndex: Integer;

Description

В случае, если свойство LookupDisplay задает более одного поля для отображения в списке, значение свойства LookupDisplayIndex определяет номер поля, значение которого возвращается свойством DisplayValue и отображается в строке компоненты TrxDBLookupCombo.


RowCount
RowCount Property

Applies to

TRxDBLookupList component

Declaration

property RowCount: Integer;

Description

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


TRxDBLookupList.Value
Value Property

Applies to

TRxDBLookupList component

Declaration

property Value: string;

Description

Run-time only. The value of the Value property is the contents of the DataField for the current record in the primary dataset. As the user moves through the primary dataset, the value of the Value property changes.

By explicitly changing the Value property value at run time, you change the contents of the field.


OnGetImage
OnGetImage Event

Applies to

TRxLookupEdit, TRxDBLookupList, TRxDBLookupCombo components

Declaration

property OnGetImage: TGetImageEvent;

Description

Событие позволяет задать картинку (битовое изображение, иконку и т.д.), которая будет изображаеться в левой части строки списка. В обработчике события Вы можете определить значение параметра TextMargin, определяющее отступ текста от левого края списка (рекомендуется задавать это значение одинаковым для всех строк списка) и значение параметра Graphic, определяющего изображение для рисования.

В обработчике события текущая запись Lookup-набора данных (заданного свойством LookupSource) соотвествует той, для которой Вы будете задавать изображение, таким образом Вы можете проверить содержимое этой записи и заданнное Вами графическое изображение будет зависеть от наполнения полей БД.

В компоненте TRxDBLookupCombo имеет смысл параметр события IsEmpty. Если передано значение True, то этот обработчик будет определять картинку для "пустого" значения Value (если задано непустое значение свойства DisplayEmpty), и в этом случае Вы не должны обращаться к полям LookupSource.


TRxLookupEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxLookup

Description

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

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

Введенное пользователем или выбранное из списка значение доступно через свойство Text.

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


TRxLookupEdit See Also
See also

TComboBox

TComboEdit

TEdit

TRxDBLookupCombo

TRxDBLookupList


TRxLookupEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit


TRxLookupEdit properties
Properties

Run-time only    [image] Key properties

Alignment	Font	ParentCtl3D
AutoSelect	Height	ParentFont
BorderStyle	HelpContext	ParentShowHint
ButtonHint	HideSelection	PopupAlign
CharCase	Hint	PopupMenu
ClickKey	Left	PopupOnlyLocate
Color	ListStyle	ReadOnly
ComponentCount	LookupDisplay	SelLength
ComponentIndex	LookupDisplayIndex	SelStart
Components	LookupField	SelText
Ctl3D	LookupSource	ShowHint
Cursor	LookupValue	Showing
DirectInput	MaxLength	TabOrder
DragCursor	Modified	TabStop
DragMode	Name	Tag
DropDownCount	OEMConvert	Text
DropDownWidth	Owner	Top
EditMask	Parent	Visible
Enabled	ParentColor	Width


TRxLookupEdit events
Events

Run-time only    [image] Key events

OnButtonClick	OnDropDown	OnKeyUp
OnChange	OnEndDrag	OnMouseDown
OnClick	OnEnter	OnMouseMove
OnCloseUp	OnExit	OnMouseUp
OnDblClick	OnGetImage	OnStartDrag
OnDragDrop	OnKeyDown
OnDragOver	OnKeyPress


TRxLookupEdit methods
Methods

Key methods

BeginDrag	Invalidate	SendToBack
BringToFront	Perform	SetBounds
ClientToScreen	Refresh	SetFocus
DoClick	Repaint	SetTextBuf
EndDrag	ScreenToClient	Show
Hide	SelectAll	Update


TRxLookupEdit.DropDownWidth
DropDownWidth Property

Applies to

TRxLookupEdit component

Declaration

property DropDownWidth: Integer;

Description

DropDownWidth is the width, in pixels, of the drop-down list.

Use DropDownWidth to customize the width of the drop-down list. If DropDownWidth is 0 (the default), the drop-down list is the same width as the edit box. If DropDownWidth is less then 0 (negative value), the drop-down list calculates its width to accommodate all lookup fields by using their DisplayWidth property.

DropDownWidth is useful when displaying multiple lookup fields, and therefore, multiple columns in the database lookup edit box.


TRxLookupEdit.LookupValue
LookupValue Property

Applies to

TRxLookupEdit component

Declaration

property LookupValue: string;

Description

Run-time only. Свойство позволяет получить занчение LookupField из набора данных LookupSource, если текст в редакторе был выбран из выпадающего списка.

Если текст был введен пользователем вручную, и в lookup-наборе данных нет записей с соответствующим значением поля LookupDisplay, то значение свойства LookupValue равно пустой строке.

При присвоении значения свойству LookupValue, если соответствующее значение найдно в наборе данных, свойству текст присваивается значение поля LookupDisplay.


PopupAlign
PopupAlign Property

Applies to

TRxLookupEdit, TRxDBCalcEdit, TRxCalcEdit, TDBDateEdit, TDateEdit components

Declaration

property PopupAlign: TPopupAlign;

Description

Specifies how the popup control (drop-down list, calendar, calculator) is aligned relative to its edit box.

Use PopupAlign to specify the position of the popup control relative to the edit region of the editor control. The popup control can be aligned to the left or right.


TRxLookupEdit.PopupOnlyLocate
PopupOnlyLocate Property

Applies to

TRxLookupEdit component

Declaration

property PopupOnlyLocate: Boolean;

Description

Свойство определяет, будет ли производится поиск вводимого пользователем значения в lookup-наборе данных при закрытом выпадающем списке. По умолчанию имеет значение True, и поиск производится только при открытом списке.


TGetImageEvent Type

Unit

RxLookup

Declaration

type

TGetImageEvent = procedure (Sender: TObject; IsEmpty: Boolean; var Graphic: TGraphic; var TextMargin: Integer) of object;

Description

Тип определяет процедуру - обработчик события OnGetImage для компонент TRxDBLookupList и TRxDBLookupCombo.


TLookupListStyle Type

Unit

RxLookup

Declaration

type

TLookupListStyle = (lsFixed, lsDelimited);

Description

Тип описывает возможные значения свойства ListStyle компонент TRxDBLookupList и TRxDBLookupCombo.


RxMemDS Unit

The RxMemDS 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.

The following items are declared in the RxMemDS unit:

Components and objects

TRxMemoryData

Types

TLoadMode

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


TRxMemoryData Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxMemDS

Description

Компонента TRxMemoryData представляет собой таблицу в памяти (RAM), которая может быть использована как обычный набор данных (dataset) в Delphi. Эта компонента (в отличие от TMemoryTable) не использует доступ к данным через BDE и может быть использована с любыми data-aware элементами управления Delphi VCL.

Все записи таблицы сохраняются в памяти и уничтожаются при закрытии таблицы.

Структуры таблицы вы можете задать в дизайнере Delphi с помощью редактора компоненты "Fields Editor", или скопировать из другого набора данных в run-time с помощью метода CopyStructure.

В настоящее время объектные поля (Delphi 4) не поддерживаются.

Внимание

Компонента TRxMemoryData реализована только для Delphi версии 3.0 и выше.


TRxMemoryData See Also
See also

TDataSet

TDataSource

TField

TMemoryTable

TTable


TRxMemoryData Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TDataSet


TRxMemoryData properties
Properties

Run-time only    [image] Key properties

Active	Components	Name
AutoCalcFields	EOF	Owner
BOF	FieldCount	RecNo
Bookmark	FieldDefs	RecordCount
CanModify	Fields	RecordSize
ComponentCount	FieldValues	State
ComponentIndex	Modified	Tag


TRxMemoryData events
Events

Run-time only    [image] Key events

AfterCancel	AfterScroll	BeforePost
AfterClose	BeforeCancel	BeforeScroll
AfterDelete	BeforeClose	OnCalcFields
AfterEdit	BeforeDelete	OnDeleteError
AfterInsert	BeforeEdit	OnEditError
AfterOpen	BeforeInsert	OnNewRecord
AfterPost	BeforeOpen	OnPostError


TRxMemoryData methods
Methods

Key methods

Append	FieldByName	MoveBy
Cancel	FindField	Next
Close	First	Open
CopyStructure	GetBookmark	Post
Create	GotoBookmark	Prior
Delete	Insert	Refresh
Destroy	IsEmpty	Resync
DisableControls	IsSequenced	SaveToDataSet
Edit	Last	SortOnFields
EmptyTable	LoadFromDataSet
EnableControls	Locate


LoadFromDataSet
LoadFromDataSet Method

Applies to

TRxMemoryData component

Declaration

function LoadFromDataSet(Source: TDataSet; RecordCount: Integer; Mode: TLoadMode): Integer;

Description

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

Поддерживаются два возможных режима, задаваемого параметром Mode - lmCopy (в этом случае все сущствующие записи удаляются и копируется также структура исходного набора данных) и lmAppend. Параметр RecordCount задает максимальное число добавляемых записей. Если RecordCount=0, то копируются все записи.

Метод возвращает число скопированных записей.


SaveToDataSet
SaveToDataSet Method

Applies to

TRxMemoryData component

Declaration

function SaveToDataSet(Dest: TDataSet; RecordCount: Integer): Integer;

Description

Метод копирует записи из таблицы в памяти в набор данных Dest. Максимальное число копируемых записей задается параметром RecordCount. Метод возвращает число скопированных записей.

Для загрузки записей в таблицу в памяти из другого набора данных используйте метод LoadFromDataSet.


SortOnFields
SortOnFields Method

Applies to

TRxMemoryData component

Declaration

procedure SortOnFields(const FieldNames: string; CaseInsensitive, Descending: Boolean);

Description

Метод сортирует данные в таблице в памяти в порядке возрастания или убывания (в зависимости от параметра Descending) значений полей, имена которых переданы в качестве параметра FieldNames. Для строковых полей сортировка может осуществляться с учетом или без учета регистра символов в зависимости от параметра CaseInsensitive.

Если осуществляется сортировка по нескольким полям, то их имена разделяются точкой с запятой (;).


TLoadMode Type

Unit

RxMemDS

Declaration

type

TLoadMode = (lmCopy, lmAppend);

Description

Тип определяет возможные значения параметра Mode в методе LoadFromDataSet компоненты TRxMemoryData.


RxMenus Unit

The RxMenus unit contains the declarations for the certain components on the RX Tools 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 RxMenus unit:

Components and objects

TRxMainMenu

TRxPopupMenu

Types

TDrawMarginEvent

TDrawMenuItemEvent

TItemImageEvent

TItemParamsEvent

TMeasureMenuItemEvent

TMenuOwnerDrawState

TRxMenuStyle

Procedures and functions

SetDefaultMenuFont

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


TRxMainMenu Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxMenus

Description

Компонента TRxMainMenu является наследником стандартного класса TMainMenu и предназначена для создания owner-draw меню с возможностью отрисовки его пунктов в Вашем приложении.

При значении свойства Style = msStandard поведение меню ничем не отличается от стандартной компоненты - отрисовка пунктов меню выполняется системой Windows.

При установке свойства Style в значение, отличное от msStandard отрисовку пунктов меню выполняет компонента TRxMainMenu. В этом случае Вы можете обработать событие OnGetItemParams для изменения шрифта или цвета пункта меню, а также для задания графического изображения, которое Вы хотите поместить в этот пункт меню.

Для более полного контроля за отрисовкой пунктов меню Вы можете воспользоваться также событиями OnMeasureItem и OnDrawItem.

ВНИМАНИЕ

В 16-разрядной версии компоненты существует ограничение, вызванное поведением системы Windows. Сообщение WM_DRAWITEM не посылается 16-разрядным приложениям для тех пунктов меню, которые содержат в себе подменю. Следовательно, для таких пунктов меню не вызываются события OnGetItemParams, OnMeasureItem и OnDrawItem.


TRxMainMenu See Also
See also

TMainManu

TMenuItem

TPopupMenu

TRxPopupManu


TRxMainMenu Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TMenu

  |

TMainMenu


TRxMainMenu properties
Properties

Run-time only    [image] Key properties

AutoMerge	Cursor	Name
Canvas	Handle	Owner
ComponentCount	Images	ShowCheckMarks
ComponentIndex	Items	Style
Components	MinTextOffset	Tag


TRxMainMenu events
Events

Run-time only    [image] Key events

OnDrawItem	OnGetItemParams
OnGetImageIndex	OnMeasureItem


TRxMainMenu methods
Methods

Key methods

Create	FindItem	RemoveComponent
DefaultDrawItem	GetHelpContext	Unmerge
Destroy	InsertComponent
FindComponent	Merge


TRxMainMenu.Images
Images Property

Applies to

TRxMainMenu component

Declaration

property Images: TImageList;

Description

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

Для задания конкретного графического изображения для каждого пункта меню используйте параметр ImageIndex обработчика события OnGetImageIndex.


MinTextOffset
MinTextOffset Property

Applies to

TRxPopupMenu, TRxMainMenu components

Declaration

property MinTextOffset: Cardinal;

Description

Свойство задает минимальный отступ текстовой строки в любом из пунктов меню от левого края меню. Для строки главного меню игнорируется.

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


ShowCheckMarks
ShowCheckMarks Property

Applies to

TRxPopupMenu, TRxMainMenu components

Declaration

property ShowCheckMarks: Boolean;

Description

Свойство определяет, будет ли изображаться в пунктах меню специальный символ, если значение свойства Checked отрисовываемого пункта меню True.

Если значение свойства равно True (по умолчанию), то для отрисовки символа метки выделяется пространство в левой области меню, даже если ни один пункт меню не помечен. Вы можете установить это свойство в значение False, если Вы хотите избавиться от свободного пространства в левой части пунктов меню. В этом случае, при наличии графического изображения в checked-пункте меню, это изображение рисуется "вдавленным".

Свойство ShowCheckMarks имеет смысл только при значении свойства Style, отличном от msStandard.


TRxMainMenu.Style
Style Property

Applies to

TRxMainMenu component

Declaration

property Style: TRxMenuStyle;

Description

Свойство Style определяет, будет ли отрисовка меню производиться стандартными средствами Windows, или же Вы можете использовать свой собственный код для отрисовки пунктов меню (owner-draw), например, для помещения в меню графических изображений.

Для создания owner-draw меню задайте значение свойству Style, отличное от msStandard. В этом случае Вы сможете обработать события OnMeasureItem, OnDrawItem и OnGetItemParams.


OnDrawItem
OnDrawItem Event

Applies to

TRxPopupMenu, TRxMainMenu components

Declaration

property OnDrawItem: TDrawMenuItemEvent;

Description

Событие OnDrawItem происходит при отрисовке каждого пункта меню, если значение свойства Style не равно msStandard.

В обработчике этого события Вы можете произвести необходимые действия по отрисовке пункта меню, заданного параметром Item. Отрисовку надо производить в прямоугольнике, заданном параметром Rect, пользуясь значением свойства Canvas.

Параметр State определяет состояние пункта меню (выбранный, запрещенный или помеченный).


OnGetImageIndex
OnGetImageIndex Event

Applies to

TRxPopupMenu, TRxMainMenu components

Declaration

property OnGetImageIndex: TItemImageEvent;

Description

Событие происходит перед отрисовкой пункта меню, имеющего значение свойства Style, отличное от msStandard. Используйте это событие для задания конкретного графического изображения из списка для отрисовки в пункте меню, заданном параметром Item.

Событие не происходит, если свойство Images не задано или содержит пустой список графических изображений.


OnGetItemParams
OnGetItemParams Event

Applies to

TRxPopupMenu, TRxMainMenu components

Declaration

property OnGetItemParams: TItemParamsEvent;

Description

Событие происходит перед отрисовкой каждого пункта меню, если свойство Style установлено в значение, отличное от msStandard.

В обработчике события OnGetItemParams Вы можете изменить шрифт и фоновый цвет пункта меню, а также задать графическое изображение (битовое изображение, иконку, метафайл и т.д.) для отображения в левой части пункта меню. Параметр NumGlyphs определяет, сколько картинок содержит графическое изображение Graphic. Если он отличен от 1, то второе изображение используется при отрисовке запрещенного пункта меню, третье - при отрисовке выбранного пункта меню, четвертое - отмеченного (checked), остальные картинки не используются.

Событие не происходит, если свойство Style = msStandard.

Примечание

В 32-битной версии, если задано свойство Images и обработчик события OnGetImageIndex возвращает допустимое значение параметра ImageIndex, то для отрисовки пункта меню используется изображение из image-list'а, а параметры Graphic и NumGlyphs игнорируются.


OnMeasureItem
OnMeasureItem Event

Applies to

TRxPopupMenu, TRxMainMenu components

Declaration

property OnMeasureItem: TMeasureMenuItemEvent;

Description

Событие OnMeasureItem происходит когда приложению необходимо перерисовать пункт меню, имеющего стиль owner-draw. Используйте это событие для изменения высоты и ширины пункта меню.

Событие OnMeasureItem имеет тип TMeasureMenuItemEvent и имеет 4 паратметра:

• Sender - меню, содержащее пункт, который надо перерисовать;

• Item - пункт меню;

• Width - ширина пункта меню;

• Height - высота пункта меню.

Параметры Width и Height являются var-параметрами, которые изначально имеют значения по-умолчанию, определенные в соответствии с высотой используемого шрифта, длины текста и, возможно, по результатам обработки события OnGetItemParams. Обработчик события OnMeasureItem может изменить эти значения.

После вызова события OnMeasureItem происходит вызов события OnDrawItem.

Событие OnMeasureItem не происходит, если свойство Style = msStandard.


DefaultDrawItem
DefaultDrawItem Method

Applies to

TRxPopupMenu, TRxMainMenu components

Declaration

procedure DefaultDrawItem(Item: TMenuItem; Rect: TRect; State: TMenuOwnerDrawState);

Description

Метод DefaultDrawItem производит отрисовку пункта меню Item.

Вы можете вызвать этот метод из Вашего обработчика события OnDrawItem. Если задан обработчик события OnGetItemParams, то метод DefaultDrawItem производит отрисовку пункта меню в соответствии со значениями параметров, полученными из обработчика этого события.

Метод DefaultDrawItem рисует пункт меню в точности также, как это делается в компоненте TRxMainMenu или TRxPopupMenu при отсутствии пользовательского обработчика события OnDrawItem.


TRxPopupMenu Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxMenus

Description

Компонента TRxPopupMenu является наследником стандартного класса TPopupMenu и предназначена для создания owner-draw меню с возможностью отрисовки его пунктов в Вашем приложении.

При значении свойства Style = msStandard поведение меню ничем не отличается от стандартной компоненты - отрисовка пунктов меню выполняется системой Windows.

При установке свойства Style в значение, отличное от msStandard отрисовку пунктов меню выполняет компонента TRxPopupMenu. В этом случае Вы можете обработать событие OnGetItemParams для изменения шрифта или цвета пункта меню, а также для задания графического изображения, которое Вы хотите поместить в этот пункт меню. Вы можете также установить значение свойства LeftMargin для получения поля в левой части выпадающего меню.

Для более полного контроля за отрисовкой меню Вы можете воспользоваться также событиями OnMeasureItem, OnDrawItem, OnDrawMargin.

ВНИМАНИЕ

В 16-разрядной версии компоненты существует ограничение, вызванное поведением системы Windows. Сообщение WM_DRAWITEM не посылается 16-разрядным приложениям для тех пунктов меню, которые содержат в себе подменю. Следовательно, для таких пунктов меню не вызываются события OnGetItemParams, OnMeasureItem и OnDrawItem.


TRxPopupMenu See Also
See also

TMainMenu

TMenuItem

TPopupMenu

TRxMainMenu


TRxPopupMenu Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TMenu

  |

TPopupMenu


TRxPopupMenu properties
Properties

Run-time only    [image] Key properties

Alignment	Handle	Owner
AutoPopup	HelpContext	PopupComponent
Canvas	Images	ShowCheckMarks
ComponentCount	Items	Style
ComponentIndex	LeftMargin	Tag
Components	MinTextOffset
Cursor	Name


TRxPopupMenu events
Events

Run-time only    [image] Key events

OnDrawItem	OnGetImageIndex	OnMeasureItem
OnDrawMargin	OnGetItemParams	OnPopup


TRxPopupMenu methods
Methods

Key methods

Create	FindComponent	Popup
DefaultDrawItem	FindItem	RemoveComponent
DefaultDrawMargin	GetHelpContext
Destroy	InsertComponent


TRxPopupMenu.Images
Images Property

Applies to

TRxPopupMenu component

Declaration

property Images: TImageList;

Description

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

Для задания конкретного графического изображения для каждого пункта меню используйте параметр ImageIndex обработчика события OnGetImageIndex.


TRxPopupMenu.LeftMargin
LeftMargin Property

Applies to

TRxPopupMenu component

Declaration

property LeftMargin: Cardinal;

Description

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

Если свойство Sytle = msStandard, то значение свойства LeftMargin игнорируется.

По умолчанию, если не задан обработчик события OnDrawMargin, компонента TRxPopupMenu заполняет пространство, определенное LeftMargin, градиентной заливкой, используя метод DefaultDrawMargin. Вы можете также вызвать этот метод из Вашего обработчика события OnDrawMargin.


TRxPopupMenu.Style
Style Property

Applies to

TRxPopupMenu component

Declaration

property Style: TRxMenuStyle;

Description

Свойство Style определяет, будет ли отрисовка меню производиться стандартными средствами Windows, или же Вы можете использовать свой собственный код для отрисовки пунктов меню (owner-draw), например, для помещения в меню графических изображений.

Для создания owner-draw меню задайте значение свойству Style, отличное от msStandard. В этом случае Вы сможете обработать события OnMeasureItem, OnDrawItem и OnGetItemParams; а также задать значения свойствам ShowCheckMarks и LeftMargin.


OnDrawMargin
OnDrawMargin Event

Examples

Applies to

TRxPopupMenu component

Declaration

property OnDrawMargin: TDrawMarginEvent;

Description

Событие OnDrawMargin происходит при перерисовке области в левой стороне меню, размер которой задан свойством LeftMargin. Событие не происходит для меню, имеющих свойство Style = msStandard или LeftMargin = 0.

Если обработчик этого события не задан, компонента TRxPopupMenu самостоятельно заполняет левое поле меню, используя метод DefaultDrawMargin.


OnDrawMargin example
Example

Типичный обработчик события OnDrawMargin, рисующий строку текста вдоль левого края выпадающего owner-draw меню со значением свойства LeftMargin = 30.

procedure TForm1.RxPopupMenu1DrawMargin(Sender: TMenu; Rect: TRect);

const

  Txt = 'RX Library';

begin

  RxPopupMenu1.DefaultDrawMargin(Rect, clLime, clBlack);

  with RxPopupMenu1.Canvas.Font do begin

    Name := 'Courier New';

    Style := [fsBold];

    Size := 20;

    Color := clWhite;

    Handle := CreateRotatedFont(RxPopupMenu1.Canvas.Font, 90);

    SetBkMode(RxPopupMenu1.Canvas.Handle, TRANSPARENT);

    ExtTextOut(RxPopupMenu1.Canvas.Handle, Rect.Left, Rect.Bottom - 5,

      ETO_CLIPPED, @Rect, Txt, Length(Txt), nil);

  end;

end;


DefaultDrawMargin
DefaultDrawMargin Method

Applies to

TRxPopupMenu component

Declaration

procedure DefaultDrawMargin(ARect: TRect; StartColor, EndColor: TColor);

Description

Метод DefaultDrawMargin предназначен для отрисовки поля в левой стороне popup-меню, когда значение свойства LeftMargin больше 0. Метод рисует прямоугольник Rect, цвет которого изменяется от StartColor до EndColor сверху вниз, используя процедуру GradientFillRect.

Вы можете вызвать метод DefaultDrawMargin из вашего обработчика события OnDrawMargin. Этот метод используется компонентой TRxPopupMenu для отрисовки левого поля, когда не задан пользовательсктй обработчик события OnDrawMargin.


TDrawMarginEvent Type

Unit

RxMenus

Declaration

type

TDrawMarginEvent = procedure(Sender: TMenu; Rect: TRect) of object;

Description

Тип определяет методы - обработчики события OnDrawMargin компоненты TRxPopupMenu.


TDrawMenuItemEvent Type

Unit

RxMenus

Declaration

type

TDrawMenuItemEvent = procedure(Sender: TMenu; Item: TMenuItem; Rect: TRect; State: TMenuOwnerDrawState) of object;

Description

Тип TDrawMenuItemEvent определяет методы - обработчики события OnDrawItem компонент TRxMainMenu и TRxPopupMenu.

Параметр Item определяет пункт главного или popup- меню, Rect - прямоугольную область, в которой должен быть нарисован пункт меню, и State - текущее состояние пункта меню. Возможные значения параметра State:

• mdSelected - пункт меню является выбранным;

• mdDisabled - пункт меню запрещен;

• mdChecked - пункт меню помечен;

• mdDefault - пункт меню является пунктом меню "по умолчанию" (32-bit version only).


TItemImageEvent Type

Unit

RxMenus

Declaration

type

TItemImageEvent = procedure(Sender: TMenu; Item: TMenuItem; State: TMenuOwnerDrawState; var ImageIndex: Integer) of object;

Description

Тип определяет методы - обработчики событий OnGetImageIndex компонент TRxMainMenu и TRxPopupMenu.


TItemParamsEvent Type

Unit

RxMenus

Declaration

type

TItemParamsEvent = procedure(Sender: TMenu; Item: TMenuItem; State: TMenuOwnerDrawState; AFont: TFont; var Color: TColor; var Graphic: TGraphic; var NumGlyphs: Integer) of object;

Description

Тип определяет методы - обработчики события OnGetItemParams компонент TRxMainMenu и TRxPopupMenu.


TMeasureMenuItemEvent Type

Unit

RxMenus

Declaration

type

TMeasureMenuItemEvent = procedure(Sender: TMenu; Item: TMenuItem; var Width, Height: Integer) of object;

Description

Тип TMeasureMenuItemEvent определяет методы - обработчики события OnMeasureItem компонент TRxMainMenu и TRxPopupMenu.

Параметр Item определяет пункт меню, размеры которого необходимо получить, параметры Height и Width определяют высоту и ширину пункта меню, соответственно.


TMenuOwnerDrawState Type

Unit

RxMenus

Declaration

type

TMenuOwnerDrawState = set of (mdSelected, mdGrayed, mdDisabled, mdChecked, mdFocused, mdDefault);

Description

Тип определяет возможные значения параметра State обработчика события OnDrawItem компонент TRxMainMenu и TRxPopupMenu.


TRxMenuStyle Type

Unit

RxMenus

Declaration

type

TRxMenuStyle = (msStandard, msOwnerDraw, msBtnLowered, msBtnRaised);

Description

Тип определяет возможные значения свойства Style компонент TRxMainMenu и TRxPopupMenu. Значения msBtnLowered и msBtnRaised доступны только в 32-разрядной версии.


SetDefaultMenuFont Procedure

Examples

Unit

RxMenus

Declaration

procedure SetDefaultMenuFont(AFont: TFont);

Description

Процедура устанавливает параметры шрифта AFont в значения, совпадающие со значениями параметров шрифта, используемого Windows для отрисовки пунктов меню.


SetDefaultMenuFont example
Example

  SetDefaultMenuFont(Control1.Font);


RxNotify Unit

The RxNotify unit contains the declarations for the certain components on the RX Tools 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 RxNotify unit:

Components and objects

TRxFolderMonitor

Types

TFileChangeFilter

TFileChangeFilters

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


TRxFolderMonitor Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxNotify

Description

Компонента TRxFolderMonitor предназначена для отслеживания изменений в каталогах файловой системы, таких как создание, удаление, изменение файлов или каталогов, смена аттрибутов файлов и т.д. Когда происходит одно из изменений, определенных свойством Filter, вызывается событие OnChange.

Компонента использует функции Win 32 API FindFirstChangeNotification, FindCloseChangeNotification и FindNextChangeNotification.


TRxFolderMonitor See Also
See also

TThread


TRxFolderMonitor Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxFolderMonitor properties
Properties

Run-time only    [image] Key properties

Active	DelayTime	Name
ComponentCount	Filter	Owner
ComponentIndex	FolderName	Tag
Components	MonitorSubtree


TRxFolderMonitor events
Events

Run-time only    [image] Key events

OnChange


TRxFolderMonitor methods
Methods

Key methods

Create	Destroy


TRxFolderMonitor.Active
Active Property

Applies to

TRxFolderMonitor component

Declaration

property Active: Boolean;

Description

Свойство определяет, будет ли компонента TRxFolderMonitor реагировать на изменения в каталоге, заданном свойством FolderName.

Если Active = True, то изменения файлов или каталогов приводят к вызову события OnChange.


TRxFolderMonitor.DelayTime
DelayTime Property

Applies to

TRxFolderMonitor component

Declaration

property DelayTime: Cardinal;

Description

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

При значении DelayTime = 0 событие OnChange вызывается сразу же при соответствующем изменении в файловой системе. Установка этого ссвойства в ненулевое значение позволяет уменьшить число вызовов события OnChange при нескольких подряд изменениях файлов. Например, при перезаписи одного файла другим старый файл будет удален, а новый создан - и (при DelayTime=0) событие OnChange будет вызвано дважды. Если DelayTime>0, то событие OnChange вызовется один раз по прошествии после первой файловой операции заданного интервала.


TRxFolderMonitor.Filter
Filter Property

Applies to

TRxFolderMonitor component

Declaration

property Filter: TFileChangeFilters;

Description

Свойство определяет файловые операции, которые активизируют событие OnChange.

Возможные значения свойства:

• fnFileName - любые изменения имен файлов в отслеживаемом каталоге и, возможно, его подкаталогах (переименование, создание или удаление файлов) вызывает событие OnChange.

• fnDirName - любые изменения имен директорий в отслеживаемом каталоге и, возможно, его подкаталогах (создание или удаление каталогов) вызывает событие OnChange.

• fnAttributes - любые изменения файловых аттрибутов в отслеживаемом каталоге и, возможно, его подкаталогах вызывает событие OnChange.

• fnSize - любые изменения размера файлов в отслеживаемом каталоге и, возможно, его подкаталогах вызывает событие OnChange.

• fnLastWrite - любые изменения времени последний записи (last write-time) в файл в отслеживаемом каталоге и, возможно, его подкаталогах вызывает событие OnChange.

• fnLastAccess - любые изменения времени последнего доступа к файлу в отслеживаемом каталоге и, возможно, его подкаталогах вызывает событие OnChange.

• fnSecurity - любые изменения security-descriptor в отслеживаемом каталоге и, возможно, его подкаталогах вызывает событие OnChange.

Note

Имейте в виду, что некоторые значения свойства Filter (например, fnLastAccess) применимы только в Windows NT 4.0 и выше, и их включение может вызвать ошибку в Windows 95.


TRxFolderMonitor.FolderName
FolderName Property

Applies to

TRxFolderMonitor component

Declaration

property FolderName: string;

Description

The FolderName property specifies the path of the directory to watch.


MonitorSubtree
MonitorSubtree Property

Applies to

TRxFolderMonitor component

Declaration

property MonitorSubtree: Boolean;

Description

Specifies whether the TRxFolderMonitor will monitor the directory or the directory tree. If this property is True (by default), the component monitors the directory tree rooted at the specified directory; if it is False, it monitors only the specified directory.


TRxFolderMonitor.OnChange
OnChange Event

Applies to

TRxFolderMonitor component

Declaration

property OnChange: TNotifyEvent;

Description

Событие вызывается, когда в отслеживаемом каталоге и, возможно, его подкаталогах, происходят любые изменения, определенные свойством Filter.

Событие вызывается только при значении свойства Active=True.


TFileChangeFilter Type

Unit

RxNotify

Declaration

type

TFileChangeFilter = (fnFileName, fnDirName, fnAttributes, fnSize, fnLastWrite, fnLastAccess, fnCreation, fnSecurity);

Description

Тип определяет возможные значения свойства Filter компоненты TRxFolderMonitor.


TFileChangeFilters Type

Unit

RxNotify

Declaration

type

TFileChangeFilters = set of TFileChangeFilter;

Description

Тип определяет возможные значения свойства Filter компоненты TRxFolderMonitor.


RxQuery Unit

The RxQuery 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.

The following items are declared in the RxQuery unit:

Components and objects

TRxQuery

TSQLScript

Types

TQueryOpenStatus

TScriptAction

TScriptErrorEvent

Constants

DefaultMacroChar

DefaultTermChar

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


TRxQuery Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxQuery

Description

Компонента TRxQuery является наследником компоненты TQuery, поэтому обладает всеми ее свойствами и методами и сохраняет ее функциональность.

Отличие заключается в наличии свойства Macros, с помощью которого можно легко и удобно изменять текст SQL-запроса в дизайнере или во время исполнения.

Как известно, TQuery поддерживает динамические (dynamic) запросы, которые более точно было бы называть параметризуемыми. Для работы с параметрами предназначено свойство Params. Однако их возможностей часто бывает недостаточно. Самый простой пример - сменить порядок сортировки (выражение в ORDER BY). Или динамически поменять выражение WHERE.

Для решения таких задач TRxQuery предлагает свойство Macros и механизм расширения макроопределений. Макроопределения (Macros) создаются подобно  параметрам (Params). Вы указываете в тексте запроса (свойство SQL) идентификатор, начинающийся со специального символа - признака макроопределения (свойство MacroChar). После этого макрос с соответствующим именем появляется в редакторе свойства Macros и доступен во время исполнения с помощью метода MacroByName. Вы присваиваете значение макросу, и это значение в строковом виде будет подставляться в текст запроса вместо определения макроса каждый раз при выполнении запроса.

Таким образом, чтобы изменить запрос, вам не нужно изменять свойство SQL - достаточно изменить значение макроса, присутствующего в запросе, и переоткрыть запрос.


TRxQuery See Also
See also

Params

TQuery


TRxQuery Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TDataSet

  |

TBDEDataSet

  |

TDBDataSet

  |

TQuery


TRxQuery properties
Properties

Run-time only    [image] Key properties

Active	FieldDefs	Params
AutoCalcFields	Fields	Prepared
BOF	Handle	RecordCount
CanModify	Local	RecordSize
ComponentCount	Locale	RequestLive
ComponentIndex	MacroChar	SessionName
Components	MacroCount	SQL
Database	Macros	State
DatabaseName	Modified	StmtHandle
DataSource	Name	Tag
DBSession	OpenStatus	UniDirectional
DefaultFields	Owner	UpdateMode
EOF	ParamCheck
FieldCount	ParamCount


TRxQuery events
Events

Run-time only    [image] Key events

AfterCancel	AfterPost	BeforeOpen
AfterClose	BeforeCancel	BeforePost
AfterDelete	BeforeClose	OnCalcFields
AfterEdit	BeforeDelete	OnNewRecord
AfterInsert	BeforeEdit
AfterOpen	BeforeInsert


TRxQuery methods
Methods

Key methods

ActiveBuffer	ExpandMacros	MoveBy
Append	FieldByName	Next
AppendRecord	FindComponent	Open
Cancel	FindField	OpenOrExec
CheckBrowseMode	First	ParamByName
ClearFields	FreeBookmark	Post
Close	GetBookmark	Prepare
Create	GetCurrentRecord	Prior
CursorPosChanged	GetFieldNames	Refresh
Delete	GotoBookmark	RemoveComponent
Destroy	Insert	Resync
DisableControls	InsertComponent	SetFields
Edit	InsertRecord	UnPrepare
EnableControls	IsEmpty	UpdateCursorPos
ExecDirect	Last	UpdateRecord
ExecSQL	MacroByName


MacroChar
MacroChar Property

Applies to

TRxQuery component

Declaration

property MacroChar: Char;

Description

Свойство указывает символ, который будет интерпретироваться как задание макроса в тексте запроса. Этот символ используется точно так же, как символ ':' используется для идентификации параметров запроса (Params).

Значение по умолчанию - '%'.


MacroCount
MacroCount Property

Applies to

TRxQuery component

Declaration

property MacroCount: Word;

Description

Свойство только на чтение во время выполнения. MacroCount сообщает, сколько элементов имеется в массиве Macros у TRxQuery, то есть сколько запрос имеет макросов.


TRxQuery.Macros
Macros Property

Examples

Applies to

TRxQuery component

Declaration

property Macros: TParams;

Description

Когда вы вводите запрос, компонента создает массив Macros для макроопределений вашего SQL-выражения.

Macros является массивом объектов типа TParam, где каждый элемент соответствует макроопределению в запросе. Первому макроопределению соответствует Macros[0], второму Macros[1] и т.д.

Число макроопределений сообщает свойство MacroCount.

Внимание

Используйте метод MacroByName вместо прямого доступа к Macros для того, чтобы избежать зависимости от порядка макроопределенй в запросе.


TRxQueryMacros example
Example

Пусть компонента TRxQuery с именем rxQuery2 содержит следующее SQL-выражение:

SELECT * FROM ITEMS ORDER BY %ORDER

и значение MacroChar = '%'.

Приложение может использовать метод MacroByName для изменения значения макроопределения ORDER.

rxQuery2.MacroByName('ORDER').AsString := 'ITEMS.ID';

rxQuery2.Close;

rxQuery2.Open;

rxQuery2.MacroByName('ORDER').AsString := 'ITEMS.NAME';

rxQuery2.Close;

rxQuery2.Open;

rxQuery2.MacroByName('ORDER').AsString := 'ITEMS.VENDOR';

rxQuery2.Close;

rxQuery2.Open;

В этих трех случаях результат выполнения запроса будет отсортирован по полям таблицы ITEMS соответственно: ID, NAME, VENDOR.


OpenStatus
OpenStatus Property

Applies to

TRxQuery component

Declaration

property OpenStatus: TQueryOpenStatus;

Description

Свойство определяет состояние компоненты после выполнения SQL-запроса с помощью метода OpenOrExec. Возможные значения свойства:

• qsOpened - запрос выполнен, результат доступен как набор данных (курсор);

• qsExecuted - запрос выполнен, набор данных не получен;

• qsFailed - ошибка при выполнении запроса.


ExecDirect
ExecDirect Method

Applies to

TRxQuery component

Declaration

ExecDirect

Description

Метод предназначен для выполнения запроса, игнорируя символы ':', как обозначающие параметры. Позволяет выполнять команды DDL, содержащие символы ':'.


ExpandMacros
ExpandMacros Method

Applies to

TRxQuery component

Declaration

procedure ExpandMacros;

Description

Метод производит подстановку в тексте запроса макроопределений на их строковое значение, чтобы подготовленный таким образом запрос передавался BDE.

Метод автоматически вызывается при открытии запроса или вызове метода ExecSQL, но должен вызываться вручную при выполнении запроса вызовом методов ExecDirect или OpenOrExec, если текст запроса содержит макросы.


IsEmpty
IsEmpty Method

Applies to

TRxQuery, TQBEQuery components

Declaration

function IsEmpty: Boolean;

Description

Checks for a dataset without records.


MacroByName
MacroByName Method

Examples

Applies to

TRxQuery component

Declaration

function MacroByName(const Value: string): TParam;

Description

Метод возвращает элемент свойства Macros, чье свойство Name совпадает с Value.

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


MacroByName example
Example

rxQuery1.ParamByName('ORDER').AsString := 'ITEMS.NAME';


OpenOrExec
OpenOrExec Method

Examples

Applies to

TRxQuery component

Declaration

procedure OpenOrExec(ChangeLive: Boolean);

Description

Метод предназначен для выполнения SQL-запроса, когда заранее невозможно проанализировать его текст и определить, какой метод: Open или ExecSQL использовать для его выполнения. Такая ситуация может возникнуть, когда пользователь вводит текст запроса вручную во время выполнения программы.

Метод пытается открыть курсор (создать набор данных) и если это не удается, выполняет его без открытия курсора. Параметр ChangeLive задает, будет ли произведена попытка открыть курсор в режиме RequestLive = False, если значение RequestLive при вызове метода равно True. Это происходит, если значение ChangeLive = True.

После вызова метода о результате выполнения запроса можно узнать по значению свойства OpenStatus.


OpenOrExec example
Example

begin

  {...}

  rxQuery1.SQL := Memo1.Lines;

  if Memo1.Lines.Count = 0 then Exit;

  rxQuery1.RequestLive := True;

  rxQuery1.Params.Clear;

  StartWait;

  try

    rxQuery1.OpenOrExec(True);

  finally

    StopWait;

  end;

  if rxQuery1.OpenStatus = qsExecuted then

    MessageDlg('Query successfully executed.', mtInformation, [mbOk], 0);

  {...}

end;


TSQLScript Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxQuery

Description

Компонента предназначена для выполнения SQL-скриптов (сценариев), содержащих более одного SQL-предложения.

Текст скрипта задается свойством SQL. Если свойство SemicolonTerm установлено в значение True (по умолчанию), то каждое SQL-предложение в скрипте отделяется точкой с запятой. Независимо от значения свойства SemicolonTerm отдельные SQL-предложения скрипта могут отделяться друг от друга строкой, содержащей единственный символ, указанный в свойстве Term (по умолчанию "/").

Свойство DatabaseName задает имя базы данных, в которой будет выполняться скрипт. Если эта база данных позволяет использовать транзакции, то вы можете установить свойство Transaction в значение True - в этом случае все SQL-предложения, входящие в сценарий, будут выполнены в рамках одной транзакции.


TSQLScript See Also
See also

TDatabase

TParams

TQuery


TSQLScript Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TSQLScript properties
Properties

Run-time only    [image] Key properties

ComponentCount	Name	SQL
ComponentIndex	Owner	Tag
Components	ParamCount	Term
Database	Params	Transaction
DatabaseName	SemicolonTerm
DBSession	SessionName


TSQLScript events
Events

Run-time only    [image] Key events

AfterExec	BeforeExec	OnScriptError


TSQLScript methods
Methods

Key methods

Create	ExecStatement	ParamByName
Destroy	FindComponent	RemoveComponent
ExecSQL	InsertComponent


SemicolonTerm
SemicolonTerm Property

Applies to

TSQLScript component

Declaration

property SemicolonTerm: Boolean;

Description

Если свойство SemicolonTerm установлено в значение True (по умолчанию), то символ ';' (точка с запятой) в тексте скрипта воспринимается как разделитель между отдельными SQL-предложениями.

Независимо от значения свойства SemicolonTerm отдельные SQL-предложения скрипта могут отделяться друг от друга строкой, содержащей единственный символ, указанный в свойстве Term (по умолчанию '/').


TSQLScript.SQL
SQL Property

Examples

Applies to

TSQLScript component

Declaration

property SQL: TStrings;

Description

Свойство SQL содержит текст SQL-скрипта (набор SQL-предложений или команд), который будет выполнен при вызове методов ExecSQL или ExecStatement. Каждое SQL-предложение должно либо оканчиваться символом ';' (если свойство SemicolonTerm установлено в True), либо разделяться от следующего предложения отдельной строкой, содержащей единственный символ, заданный свойством Term (по умолчанию - '/').


TSQLScriptSQL example
Example

Возможные варианты написания SQL-скриптов:

UPDATE NEXTITEM SET NewItem = 1098;

UPDATE NEXTORDER SET NewItem = 1099;

или

UPDATE NEXTITEM SET NewItem = 1098

/

UPDATE NEXTORD SET NewOrder = 1099

или

UPDATE NEXTITEM SET NewItem = 1098;

/

UPDATE NEXTORD SET NewOrder = 1099;

UPDATE NEXTCUST SET NewCustomer = 1034;


Term
Term Property

Applies to

TSQLScript component

Declaration

property Term: Char;

Description

Отдельные SQL-предложения скрипта, заданного свойством SQL, могут отделяться друг от друга строкой, содержащей единственный символ, указанный в свойстве Term (по умолчанию - '/').


TSQLScript.Transaction
Transaction Property

Applies to

TSQLScript component

Declaration

property Transaction: Boolean;

Description

Если свойство Transaction установлено в значение True и используемый драйвер базы данных поддерживает работу с транзакциями, то все SQL-предложения, входящие в состав сценария, заданного свойством SQL, будут выполнены в рамках одной транзакции.


AfterExec
AfterExec Event

Applies to

TSQLScript component

Declaration

property AfterExec: TNotifyEvent;

Description

Событие происходит после выполнения SQL-скрипта вызовом метода ExecSQL.


BeforeExec
BeforeExec Event

Applies to

TSQLScript component

Declaration

property BeforeExec: TNotifyEvent;

Description

Событие происходит перед выполнением SQL-скрипта вызовом метода ExecSQL.


OnScriptError
OnScriptError Event

Applies to

TSQLScript component

Declaration

property OnScriptError: TScriptErrorEvent;

Description

Событие OnScriptError происходит при возникновении ошибки выполнения одной SQL-команды из SQL-скрипта. Параметр Sender указывает на компоненту TSQLScript, вызвавшую ошибку, параметр E - экземпляр объекта EDatabaseError, содержащий информацию об ошибке, LineNo и StatementNo - номер строки в скрипте и порядковый номер SQL-команды, вызвавшей ошибку. Параметр Action типа TScriptAction позволяет Вам контролировать то, как ошибка будет обработана в дальнейшем.


ExecStatement
ExecStatement Method

Applies to

TSQLScript component

Declaration

procedure ExecStatement(StatementNo: Integer);

Description

Метод позволяет выполнить один SQL-оператор из скрипта по его порядковому номеру StatementNo. Нумерация идет от 0.


DefaultMacroChar Constant

Unit

RxQuery

Declaration

const

  DefaultMacroChar = '%';

Description

Символ - признак начала макроопределения по умолчанию.


DefaultTermChar Constant

Unit

RxQuery

Declaration

const

  DefaultTermChar = '/';

Description

Символ, используемый как значение свойства Term компоненты TSQLScript по умолчанию.


TQueryOpenStatus Type

Unit

RxQuery

Declaration

type

TQueryOpenStatus = (qsOpened, qsExecuted, qsFailed);

Description

Тип используется для задания возможных значений свойства OpenStatus компоненты TrxQuery.


TScriptAction Type

Unit

RxQuery

Declaration

type

TScriptAction = (saFail, saAbort, saRetry, saIgnore, saContinue);

Description

Тип описывает возможные значения параметра Action обработчика события OnScriptError компоненты TSQLScript. Смысл значений типа TScriptAction приведен ниже:

- saFail - (Значение по умолчанию.) Происходит генерация исключения (exception), как это было бы в отсутствие пользовательского обработчика OnScriptError.

- saAbort - Вызывается исключительная ситуация EAbort, не приводящая к выводу сообщения об ошибке, выполнение скрипта прерывается.

- saRetry - Производится попытка повторного выполнения вызвавшей ошибку команды SQL.

- saIgnore - Сообщение об ошибке не выводится, выполнение скрипта продолжается со следующей команды SQL.

- saContinue - Выводится сообщение об ошибке (используя метод Application.HandleException), и выполнение скрипта продолжается со следующей команды SQL.


TScriptErrorEvent Type

Unit

RxQuery

Declaration

type

TScriptErrorEvent = procedure(Sender: TObject; E: EDatabaseError; LineNo, StatementNo: Integer; var Action: TScriptAction) of object;

Description

Описывает тип метода - обработчика события OnScriptError.


RxRichEd Unit

The RxRichEd 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 RxRichEd unit:

Components and objects

TRxParaAttributes

TRxRichEdit

TRxTextAttributes

Types

TLineSpacingRule

TParaAlignment

TRichEditFindCloseEvent

TRichEditFindErrorEvent

TRichEditURLClickEvent

TRichEditVersion

TRichLangOption

TRichLangOptions

TRichSearchType

TRichSearchTypes

TRichSelection

TRichSelectionType

TRichStreamFormat

TRichStreamMode

TRichStreamModes

TRxConsistentAttribute

TRxConsistentAttributes

TRxNumbering

TRxNumberingStyle

TSubscriptStyle

TUnderlineType

TUndoName

Constants

RichEditVersion

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


TRxParaAttributes object
TRxParaAttributes Class

Hierarchy             See also             Properties             Methods

Unit

RxRichEd

Description

TRxParaAttributes represents paragraph formatting properties for a rich edit control.

TRxParaAttributes includes a number of properties that describe the formatting characteristics of a paragraph in a rich text document. TRxParaAttributes is tailored to allow a descendant of TRxRichEdit to read and write formatting characteristics of selected paragraphs. The properties of a TRxParaAttributes object are invalid unless it is owned by a descendant of TRxCustomRichEdit.


TRxParaAttributes See Also
See also

TParaAttributes

TRichEdit

TRxRichEdit

TRxTextAttributes

TTextAttributes


TRxParaAttributes Hierarchy
Hierarchy

TObject

  |

TPersistent


TRxParaAttributes properties
Properties

Run-time only    [image] Key properties

Alignment	Numbering	SpaceBefore
FirstIndent	NumberingStyle	Tab
LeftIndent	NumberingTab	TabCount
LineSpacing	RightIndent
LineSpacingRule	SpaceAfter


TRxParaAttributes methods
Methods

Key methods

Assign	Create	Destroy


TRxParaAttributes.Alignment
Alignment Property

Applies to

TRxParaAttributes component

Declaration

property Alignment: TParaAlignment;

Description

Specifies the paragraph alignment.

This property can be one of the following values:

• paLeftJustify - Paragraphs are aligned with the left margin.

• paRightJustify - Paragraphs are aligned with the right margin.

• paCenter - Paragraphs are centered.

• paJustify - Paragraphs are justified. Rich edit controls earlier than version 3.0 display the text aligned with the left margin.


TRxParaAttributes.FirstIndent
FirstIndent Property

Applies to

TRxParaAttributes component

Declaration

property FirstIndent: Longint;

Description

Specifies the indent, in pixels, of the first line of the paragraph relative to the left margin.

Use FirstIndent to specify the number of pixels to indent the first line of the paragraph. This value is relative to the value of LeftIndent.


TRxParaAttributes.LeftIndent
LeftIndent Property

Applies to

TRxParaAttributes component

Declaration

property LeftIndent: Longint;

Description

Specifies the indent, in pixels, of the paragraph relative to the left margin.

Use LeftIndent to indent a paragraph from the left margin of the entire body of text. LeftIndent is useful for making individual paragraphs stand out from the rest of the text.

Note

Adding bullets to a set of paragraphs by using the Numbering property also affects the left indentation.


TRxParaAttributes.LineSpacing
LineSpacing Property

Applies to

TRxParaAttributes component

Declaration

property LineSpacing: Longint;

Description

Specifies the spacing between lines. For a description of how this property is interpreted, see the LineSpacingRule property.

Note

Requires Rich Edit 2.0 or later.


TRxParaAttributes.LineSpacingRule
LineSpacingRule Property

Applies to

TRxParaAttributes component

Declaration

property LineSpacingRule: TLineSpacingRule;

Description

Specifies the type of line spacing.

This member can be one of the following values:

• lsSingle - Single spacing. The LineSpacing property is ignored.

• lsOneAndHalf - One-and-a-half spacing. The LineSpacing property is ignored.

• lsDouble - Double spacing. The LineSpacing property is ignored.

• lsSpecifiedOrMore - The LineSpacing property specifies the spacing, in points, from one line to the next. However, if LineSpacing specifies a value that is less than single spacing, the control displays single-spaced text.

• lsSpecified - The LineSpacing property specifies the spacing, in points, from one line to the next. The control uses the exact spacing specified, even if LineSpacing specifies a value that is less than single spacing.

• lsMultiple - The value of the LineSpacing property is the spacing, in lines, from one line to the next. Thus, setting LineSpacing to 1 produces single-spaced text, 2 is double spaced, 3 is triple spaced, and so on.

Note

Requires Rich Edit 2.0 or later.


TRxParaAttributes.Numbering
Numbering Property

Applies to

TRxParaAttributes component

Declaration

property Numbering: TRxNumbering;

Description

Specifies the options for bulleted or numbered paragraphs.

This property can be one of the following values:

• nsNone - No paragraph numbering or bullets.

• nsBullet - Insert a bullet at the beginning of each selected paragraph.

• nsArabicNumbers - Uses Arabic numbers (1, 2, 3, ...).

• nsLoCaseLetter - Uses lowercase letters (a, b, c, ...).

• nsUpCaseLetter - Uses uppercase letters (A, B, C, ...).

• nsLoCaseRoman - Uses lowercase Roman numerals (i, ii, iii, ...).

• nsUpCaseRoman - Uses uppercase Roman numerals (I, II, III, ...).

Note

Rich Edit versions earlier than 3.0 do not display paragraph numbers. However, the rich edit control stores the value but does not use it to display the text.


TRxParaAttributes.NumberingStyle
NumberingStyle Property

Applies to

TRxParaAttributes component

Declaration

property NumberingStyle: TRxNumberingStyle;

Description

Specifies the numbering style to use with numbered paragraphs. Use this property in conjunction with the Numbering property.

This member can be one of the following values:

• nsParenthesis - Follows the number with a right parenthesis.

• nsPeriod - Follows the number with a period.

• nsEnclosed - Encloses the number in parentheses.

• nsSimple - Displays only the number.

Note

Requires Rich Edit 2.0 or later.

The rich edit control stores the value but versions earlier than 3.0 do not use it to display the text or bullets.


TRxParaAttributes.NumberingTab
NumberingTab Property

Applies to

TRxParaAttributes component

Declaration

property NumberingTab: Word;

Description

Specifies the minimum space, in points, between a paragraph number and the paragraph text. Use this property in conjunction with the Numbering property.

Note

Requires Rich Edit 2.0 or later.

The rich edit control earlier than version 3.0 stores the value but does not use it to display text.


TRxParaAttributes.RightIndent
RightIndent Property

Applies to

TRxParaAttributes component

Declaration

property RightIndent: Longint;

Description

Specifies the indent, in pixels, of the paragraph relative to the right margin.

Use RightIndent to indent a paragraph from the right margin of the entire body of text. RightIndent is useful for making individual paragraphs stand out from the rest of the text, especially when Alignment is set to paRightJustify.


TRxParaAttributes.SpaceAfter
SpaceAfter Property

Applies to

TRxParaAttributes component

Declaration

property SpaceAfter: Longint;

Description

Specifies the size, in points, of the spacing below the paragraph. Must be greater than or equal to zero.

Note

Requires Rich Edit 2.0 or later.


TRxParaAttributes.SpaceBefore
SpaceBefore Property

Applies to

TRxParaAttributes component

Declaration

property SpaceBefore: Longint;

Description

Specifies the size, in points, of the spacing above the paragraph. Must be greater than or equal to zero.

Note

Requires Rich Edit 2.0 or later.


TRxParaAttributes.Tab[Index: Byte]
Tab Property

Applies to

TRxParaAttributes component

Declaration

property Tab[Index: Byte]: Longint;

Description

Specifies the position, in pixels, of a particular tab stop.

Tab is an indexed property into an array of absolute tab stop positions. The position of the first tab stop is Tab[0], the next tab stop is Tab[1], and so on to Tab[TabCount - 1].

When setting Tab, values of index below TabCount change the positions of existing tab stops. Values of index greater than or equal to TabCount increase the number of tab stops in the paragraph and change the value of TabCount.

Note

Setting Tab does not insert a tab into the text of the paragraph. It sets the positions within the paragraph where tabs will occur if they are inserted. The actual tab characters are inserted into the paragraph by using the Tab key.


TRxParaAttributes.TabCount
TabCount Property

Applies to

TRxParaAttributes component

Declaration

property TabCount: Integer;

Description

Indicates the number of tab stops that are defined for the paragraph.

Read TabCount to determine the number of tab stops in the Tab array. Use TabCount with the Tab property to iterate over all the tab stops defined for the paragraph.


TRxRichEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxRichEd

Description

Компонента TRxRichEdit представляет собой стандартный редактор Windows - "rich edit control". В отличие от компоненты TRichEdit, входящей в состав VCL, компонента TRxRichEdit поддерживает работу как с rich-edit версии 1.0, так и версии 2.0, поддерживая все дополнительные возможности версии 2.0, такие как многоуровневые опреации undo/redo, поиск текста в обоих направлениях от положения курсора, автоматическое определение и выделение URL-ссылок в тексте и т.д.

Вы можете определить, какая версия библиотеки rich-edit используется приложением, по значению переменной RichEditVersion.

Кроме того, компонента TRxRichEdit поддерживает вставку OLE-объектов (в том числе графических изображений) и активизацию их по месту. Работа с OLE-объектами в редактируемом тексте определяется значениями свойств AllowObjects, AllowInPlace и AutoVerbMenu.

Класс TRxRichEdit реализует несколько методов для работы со стандартными диалогами Windows - InsertObjectDialog, PasteSpecialDialog, ObjectPropertiesDialog, FindDialog, ReplaceDialog.


TRxRichEdit See Also
See also

TRichEdit

TRxDBRichEdit


TRxRichEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMemo

  |

TRxCustomRichEdit


TRxRichEdit properties
Properties

Run-time only    [image] Key properties

Align	LangOptions	SelStart
Alignment	Left	SelText
AllowInPlace	Lines	ShowHint
AllowObjects	MaxLength	Showing
AutoURLDetect	Modified	StreamFormat
AutoVerbMenu	Name	StreamMode
BorderStyle	Owner	TabOrder
CanPaste	PageRect	TabStop
CanRedo	Paragraph	Tag
CanUndo	Parent	Text
CaretPos	ParentColor	Title
Color	ParentCtl3D	Top
Ctl3D	ParentFont	UndoLimit
DefAttributes	ParentShowHint	UndoName
DefaultConverter	PlainText	Visible
DragCursor	PopupMenu	WantReturns
DragMode	ReadOnly	WantTabs
Enabled	RedoName	Width
Font	ScrollBars	WordAttributes
Height	SelAttributes	WordSelection
HelpContext	SelectionBar	WordWrap
HideScrollBars	SelectionType
HideSelection	SelLength


TRxRichEdit events
Events

Run-time only    [image] Key events

OnChange	OnKeyDown	OnResizeRequest
OnCloseFindDialog	OnKeyPress	OnSaveClipboard
OnDragDrop	OnKeyUp	OnSelectionChange
OnDragOver	OnMouseDown	OnStartDrag
OnEndDrag	OnMouseMove	OnTextNotFound
OnEnter	OnMouseUp	OnURLClick
OnExit	OnProtectChange


TRxRichEdit methods
Methods

Key methods

Clear	FindText	Redo
ClearUndo	GetCharPos	RegisterConversionFormat
CopyToClipboard	GetSelTextBuf	ReplaceDialog
Create	GetTextRange	SelectAll
CutToClipboard	InsertObjectDialog	StopGroupTyping
Destroy	PasteFromClipboard	Undo
FindDialog	PasteSpecialDialog
FindNext	Print


AllowInPlace
AllowInPlace Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property AllowInPlace: Boolean;

Description

AllowInPlace determines whether the rich edit control allows inplace activation of contained OLE objects.

Set AllowInPlace to specify what happens when the user activates the OLE object in the rich edit control. If AllowInPlace is True and object is not iconic, the OLE object is activated inplace. If AllowInPlace is False, the OLE object is activated in a separate window.

Note

This property is present only in Delphi 3.0 or higher.


AllowObjects
AllowObjects Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property AllowObjects: Boolean;

Description

Свойство определяет, возможно ли будет вставлять OLE-объекты в редактор TRxRichEdit. Значение True (по умолчанию) разрешает использование OLE-объектов.


AutoURLDetect
AutoURLDetect Property

Applies to

TRxRichEdit component

Declaration

property AutoURLDetect: Boolean;

Description

Set AutoURLDetect to enable or disable automatic detection of URLs by a rich edit control 2.0. Specify True to enable automatic URL detection, or False to disable it.

If automatic URL detection is enabled, the rich edit control scans any modified text to determine whether the text matches the format of a URL. The rich edit 2.0 control detects several URL formats, including the following formats:

• http:<text with no white space>

• file:<text with no white space>

• mailto:<text with no white space>

• ftp:<text with no white space>

• https:<text with no white space>

• gopher:<text with no white space>

• nntp:<text with no white space>

• prospero:<text with no white space>

• telnet:<text with no white space>

• news:<text with no white space>

• wais:<text with no white space>

The control highlights the URL string by underlining it and setting the text color. A rich edit control sends the OnURLClick event when the user click mouse button over text that has the Link effect.

Warning

Note that when automatic URL detection is enabled, the rich edit control removes the Link effect from modified text that does not have a URL format recognized by the control. If your application uses the Link effect to mark other types of text (the Link property of TRxTextAttributes), do not enable automatic URL detection.

Note

Requires Rich Edit 2.0 or later.


AutoVerbMenu
AutoVerbMenu Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property AutoVerbMenu: Boolean;

Description

AutoVerbMenu determines whether the rich edit control automatically creates a pop-up menu containing the OLE object's verbs.

Use AutoVerbMenu to specify whether the OLE object can add items to the rich edit control's popup menu. If AutoVerbMenu is True (the default), the OLE object add items to the menu specified by PopupMenu property or creates new popup menu. If AutoVerbMenu is False, no popup menu items are automatically created.


CanPaste
CanPaste Property

Applies to

TRxRichEdit component

Declaration

property CanPaste: Boolean;

Description

Indicates whether a rich edit control can paste any format currently on the clipboard.

To paste data from the Windows clipboard, call the PasteFromClipboard method.

You can use CanPaste method when enabling or disabling menu items that correspond to the "Paste" command.


CanRedo
CanRedo Property

Applies to

TRxRichEdit component

Declaration

property CanRedo: Boolean;

Description

Indicates whether the rich edit 2.0 control contains any actions in the redo queue.

Read CanRedo to determine whether there are any actions in the control's redo queue. To redo the most recent undo operation, call the Redo method. This is useful when enabling or disabling menu items that correspond to these commands.


CanUndo
CanUndo Property

Applies to

TRxRichEdit component

Declaration

property CanUndo: Boolean;

Description

Indicates whether the edit control contains changes that can be backed out.

Read CanUndo to determine whether the user has made any changes to the text that can be undone by calling the Undo method.  This is useful when enabling or disabling menu items that correspond to these commands.


CaretPos
CaretPos Property

Applies to

TRxRichEdit component

Declaration

property CaretPos: TPoint;

Description

Indicates the position of the caret in the client area of the rich edit control. Run-time and read only property.

Use CaretPos to determine the coordinates of the cursor. CaretPos indicates the X and Y position (in pixels) relative to the client origin of the edit control.

To determine the position of the caret in terms of characters of text rather than physical location, use the SelStart property.


DefAttributes
DefAttributes Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property DefAttributes: TRxTextAttributes;

Description

Describes the rich text characteristics of the default font for the rich edit control.

Use DefAttributes to discover or set the default font characteristics that the rich edit control uses for newly inserted text. These are the characteristics of the text before any special attributes have been applied. Once any special attributes are applied to a portion of text, no text from that point on is considered to have the default attributes, even if the attributes match the DefAttributes.

For example, if a rich edit control has had no attributes applied, the entire text has the default attributes. Selecting a portion of text in the middle and applying a specific attribute (such as a font change) results in three sections: a first section with the default attributes, a middle section with the applied attribute, and a final section with a non-default set of attributes that match the default attributes. Changing the DefAttributes property affects only the first section.

When inserting new text, the font characteristics of the new text will match the font characteristics at the cursor position, or, if the typing replaces a selection, the font characteristics of the selected text. New text will only have the default attributes when typed into the section of text that has the default attributes.

Note

DefAttributes is available only at runtime.


LangOptions
LangOptions Property

Applies to

TRxRichEdit component

Declaration

property LangOptions: TRichLangOptions;

Description

Use LangOptions property to set and get options for input method editors (IME) and Asian language support in a rich edit control 2.0.

LangOptions is a set drawn from the following values:

• rlAutoFont - If this flag is set, the control automatically changes fonts when the user explicitly changes to a different keyboard layout. Useful to turn off for universal Unicode fonts. This option is on by default.

• rlAutoKeyboard - If this flag is set, the control automatically changes the keyboard layout when the user explicitly changes to a different font, or when the user explicitly changes the insertion point to a new location in the text.

• rlImeCancelComplete - This flag determines how the control uses the composition string of an IME if the user cancels it. If this flag is set, the control discards the composition string. If this flag is not set, the control uses the composition string as the result string.

• rlImeAlwaysSendNotify - Controls how Rich Edit 2.0 notifies the client during IME composition. If this flag is not set, no OnChange or OnSelectionChange notifications during undetermined state. Send notification when final string comes in. If this flag is set, the OnChange and OnSelectionChange events occurs during undetermined state.


Paragraph
Paragraph Property

Applies to

TRxRichEdit component

Declaration

property Paragraph: TRxParaAttributes;

Description

Specifies the formatting information for the current paragraphs.

Read Paragraph to get the TRxParaAttributes object used by the rich edit control to specify paragraph formatting information. Use the TRxParaAttributes object to read or write the paragraph formatting information for the current paragraph. Paragraph formatting information includes alignment, indentation, numbering, and tabs.

Paragraph is a read-only property, because a TRxRichEdit object has only one TRxParaAttributes object, which cannot be changed. The attributes of the current paragraphs, however, can be changed, by setting the properties of the TRxParaAttributes object. These can be set one by one, or all can be set to the value of an existing TRxParaAttributes object by using Paragraph.Assign method.

The current paragraphs are the paragraphs that contain the selected text. If no text is selected, the current paragraph is the one containing the cursor.

Note

Paragraph is available only at runtime.


PlainText
PlainText Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property PlainText: Boolean;

Description

Controls whether the rich edit control treats the text as plain text or formatted rich text (RTF).


RedoName
RedoName Property

Applies to

TRxRichEdit component

Declaration

property RedoName: TUndoName;

Description

Use RedoName property to retrieve the type of the next action, if any, in the control's redo queue.

If the control's redo queue is not empty, the value returned is an TUndoName enumeration value that indicates the type of the next action in the control's redo queue.

If there are no redoable actions or the type of the next redoable action is unknown, the return value is unUnknown.

The types of actions that can be undone or redone include typing, delete, drag, drop, cut, and paste operations. This information can be useful for applications that provide an extended user interface for undo and redo operations, such as a drop-down list box of actions that can be undone.

Note

Requires Rich Edit 2.0 or later.


SelAttributes
SelAttributes Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property SelAttributes: TRxTextAttributes;

Description

Describes the rich text characteristics of the selected text in the rich edit control.

Use SelAttributes to discover or set the font characteristics of the currently selected text. SelAttributes is a TRxTextAttributes object, which specifies characteristics such as font face, color, size, style, and pitch. To change a single attribute of the currently selected text, read SelAttributes, and set one of its properties. To change all of the attributes of the currently selected text, set SelAttributes to a TRxTextAttributes object that represents the desired configuration of attributes. If no text is selected, SelAttributes represents the attributes of the cursor position.

When inserting new text, the font characteristics of the new text will match SelAttributes.

Note

SelAttributes is available only at runtime.


SelectionBar
SelectionBar Property

Applies to

TRxRichEdit component

Declaration

property SelectionBar: Boolean;

Description

Свойство определяет, оставлять ли в левой части редактора специальную полосу, не занятую текстом, в которой пользователь может выделять при помощи мыши целые строки или параграфы текста. Значение по умолчанию - True.


SelectionType
SelectionType Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property SelectionType: TRichSelectionType;

Description

SelectionType determines the current selection type for a rich edit control. Run-time and read-only property.

If the selection is empty, the return value is empty set.

If the selection is not empty, the return value is a set of flags containing one or more of the following values:

• stText - Text;

• stObject - At least one OLE object;

• stMultiChar - More than one character of text;

• stMultiObject - More than one OLE object.


StreamFormat
StreamFormat Property

Applies to

TRxRichEdit component

Declaration

property StreamFormat: TRichStreamFormat;

Description

Свойство определяет, в каком формате rich edit control будет осуществлять чтение из потока и запись в поток текста.

Если StreamFormat = sfDefault, для определения формата чтения/записи (RTF или plain-text) используется значение свойства PlainText.

Дополнительные параметры чтения/записи в поток могут быть заданы при помощи свойства StreamMode.


StreamMode
StreamMode Property

Applies to

TRxRichEdit component

Declaration

property StreamMode: TRichStreamModes;

Description

Свойство определяет дополнительные флаги для чтения/записи в поток содержимого элемента управления rich edit. Возможные значения этого свойства и их значение:

- smSelection - при установке этого флага методы LoadFromFile, SaveToFile будут записывать или заменять только выделенный текст.

- smPlainRtf - при установке этого флага все зависимые от конкретного языка ключи в формате RTF игнорируются при чтении/записи.

- smNoObjects - используется только при записи текста. При установке этого флага OLE-объекты, включенные в текст, в формате RTF не сохраняются - на их место вставляются пробелы.

- smUnicode - используется только если StreamFormat определяет запись/чтение простого текста (plain-text). При утановке этого флага текст считывается/записывается в формате Unicode.


TRxRichEdit.Title
Title Property

Applies to

TRxRichEdit component

Declaration

property Title: string;

Description

Defines the "host name" to be given to OLE-objects as they are inserted to a rich edit control. The host name is used in the user interface of servers to describe the container context of opened OLE-objects.


UndoLimit
UndoLimit Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property UndoLimit: Integer;

Description

Specifies the maximum number of actions that can be stored in the undo queue.

By default, the maximum number of actions in the undo queue is 100. If you increase this number, there must be enough available memory to accommodate the new number. For better performance, set the limit to the smallest possible value.

Setting the limit to zero disables the Undo feature.

Note

Requires Rich Edit 2.0 or later.


UndoName
UndoName Property

Applies to

TRxRichEdit component

Declaration

property UndoName: TUndoName;

Description

Use UndoName property to retrieve the type of the next undo action, if any.

If there is an undo action, the value returned is an TUndoName enumeration value that indicates the type of the next action in the control's undo queue.

If there are no actions that can be undone or the type of the next undo action is unknown, the return value is unUnknown.

The types of actions that can be undone or redone include typing, delete, drag, drop, cut, and paste operations. This information can be useful for applications that provide an extended user interface for undo and redo operations, such as a drop-down list box of actions that can be undone.

Note

Requires Rich Edit 2.0 or later.


WordAttributes
WordAttributes Property

Applies to

TRxRichEdit component

Declaration

property WordAttributes: TRxTextAttributes;

Description

Describes the rich text characteristics of the word at the caret in the rich edit control.

Use WordAttributes to discover or set the font characteristics of the current word (word at caret). WordAttributes is a TRxTextAttributes object, which specifies characteristics such as font face, color, size, style, pitch etc. To change a single attribute of the current word, read WordAttributes, and set one of its properties. To change all of the attributes of the current word, set WordAttributes to a TRxTextAttributes object that represents the desired configuration of attributes.

Note

WordAttributes is available only at runtime.


WordSelection
WordSelection Property

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property WordSelection: Boolean;

Description

Specifies to have TRxRichEdit highlight one word at a time as user drag the mouse over text. To highlight one character at a time, set WordSelection property to False.


OnCloseFindDialog
OnCloseFindDialog Event

Applies to

TRxRichEdit component

Declaration

property OnCloseFindDialog: TRichEditFindCloseEvent;

Description

Событие возникает при закрытии диалога поиска/замены текста, вызванного методами FindDialog или ReplaceDialog.


OnTextNotFound
OnTextNotFound Event

Applies to

TRxRichEdit component

Declaration

property OnTextNotFound: TRichEditFindErrorEvent;

Description

Событие возникает, когда пользователь вызвал диалог поиска/замены текста методами FindDialog или ReplaceDialog, и заданная им для поиска строка не найдена в тексте редактора. Срока поиска передается в качестве параметра FindText.


OnURLClick
OnURLClick Event

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

property OnURLClick: TRichEditURLClickEvent;

Description

OnURLClick event occurs when the user clicks left or right mouse button on URL.

The URLText parameter contains text string with selected URL.

Note

Requires Rich Edit 2.0 or later.


ClearUndo
ClearUndo Method

Applies to

TRxRichEdit component

Declaration

procedure ClearUndo;

Description

Clears the undo buffer so that no changes to the text can be backed out.

Use ClearUndo to commit changes to the Lines property. After calling ClearUndo, the CanUndo property is False and the Undo method does nothing.


TRxRichEdit.FindDialog
FindDialog Method

Applies to

TRxRichEdit component

Declaration

function FindDialog(const SearchStr: string): TFindDialog;

Description

Метод вызывает появление стандартного диалога TFindDialog для поиска текста в редакторе TRxRichEdit. После поиска текста найденная строка становится выделенной (selected) в редакторе; если текст не найден, происходит событие OnTextNotFound.


TRxRichEdit.FindNext
FindNext Method

Applies to

TRxRichEdit component

Declaration

function FindNext: Boolean;

Description

Метод используется для повторного поиска или замены текста в редакторе после вызова стандартного диалога поиска/замены методами FindDialog или ReplaceDialog. Может быть вызван из обработчика события OnClick соответтвующего пункта меню (например, "Edit | Find Next...").


FindText
FindText Method

Applies to

TRxRichEdit, TRxDBRichEdit components

Declaration

function FindText(const SearchStr: string; StartPos, Length: Integer; Options: TRichSearchTypes): Integer;

Description

Searches a given range in the text for a target string.

Use FindText to search a range of text in a rich edit control for the string specified by the SearchStr parameter. Only the text in the range starting at the position StartPos and continuing through the next Length positions will be searched. Use Options to specify whether the search should match whole words only, whether the search should be case sensitive, whether the search should be backward (only fo rich edit 2.0), and whether the string found should be selected.  FindText returns the position of the search string, where 0 is the position of the first character in the rich edit control (as opposed to the first position in the search range).  If the search string does not appear in the indicated range, FindText returns -1.

Use FindText rather than programmatically searching through the text of the control, to keep from being thrown off by the encoding of rich text characteristics.


GetCharPos
GetCharPos Method

Applies to

TRxRichEdit component

Declaration

function GetCharPos(CharIndex: Integer): TPoint;

Description

Retrieves the coordinates of the specified character in a rich edit control.

If the CharIndex is greater than the index of the last character in the control, the returned coordinates are of the position just past the last character of the control. The coordinates are relative to the upper-left corner of the rich edit control's client area.


GetTextRange
GetTextRange Method

Applies to

TRxRichEdit component

Declaration

function GetTextRange(StartPos, EndPos: Longint): string;

Description

The GetTextRange function returns a specified range of characters from a rich edit control. Use StartPos and EndPos parameters to specify the range of characters to retrieve.


InsertObjectDialog
InsertObjectDialog Method

Applies to

TRxRichEdit component

Declaration

function InsertObjectDialog: Boolean;

Description

Displays the Insert Object OLE dialog box.

Call InsertObjectDialog to let the user create an OLE object. The OLE object can be embedded or linked. InsertObjectDialog returns True if the dialog box was successfully displayed and the user chose the OK button. InsertObjectDialog returns False otherwise. If the user chose OK then InsertObjectDialog method inserts an object into a rich edit control and the selection is replaced with the new OLE-object.

Note

If AllowObjects is Flase this method simply returns False without any actions.


PasteSpecialDialog
PasteSpecialDialog Method

Applies to

TRxRichEdit component

Declaration

function PasteSpecialDialog: Boolean;

Description

Displays the Paste Special OLE dialog box.

Call PasteSpecialDialog to let the user control how the contents of the Windows clipboard are pasted into the rich edit control. The Paste Special dialog box lets the user select the format of the data and whether the OLE object should be displayed as an icon (and if so, to choose a different icon). PasteSpecialDialog returns True if the dialog box was successfully displayed and the user chose the OK button. It returns False otherwise.

Note

If AllowObjects is Flase this method simply returns False without any actions.


Redo
Redo Method

Applies to

TRxRichEdit component

Declaration

procedure Redo;

Description

Call Redo method to redo the next action in the rich edit 2.0 control's redo queue.

To determine whether there are any actions in the control's redo queue, check CanRedo property.


TRxRichEdit.RegisterConversionFormat
RegisterConversionFormat Method

Applies to

TRxRichEdit component

Declaration

class procedure RegisterConversionFormat(const AExtension: string; APlainText: Boolean; AConversionClass: TConversionClass);

Description

Registers an association between a file extension and a TConversion object that can convert between the native file format and rich text format (RTF).

Rich edit controls encode text attributes in RTF format. To read from or write to files that encode text attributes in some other format, a converter is required. The converter is a descendant of TConversion that translates between the native file format and RTF when the text is streamed in or out. RegisterConversionFormat sets up an association between a file extension and a converter, so that all attempts to stream between a file with that extension and a rich edit control automatically invoke the appropriate converter.


TRxRichEdit.ReplaceDialog
ReplaceDialog Method

Applies to

TRxRichEdit component

Declaration

function ReplaceDialog(const SearchStr, ReplaceStr: string): TReplaceDialog;

Description

Метод вызывает появление стандартного диалога TReplaceDialog для поиска и замены текста в редакторе TRxRichEdit.

Если текст не найден, происходит событие OnTextNotFound.


StopGroupTyping
StopGroupTyping Method

Applies to

TRxRichEdit component

Declaration

procedure StopGroupTyping;

Description

Use StopGroupTyping to stop the rich edit 2.0 control from collecting additional typing actions into the current undo action. The control stores the next typing action, if any, into a new action in the undo queue.

A TRxRichEdit control groups consecutive typing actions, including characters deleted by using the BACKSPACE key, into a single undo action until one of the following events occurs:

• The StopGroupTyping method is called or the control receives an EM_STOPGROUPTYPING message.

• The control loses focus.

• The user moves the current selection, either by using the arrow keys or by clicking the mouse.

• The user presses the DELETE key.

• The user performs any other action that is not typing, such as a paste operation.

You can call StopGroupTyping method to break consecutive typing actions into smaller undo groups. For example, you could call StopGroupTyping after each character or at each word break.


Undo
Undo Method

Applies to

TRxRichEdit component

Declaration

procedure Undo;

Description

Backs out all changes in the undo buffer.

To determine whether there are any changes in the undo buffer, check the CanUndo property.

Call ClearUndo to clear undo buffer of an edit control.


TRxTextAttributes object
TRxTextAttributes Class

Hierarchy             See also             Properties             Methods

Unit

RxRichEd

Description

TRxTextAttributes represents the font characteristics of a section of text in a rich edit control.

TRxTextAttributes includes a number of properties that describe the font characteristics of some text in a rich text document. TRxTextAttributes is tailored to allow a descendant of TRxRichEdit to read and write the default text characteristics (via its DefAttributes property) or the characteristics of the selected text (via its SelAttributes and WordAttributes properties). The properties of a TRxTextAttributes object are invalid unless it is owned by a descendant of TRxCustomRichEdit.

Many of the font characteristics represented by a TRxTextAttributes object are the same as the properties of a TFont object with the same names. Applications can assign fonts to text attributes and vice versa.


TRxTextAttributes See Also
See also

TParaAttributes

TRichEdit

TRxParaAttributes

TRxRichEdit

TTextAttributes


TRxTextAttributes Hierarchy
Hierarchy

TObject

  |

TPersistent


TRxTextAttributes properties
Properties

Run-time only    [image] Key properties

BackColor	Hidden	RevAuthorIndex
Charset	Link	Size
Color	Name	Style
ConsistentAttributes	Offset	SubscriptStyle
Disabled	Pitch	UnderlineType
Height	Protected


TRxTextAttributes methods
Methods

Key methods

Assign	Create	Destroy


TRxTextAttributes.BackColor
BackColor Property

Applies to

TRxTextAttributes component

Declaration

property BackColor: TColor;

Description

Indicates the background color of the text.

Use BackColor to indicate the background color of the actual characters. If this property is clWindow or clDefault then the background color is a property of the rich edit control that uses the TRxTextAttributes object, and should be set by the Color property of the rich edit control.

Note

Requires Rich Edit 2.0 or later.


TRxTextAttributes.Charset
Charset Property

Applies to

TRxTextAttributes component

Declaration

property Charset: TFontCharset;

Description

Specifies the character set of the font.

Set Charset to identify the character set of the font. Each typeface (specified by the Name property) supports one or more character sets. Check the information supplied by the font vendor to determine what values of Charset are valid.


TRxTextAttributes.Color
Color Property

Applies to

TRxTextAttributes component

Declaration

property Color: TColor;

Description

Indicates the foreground color of the text.

Use Color to indicate the color of the actual characters. The background color should be set by the BackColor property of the TRxTextAttribute.


TRxTextAttributes.ConsistentAttributes
ConsistentAttributes Property

Applies to

TRxTextAttributes component

Declaration

property ConsistentAttributes: TRxConsistentAttributes;

Description

Indicates which of the properties of the TRxTextAttributes object are consistent throughout the text of the current selection in the rich edit object.

Read the ConsistentAttributes of the SelAttributes or WordAttributes properties of a rich text object to discover which of the properties of the TRxTextAttributes are meaningful for the current selection or current word (word at caret). This information is relevant if you want to then read the text characteristics of the current selection. Setting a property of TRxTextAttributes will cause that property to become a consistent attribute until the selection changes.

ConsistentAttributes is a set drawn from the following values:

• caBold - Characters are consistently either bold or not bold throughout the selection.

• caColor - The color of character font is consistent throughout the selection.

• caFace - The typeface of the character font is consistent throughout the selection.

• caItalic - Characters are consistently either italic or not italic throughout the selection.

• caSize - The size of the character font is consistent throughout the selection.

• caStrikeout - Characters consistently either have the strikeout style or they do not have the strikeout style throughout the selection.

• caUnderline - Characters are consistently either underlined or not underlined throughout the selection.

• caProtected - Text is consistently either protected or not protected.

• caOffset - The offset of the character from the baseline is consistent throughout the selection.

• caHidden - Text is consistently either hidden or not hidden.

• caLink - Characters are consistently either have or have not "link" effect throughout the selection.

• caBackColor - The background color of character is consistent throughout the selection.

• caDisabled - Text is consistently either disabled or not disabled.

• caSubscript - The subscription style of the character font is consistent throughout the selection.

• caRevAuthor - The index that identifies the author making a revision is consistent throughout the selection.

Note

Use ConsistentAttributes with the SelAttributes or WordAttributes properties of the rich edit control. The ConsistentAttributes of the DefAttributes property of the rich edit control is the empty set, even though all attributes are consistent in the section of text that has the default attributes.


TRxTextAttributes.Disabled
Disabled Property

Applies to

TRxTextAttributes component

Declaration

property Disabled: Boolean;

Description

Indicates whether the text represented by the TRxTextAttributes object is disabled.

Note

Requires Rich Edit 2.0 or later.


TRxTextAttributes.Height
Height Property

Applies to

TRxTextAttributes component

Declaration

property Height: Integer;

Description

Specifies the height of the font in pixels.

To specify a font height in pixels, use the Height property. To specify the size of the font in points instead, use the Size property. Users usually specify font size in points within an application, while programmers are often concerned with the actual size of the font in pixels when displaying a font on the screen.

The relationship between the Height and Size properties is expressed by the formula:

 Height = Size * ScreenPixelsPerInch / 72

Note

Unlike the Height property of a TFont object, the Height property of a TRxTextAttributes object always includes the internal leading that appears at the top of the font.


TRxTextAttributes.Hidden
Hidden Property

Applies to

TRxTextAttributes component

Declaration

property Hidden: Boolean;

Description

Indicates whether the text represented by the TRxTextAttributes object is hidden. Does not affect how the rich edit control displays the text.


TRxTextAttributes.Link
Link Property

Applies to

TRxTextAttributes component

Declaration

property Link: Boolean;

Description

Indicates whether the text represented by the TRxTextAttributes object has "link" effect.

The control highlights the "link" string by underlining it and setting the text color. A rich edit control sends the OnURLClick event when the user click mouse button over text that has the Link effect.

Note that when automatic URL detection is enabled (property AutoURLDetect is True), the rich edit control removes the Link effect from modified text that does not have a URL format recognized by the control. If your application uses the Link effect to mark other types of text, do not enable automatic URL detection.

Note

Requires Rich Edit 2.0 or later.


TRxTextAttributes.Name
Name Property

Applies to

TRxTextAttributes component

Declaration

property Name: TFontName;

Description

Specifies the typeface of the font described by the TRxTextAttributes object.

Use Name to specify the typeface of the font. Typefaces are strings of up to 32 characters used by Windows to identify a font. The Name is the identifier for the font that most font selection controls show.


TRxTextAttributes.Offset
Offset Property

Applies to

TRxTextAttributes component

Declaration

property Offset: Integer;

Description

Specifies the character offset, in points, from the baseline.

If this member is positive, the character is a superscript; if it is negative, the character is a subscript.

In rich edit control 2.0 or higher use SubscriptStyle property instead.


TRxTextAttributes.Pitch
Pitch Property

Applies to

TRxTextAttributes component

Declaration

property Pitch: TFontPitch;

Description

Specifies whether the characters in the font all have the same width.

Each typeface has an associated pitch. The characters in fixed-pitch fonts are all the same width. The characters in variable-pitch fonts differ in width. Fixed pitch fonts are generally used for representing source code, because they allow the indentation to line up properly. Variable pitch fonts are generally used to give text a more natural appearance.


TRxTextAttributes.Protected
Protected Property

Applies to

TRxTextAttributes component

Declaration

property Protected: Boolean;

Description

Indicates whether the text represented by the TRxTextAttributes object is protected.

Protected text can’t be changed by the user. When the user attempts to edit a selection that includes protected text, the rich edit control calls the OnProtectChange event handler. The OnProtectChange event handler can then permit or disallow the editing of the protected text. If there is no OnProtectChange event handler, protected text is read-only.


TRxTextAttributes.RevAuthorIndex
RevAuthorIndex Property

Applies to

TRxTextAttributes component

Declaration

property RevAuthorIndex: Byte;

Description

Specifies an index that identifies the author making a revision. The rich edit control uses different text colors for each different author index.

Note

Requires Rich Edit 2.0 or later.


TRxTextAttributes.Size
Size Property

Applies to

TRxTextAttributes component

Declaration

property Size: Integer;

Description

Specifies the height of the font in points.

To specify a font height in points, use the Size property. To specify the size of the font in pixels instead, use the Height property. Users usually specify font size in points within an application, while programmers are usually concerned with the actual size of the font in pixels when displaying a font on the screen.

The relationship between the Height and Size properties is expressed by the formula:

 Size = Height * 72 / ScreenPixelsPerInch

Note

Unlike the Size property of a TFont object, the Size property of a TRxTextAttributes object always omits the internal leading that appears at the top of the font.


TRxTextAttributes.Style
Style Property

Applies to

TRxTextAttributes component

Declaration

property Style: TFontStyles;

Description

Determines whether the font is normal, italic, underlined, bold, or strikeout.


TRxTextAttributes.SubscriptStyle
SubscriptStyle Property

Applies to

TRxTextAttributes component

Declaration

property SubscriptStyle: TSubscriptStyle;

Description

Indicates whether the text represented by the TRxTextAttributes object is normal, subscript or superscript.

Here are the possible values for SubscriptStyle:

• ssNone - characters are normal

• ssSubscript - characters are subscript.

• ssSuperscript - characters are superscript.

For both ssSubscript and ssSuperscript values, the control automatically calculates an offset and a smaller font size. Alternatively, you can use the Height and Offset properties to explicitly specify font size and offset for subscript and superscript characters.

Note

Requires Rich Edit 2.0 or later.


TRxTextAttributes.UnderlineType
UnderlineType Property

Applies to

TRxTextAttributes component

Declaration

property UnderlineType: TUnderlineType;

Description

Specifies the underline type. Valid only for characters which have fsUnderline flag in the Style property.

This property can be one of the following values:

• utNone - No underline.

• utSolid - Solid underline.

• utWord - Underline words only. The rich edit control displays the text with a solid underline.

• utDouble - Double-underlined text. The rich edit control displays the text with a solid underline.

• utDotted - Dotted-underlined text. The rich edit versions earlier than 3.0 displayed the text with a solid underline.

• utWave - Wave-underlined text. The rich edit control displays the text with a solid underline.

Note

Requires Rich Edit 2.0 or later.


RichEditVersion Constant

Unit

RxRichEd

Declaration

const

  RichEditVersion: TRichEditVersion;

Description

RichEditVersion indicates which version of rich edit control DLL is installed.

The appearance and behavior of rich edit control varies depending on which version of rich edit library (riched32.dll or riched20.dll) is installed. Use RichEditVersion variable to determine which version is installed.

Windows NT

Microsoft® Windows NT® version 4.0 ships rich edit libraries 1.0 and 2.0. Windows NT version 5.0 ships rich edit library 3.0 with Rich Edit 1.0 emulation.

Windows 95

Microsoft® Windows® 95 ships only Riched32.dll. However, Riched20.dll is compatible with Windows 95 and may be present if an application that uses Rich Edit 2.0 has been installed on the system.

Windows 98

Microsoft® Windows® 98 ships Riched32.dll and Riched20.dll. This Riched20.dll is the Rich Edit 2.0 version.


TLineSpacingRule Type

Unit

RxRichEd

Declaration

type

TLineSpacingRule = (lsSingle, lsOneAndHalf, lsDouble, lsSpecifiedOrMore, lsSpecified, lsMultiple);

Description

Тип задает возможные значения свойства LineSpacingRule класса TRxParaAttributes.


TParaAlignment Type

Unit

RxRichEd

Declaration

type

TParaAlignment = (paLeftJustify, paRightJustify, paCenter, paJustify);

Description

Тип задает возможные значения свойства Alignment класса TRxParaAttributes.


TRichEditFindCloseEvent Type

Unit

RxRichEd

Declaration

type

TRichEditFindCloseEvent = procedure(Sender: TObject; Dialog: TFindDialog) of object;

Description

Тип опеределяет метод - обработчик события OnCloseFindDialog компонент TRxRichEdit и TRxDBRichEdit.

Существует только в версии для Delphi 3.0 и выше.


TRichEditFindErrorEvent Type

Unit

RxRichEd

Declaration

type

TRichEditFindErrorEvent = procedure(Sender: TObject; const FindText: string) of object;

Description

Тип опеределяет метод - обработчик события OnTextNotFound компонент TRxRichEdit и TRxDBRichEdit.


TRichEditURLClickEvent Type

Unit

RxRichEd

Declaration

type

TRichEditURLClickEvent = procedure(Sender: TObject; const URLText: string; Button: TMouseButton) of object;

Description

Тип опеределяет метод - обработчик события OnURLClick компонент TRxRichEdit и TRxDBRichEdit.


TRichEditVersion Type

Unit

RxRichEd

Declaration

type

TRichEditVersion = 1..3;

Description

Тип определяет возможные значения версии библиотеки (DLL), содержащей элемент управления Rich Edit.


TRichLangOption Type

Unit

RxRichEd

Declaration

type

TRichLangOption = (rlAutoKeyboard, rlAutoFont, rlImeCancelComplete, rlImeAlwaysSendNotify);

Description

Тип определяет возможные значения свойства LangOptions компонент TRxRichEdit и TRxDBRichEdit.


TRichLangOptions Type

Unit

RxRichEd

Declaration

type

TRichLangOptions = set of TRichLangOption;

Description

Тип определяет возможные значения свойства LangOptions компонент TRxRichEdit и TRxDBRichEdit.


TRichSearchType Type

Unit

RxRichEd

Declaration

type

TRichSearchType = (stWholeWord, stMatchCase, stBackward, stSetSelection);

Description

Тип задает возможные значения для параметра Options метода FindText компонент TRxRichEdit и TRxDBRichEdit.


TRichSearchTypes Type

Unit

RxRichEd

Declaration

type

TRichSearchTypes = set of TRichSearchType;

Description

Тип определяет значения параметра Options метода FindText компонент TRxRichEdit и TRxDBRichEdit.


TRichSelection Type

Unit

RxRichEd

Declaration

type

TRichSelection = (stText, stObject, stMultiChar, stMultiObject);

Description

Тип задает возможные значения для свойства SelectionType компонент TRxRichEdit и TRxDBRichEdit.


TRichSelectionType Type

Unit

RxRichEd

Declaration

type

TRichSelectionType = set of TRichSelection;

Description

Тип определяет значения свойства SelectionType компоненты TRxRichEdit.


TRichStreamFormat Type

Unit

RxRichEd

Declaration

type

TRichStreamFormat = (sfDefault, sfRichText, sfPlainText);

Description

Тип задает возможные значения свойства StreamFormat компонент TRxRichEdit и TRxDBRichEdit.


TRichStreamMode Type

Unit

RxRichEd

Declaration

type

TRichStreamMode = (smSelection, smPlainRtf, smNoObjects, smUnicode);

Description

Тип задает возможные значения для свойства StreamMode компонент TRxRichEdit и TRxDBRichEdit.


TRichStreamModes Type

Unit

RxRichEd

Declaration

type

TRichStreamModes = set of TRichStreamMode;

Description

Тип задает значения свойства StreamMode компонент TRxRichEdit и TRxDBRichEdit.


TRxConsistentAttribute Type

Unit

RxRichEd

Declaration

type

TRxConsistentAttribute = (caBold, caColor, caFace, caItalic, caSize, caStrikeOut, caUnderline, caProtected, caOffset, caHidden, caLink, caBackColor, caDisabled, caWeight, caSubscript, caRevAuthor);

Description

Тип задает возможные значения свойства ConsistentAttributes класса TRxTextAttributes.


TRxConsistentAttributes Type

Unit

RxRichEd

Declaration

type

TRxConsistentAttributes = set of TRxConsistentAttribute;

Description

Тип определяет значения свойства ConsistentAttributes класса TRxTextAttributes.


TRxNumbering Type

Unit

RxRichEd

Declaration

type

TRxNumbering = (nsNone, nsBullet, nsArabicNumbers, nsLoCaseLetter, nsUpCaseLetter, nsLoCaseRoman, nsUpCaseRoman);

Description

Тип задает возможные значения свойства Numbering класса TRxParaAttributes.


TRxNumberingStyle Type

Unit

RxRichEd

Declaration

type

TRxNumberingStyle = (nsParenthesis, nsPeriod, nsEnclosed, nsSimple);

Description

Тип задает возможные значения свойства NumberingStyle класса TRxParaAttributes.


TSubscriptStyle Type

Unit

RxRichEd

Declaration

type

TSubscriptStyle = (ssNone, ssSubscript, ssSuperscript);

Description

Тип задает возможные значения свойства SubscriptStyle класса TRxTextAttributes.


TUnderlineType Type

Unit

RxRichEd

Declaration

type

TUnderlineType = (utNone, utSolid, utWord, utDouble, utDotted, utWave);

Description

Тип задает возможные значения свойства UnderlineType класса TRxTextAttributes.


TUndoName Type

Unit

RxRichEd

Declaration

type

TUndoName = (unUnknown, unTyping, unDelete, unDragDrop, unCut, unPaste);

Description

Тип задает возможные значения свойств UndoName и RedoName компонент TRxRichEdit и TRxDBRichEdit.


RxShell Unit

The RxShell unit contains the declarations for the certain components on the RX Tools 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 RxShell unit:

Components and objects

TRxTrayIcon

Types

TExecState

Procedures and functions

FileExecute

FileExecuteWait

IconExtract

WinAbout

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


TRxTrayIcon Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxShell

Description

Компонента TRxTrayIcon предназначена для отображения иконки, заданной свойством Icon, в системной области (tray) панели задач (TaskBar) Windows95 или Windows NT 4.0 и старше. Иконка может быть статической (задается свойством Icon) либо анимированной (при задании значения свойству Icons и установке свойства Animated в значение True) - в этом случае частота смены изображения иконки задается свойством Interval.

Вы можете показывать и скрывать иконку, изменяя значение свойства Active. Свойство Hint задает текстовую строку, которая появляется над иконкой, когда вы останавливаете над ней мышь. Для тестирования компоненты в режиме дизайна Вы можете отобразить иконку в системной области панели задач, установив свойство ShowDesign в True.

Вы можете задать значение свойства PopupMenu - заданное вами меню (при значении его свойства AutoPopup = True) будет появляться при нажатии правой кнопки мыши на иконке в системной области. Если это меню имеет пункт "по-умолчанию" (со значением свойства Default = True, только в 32-битной версии), то при двойном нажатии левой кнопки мыши будет вызван метод Click этого пункта меню. Вы можете также самостоятельно обработать события от мыши за счет использования обработчиков событий OnClick, OnDblClick и др., если не были вызваны обработчики по-умолчанию.


TRxTrayIcon See Also
See also

TForm

TIcon

TIconList


TRxTrayIcon Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxTrayIcon properties
Properties

Run-time only    [image] Key properties

Active	Hint	Owner
Animated	Icon	PopupMenu
ComponentCount	Icons	ShowDesign
ComponentIndex	Interval	Tag
Components	Name


TRxTrayIcon events
Events

Run-time only    [image] Key events

OnClick	OnMouseDown	OnMouseUp
OnDblClick	OnMouseMove


TRxTrayIcon methods
Methods

Key methods

Create	FindComponent	RemoveComponent
Destroy	InsertComponent


TRxTrayIcon.Active
Active Property

Applies to

TRxTrayIcon component

Declaration

property Active: Boolean;

Description

Свойство позволяет показывать и скрывать иконку, заданную свойством Icon, в системной области TaskBar'а (панели задач) Windows. Изменение значения свойства имеет эффект во время выполнения приложения.

Если свойство Animated установлено в True, и задано значение свойству Icons, то отображается анимированная иконка, в противном случае изображается статическая иконка, заданная свойством Icon. Для тестирования при разработке (в режиме дизайна) вы можете отобразить иконку в системной области панели задач, установив свойство ShowDesign в значение True.


TRxTrayIcon.Animated
Animated Property

Applies to

TRxTrayIcon component

Declaration

property Animated: Boolean;

Description

Если свойство Animated установлено в True, и задано значение свойству Icons, то (при Active = True в run-time или ShowDesign = True в design-time) в tray-области изображается анимированная иконка, в противном случае изображается статическая иконка, заданная свойством Icon.


TRxTrayIcon.Icons
Icons Property

Applies to

TRxTrayIcon component

Declaration

property Icons: TIconList;

Description

Свойство задает список иконок, используемый для отображения анимированной иконки в tray-области.

Если свойство Animated установлено в True, и задано значение свойству Icons, то отображается анимированная иконка, в противном случае изображается статическая иконка, заданная свойством Icon.

Редактор свойства Icons позволяет Вам загрузить набор иконок из анимированного курсора Windows (ANI-файла).


ShowDesign
ShowDesign Property

Applies to

TRxTrayIcon component

Declaration

property ShowDesign: Boolean;

Description

Свойство позволяет показывать и скрывать иконку, заданную свойством Icon или Icons (при Animated = True), в системной (tray) области TaskBar'а (панели задач) Windows во время разработки приложения (в режиме дизайна). В run-time присвоение значения свойству игнорируется.


TRxTrayIcon.OnClick
OnClick Event

Applies to

TRxTrayIcon component

Declaration

property OnClick: TMouseEvent;

Description

Событие OnClick вызывается при нажатии одной из кнопок мыши (левой или правой) на иконке, отображаемой в системной области (tray) панели задач (TaskBar) Windows95 или Windows NT 4.x.


TExecState Type

Unit

RxShell

Declaration

type

TExecState = (esNormal, esMinimized, esMaximized, esHidden);

Description

Тип определяет возможные значения параметра InitialState в функциях FileExecute и FileExecuteWait.


FileExecute Function

Examples

Unit

RxShell

Declaration

function FileExecute(const FileName, Params, StartDir: string; InitialState: TExecState): THandle;

Description

The FileExecute function opens a specified file. The file can be an executable file or a document file. If FileName specifies an executable file, Params is a string that specifies parameters to be passed to the application. StartDir specifies the default directory. If FileName specifies an executable file, InitialState specifies how the application is to be shown when it is opened. This parameter can be one of the following values: esNormal, esMinimized, esMaximized or esHide.

If the function succeeds, the return value is the instance handle of the application that was run. If the function fails, the return value is an error value that is less than or equal to 32.


FileExecute example
Example

if FileExecute('NOTEPAD.EXE', '', 'C:\', esNormal) <= 32 then

  ShowMessage('Can't start NOTEPAD.EXE');


FileExecuteWait Function

Examples

Unit

RxShell

Declaration

function FileExecuteWait(const FileName, Params, StartDir: string; InitialState: TExecState): Integer;

Description

Функция полностью аналогична функции FileExecute, но в отличие от нее приостанавливает выполнение вызвавшего ее потока до завершения запущенного приложения.

В случае ошибки выполнения возвращаемое значение равно -1. При успешном выполнении приложения в 32-битной версии возвращаемое значение содержит код возврата отработавшего приложения.


FileExecuteWait example
Example

  if FileExecuteWait('NOTEPAD.EXE', 'readme.txt', 'C:\', esNormal) = -1 then

    ShowMessage('Can not start NOTEPAD.EXE');


IconExtract Function

Examples

Unit

RxShell

Declaration

function IconExtract(const FileName: string; Id: Integer): TIcon;

Description

Функция создает объект класса TIcon из ресурсов исполнимого файла FileName. Параметр ID задает порядковый номер иконки в файле. После использования вы должны уничтожить созданный объект, вызвав его метод Free.


IconExtract example
Example

 var

   Ico: TIcon;

 begin

   Ico := IconExtract('PROGMAN.EXE', 0);

   try

     { use icon }

   finally

     Ico.Free;

   end;

 end;


WinAbout Procedure

Examples

Unit

RxShell

Declaration

procedure WinAbout(const AppName, Stuff: string);

Description

Процедура вызывает стандартное диалоговое окно "About" системы Microsoft Windows.

Параметр AppName  задает текст, который будет отображаться в заголовке окна и в первой строке после текста "Microsoft Windows" или "Microsoft Windows NT." Если этот текст содержит символ "#", разделяющий его на 2 части, процедура отображает первую часть текста в заголовке окна, а вторую после слов "Microsoft Windows" или "Microsoft Windows NT".

Параметр Stuff - текст, отображаемый в диалоге About после информации о версии и авторских правах.


WinAbout example
Example

WinAbout('Delphi Demo Application', 'Borland Int., 1995');


RxSlider Unit

The RxSlider 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 RxSlider unit:

Components and objects

TRxSlider

Types

TNumThumbStates

TSliderOption

TSliderOptions

TSliderOrientation

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


TRxSlider Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxSlider

Description

Компонента TRxSlider является реализацией "ползункового" элемента управления, пр умолчанию имеющей вид сходного элемента Windows 95, для выбора одного значения из заданного диапазона с заданным шагом изменения.

Он состоит из направляющей - "линейки" и ползунка, перемещаемого вдоль направляющей. Крайние положения ползунка соответствуют значениям, задаваемыми свойствами MinValue и MaxValue, текущее положение ползунка соответствует свойству Value. Перемещение ползунка пользователем меняет значение Value, в свою очередь, программное присвоение свойству Value передвигает ползунок.

Элемент может иметь горизонтальную и вертикальную ориентацию, контролируемую свойством Orientation.

Внешний вид элемента может быть изменен с помощью свойств ImageHThumb, ImageHRuler, ImageVThumb, ImageVRuler типа TBitmap, отвечающих соответственно за горизонтальное и вертикальное изображение ползунка и направляющей.


TRxSlider See Also
See also

TSliderOptions

TSliderOrientation


TRxSlider Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl


TRxSlider properties
Properties

Run-time only    [image] Key properties

Align	Hint	Parent
BevelStyle	ImageHRuler	ParentColor
Canvas	ImageHThumb	ParentShowHint
Color	ImageVRuler	ShowHint
ComponentCount	ImageVThumb	Showing
ComponentIndex	Increment	TabOrder
Components	Left	TabStop
Cursor	MaxValue	Tag
DragCursor	MinValue	Top
DragMode	Name	Value
EdgeSize	NumThumbStates	Visible
Enabled	Options	Width
Height	Orientation
HelpContext	Owner


TRxSlider events
Events

Run-time only    [image] Key events

OnChange	OnDrawPoints	OnMouseDown
OnClick	OnEndDrag	OnMouseMove
OnDblClick	OnKeyDown	OnMouseUp
OnDragDrop	OnKeyPress	OnStartDrag
OnDragOver	OnKeyUp


TRxSlider methods
Methods

Key methods

BeginDrag	FindComponent	ScreenToClient
BringToFront	Hide	SendToBack
ClientToScreen	InsertComponent	SetBounds
Create	Invalidate	SetFocus
DefaultDrawPoints	Perform	Show
Destroy	Refresh	Update
Dragging	RemoveComponent
EndDrag	Repaint


TRxSlider.BevelStyle
BevelStyle Property

Applies to

TRxSlider component

Declaration

property BevelStyle: TPanelBevel;

Description

BevelStyle determines the style of the bevel of a slider.

Use BevelStyle to provide the slider with a three-dimensional bevelled look.

These are the possible values:

• bvNone - no bevel exists.

• bvLowered - the bevel is lowered.

• bvRaised - the bevel is raised.


EdgeSize
EdgeSize Property

Applies to

TRxSlider component

Declaration

property EdgeSize: Integer;

Description

Число, которое задает число пикселей, отводимых под края для изображения направляющей слайдера (ImageHRuler или ImageVRuler).

Требуется для формирования изображения направляющей требуемого (переменного) размера.

Например, при горизонтальной ориентации, картинка направляющей составляется из левой части ImageHRuler шириной в EdgeSize пикселей; повторенной необходимое число раз "серединной" частью ImageHRuler (не включая EdgeSize пикселей слева и справа); правой части ImageHRuler шириной EdgeSize пикселей.


ImageHRuler
ImageHRuler Property

Applies to

TRxSlider component

Declaration

property ImageHRuler: TBitmap;

Description

Картинка из которой формируется изображение направляющей (линейки) при горизонтальной ориентации.

Состоит из левого края, повторяемой области, правого края. В соответствии с каритнкой нужно правильно выставить свойство EdgeSize.


ImageHThumb
ImageHThumb Property

Applies to

TRxSlider component

Declaration

property ImageHThumb: TBitmap;

Description

Картинка с одним или двумя изображениями ползунка для горизонтальной ориентации.

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

В зависимости от числа состояний на картинке нужно выставить свойство NumThumbStates.


ImageVRuler
ImageVRuler Property

Applies to

TRxSlider component

Declaration

property ImageVRuler: TBitmap;

Description

Картинка из которой формируется изображение направляющей (линейки) при вертикальной ориентации.

Состоит из верхнего края, повторяемой области, нижнего края. В соответствии с каритнкой нужно правильно выставить свойство EdgeSize.


ImageVThumb
ImageVThumb Property

Applies to

TRxSlider component

Declaration

property ImageVThumb: TBitmap;

Description

Картинка с одним или двумя изображениями ползунка для вертикальной ориентации.

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

В зависимости от числа состояний на картинке нужно выставить свойство NumThumbStates.


TRxSlider.Increment
Increment Property

Applies to

TRxSlider component

Declaration

property Increment: Longint;

Description

Шаг изменения Value.


TRxSlider.MaxValue
MaxValue Property

Applies to

TRxSlider component

Declaration

property MaxValue: Longint;

Description

Максимальное значение Value. Соответствует крайнему правому (или нижнему) положению ползунка.


TRxSlider.MinValue
MinValue Property

Applies to

TRxSlider component

Declaration

property MinValue: Longint;

Description

Минимальное значение Value. Соответствует крайнему левому (или верхнему) положению ползунка.


NumThumbStates
NumThumbStates Property

Applies to

TRxSlider component

Declaration

property NumThumbStates: TNumThumbStates;

Description

Количество изображений ползунка в картинке ImageHThumb, ImageVThumb.

Если присутствует только одно изображение ползунка в нормальном состоянии, то NumThumbStates = 1. Если есть изображение в "нажатом" состоянии, то NumThumbStates = 2.


TRxSlider.Options
Options Property

Applies to

TRxSlider component

Declaration

property Options: TSliderOptions;

Description

Возможные способы рисования и поведения элемента TRxSlider:

- soSmooth - "гладкость", Если установлен, то при перетаскивании ползунка мышкой перемещение курсора вызывает перемещение ползунка, вне зависимости от изменения Value. При отключенной опции ползунок перемещается, только если новое положение курсора мыши соответствует значению Value, отличному от текущего.

- soShowPoints - определяет рисовать ли "риски" или "деления" вдоль направляющей.

- soShowFocus - рисовать ли пунктирный прямоугольник вокруг элемента при его сфокусированном положении.

- soRulerOpaque - определяет, рисовать ли изображение направляющей (ruler) прозрачным, используя свойство TransparentColor соответствующего изображения TBitmap, или нет.

- soThumbOpaque - определяет, рисовать ли изображение ползунка (thumb) прозрачным, используя свойство TransparentColor соответствующего изображения TBitmap, или нет.


Orientation
Orientation Property

Applies to

TRxSlider component

Declaration

property Orientation: TSliderOrientation;

Description

Ориентация - горизонтальная (soHorizontal) или вериткальная (soVertical).


TRxSlider.Value
Value Property

Applies to

TRxSlider component

Declaration

property Value: Longint;

Description

Выбранное значение в диапазоне от MinValue до MaxValue, соответствующее текущему положению ползунка.


OnDrawPoints
OnDrawPoints Event

Applies to

TRxSlider component

Declaration

property OnDrawPoints: TNotifyEvent;

Description

Событие вызывается для дополнительных рисований в области элемента.


DefaultDrawPoints
DefaultDrawPoints Method

Applies to

TRxSlider component

Declaration

procedure DefaultDrawPoints(PointsStep, PointsHeight, ExtremePointsHeight: Integer); virtual;

Description

Рисует "деления" вдоль направляющей по умолчанию.


TNumThumbStates Type

Unit

RxSlider

Declaration

type

TNumThumbStates = 1..2;

Description

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


TSliderOption Type

Unit

RxSlider

Declaration

type

TSliderOption = (soShowFocus, soShowPoints, soSmooth, soRulerOpaque, soThumbOpaque);

Description

Возможные опции:

- soSmooth - "гладкость", Если установлен, то при перетаскивании ползунка мышкой перемещение курсора вызывает перемещение ползунка, вне зависимости от изменения Value. При отключенной опции ползунок перемещается, только если новое положение курсора мыши соответствует значению Value, отличному от текущего.

- soShowPoints - определяет, рисовать ли "риски" или "деления" вдоль направляющей.

- soShowFocus - рисовать ли пунктирный прямоугольник вокруг элемента при его сфокусированном положении.

- soRulerOpaque - определяет, рисовать ли изображение направляющей (ruler) прозрачным, используя свойство TransparentColor соответствующего изображения TBitmap, или нет.

- soThumbOpaque - определяет, рисовать ли изображение ползунка (thumb) прозрачным, используя свойство TransparentColor соответствующего изображения TBitmap, или нет.


TSliderOptions Type

Unit

RxSlider

Declaration

type

TSliderOptions = set of TSliderOption;

Description

Набор из TSliderOption:

- soSmooth - "гладкость", Если установлен, то при перетаскивании ползунка мышкой перемещение курсора вызывает перемещение ползунка, вне зависимости от изменения Value. При отключенной опции ползунок перемещается, только если новое положение курсора мыши соответствует значению Value, отличному от текущего.

- soShowPoints - определяет рисовать ли "риски" или "деления" вдоль направляющей.

- soShowFocus - рисовать ли пунктирный прямоугольник вокруг элемента при его сфокусированном положении.

- soRulerOpaque - определяет, рисовать ли изображение направляющей (ruler) прозрачным, используя свойство TransparentColor соответствующего изображения TBitmap, или нет.

- soThumbOpaque - определяет, рисовать ли изображение ползунка (thumb) прозрачным, используя свойство TransparentColor соответствующего изображения TBitmap, или нет.


TSliderOrientation Type

Unit

RxSlider

Declaration

type

TSliderOrientation = (soHorizontal, soVertical);

Description

Ориентация элемента может быть горизонтальной или вертикальной.


RxSpin Unit

The RxSpin 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 RxSpin unit:

Components and objects

TRxSpinButton

TRxSpinEdit

Types

TSpinButtonKind

TSpinButtonState

TValueType

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


TRxSpinButton Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxSpin

Description

TRxSpinButton является еще одной реализацией представленной на странице Samples комбинации двух кнопок TSpinButton. Внешний вид данной компоненты заимствован из ForeHelp 1.0.

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


TRxSpinButton See Also
See also

TrxSpinEdit


TRxSpinButton Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TGraphicControl


TRxSpinButton properties
Properties

Run-time only    [image] Key properties

ComponentCount	FocusControl	Showing
ComponentIndex	Height	TabOrder
Components	HelpContext	TabStop
Cursor	Hint	Tag
Down	Left	Top
DownGlyph	Name	UpGlyph
DragCursor	Owner	Visible
DragMode	Parent	Width
Enabled	ShowHint


TRxSpinButton events
Events

Run-time only    [image] Key events

OnBottomClick	OnDragOver	OnStartDrag
OnDragDrop	OnEndDrag	OnTopClick


TRxSpinButton methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TRxSpinButton.Down
Down Property

Applies to

TRxSpinButton component

Declaration

property Down: TSpinButtonState;

Description

Текущее состояние кнопки.


TRxSpinButton.DownGlyph
DownGlyph Property

Applies to

TRxSpinButton component

Declaration

property DownGlyph: TBitmap;

Description

Специфичное для TrxSpinButton свойство. Изображение рисунка в верхней левой части кнопки. Может быть произвольного размера. Центрируется по выделенной ему части кнопки. По умолчанию подкачивается изображение размера 6x6 из ресурсов компоненты.


TRxSpinButton.FocusControl
FocusControl Property

Applies to

TRxSpinButton component

Declaration

property FocusControl: TWinControl;

Description

Свойство определяет элемент управления - наследник TWinControl, который должен получать фокус ввода при нажатии на кнопку TRxSpinButton.


TRxSpinButton.UpGlyph
UpGlyph Property

Applies to

TRxSpinButton component

Declaration

property UpGlyph: TBitmap;

Description

Специфичное для TrxSpinButton свойство. Изображение рисунка в нижней правой части кнопки. Может быть произвольного размера. Центрируется по выделенной ему части кнопки. По умолчанию подкачивается изображение размера 6x6 из ресурсов компоненты.


TRxSpinButton.OnBottomClick
OnBottomClick Event

Applies to

TRxSpinButton component

Declaration

property OnBottomClick: TNotifyEvent;

Description

Специфичное для TrxSpinButton событие. Происходит при нажатии на нижнюю (правую) кнопку.


TRxSpinButton.OnTopClick
OnTopClick Event

Applies to

TRxSpinButton component

Declaration

property OnTopClick: TNotifyEvent;

Description

Специфичное для TrxSpinButton событие. Происходит при нажатии на левую (верхнюю) кнопку.


TRxSpinEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxSpin

Description

TRxSpinEdit является еще одной реализацией представленной на странице Samples строки редактирования TSpinEdit. Внешний вид данной компоненты заимствован из ForeHelp 1.0. Компонента предназначена для редактирования численных значений (целочисленных и с плавающей точкой) не только с помощью клавиатуры, но и последовательного изменения их при помощи мыши. Текущее значение хранится в свойстве Value. Можно задать границы его изменения в пределах MinValue и MaxValue.

Свойство ValueType задает допустимый тип вводимых значений - если ValueType = vtFloat, то разрешен ввод чисел с плавающей точкой, при этом число цифр после десятичной точки задается значением свойства Decimal; если ValueType = vtInteger, то допустим ввод только целочисленных значений.

Можно запретить прямой ввод данных с клавиатуры, установив значение EditorEnabled в False. Изменеие значения может производиться и при помощи клавиатуры - клавиши управления курсором [вверх] и [вниз] соответственно увеличивают и уменьшают значение Value на величину Increment.

Значение Increment определяет величину изменения Value при отработке сообщений от мыши.


TRxSpinEdit See Also
See also

TrxSpinButton


TRxSpinEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit


TRxSpinEdit properties
Properties

Run-time only    [image] Key properties

ArrowKeys	EditorEnabled	ParentCtl3D
AsInteger	Enabled	ParentFont
AutoSelect	Font	ParentShowHint
AutoSize	Height	PopupMenu
BorderStyle	HelpContext	ReadOnly
ButtonKind	Hint	ShowHint
Color	Increment	Showing
ComponentCount	Left	TabOrder
ComponentIndex	MaxLength	TabStop
Components	MaxValue	Tag
Ctl3D	MinValue	Top
Cursor	Name	Value
Decimal	Owner	ValueType
DragCursor	Parent	Visible
DragMode	ParentColor	Width


TRxSpinEdit events
Events

Run-time only    [image] Key events

OnChange	OnEndDrag	OnKeyUp
OnClick	OnEnter	OnMouseDown
OnDblClick	OnExit	OnMouseMove
OnDragDrop	OnKeyDown	OnMouseUp
OnDragOver	OnKeyPress	OnStartDrag


TRxSpinEdit methods
Methods

Key methods

BeginDrag	GetTextBuf	Repaint
BringToFront	GetTextLen	ScreenToClient
ClientToScreen	Hide	SendToBack
Create	InsertComponent	SetBounds
Destroy	Invalidate	SetFocus
Dragging	Perform	SetTextBuf
EndDrag	Refresh	Show
FindComponent	RemoveComponent	Update


TRxSpinEdit.ArrowKeys
ArrowKeys Property

Applies to

TRxSpinEdit component

Declaration

property ArrowKeys: Boolean;

Description

Свойство определяет, будет ли редактор TRxSpinEdit реагировать на нажатие клавиш "Up" и "Down".

Если ArrowKeys = True, то нажатие клавиш "Up" и "Down" будет приводить, соответственно, к увеличению или уменьшению значения Value на величину, определенную свойством Increment.


TRxSpinEdit.ButtonKind
ButtonKind Property

Applies to

TRxSpinEdit component

Declaration

property ButtonKind: TSpinButtonKind;

Description

Свойство задает вид кнопки в редакторе класса TRxSpinEdit.

Возможные значения свойства:

• bkDiagonal - используется "диагональная" кнопка TRxSpinButton;

• bkStandard - используется стандартный "прямоугольный" элемент управления класса TUpDown. Значение по умолчанию: bkDiagonal.


TRxSpinEdit.Decimal
Decimal Property

Applies to

TRxSpinEdit component

Declaration

property Decimal: Integer;

Description

Свойство задает число цифр после десятичной точки при значении свойства ValueType = vtFloat.


TRxSpinEdit.EditorEnabled
EditorEnabled Property

Applies to

TRxSpinEdit component

Declaration

property EditorEnabled: Boolean;

Description

Специфичное для TRxSpinEdit свойство. По умолчанию принимает значение True. В случае, если значение свойства установлено в False, запрещает изменение данных при помощи клавиатуры, кроме как через манипулирование клавишами курсора. Сообшения от мыши обрабатываются при любом значении EditorEnabled.


TRxSpinEdit.Increment
Increment Property

Applies to

TRxSpinEdit component

Declaration

property Increment: Extended;

Description

Свойство определяет шаг изменения значения свойства Value при обработке сообщений мыши для одной из кнопок компоненты или при нажатых клавишах управления курсором.


TRxSpinEdit.MaxValue
MaxValue Property

Applies to

TRxSpinEdit component

Declaration

property MaxValue: Extended;

Description

Специфичное для TrxSpinEdit свойство. Максимальное значение, которое может принимать Value.


TRxSpinEdit.MinValue
MinValue Property

Applies to

TRxSpinEdit component

Declaration

property MinValue: Extended;

Description

Специфичное для TrxSpinEdit свойство. Минимальное значение, которое может принимать Value.


TRxSpinEdit.Value
Value Property

Applies to

TRxSpinEdit component

Declaration

property Value: Extended;

Description

Свойство TrxSpinEdit, задающее текущее значение величины, изменяемой в строке редактирования компоненты.


ValueType
ValueType Property

Applies to

TRxSpinEdit component

Declaration

property ValueType: TValueType;

Description

Свойство ValueType задает допустимый тип вводимых значений - если ValueType = vtFloat, то разрешен ввод чисел с плавающей точкой, при этом число цифр после десятичной точки задается значением свойства Decimal; если ValueType = vtInteger, то допустим ввод только целочисленных значений.

Замечание

В Borland C++Builder тип TValueType объявлен как

   TValueType = (vtInt, vtFloat);


TSpinButtonKind Type

Unit

RxSpin

Declaration

type

TSpinButtonKind = (bkStandard, bkDiagonal);

Description

Тип задает возможные значения свойства ButtonKind компоненты TRxSpinEdit.


TSpinButtonState Type

Unit

RxSpin

Declaration

type

TSpinButtonState = (sbNotDown, sbTopDown, sbBottomDown);

Description

Описывает возможные значения свойства Down компоненты TrxSpinButton. Определяет текущее состояние кнопки. Значение sbTopDown, если нажат верхний левый угол, значение sbBottomDown, если нажат нижний правый и sbNotDown в противном случае.


TValueType Type

Unit

RxSpin

Declaration

type

TValueType = (vtInteger, vtFloat);

Description

Тип определяет возможные значения свойства ValueType компоненты TRxSpinEdit.

Замечание

В C++Builder этот тип объявлен как

  TValueType = (vtInt, vtFloat);


RxSplit Unit

The RxSplit 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 RxSplit unit:

Components and objects

TRxSplitter

Types

TSplitterStyle

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


TRxSplitter Component

Hierarchy             See also             Properties             Methods             Events             Tasks

Unit

RxSplit

Description

TRxSplitter (разделитель) предназначен для помещения между двумя элементами управления (controls), с целью дать возможность пользователю во время выполнения программы изменять взаимные размеры этих двух элементов управления.

Для этого нужно провести курсор над полоской, разделяющей эти два элемента, и при появлении курсора изменения размера, нажав левую кнопку, перетащить полоску в ее новое положение. При этом произойдет изменение размеров.

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

Элементы управления, которые он будет разделять, задаются свойствами ControlFirst и ControlSecond. При использовании важным является сочетание свойств Align у самого Splitter'а и у элементов ControlFirst, ControlSecond. При правильном выставлении этих свойств в дизайнере Delphi, read-only свойство Cursor у Splitter'а примет значение crHSplit при вертикальном разделении и crVSplit при горизонтальном. Иначе, изменение размеров во время выполнения будет невозможно.

Возможно задание значения только одного свойства - ControlFirst. При правильной установке свойств Align у этого элемента и сопряженных с ним в форме компонента TRxSplitter также позволяет изменять их размеры.

Во время перемещения splitter-а по форме в run-time пользователь может нажать клавишу "Esc" для отмены перемещения разделителя.


Using the TRxSplitter Component

See also             TRxSplitter Reference

Purpose

Дать возможность пользователю во время выполнения программы изменять взаимные размеры двух элементов управления.

Tasks

Поместите первый элемент в форму: пусть, например, это будет TPanel. Выставите свойство Align в alTop.

Поместите в форму TRxSplitter, выставив ему Align alTop. Он теперь должен располагаться тонкой полоской под Panel.

Поместите в форму под Panel, например TDBGrid. Установите его Align в alClient или alTop. Splitter окажется зажат между панелью и гридом.

Выберите ControlFirst и ControlSecond у Splitter'а соответственно в Panel и DBGrid. Свойство Cursor у rxSplitter'а должно измениться в crVSplit, означая, что будет доступно вертикальное взаимное изменение размеров Panel и  DBGrid.

По аналогии можно установить разделитель вериткально между горизонтальными элементами.


TRxSplitter See Also
See also

Common Component Tasks


TRxSplitter See Also
See also

Align

TPanel

TSplitterStyle


TRxSplitter Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TCustomPanel


TRxSplitter properties
Properties

Run-time only    [image] Key properties

Align	Cursor	ParentShowHint
BevelInner	DragCursor	ShowHint
BevelOuter	Enabled	Showing
BevelWidth	Height	TabOrder
BottomRightLimit	HelpContext	TabStop
Color	Hint	Tag
ComponentCount	Left	Top
ComponentIndex	Name	TopLeftLimit
Components	Owner	Visible
ControlFirst	Parent	Width
ControlSecond	ParentColor
Ctl3D	ParentCtl3D


TRxSplitter events
Events

Run-time only    [image] Key events

OnClick	OnExit	OnMouseUp
OnDblClick	OnMouseDown	OnPosChanged
OnEnter	OnMouseMove	OnResize


TRxSplitter methods
Methods

Key methods

BeginDrag	FindComponent	Repaint
BringToFront	Hide	ScreenToClient
ClientToScreen	InsertComponent	SendToBack
Create	Invalidate	SetBounds
Destroy	Perform	SetFocus
Dragging	Refresh	Show
EndDrag	RemoveComponent	Update


BottomRightLimit
BottomRightLimit Property

Applies to

TRxSplitter component

Declaration

property BottomRightLimit: Integer;

Description

Свойства TopLeftLimit и BottomRightLimit задают минимальное смещение (от границ формы-владельца) положения разделителя TRxSplitter при его перемещении в ту или иную сторону, устанавливая таким образом минимальные размеры для компонент ControlFirst и ControlSecond.


ControlFirst
ControlFirst Property

Applies to

TRxSplitter component

Declaration

property ControlFirst: TControl;

Description

Один из элементов управления, которые разделяет и чьи размеры меняет rxSplitter.

Это элемент расположенный либо левее, либо выше.

Значение этого свойства задается автоматически при присвоении значения свойству Align и сожет быть изменено вручную.

Обычно Вам достаточно задать значение одному из двух свойств - ControlFirst или ControlSecond.


ControlSecond
ControlSecond Property

Applies to

TRxSplitter component

Declaration

property ControlSecond: TControl;

Description

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

Если задано значение ControlFirst, Вам нет необходимости задавать значение этого свойства.


TopLeftLimit
TopLeftLimit Property

Applies to

TRxSplitter component

Declaration

property TopLeftLimit: Integer;

Description

Свойства TopLeftLimit и BottomRightLimit задают минимальное смещение (от границ формы-владельца) положения разделителя TRxSplitter при его перемещении в ту или иную сторону, устанавливая таким образом минимальные размеры для компонент ControlFirst и ControlSecond.


OnPosChanged
OnPosChanged Event

Applies to

TRxSplitter component

Declaration

property OnPosChanged: TNotifyEvent;

Description

Событие происходит после изменения пользователем размеров разделяемых элементов.


TSplitterStyle Type

Unit

RxSplit

Declaration

type

TSplitterStyle = (spUnknown, spHorizontalFirst, spHorizontalSecond, spVerticalFirst, spVerticalSecond);

Description

Состояние, в котором находится Splitter в зависимости от свойств Align контролов, к которым он прикреплен.


RxSwitch Unit

The RxSwitch 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 RxSwitch unit:

Components and objects

TRxSwitch

Types

TTextPos

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


TRxSwitch Component

Hierarchy             See also             Properties             Methods             Events

Unit

RxSwitch

Description

Компонента относится к набору "безделушек" наряду с такими компонентами библиотеки, как TRxDice и TRxClock, и представляет собой реализацию в виде компоненты Delphi двухпозиционного переключателя, полностью аналогичного такому же элементу VBX, поставляемому вместе с Borland Delphi в качестве примера.

Вы можете изменить изображения для двух положений переключателя с помощью свойств GlyphOn и GlyphOff. Текущее состояние переключателя определяется свойством StateOn. Для определения "горячей" клавиши, переключающей состояние элемента, служит свойство ToggleKey. Свойство TextPosition управляет расположением текста Caption относительно изображения переключателя.


TRxSwitch See Also
See also

TBitmap

TRxDice


TRxSwitch Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl


TRxSwitch properties
Properties

Run-time only    [image] Key properties

Align	GlyphOn	ShowHint
BorderStyle	Height	Showing
Caption	HelpContext	StateOn
Color	Hint	TabOrder
ComponentCount	Left	TabStop
ComponentIndex	Name	Tag
Components	Owner	TextPosition
Cursor	Parent	ToggleKey
DragCursor	ParentColor	Top
DragMode	ParentFont	Visible
Enabled	ParentShowHint	Width
Font	PopupMenu
GlyphOff	ShowFocus


TRxSwitch events
Events

Run-time only    [image] Key events

OnClick	OnKeyDown	OnMouseUp
OnDblClick	OnKeyPress	OnOff
OnDragDrop	OnKeyUp	OnOn
OnDragOver	OnMouseDown	OnStartDrag
OnEndDrag	OnMouseMove


TRxSwitch methods
Methods

Key methods

BringToFront	Invalidate	SetBounds
ClientToScreen	Perform	SetFocus
Create	Refresh	Show
Destroy	RemoveComponent	ToggleSwitch
FindComponent	Repaint	Update
Hide	ScreenToClient
InsertComponent	SendToBack


GlyphOff
GlyphOff Property

Applies to

TRxSwitch component

Declaration

property GlyphOff: TBitmap;

Description

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


GlyphOn
GlyphOn Property

Applies to

TRxSwitch component

Declaration

property GlyphOn: TBitmap;

Description

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


StateOn
StateOn Property

Applies to

TRxSwitch component

Declaration

property StateOn: Boolean;

Description

Свойство определяет текущее состояние перерключателя. Значение True соответствует состоянию "On" (включено), значение False - состоянию "Off" (выключено).


TextPosition
TextPosition Property

Applies to

TRxSwitch component

Declaration

property TextPosition: TTextPos;

Description

Свойство TextPosition управляет расположением текста Caption относительно изображения переключателя.


ToggleKey
ToggleKey Property

Applies to

TRxSwitch component

Declaration

property ToggleKey: TShortCut;

Description

Свойство ToggleKey позволяет определить "горячую" клавишу, при нажатии на которую происходит изменение состояния переключателя на противоположное (если переключатель в данный момент имеет фокус ввода).


OnOff
OnOff Event

Applies to

TRxSwitch component

Declaration

property OnOff: TNotifyEvent;

Description

Событие происходит при изменении состояния переключателя с "включено" (On) на "выключено" (Off), то есть при "выключении" переключателя.


OnOn
OnOn Event

Applies to

TRxSwitch component

Declaration

property OnOn: TNotifyEvent;

Description

Событие происходит при изменении состояния переключателя с "выключено" (Off) на "включено" (On), то есть при "включении" переключателя.


ToggleSwitch
ToggleSwitch Method

Applies to

TRxSwitch component

Declaration

procedure ToggleSwitch;

Description

Вызов метода ToggleSwitch вызывает изменение состояния переключателя на противоположное, изменяя значение свойства StateOn.


TTextPos Type

Unit

RxSwitch

Declaration

type

TTextPos = (tpRight, tpLeft, tpAbove, tpBelow, tpNone);

Description

Тип задает возможные значения расположения текста для свойства TextPosition компоненты TRxSwitch.


RxVerInf Unit

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 RxVerInf unit:

Components and objects

TVersionInfo

Types

TVersionCharSet

TVersionLanguage

Procedures and functions

OkToWriteModule

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


TVersionInfo object
TVersionInfo Class

Hierarchy             See also             Properties             Methods

Unit

RxVerInf

Description

Класс TVersionInfo предназначен для доступа к ресурсам типа VERSIONINFO. После создания объекта этого класса вы можете получить доступ к информации из ресурса VERSIONINFO через свойства (только-для-чтения) объекта, если чтение ресурса из специфицированного файла окончилось успешно. Вы можете проверить результат чтения информации из файла по значению свойства Valid - значение True соответствует успешному чтению данных. При изменении свойства, задающего имя исполняемого файла с ресурсом VERSIONINFO, происходит обновление данных объекта. Успешность обновления можно также проверить по значению свойства Valid.


TVersionInfo See Also
See also

TVersionCharSet

TVersionLanguage


TVersionInfo Hierarchy
Hierarchy

TObject


TVersionInfo properties
Properties

Run-time only    [image] Key properties

Comments	LegalCopyright	Translation
CompanyName	LegalTrademarks	Valid
FileDescription	OriginalFilename	Values
FileName	PrivateBuild	VersionCharSet
FileVersion	ProductName	VersionLanguage
FixedFileInfo	ProductVersion	VersionNum
InternalName	SpecialBuild


TVersionInfo methods
Methods

Key methods

Create	GetVerValue


Comments
Comments Property

Applies to

TVersionInfo component

Declaration

property Comments: string;

Description

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


CompanyName
CompanyName Property

Applies to

TVersionInfo component

Declaration

property CompanyName: string;

Description

Свойство для доступа к строке из иформации о версии, специфицирующей имя компании-производителя.


FileDescription
FileDescription Property

Applies to

TVersionInfo component

Declaration

property FileDescription: string;

Description

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


TVersionInfo.FileName
FileName Property

Applies to

TVersionInfo component

Declaration

property FileName: string;

Description

Свойство задает имя исполняемого файла (EXE или DLL), из которого считывается информация о версии. При изменении значения свойства FileName происходит чтение ресурса VERSIONINFO из указанного файла. Если чтение данных окончилось успешно, свойство Valid (только чтение) устанавливается в значение True, иначе - в False.


FileVersion
FileVersion Property

Applies to

TVersionInfo component

Declaration

property FileVersion: string;

Description

Свойство для доступа к строке, содержащей номер версии файла, полученной из ресурса типа VERSIONINFO.


FixedFileInfo
FixedFileInfo Property

Applies to

TVersionInfo component

Declaration

property FixedFileInfo: PVSFixedFileInfo;

Description

Свойство предоставляет доступ к информации из ресурса VERSIONINFO, представленной в фиксированном формате. Тип данных PVSFixedFileInfo определяется как

  TVSFixedFileInfo = record

    dwSignature: Longint;

    dwStrucVersion: Longint;

    dwFileVersionMS: Longint;

    dwFileVersionLS: Longint;

    dwProductVersionMS: Longint;

    dwProductVersionLS: Longint;

    dwFileFlagsMask: Longint;

    dwFileFlags: Longint;

    dwFileOS: Longint;

    dwFileType: Longint;

    dwFileSubtype: Longint;

    dwFileDateMS: Longint;

    dwFileDateLS: Longint;

  end;


InternalName
InternalName Property

Applies to

TVersionInfo component

Declaration

property InternalName: string;

Description

Свойство для доступа к строке, содержашей "внутреннее" имя файла, если оно присутствует в информации о версии. Это, например, может быть имя модуля, если файл является динамически загружаемой библиотекой (DLL).


LegalCopyright
LegalCopyright Property

Applies to

TVersionInfo component

Declaration

property LegalCopyright: string;

Description

Свойство для доступа к строке из иформации о версии, специфицирующей авторские права.


LegalTrademarks
LegalTrademarks Property

Applies to

TVersionInfo component

Declaration

property LegalTrademarks: string;

Description

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


OriginalFilename
OriginalFilename Property

Applies to

TVersionInfo component

Declaration

property OriginalFilename: string;

Description

Свойство для доступа к строке из иформации о версии, специфицирующей оригинальное (первоначальное) имя файла (не включая путь). Эта информация может понадобиться, если файл переименован пользователем.


PrivateBuild
PrivateBuild Property

Applies to

TVersionInfo component

Declaration

property PrivateBuild: string;

Description

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


ProductName
ProductName Property

Applies to

TVersionInfo component

Declaration

property ProductName: string;

Description

Свойство для доступа к имени продукта из информации о версии. Распространение продукта обычно производится с этим именем.


ProductVersion
ProductVersion Property

Applies to

TVersionInfo component

Declaration

property ProductVersion: string;

Description

Свойство для доступа к строке, содержащей номер версии продукта, полученной из ресурса типа VERSIONINFO, например "3.10" или "5.00.RC2".


SpecialBuild
SpecialBuild Property

Applies to

TVersionInfo component

Declaration

property SpecialBuild: string;

Description

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


Translation
Translation Property

Applies to

TVersionInfo component

Declaration

property Translation: Pointer;

Description

Значение свойства представляет собой указатель на массив идентификаторов языка (language) и набора символов (character-set), используемых при чтении данных из ресурса с информацией о версии.


Valid
Valid Property

Applies to

TVersionInfo component

Declaration

property Valid: Boolean;

Description

Свойство Valid (только-для-чтения) позволяет вам определить результат чтения данных с информацией о версии из специфицированного исполняемого файла. Значение True говорит о том, что чтение данных прошло успешно, в противном случае Valid = False.


TVersionInfo.Values[const Name: string]
Values Property

Applies to

TVersionInfo component

Declaration

property Values[const Name: string]: string;

Description

Свойство предоставляет доступ к любой текстовой информации из ресурса VERSIONINFO. Считываемая строка задается параметром Name.


VersionCharSet
VersionCharSet Property

Applies to

TVersionInfo component

Declaration

property VersionCharSet: TVersionCharSet;

Description

Идентификатор набора символов (character-set), используемого при чтении информации из ресурса.


VersionLanguage
VersionLanguage Property

Applies to

TVersionInfo component

Declaration

property VersionLanguage: TVersionLanguage;

Description

Идентификатор языка (language), используемого при чтении информации из ресурса.


VersionNum
VersionNum Property

Applies to

TVersionInfo component

Declaration

property VersionNum: Longint;

Description

Свойство определяет номер версии файла как длинное целое.


TVersionInfo.Create
Create Method

Applies to

TVersionInfo component

Declaration

constructor Create(const AFileName: string);

Description

Метод выделяет память и инициализирует объект класса TVersionInfo, считывая данные ресурса VERSIONINFO из исполняемого файла (или DLL), имя которого передано в качестве параметра AFileName. Если в указанном файле не оказалось ресурса VERSIONINFO либо при чтении данных произошла ошибка, свойство Valid будет установлено в значение False.


GetVerValue
GetVerValue Method

Applies to

TVersionInfo component

Declaration

function GetVerValue(const VerName: string): string;

Description

Метод GetVerValue позволяет считать из ресурса VERSIONINFO значение строки с ключом, переданным в качестве параметра VerName. Для доступа к большинству наиболее часто используемых в ресурсах этого типа строковых ключей существуют свойства "только-для-чтения", метод же позволяет считать любое строковое значение, не определенное как свойство объекта класса TVersionInfo.


TVersionCharSet Type

Unit

RxVerInf

Declaration

type

TVersionCharSet = (vcsASCII, vcsJapan, vcsKorea, vcsTaiwan, vcsUnicode, vcsEasternEuropean, vcsCyrillic, vcsMultilingual, vcsGreek, vcsTurkish, vcsHebrew, vcsArabic, vcsUnknown);

Description

Тип определяет допустимые значения для идентификатора набора символов, используемого ресурсами типа VERSIONINFO. Используется для свойства VersionCharSet класса TVersionInfo.


TVersionLanguage Type

Unit

RxVerInf

Declaration

type

TVersionLanguage = (vlArabic, ..., vlUnknown);

Description

Тип определяет допустимые значения для идентификатора языка, используемого ресурсами типа VERSIONINFO. Используется для свойства VersionLanguage класса TVersionInfo.


OkToWriteModule Function

Examples

Unit

RxVerInf

Declaration

function OkToWriteModule(ModuleName: string; NewVer: Longint): Boolean;

Description

Функция OkToWriteModule может быть использована в инсталляционных программах для определения того, нужно ли заменять уже происнталлированный на компьютер исполняемый файл (DLL) на тот, который входит в ваш инсталляционный пакет.


OkToWriteModule example
Example

Если вы хотите записать на компьютер библиотеку MYLIB.DLL (например, в инсталляционной программе), при этом вам известен номер версии этой библиотеки NewVerNum, и на компьютере уже присутствует файл MYLIB.DLL, то вы можете проверить необходимость записи вашего файла на диск с помощью вызова

  if OkToWriteModule('C:\WINDOWS\MYLIB.DLL', NewVerNum) then

    { write file to disk }


Speedbar Unit

The Speedbar unit contains the declarations for the certain components on the RX Tools 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 Speedbar unit:

Components and objects

TSpeedbar

TSpeedItem

Types

TApplyAlignEvent

TBarOrientation

TBarPosition

TBoundLine

TBoundLines

TSpeedbarOption

TSpeedbarOptions

Procedures and functions

FindSpeedBar

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


TSpeedbar Component

Hierarchy             See also             Properties             Methods             Events

Unit

Speedbar

Description

Компонента TSpeedbar предназначена для размещения в ваших формах настраиваемых пользователем панелей инструментов. При работе с VCL вы обычно создаете инструментальные панели, пользуясь компонентами TPanel и TSpeedButton.

Компонента TSpeedbar объединяет в себя панель и набор кнопок, который вы можете задать в режиме дизайна формы. Работа по созданию панели инструментов в форме аналогична работе по созданию полосы меню. Редактор компоненты TSpeedbar позволяет вам добавлять и удалять кнопки из компоненты, группировать их в секции (категории) и изменять набор видимых кнопок путем перетаскивания кнопок мышкой из окна редактирования на панель, как это сделано в среде Delphi. При установленных флажках sbAllowDrag и sbAllowResize в свойстве Options пользователь вашего приложения сможет перемещать панель инструментов в окне, размещая ее на различных сторонах окна (аналогично перемещению панели задач (taskbar) в Windows95), и изменять ее размеры.

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

Вы можете также задать "покрытие" (обои) для панели инструментов (битовое изображение, которое будет накладываться на панель при ее отображении) с помощью свойства Wallpaper.

Компонента TSpeedbar имеет метод Customize, позволяющий пользователю динамически менять настройки панели инструментов. Вы можете сохранять настройки Speedbar'а в INI-файле или в системном регистре (для 32-разрядной версии) автоматически, задав значение свойству IniStorage, либо вручную с помощью методов SaveLayout, SaveLayoutReg и RestoreLayout, RestoreLayoutReg.

При создании очередных версий Вашего приложения Вы можете не захотеть, чтобы при запуске приложения пользователем из INI-файла были восстановлены сохраненные там предыдущей версией параметры. Для этого при подготовке новой версии приложения увеличьте значение свойства Version - установки из INI-файла считываются только если записанный там номер версии SpeedBar'а меньше либо равен текущему.


TSpeedbar See Also
See also

TPanel

TRxSpeedButton

TSpeedButton

TSpeedItem


TSpeedbar Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomControl

  |

TCustomPanel


TSpeedbar properties
Properties

Run-time only    [image] Key properties

Align	DragCursor	ParentCtl3D
BevelInner	DragMode	ParentFont
BevelOuter	Enabled	ParentShowHint
BevelWidth	Font	PopupMenu
BorderStyle	Height	Position
BorderWidth	HelpContext	Sections
BoundLines	Hint	ShowHint
BtnHeight	Images	Showing
BtnOffsetHorz	IniStorage	TabOrder
BtnOffsetVert	Left	TabStop
BtnWidth	Locked	Tag
Color	Name	Top
ComponentCount	Options	Version
ComponentIndex	Orientation	Visible
Components	Owner	Wallpaper
Ctl3D	Parent	Width
Cursor	ParentColor


TSpeedbar events
Events

Run-time only    [image] Key events

OnApplyAlign	OnEndDrag	OnPosChanged
OnClick	OnEnter	OnResize
OnCustomize	OnExit	OnStartDrag
OnDblClick	OnMouseDown	OnVisibleChanged
OnDragDrop	OnMouseMove
OnDragOver	OnMouseUp


TSpeedbar methods
Methods

Key methods

AddItem	Invalidate	SaveLayout
AddSection	Items	SaveLayoutReg
BringToFront	ItemsCount	ScreenToClient
ClientToScreen	Perform	SearchSection
Create	Refresh	SendToBack
Customize	RemoveComponent	SetBounds
Destroy	RemoveItem	SetFocus
FindComponent	RemoveSection	SetFontDefault
FindItem	Repaint	Show
Hide	RestoreLayout	Update
InsertComponent	RestoreLayoutReg


BoundLines
BoundLines Property

Applies to

TSpeedbar component

Declaration

property BoundLines: TBoundLines;

Description

Свойство определяет стороны компоненты TSpeedbar, вдоль которых рисуется дополнительная "углубленная" (lowered) линия.


BtnHeight
BtnHeight Property

Applies to

TSpeedbar component

Declaration

property BtnHeight: Integer;

Description

Свойство позволяет задать размер кнопки на панели инструментов. Размер всех кнопок на панели одинаков.

При изменении значений свойств BtnWidth и BtnHeight расположение кнопок на панели не меняется автоматически - Вы должны перерасположить их вручную в режиме дизайна формы.

Если пользователи уже работают с предыдущими версиями Вашего приложения, не забудьте при изменении размера кнопок увеличить значение свойства Version во избежание конфликта со считанными из INI-файла установками.


BtnOffsetHorz
BtnOffsetHorz Property

Applies to

TSpeedbar component

Declaration

property BtnOffsetHorz: Integer;

Description

Задает минимальное смещение крайней кнопки от левой границы панели управления по горизонтали (в пикселях) и применяется при "опускании" на панель кнопки с помощью мыши при редактировании панели управления.


BtnOffsetVert
BtnOffsetVert Property

Applies to

TSpeedbar component

Declaration

property BtnOffsetVert: Integer;

Description

Задает минимальное смещение крайней кнопки от верхней границы панели управления по вертикали (в пикселях) и применяется при "опускании" на панель кнопки с помощью мыши при редактировании панели управления.


BtnWidth
BtnWidth Property

Applies to

TSpeedbar component

Declaration

property BtnWidth: Integer;

Description

Свойство позволяет задать размер кнопки на панели инструментов. Размер всех кнопок на панели одинаков.

При изменении значений свойств BtnWidth и BtnHeight расположение кнопок на панели не меняется автоматически - Вы должны перерасположить их вручную в режиме дизайна формы.

Если пользователи уже работают с предыдущими версиями Вашего приложения, не забудьте при изменении размера кнопок увеличить значение свойства Version во избежание конфликта со считанными из INI-файла установками.


TSpeedbar.Images
Images Property

Applies to

TSpeedbar component

Declaration

property Images: TImageList;

Description

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

Если свойство Images не задано, либо не содержит изображений, либо свойство ImageIndex кнопки TSpeedItem задает неверный индекс, то для отрисовки изображения используется свойство Glyph кнопки.


IniStorage
IniStorage Property

Applies to

TSpeedbar, TRxDrawGrid, TRxDBGrid, TRxCheckListBox, TMRUManager components

Declaration

property IniStorage: TFormPlacement;

Description

Свойство позволяет автоматически сохранять специфические установки компоненты в INI-файле или (для 32-разрядной версии) в системном регистре при помощи компонент TFormPlacement или TFormStorage.

При задании значения свойству IniStorage (и непустом имени компоненты), некоторые ее настройки, которые не являются published-свойствами и не могут быть заданы для TFormStorage напрямую, будут сохраняться и восстанавливаться одновременни с другими значениями, заданными для соответствующей компоненты TFormPlacement (TFormStorage).

Для TSpeedbar - это расположение кнопок на панели и положение самой панели, для TMRUManager - список строк, для TRxDBGrid - ширины и положение полей в таблице и т.д. Все компоненты, имеющие свойство IniStorage, имеют также методы для сохранения и восстановления их настроек вручную, такие как Save/RestoreLayout и т.д.


TSpeedbar.Options
Options Property

Applies to

TSpeedbar component

Declaration

property Options: TSpeedbarOptions;

Description

Свойство задает режимы работы и отображения кнопок панели инструментов.

Смысл флажков типа TSpeedbarOptions:

- sbAllowDrag - пользователь может перемещать мышью панель инструментов внутри окна-родителя, изменяя ее свойство Align.

- sbAllowResize - пользователь может изменять с помощью мыши размеры панели управления.

- sbFlatBtns - панель использует "всплывающие" кнопки, т.е. границы которых отображаются только при перемещении над ними указателя мыши.

- sbGrayedBtns - имеет смысл при установленном флажке sbFlatBtns; при этом битовые изображения "неактивных" кнопок делаются "серыми" (если картинка в свойстве Glyph содержит 5 изображений, то 5-ое используется для отображения неактивной кнопки, если же меньше, то соответствующая "серая" картинка будет сделана автоматически)

- sbTransparentBtns - кнопки на панели являются прозрачными, через них, например, можно видеть битовое изображение, заданное свойством Wallpaper панели инструментов.

- sbStretchBitmap - изображение, заданное свойством Wallpaper, рисуется "растянутым" по всему размеру панели инструментов.

По умолчанию свойство имеет значение [sbAllowDrag, sbGrayedBtns].


TSpeedbar.Orientation
Orientation Property

Applies to

TSpeedbar component

Declaration

property Orientation: TBarOrientation;

Description

Задает ориентацию панели инструментов (по горизонтали или по вертикали), и в соответствии с установленным значением переразмещает кнопки на панели управления. Если свойство Position установлено в значение bpAuto, то присвоение значения свойству Orientation вызовет исключительную ситуацию (exception). Для изменения вручную ориентации панели инструментов установите свойство Position в значение bpCustom.


Position
Position Property

Applies to

TSpeedbar component

Declaration

property Position: TBarPosition;

Description

Свойство предназначено для задания поведения панели инструментов при смене ее расположения в форме. При установленном значении bpAuto изменение значения свойства Align компоненты TSpeedBar (путем прямого присвоения значения либо при перемещении панели мышью внутри формы пользователем) приводит к установке соответствующего значения свойства Orientation и к автоматическому переразмещению кнопок на ней, при этом положениям alTop, alBottom соответствует Orientation=boHorizontal, а положениям alLeft, alRight - Orientation=boVertical. Другие значения свойства Align при этом не могут быть установлены. Если Вы хотите установить иное значение свойства Align либо Вам необходим ручной контроль за размещением кнопок на панели инструментов при перемещении панели, установите свойство Position в значение bpCustom.


Sections
Sections Property

Applies to

TSpeedbar component

Declaration

property Sections: TStrings;

Description

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


Version
Version Property

Applies to

TSpeedbar component

Declaration

property Version: Integer;

Description

Свойство Version служит для предотвращения считывания из INI-файла (или Windows registry) конфигурации панели инструментов (с помощью ее методов RestoreLayout или RestoreLayoutReg) при изменении разработчиком приложения набора кнопок в панели.

Если Вы не изменяете значение свойства Version, то метод RestoreLayout (RestoreLayoutReg) считывает настройки из INI-файла или registry и восстанавливает состояние панели инструментов вне зависимости от изменений в форме, произведенных разработчиком в очередной версии приложения. Вы можете при изменении версий Вашего приложения наращивать значение свойства Version - метод RestoreLayout (RestoreLayoutReg) не будет восстанавливать настройки панели инструментов, если считанное им из INI-файла или registry значение свойства Version меньше текущего.


Wallpaper
Wallpaper Property

Applies to

TSpeedbar component

Declaration

property Wallpaper: TPicture;

Description

Свойство позволяет задать картинку, которая будет покрывать клиентскую область панели инструментов. Изображение может быть растянуто на всю область (при наличии флажка sbStretchBitmap в свойстве Options), либо будет накладываться на всю видимую область панели каскадно, как "обои".


OnApplyAlign
OnApplyAlign Event

Examples

Applies to

TSpeedbar component

Declaration

property OnApplyAlign: TApplyAlignEvent;

Description

Событие возникает при перемещении пользователем панели инструментов (TSpeedBar) при помощи мыши, если свойство Options содержит флажок sbAllowDrag. В обработчике события Вы можете разрешить либо запретить размещение панели с выравниванием, заданным параметром Align.


OnApplyAlign example
Example

Пример обработчика события OnApplyAlign, позволяющий размещать панель инструментов только на верхней и нижней стороне окна-владельца:

procedure TMainForm.SpeedBarApplyAlign(Sender: TObject;

  Align: TAlign; var Apply: Boolean);

begin

  Apply := Align in [alTop, alBottom];

end;


TSpeedbar.OnCustomize
OnCustomize Event

Applies to

TSpeedbar component

Declaration

property OnCustomize: TNotifyEvent;

Description

OnCustomize occurs when the speedbar's Customize Dialog closes. Write an OnCustomize event handler to perform special processing when the customize dialog closes.


TSpeedbar.OnPosChanged
OnPosChanged Event

Applies to

TSpeedbar component

Declaration

property OnPosChanged: TNotifyEvent;

Description

Событие возникает во время выполнения программы после смены расположения панели инструментов (TSpeedBar) пользователем (при перемещении панели мышью), если свойство Options содержит флажок sbAllowDrag.


OnVisibleChanged
OnVisibleChanged Event

Applies to

TSpeedbar component

Declaration

property OnVisibleChanged: TNotifyEvent;

Description

OnVisibleChanged occurs when the control is shown or hide (that is, when the control’s Visible property changes).


AddItem
AddItem Method

Applies to

TSpeedbar component

Declaration

procedure AddItem(Section: Integer; Item: TSpeedItem);

Description

Метод позволяет добавить кнопку в панель инстументов TSpeedbar во время выполнения программы. Для того, чтобы добавленная кнопка стала видимой, используйте свойства Visible, Left и Right кнопки TSpeedItem. Удаление кнопки из панели инструментов осуществляется с помощью метода RemoveItem.

Вы можете также добавлять или удалять кнопки в режиме дизайна формы с помощью редактора компоненты TSpeedbar (Speedbar Designer).


AddSection
AddSection Method

Applies to

TSpeedbar component

Declaration

function AddSection(const ACaption: string): Integer;

Description

Метод добавляет секцию с именем (заголовком) ACaption к списку секций компоненты TSpeedBar и возвращает индекс вновь созданной секции. В случае ошибки возвращаемое значение отрицательно. Все секции в панели инструментов должны иметь уникальные заголовки. При попытке добавления секции с именем уже существующей секции, метод просто вернет положительный индекс уже существующей секции.


Customize
Customize Method

Applies to

TSpeedbar component

Declaration

procedure Customize(HelpCtx: Longint);

Description

Метод предназначен для настройки панели управления (TSpeedbar) пользователем во время выполнения программы. Вызов метода вызывает диалоговое окно, отображающее список всех доступных кнопок панели инструментов, разделенных по категориям. Пользуясь этим диалогом можно переместить мышкой кнопки из диалога на панель управления или удалить кнопки с панели управления опять же с помощью мыши (drag-and-drop). Вы можете воспользоваться методом SaveLayout для сохранения текущих установок компоненты TSpeedbar в INI-файле, и методом RestoreLayout для восстановления этих установок из INI-файла.


FindItem
FindItem Method

Applies to

TSpeedbar component

Declaration

function FindItem(Item: TSpeedItem; var Section, Index: Integer): Boolean;

Description

Метод предназначен для определения индекса (позиции) кнопки Item в списке кнопок панели управления. Метод возвращает индекс кнопки в секции (первая кнопка имеет индекс 0) в параметре Index, и номер секции в параметре Section. Если кнопка Item найдена в панели инструментов, функция возвращает True, в противном случае - False.


TSpeedbar.Items
Items Method

Applies to

TSpeedbar component

Declaration

function Items(Section, Index: Integer): TSpeedItem;

Description

Функция вовзращает ссылку на компонент TSpeedItem из панели инструментов по индексу секции Section и позиции в секции Index. Если переданные значения индексов содержат недействительные значения, функция возвращает nil.


ItemsCount
ItemsCount Method

Applies to

TSpeedbar component

Declaration

function ItemsCount(Section: Integer): Integer;

Description

Метод возвращает полное число кнопок TSpeedItem во всех секциях компоненты TSpeedBar.


RemoveItem
RemoveItem Method

Applies to

TSpeedbar component

Declaration

procedure RemoveItem(Item: TSpeedItem);

Description

Метод позволяет удалить кнопку, заданную параметром Item, из панели инстументов TSpeedbar во время выполнения программы. Если удаляемая кнопка отображается на панели, то она будет скрыта. Метод не уничтжает объект класса TSpeedItem, заданный параметром Item. Для освобождения объекта вызовите Item.Free.

Вы можете также добавлять или удалять кнопки в режиме дизайна формы с помощью редактора компоненты TSpeedbar (Speedbar Designer).


RemoveSection
RemoveSection Method

Applies to

TSpeedbar component

Declaration

procedure RemoveSection(Section: Integer);

Description

Метод удаляет секцию, заанную индексом Section, из панели инструментов TSpeedbar. При этом будут удалены и освобождены все кнопки, входящие в указанную секцию.


SearchSection
SearchSection Method

Applies to

TSpeedbar component

Declaration

function SearchSection(const ACaption: string): Integer;

Description

Функция возвращает индекс секции в компоненте TSpeedBar по ее заголовку ACaption. Если секция с таким заголовком отсутствует в панели инструментов, метод вернет -1.


TSpeedbar.SetFontDefault
SetFontDefault Method

Applies to

TSpeedbar component

Declaration

procedure SetFontDefault;

Description

Метод устанавливает шрифт по умолчанию для всех кнопок компоненты TSpeedbar. Для 16-битной версии это "Ms Sans Serif", regular, 8. В 32-битной версии это системный шрифт, используемый для отрисовки меню.

Вы можете вызвать этот метод, например, при изменении системных настроек Windows, из обработчика события OnSettingsChanged компоненты TAppEvents.


TSpeedItem object
TSpeedItem Class

Hierarchy             See also             Properties             Methods             Events

Unit

Speedbar

Description

Класс TSpeedItem предназначен для определения невизуальной компоненты, с помощью которой осуществляется интерфейс между кнопками TRxSpeedButton и компонентой TSpeedbar. Компонента TSpeedItem имеет все те же самые свойства, методы и события, что и компонента TRxSpeedButton, за исключением некоторых специфических свойств, не требующихся для работы компоненты TSpeedbar.


TSpeedItem See Also
See also

TRxSpeedButton

TSpeedbar

TSpeedButton


TSpeedItem Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TSpeedItem properties
Properties

Run-time only    [image] Key properties

AllowAllUp	Enabled	NumGlyphs
AllowTimer	Font	Owner
BtnCaption	Glyph	ParentFont
Button	GroupIndex	ParentShowHint
Caption	Hint	ShowHint
ComponentCount	ImageIndex	Spacing
ComponentIndex	Layout	Stored
Components	Left	Tag
Cursor	Margin	Top
Down	MarkDropDown	Visible
DropDownMenu	Name	WordWrap


TSpeedItem events
Events

Run-time only    [image] Key events

OnClick	OnMouseEnter	OnMouseUp
OnDblClick	OnMouseLeave
OnMouseDown	OnMouseMove


TSpeedItem methods
Methods

Key methods

ButtonClick	Create	InsertComponent
CheckBtnMenuDropDown	Destroy	RemoveComponent
Click	FindComponent


TSpeedItem.BtnCaption
BtnCaption Property

Applies to

TSpeedItem component

Declaration

property BtnCaption: TCaption;

Description

Свойство определяет текст, отображаемый в кнопке компоненты TSpeedbar.


TSpeedItem.Button
Button Property

Applies to

TSpeedItem component

Declaration

property Button: TRxSpeedButton;

Description

Свойство Button (только-для-чтения) предоставляет вам прямой доступ к кнопке, являющейся составной частью компонента TSpeedItem, как к объекту класса TRxSpeedButton. Вы можете напрямую изменять некоторые свойства этой кнопки, если хорошо представляете себе, что Вы собираетесь сделать.


TSpeedItem.ImageIndex
ImageIndex Property

Applies to

TSpeedItem component

Declaration

property ImageIndex: Integer;

Description

Определяет индекс графического изображения, используемого при отрисовке кнопки, в списке графических изображений, заданном свойством TSpeedbar.Images.

Нумерация изображений в списке начинается от 0.

Если свойство TSpeedbar.Images задает непустой список изображений, и свойство ImageIndex задает допустимый индекс в этом списке, то свойство Glyph игнорируется и используется графическое изображение из списка.


TSpeedItem.Stored
Stored Property

Applies to

TSpeedItem component

Declaration

property Stored: Boolean;

Description

Свойство определяет, будут ли сохранены в INI-файле (или в Registry) позиция и видимость кнопки, при вызове методов SaveLayout (или SaveLayoutReg) компоненты TSpeedbar.


TSpeedItem.ButtonClick
ButtonClick Method

Applies to

TSpeedItem component

Declaration

procedure ButtonClick;

Description

Метод позволяет программно эмулировать нажатие на кнопку.


TApplyAlignEvent Type

Unit

Speedbar

Declaration

type

TApplyAlignEvent = procedure (Sender: TObject; Align: TAlign; var Apply: Boolean) of object;

Description

Тип описывает обработчик события OnApplyAlign компоненты TSpeedBar.


TBarOrientation Type

Unit

Speedbar

Declaration

type

TBarOrientation = (boHorizontal, boVertical);

Description

Тип TBarOrientation определяет возможные значения свойства Orientation компоненты TSpeedbar.


TBarPosition Type

Unit

Speedbar

Declaration

type

TBarPosition = (bpAuto, bpCustom);

Description

Тип TBarPosition определяет возможные значения свойства Position компоненты TSpeedbar.


TBoundLine Type

Unit

Speedbar

Declaration

type

TBoundLine = (blTop, blBottom, blLeft, blRight);

Description

Тип задает возможные значения свойства BoundLines компоненты TSpeedbar.


TBoundLines Type

Unit

Speedbar

Declaration

type

TBoundLines = set of TBoundLine;

Description

Тип задает возможные значения свойства BoundLines компоненты TSpeedbar.


TSpeedbarOption Type

Unit

Speedbar

Declaration

type

TSpeedbarOption = (sbAllowDrag, sbAllowResize, sbFlatBtns, sbGrayedBtns, sbTransparentBtns, sbStretchBitmap);

Description

Тип задает возможные значения для свойства Options компоненты TSpeedBar.


TSpeedbarOptions Type

Unit

Speedbar

Declaration

type

TSpeedbarOptions = set of TSpeedbarOption;

Description

Тип задает возможные значения для свойства Options компоненты TSpeedBar.


FindSpeedBar Function

Examples

Unit

Speedbar

Declaration

function FindSpeedBar(const Pos: TPoint): TSpeedBar;

Description

Функция определяет, является ли верхним оконным объектом Windows в точке, заданной экранными координатами Pos, компонента класса TSpeedbar и в этом случае возвращает ссылку на эту компоненту.


FindSpeedBar example
Example

Bar := FindSpeedBar(Point(X, Y));

if Bar <> nil then begin

  {...}

end;


SplshWnd Unit

The following items are declared in the SplshWnd unit:

Types

TSplashWindow

Constants

SplashStayOnTop

Procedures and functions

ShowSplashWindow

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


SplashStayOnTop Constant

Unit

SplshWnd

Declaration

const

  SplashStayOnTop: Boolean = True;

Description

Переменная определяет, будет ли стиль окна, создаваемого функцией ShowSplashWindow, установлен в значение fsStayOnTop.

При значении переменной True стиль созданной формы будет fsStayOnTop, иначе fsNormal.


TSplashWindow Type

Unit

SplshWnd

Declaration

type

TSplashWindow = class(TForm);

Description

Класс предназначен для создания простых заставок (SplashScreen's) при загрузке приложения или при выполнении длительных операций.

Для создания и отображения объектов этого класса воспользуйтесь функцией ShowSplashWindow.


ShowSplashWindow Function

Examples

Unit

SplshWnd

Declaration

function ShowSplashWindow(Graphic: TGraphic; const MsgText: string; Animate: Boolean; AlignForm: TForm): TSplashWindow;

Description

Функция создает и отображает форму без заголовка с установленным стилем fsStayOnTop, которую можно использовать как заставку при загрузке приложения или при выполнении длительных операций (Splash Screen).

Параметр Graphic задает изображение, отображаемое в левой части формы. Это может быть битовое изображение, иконка, метафайл или любой другой объект класса - наследника TGraphic. Если параметр Animate = True и переданное изображение представляет собой TBitmap с расположенными последовательно картинками равной ширины и высоты (как требуется для компоненты TAnimatedImage), то изображение в форме будет "движущимся" (естественно, Вы должны для этого давать возможность картинке перерисоваться, т.е. вызывать Application.ProcessMessages, например).

Параметр MsgText задает текст сообщения, отображаемого в форме.

Параметр AlignForm задает форму, относительно которой будет центрироваться создаваемая Splash-форма. Если этот параметр равен nil, то Splash центрируется относительно всего экрана дисплея.

Стиль формы StayOnTop регулируется глобальной переменной SplashStayOnTop из модуля SplshWnd.pas.

Не забудьте уничтожить созданную splash-форму после ее использования вызовом метода Free.


ShowSplashWindow example
Example

var

  Splash: TForm;

begin

  Splash := ShowSplashWindow(Application.Icon,

    'Загрузка данных. Подождите, пожалуйста...', False,

    Application.MainForm);

  try

    { здесь Вы выполняете какие-то операции }

  finally

    Splash.Free;

  end;

end;


StrHlder Unit

The StrHlder unit contains the declarations for the certain components on the RX Tools 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 StrHlder unit:

Components and objects

TStrHolder

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


TStrHolder Component

Hierarchy             See also             Properties             Methods             Events

Unit

StrHlder

Description

Компонента предназначена для сохранения в форме (в DFM-файле) списков строк.


TStrHolder See Also
See also

TStringList

TStrings


TStrHolder Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TStrHolder properties
Properties

Run-time only    [image] Key properties

Capacity	Components	Owner
CommaText	Duplicates	Sorted
ComponentCount	KeyString	Strings
ComponentIndex	Name	Tag


TStrHolder events
Events

Run-time only    [image] Key events

OnChange	OnChanging


TStrHolder methods
Methods

Key methods

Create	FindComponent	RemoveComponent
Destroy	InsertComponent


TStrHolder.Capacity
Capacity Property

Applies to

TStrHolder component

Declaration

property Capacity: Integer;

Description

Indicates the number of strings the string list has allocated memory to hold.

Use Capacity to find out how much memory is available for holding strings, or to reallocate the memory to allow more or fewer strings.

Capacity is the number of entries in the string list that have been allocated, as opposed to Count, which is the number of strings in the list. Thus, Capacity is always greater than or equal to Count.

Note

This property is present only in Delphi 3.0 or higher version.


TStrHolder.CommaText
CommaText Property

Applies to

TStrHolder component

Declaration

property CommaText: string;

Description

CommaText is the list of strings in the TStrHolder object, listed in system data format (SDF) style.

Use CommaText to get or set all the strings in the TStrHolder object in a single comma-delimited string. When retrieving CommaText, any string in the list that include spaces, commas or quotes will be contained in double quotes, and any double quotes in a string will be repeated. For example, if the list contains the following strings:

 Stri,ng 1

 Stri"ng 2

 String 3

 String4

CommaText will return:

 "Stri,ng 1","Stri""ng 2","String 3",String4

When assigning CommaText, the value is parsed as SDF formatted text. For SDF format, strings are separated by commas or spaces, and optionally enclosed in double quotes. Double quote marks that are part of the string are repeated to distinguish them from the quotes that surround the string. Spaces and commas that are not contained within double quote marks are delimiters. Two commas next to each other will indicate an empty string, but spaces that appear next to another delimiter are ignored. For example, suppose CommaText is set to:

 "Stri,ng 1", "Stri""ng 2" , String 3,String4

The list will then contain:

 Stri,ng 1

 Stri"ng 2

 String

 3

 String4

Note

Reading CommaText uses the Strings property to get the text. Setting CommaText uses the Add method to set the text.


KeyString
KeyString Property

Applies to

TStrHolder component

Declaration

property KeyString: string;

Description

Если свойство KeyString задает непустую строку, то при сохранении строк Strings в ресурсе формы они будут закодированы. Используется простейший механизм кодирования - операция XOR с ключевой строкой KeyString. Предназначен этот механизм только для того, чтобы строки не лежали в EXE-файле "как есть", но никак не для засекречивания информации.


StrUtils Unit

The following items are declared in the StrUtils unit:

Types

TCharSet

Constants

DigitChars

Procedures and functions

AddChar

AddCharR

AnsiProperCase

CenterStr

CompStr

CompText

Copy2Space

Copy2SpaceDel

Copy2Symb

Copy2SymbDel

Dec2Hex

Dec2Numb

DelBSpace

DelChars

DelESpace

DelRSpace

DelSpace

DelSpace1

ExtractDelimited

ExtractQuotedString

ExtractSubstr

ExtractWord

ExtractWordPos

FindCmdLineSwitch

FindPart

GetCmdLineArg

Hex2Dec

IntToRoman

IsEmptyStr

IsWild

IsWordPresent

LeftStr

MakeStr

MS

NPos

Numb2Dec

Numb2USA

OemToAnsiStr

QuotedString

ReplaceStr

RightStr

RomanToInt

StrToOem

Tab2Space

WordCount

WordPosition

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


DigitChars Constant

Unit

StrUtils

Declaration

const

  DigitChars = ['0'..'9'];

Description

Цифры.


TCharSet Type

Unit

StrUtils

Declaration

type

TCharSet = set of Char;

Description

Тип объявлен для удобства работы с наборами символов. Используется в процедурах и функциях модуля StrUtils.


AddChar Function

Examples

Unit

StrUtils

Declaration

function AddChar(C: Char; const S: string; N: Integer): string;

Description

Добавляет слева к стpоке S символы C до длины S=N.


AddChar example
Example

В результате вызова:

 S := 'Let It Be';

 S := AddChar(' ', S, 10);

строка S будет S = ' Let It Be'.


AddCharR Function

Examples

Unit

StrUtils

Declaration

function AddCharR(C: Char; const S: string; N: Integer): string;

Description

Добавляет справа к стpоке S символы C до длины S=N.


AddCharR example
Example

В результате вызова:

S := 'Let It Be';

S := AddChar(' ', S, 10); строка S будет S = 'Let It Be '.


AnsiProperCase Function

Examples

Unit

StrUtils

Declaration

function AnsiProperCase(const S: string; const WordDelims: TCharSet): string;

Description

Returns string, with the first letter of each word in uppercase, all other letters in lowercase. Words are delimited by WordDelims.


AnsiProperCase example
Example

 S := AnsiProperCase('let  him go');

 { here S = 'Let  Him Go' }


CenterStr Function

Examples

Unit

StrUtils

Declaration

function CenterStr(const S: string; Len: Integer):string;

Description

Центpитует стpоку S относительно длины Len.


CenterStr example
Example

В результате вызова:

 S := 'Let It Be';

 S := CenterStr(S, 13);

строка S будет S = '  Let It Be  '.


CompStr Function

Examples

Unit

StrUtils

Declaration

function CompStr(const S1, S2: string): Integer;

Description

Сравнивает строки S1 и S2 (с учетом регистра). Функция возвращает 0, если строки равны; -1, если S1 < S2; и 1, если S1 > S2.


CompStr example
Example

 var

   I: Integer;

 begin

   I := CompStr(S1, S2);

   if I = 0 then begin

     { S1 = S2 }

   end

   else if I < 0 then begin

     { S1 < S2 }

   end

   else begin

     { S1 > S2 }

   end;

 end;


CompText Function

Examples

Unit

StrUtils

Declaration

function CompText(const S1, S2: string): Integer;

Description

Сравнивает строки S1 и S2 (без учета регистра). Функция возвращает 0, если строки равны; -1, если S1 < S2; и 1, если S1 > S2.


CompText example
Example

 var

   I: Integer;

 begin

   I := CompText(S1, S2);

   if I = 0 then begin

     { S1 = S2 }

   end

   else if I < 0 then begin

     { S1 < S2 }

   end

   else begin

     { S1 > S2 }

   end;

 end;


Copy2Space Function

Examples

Unit

StrUtils

Declaration

function Copy2Space(const S: string): string;

Description

Копирует с начала строки до первого пробела.


Copy2Space example
Example

  S := 'Let it be';

  S := Copy2Space(S);

  { here S = 'Let' }


Copy2SpaceDel Function

Examples

Unit

StrUtils

Declaration

function Copy2SpaceDel(var S: string): string;

Description

Копирует с начала строки до первого пробела и удаляет эту часть.


Copy2SpaceDel example
Example

  S := 'Let it be';

  S1 := Copy2SpaceDel(S);

  { here S1 = 'Let', S = 'it be' }


Copy2Symb Function

Examples

Unit

StrUtils

Declaration

function Copy2Symb(const S: string; Symb: Char): string;

Description

Копирует с начала строки S до первого символа Symb и возвращает эту часть исходной строки.


Copy2Symb example
Example

  S := 'Let-it-be';

  S := Copy2Symb(S, '-');

  { here S = 'Let' }


Copy2SymbDel Function

Examples

Unit

StrUtils

Declaration

function Copy2SymbDel(var S: string; Symb: Char): string;

Description

Копирует с начала строки S до первого символа Symb, возвращает эту часть строки и удаляет ее из исходной строки S.


Copy2SymbDel example
Example

  S := 'Let-it-be';

  S1 := Copy2SymbDel(S, '-');

  { here S1 = 'Let', S = 'it-be' }


Dec2Hex Function

Examples

Unit

StrUtils

Declaration

function Dec2Hex(N: Longint; A: Byte): string;

Description

Пpеобpазует целое число N в шестнадцатеричное число, дополняя слева нулями до длины A.


Dec2Hex example
Example

В результате вызова:

 S := Dec2Hex(10, 2);

строка S = '0A'.


Dec2Numb Function

Examples

Unit

StrUtils

Declaration

function Dec2Numb(N: Longint; A, B: Byte): string;

Description

Пpеобpазует целое число N в число по основанию B, дополняя слева нулями до длины A.


Dec2Numb example
Example

В результате вызова

  S := Dec2Numb(10, 8, 2);

строка S = '00001010'.


DelBSpace Function

Examples

Unit

StrUtils

Declaration

function DelBSpace(const S: string): string;

Description

Функция удаляет ведущие пpобелы из стpоки S.


DelBSpace example
Example

 var

   S: string;

 begin

   S := '   Let It Be';

   S := DelSpace(S);

   ShowMessage(S); { here S = 'Let It Be' }

 end;


DelChars Function

Examples

Unit

StrUtils

Declaration

function DelChars(const S: string; Chr: Char): string;

Description

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


DelChars example
Example

 var

   S: string;

 begin

   S := 'Let It Be';

   S := DelChars(S, 'e');

   ShowMessage(S); { here S = 'Lt It B' }

 end;


DelESpace Function

Examples

Unit

StrUtils

Declaration

function DelESpace(const S: string): string;

Description

Функция удаляет конечные пpобелы из стpоки S.


DelESpace example
Example

 var

   S: string;

 begin

   S := 'Let It Be     ';

   S := DelSpace(S);

   ShowMessage(S); { here S = 'Let It Be' }

 end;


DelRSpace Function

Examples

Unit

StrUtils

Declaration

function DelRSpace(const S: string): string;

Description

Функция удаляет начальные и конечные пpобелы из стpоки S.


DelRSpace example
Example

 var

   S: string;

 begin

   S := '  Let It Be     ';

   S := DelSpace(S);

   ShowMessage(S); { here S = 'Let It Be' }

 end;


DelSpace Function

Examples

Unit

StrUtils

Declaration

function DelSpace(const S: string): string;

Description

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


DelSpace example
Example

 var

   S: string;

 begin

   S := 'Let It Be';

   S := DelSpace(S);

   ShowMessage(S); { here S = 'LetItBe' }

 end;


DelSpace1 Function

Examples

Unit

StrUtils

Declaration

function DelSpace1(const S: string): string;

Description

Функция удаляет все, кpоме одного, пpобелы из стpоки S. Напpимеp:

Входная  стpока:

'dshfgj   hjsgdfhj wer      wer';

Выходная стpока:

'dshfgj hjsgdfhj wer wer'.


DelSpace1 example
Example

 var

   S: string;

 begin

   S := 'Let It      Be';

   S := DelSpace1(S);

   ShowMessage(S); { here S = 'Let It Be' }

 end;


ExtractDelimited Function

Examples

Unit

StrUtils

Declaration

function ExtractDelimited(N: Integer; const S: string; const Delims: TCharSet): string;

Description

Функция аналогична функции ExtractWord. В отличии от нее воспринимает 2 символа из Delims, идущих подряд, как разделители между пустой строкой.


ExtractDelimited example
Example

 S := 'Let  him go';

 S1 := ExtractDelimited(2, S, [' ']);

 { here S1 = '' }


ExtractQuotedString Function

Examples

Unit

StrUtils

Declaration

function ExtractQuotedString(const S: string; Quote: Char): string;

Description

ExtractQuotedString removes the Quote characters from the beginning and end of a quoted string, and reduces pairs of Quote characters within the quoted string to a single character.


ExtractQuotedString example
Example

  S := ExtractQuotedString(S, '"');


ExtractSubstr Function

Examples

Unit

StrUtils

Declaration

function ExtractSubstr(const S: string; var Pos: Integer; const Delims: TCharSet): string;

Description

Функция предназначена для выделения подстроки из строки S, если подстроки разделены символами из набора Delims.

Возвращает подстроку из строки S, начинающуюся с позиции Pos в исходной строке, и увеличивает Pos, устанавливая его в значение, соответствующее началу следующей подстроки. Работа функции аналогична функции ExtractFields из модуля DB.PAS.

Вы можете также воспользоваться для выделения отдельных подстрок из строки функциями ExtractWord, ExtractWordPos и ExtractDelimited.


ExtractSubstr example
Example

var

  Pos: Integer;

  List: TStringList;

  S: string;

begin

  { ... }

  Pos := 1;

  while Pos <= Length(S) do

    List.Add(ExtractFieldName(S, Pos, [',',';']));

  { ... }

end;


ExtractWord Function

Examples

Unit

StrUtils

Declaration

function ExtractWord(N: Integer; const S: string; const WordDelims: TCharSet): string;

Description

Выделяет N-ое слово из строки S, используя WordDelims (типа TCharSet) как разделитель между словами.


ExtractWord example
Example

 S := 'Let  him go';

 S1 := ExtractWord(2, S, [' ']);

 { here S1 = 'him' }


ExtractWordPos Function

Examples

Unit

StrUtils

Declaration

function ExtractWordPos(N: Integer; const S: string; const WordDelims: TCharSet; var Pos: Integer): string;

Description

Выделяет N-ое слово из строки S, используя WordDelims (типа TCharSet) как разделитель между словами. В отличие от функции ExtractWord дополнительно определяет позицию искомого слова во входной строке и возвращает ее в параметре Pos.


ExtractWordPos example
Example

 S := 'Let  him go';

 S1 := ExtractWordPos(2, S, [' '], P);

 { here S1 = 'him', P = 6 }


FindCmdLineSwitch Function

Examples

Unit

StrUtils

Declaration

function FindCmdLineSwitch(const Switch: string; SwitchChars: TCharSet; IgnoreCase: Boolean): Boolean;

Description

FindCmdLineSwitch determines whether a string was passed as a command line argument to the application.

FindCmdLineSwitch determines whether the string in the Switch parameter was passed as a command line argument to the application. SwitchChars identifies valid argument-delimiter characters (e.g., "-" and "/" are common delimiters). The IgnoreCase parameter controls whether a case-sensistive or case-insensitive search is performed.

Note

In Delphi 4.0 or higher use standard function FindCmdLineSwitch from SysUtils unit.


FindCmdLineSwitch example
Example

  if FindCmdLineSwitch('REGISTER', ['-', '/'], True) then

  begin

    RegisterServer(Application.ExeName);

  end;


FindPart Function

Examples

Unit

StrUtils

Declaration

function FindPart(const HelpWilds, InputStr: string): Integer;

Description

Функция FindPart сравнивает строку, содержащую символы '?', с другой строкой, и возвращает позицию HelpWilds в InputStr.


FindPart example
Example

 var

   P: Integer;

   Wild: string;

 begin

   Wild := '?im';

   P := FindPart(Wild, 'Let him go');

   { here P = 5 }

 end;


GetCmdLineArg Function

Examples

Unit

StrUtils

Declaration

function GetCmdLineArg(const Switch: string; SwitchChars: TCharSet): string;

Description

GetCmdLineArg определяет, имеется ли параметр Switch среди параметров командной строки, переданных в приложение, и возвращает значение этого параметра. Если параметр не найден, возвращается пустая строка. Параметр SwitchChars задает набор символов, используемых как разделитель параметров (например, "-" и "/").


GetCmdLineArg example
Example

  Mode := GetCmdLineArg('M', ['-', '/']);

  if Mode <> '' then begin

    ShowMessage(Format('Mode name: %s', [Mode]));

  end;


Hex2Dec Function

Examples

Unit

StrUtils

Declaration

function Hex2Dec(const S: string): Longint;

Description

Пpеобpазует шестнадцатеpичное число в стpоке S в целое десятичное.


Hex2Dec example
Example

  I := Hex2Dec('1A');

  { here I = 26 }


IntToRoman Function

Examples

Unit

StrUtils

Declaration

function IntToRoman(Value: Longint): string;

Description

IntToRoman converts the given value to a roman numeric string representation.


IntToRoman example
Example

S := IntToRoman(1996);


IsEmptyStr Function

Examples

Unit

StrUtils

Declaration

function IsEmptyStr(const S: string; const EmptyChars: TCharSet): Boolean;

Description

Функция возвращает True, если строка S содержит только символы из EmptyChars.


IsEmptyStr example
Example

 if IsEmptyStr(S, [#0,' ']) then begin

   ShowMessage('S contains only while spaces');

 end;


IsWild Function

Examples

Unit

StrUtils

Declaration

function IsWild(InputStr, Wilds: string; IgnoreCase: Boolean): Boolean;

Description

Функция IsWild сравнивает строку InputString со строкой WildCard, содержащей символы маски, и возвращает True, если строка InputStr соответствует маске.


IsWild example
Example

Примеры возможных масок и соответствующих им строк:

*   : >= 0 буквы;

*A  : строка с более чем 1 буквой  и символом A в конце;

A*A : строка более чем из 2 букв и символами A в начале и в конце;

A*  : строка с более чем 1 буквой  и символом A в начале;

?   : одна и только одна буква.


IsWordPresent Function

Examples

Unit

StrUtils

Declaration

function IsWordPresent(const W, S: string; const WordDelims: TCharSet): Boolean;

Description

Определяет, присутствует ли слово W в строке S, используя символы WordDelims как возможные разделители между словами.


IsWordPresent example
Example

 if IsWordPresent('him', 'Let him go', [' ', ',']) then

   ShowMessage('String contsins word "him"');


LeftStr Function

Examples

Unit

StrUtils

Declaration

function LeftStr(const S: string; N: Integer): string;

Description

Добавляет строку S до длины N справа.


LeftStr example
Example

В результате вызова:

 S := 'Let It Be';

 S := LeftStr(S, 10);

строка S будет S = 'Let It Be '.


MakeStr Function

Examples

Unit

StrUtils

Declaration

function MakeStr(C: Char; N: Integer): string;

Description

Фоpмиpует стpоку из N символов C.


MakeStr example
Example

Для формирования строки из 10 пробелов можно воспользоваться вызовом:

  S := MakeStr(' ', 10);


MS Function

Examples

Unit

StrUtils

Declaration

function MS(C: Char; N: Integer): string;

Description

Фоpмиpует стpоку из N символов C.


MS example
Example

Для формирования строки из 10 пробелов можно воспользоваться вызовом:

  S := MS(' ', 10);


NPos Function

Examples

Unit

StrUtils

Declaration

function NPos(const C: string; S: string; N: Integer): Integer;

Description

Ищет позицию N-го вхождения подстроки C в стpоке S.


NPos example
Example

 var

   S: string;

   I: Integer;

 begin

   S := 'Let It Be';

   I := NPos(' ', S, 2);

   { I = 7 }

 end;


Numb2Dec Function

Examples

Unit

StrUtils

Declaration

function Numb2Dec(S: string; B: Byte): Longint;

Description

Пpеобpазует число по основанию B в стpоке S в целое десятичное.


Numb2Dec example
Example

 I := Numb2Dec('1010', 2);

 { here I = 10 }


Numb2USA Function

Examples

Unit

StrUtils

Declaration

function Numb2USA(const S: string): string;

Description

Пpеобpазует числовую стpоку S к фоpмату США. Напpимеp:

Входная  стpока: '12365412';

Выходная стpока: '12,365,412'.


Numb2USA example
Example

  S := Numb2USA('12365412');

  { here S = '12,365,412' }


OemToAnsiStr Function

Examples

Unit

StrUtils

Declaration

function OemToAnsiStr(const OemStr: string): string;

Description

OemToAnsiStr translates a string from the OEM character set into the Windows character set.


OemToAnsiStr example
Example

S := OemToAnsiStr(S);


QuotedString Function

Examples

Unit

StrUtils

Declaration

function QuotedString(const S: string; Quote: Char): string;

Description

QuotedString returns the given string as a quoted string, using the provided Quote character.


QuotedString example
Example

  S := QuotedString(S, '"');


ReplaceStr Function

Examples

Unit

StrUtils

Declaration

function ReplaceStr(const S, Srch, Replace: string): string;

Description

Функция заменяет в строке S все вхождения подстроки Srch на подстроку, переданную в качестве аргумента Replace.


ReplaceStr example
Example

S := ReplaceStr(ReplaceStr(Condition, '*', '%'), '?', '_');


RightStr Function

Examples

Unit

StrUtils

Declaration

function RightStr(const S: string; N: Integer): string;

Description

Добавляет строку S до длины N слева.


RightStr example
Example

В результате вызова:

 S := 'Let It Be';

 S := RightStr(S, 10);

строка S будет S = ' Let It Be'.


RomanToInt Function

Examples

Unit

StrUtils

Declaration

function RomanToInt(const S: string): Longint;

Description

RomanToInt converts the given string to an integer value. If the string doesn't contain a valid roman numeric value, the 0 value is returned.


RomanToInt example
Example

I := RomanToInt('MCMXVI');


StrToOem Function

Examples

Unit

StrUtils

Declaration

function StrToOem(const AnsiStr: string): string;

Description

Конвертирует переданную в качестве аргумента AnsiStr строку (в ANSI-кодировке Windows) в кодировку OEM.


StrToOem example
Example

S := StrToOem(S);


Tab2Space Function

Examples

Unit

StrUtils

Declaration

function Tab2Space(const S: string; Numb: Byte): string;

Description

Преобразует знаки табуляции в строке S в Numb пробелов.


Tab2Space example
Example

Вызов функции

   S := Tab2Space(S, 8);

заменит все символы табуляции в строке S на 8 пробелов.


WordCount Function

Examples

Unit

StrUtils

Declaration

function WordCount(const S: string; const WordDelims: TCharSet): Integer;

Description

Считает число слов в строке S, используя параметр WordDelims (типа TCharSet) как разделитель между словами.


WordCount example
Example

  I := WordCount('Let him go', [' ', ',']);

  { here I = 3 }


WordPosition Function

Examples

Unit

StrUtils

Declaration

function WordPosition(const N: Integer; const S: string; const WordDelims: TCharSet): Integer;

Description

Возвращает позицию первого символа N-го слова в строке S, используя параметр WordDelims (типа TCharSet) как разделитель между словами.


WordPosition example
Example

  I := WordPosition(2, 'Let him go', [' ', ',']);

  { here I = 5 }


TimerLst Unit

The TimerLst unit contains the declarations for the certain components on the RX Tools 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 TimerLst unit:

Components and objects

TRxTimerEvent

TRxTimerList

Types

TAllTimersEvent

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


TRxTimerEvent object
TRxTimerEvent Class

Hierarchy             See also             Properties             Methods             Events

Unit

TimerLst

Description

Компонента, предназначенная для хранения данных одного события из очереди событий TRxTimerList. Имеет свойства, аналогичные свойствам TTimer: Enabled, Interval, OnTimer. Дополнительно событие может быть "однократным", т.е. после одного его срабатывания через заданное время оно становится неактивным (это зависит от значения свойства Cycled).


TRxTimerEvent See Also
See also

TRxTimerList

TTimer


TRxTimerEvent Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxTimerEvent properties
Properties

Run-time only    [image] Key properties

AsSeconds	Handle	RepeatCount
Cycled	Interval	Tag
Enabled	Name	TimerList
ExecCount	Owner


TRxTimerEvent events
Events

Run-time only    [image] Key events

OnTimer


TRxTimerEvent methods
Methods

Key methods

Create	Destroy


AsSeconds
AsSeconds Property

Applies to

TRxTimerEvent component

Declaration

property AsSeconds: Word;

Description

Свойство позволяет присваивать и получать значение свойства Interval в секундах.


TRxTimerEvent.Cycled
Cycled Property

Applies to

TRxTimerEvent component

Declaration

property Cycled: Boolean;

Description

Значение свойства определяет цикличность выполнения события. Если свойство Cycled = True, то событие будет срабатывать через равные промежутки времени, заданные свойством Interval (мсек). Если свойство установлено в False, то событие сработает только один раз, после чего станет неактивным, т.е. его свойство Enabled получит значение False. При установленном в True значении Cycled не используется свойство RepeatCount для контроля за количеством запусков события. Для определения количества событий, выполненных с момента активации TRxTimerList используйте свойство ExecCount.


ExecCount
ExecCount Property

Applies to

TRxTimerEvent component

Declaration

property ExecCount: Integer;

Description

Свойство содержит количество вызовов события с момента активации списка методом Activate или через присваивание свойству Active значения True. Когда список TRxTimerList неактивен, значение этого свойства равно нулю.


TRxTimerEvent.Handle
Handle Property

Applies to

TRxTimerEvent component

Declaration

property Handle: Integer;

Description

Идентификатор события, получаемый им при добавлении к списку событий. Этот идентификатор уникален для каждого события на протяжении всей жизни компоненты TRxTimerList.


RepeatCount
RepeatCount Property

Applies to

TRxTimerEvent component

Declaration

property RepeatCount: Integer;

Description

Значение свойства определяет количество раз, сколько через равные промежутки времени сработает событие. После выполнения последний раз событие станет неактивным, т.е. его свойство Enabled установится в False. Значение этого свойства не может быть меньше 1. Свойство используется только в том случае, когда значение свойства Cycled установлено в False. Для определения количества событий, выполненных с момента активации TRxTimerList используйте свойство ExecCount.


TimerList
TimerList Property

Applies to

TRxTimerEvent component

Declaration

property TimerList: TRxTimerList;

Description

Список (очередь событий), в котором содержится данный объект - событие.


TRxTimerList Component

Hierarchy             See also             Properties             Methods             Events

Unit

TimerLst

Description

Компонента предназначена для вызова пользовательских методов для обработчки события через заданные промежутки времени. Компонента поддерживает функциональность, аналогичную компоненте TTimer, но позволяет использовать один таймер Windows для всей очереди событий, хранящейся в списке Events (элементы типа TRxTimerEvent), сохраняя таким образом системные ресурсы, особенно в 16-битных приложениях. Каждое событие в очереди может быть активным или неактивным (свойство Enabled). Интервал вызова обработчиков задается в миллисекундах и имеет тип Longint, т.е. не имеет ограничения на длину интервала таймера Windows в 65535 мсек.

Вы можете создавать события в дизайнере с помощью редактора компоненты TRxTimerList. Любое событие может быть "однократным", т.е. после одного его срабатывания через заданное время оно становится неактивным (в зависимости от значения свойства Cycled).

При срабатывании любого из активных событий дополнительно к его обработчику OnTimer будет вызван обработчик события OnTimers компоненты, которому дополнительно передается значение свойства Handle события. Для получения события из списка по его идентификатору Handle используйте метод ItemByHandle.

Значение Handle возвращается при динамическом создании события методом Add. Для удаления события предназначен метод Delete. Очистить весь список можно вызовом метода Clear. Свойство Active определяет активность очереди событий.

Выполнение метода Activate аналогично присвоению Active := True, а метод Deactivate идентичен присвоению Active := False.

После того, как все события будут обработаны (т.е. свойство Enabled для каждого будет установлено в False), значение свойства Active самостоятельно установится в False. Чтобы отследить это, используйте событие OnFinish.


TRxTimerList See Also
See also

TRxTimerEvent

TTimer


TRxTimerList Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent


TRxTimerList properties
Properties

Run-time only    [image] Key properties

Active	Count	Owner
ComponentCount	EnabledCount	Tag
ComponentIndex	Events
Components	Name


TRxTimerList events
Events

Run-time only    [image] Key events

OnFinish	OnTimers


TRxTimerList methods
Methods

Key methods

Activate	Deactivate	InsertComponent
Add	Delete	ItemByHandle
Clear	Destroy	RemoveComponent
Create	FindComponent


TRxTimerList.Active
Active Property

Applies to

TRxTimerList component

Declaration

property Active: Boolean;

Description

При установке значения свойства Active в True активизирует таймер для сканирования и вызова событий, определенных в Events.


TRxTimerList.Count
Count Property

Applies to

TRxTimerList component

Declaration

property Count: Integer;

Description

Общее количество событий в списке Events.


TRxTimerList.EnabledCount
EnabledCount Property

Applies to

TRxTimerList component

Declaration

property EnabledCount: Integer;

Description

Количество активных событий в списке Events (т.е. у которых свойство Enabled равно True).


Events
Events Property

Applies to

TRxTimerList component

Declaration

property Events: TList;

Description

Список, в котором содержатся ссылки на события, определенные классом TRxTimerEvent. Свойство предназначено для внутреннего использования, и в процессе работы компоненты порядок событий в этом списке может меняться.

Используйте для доступа к данным событий метод ItemByHandle, для динамического добавления новых событий - метод Add.


OnFinish
OnFinish Event

Applies to

TRxTimerList component

Declaration

property OnFinish: TNotifyEvent;

Description

Вызывается при установке значения Active в False. Т.к. значение Deactivate списка выполняется автоматически после завершения отработки последнего события, можно использовать этот вызов для контроля за полной отработкой всех событий.


OnTimers
OnTimers Event

Applies to

TRxTimerList component

Declaration

property OnTimers: TAllTimersEvent;

Description

Вызывается при обработке любого события из списка Events. В качестве параметра передается идентификатор Handle обрабатываемого события.


TRxTimerList.Activate
Activate Method

Applies to

TRxTimerList component

Declaration

procedure Activate;

Description

Метод активизирует выполнение очереди событий. Его действие идентично Active := True.


TRxTimerList.Add
Add Method

Applies to

TRxTimerList component

Declaration

function Add(AOnTimer: TNotifyEvent; AInterval: Longint; ACycled: Boolean): Longint;

Description

Метод позволяет динамически добавить к списку событие TRxTimerEvent с обработчиком AOnTimer и временем запуска через интервал времени AInterval (мсек). Значение ACycled будет присвоено свойству Cycled создаваемого события.

В качестве результата будет возвращен Handle созданного события.


TRxTimerList.Clear
Clear Method

Applies to

TRxTimerList component

Declaration

procedure Clear;

Description

Метод очищает весь список событий Items.


TRxTimerList.Deactivate
Deactivate Method

Applies to

TRxTimerList component

Declaration

procedure Deactivate;

Description

Метод останавливает выполнение очереди событий. Его действие идентично Active := False.


TRxTimerList.Delete
Delete Method

Applies to

TRxTimerList component

Declaration

procedure Delete(AHandle: Longint);

Description

Метод удаляет событие из списка по заданному идентификатору Handle.


ItemByHandle
ItemByHandle Method

Applies to

TRxTimerList component

Declaration

function ItemByHandle(AHandle: Longint): TRxTimerEvent;

Description

Метод возвращает объект класса TRxTimerEvent из списка Events по заданному идентификатору Handle (Идентификатор Handle может быть получен при динамическом создании события методом Add). В случае, если в списке не окажется события с таким Handle, будет возвращено значение Nil.


TAllTimersEvent Type

Unit

TimerLst

Declaration

type

TAllTimersEvent = procedure(Sender: TObject; Handle: Longint) of object;

Description

Определят процедурный тип для обработчика события OnTimers компоненты TRxTimerList.


ToolEdit Unit

The ToolEdit 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 ToolEdit unit:

Components and objects

TComboEdit

TDateEdit

TDirectoryEdit

TFilenameEdit

Types

EComboEditError

TCalendarStyle

TDirDialogKind

TExecDateDialog

TExecOpenDialogEvent

TFileDialogKind

TGlyphKind

TPopupAlign

Constants

scAltDown

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


TComboEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

ToolEdit

Description

Компонента TComboEdit представляет собой строку редактирования (стандартный однострочный текстовый редактор Windows), комбирированную с кнопкой, аналогично тому, как объединен редактор текста и кнопка выпадающего списка в стандартном элементе Windows - ComboBox.

Вы можете определить свой обработчик события по нажатию этой кнопки (событие OnButtonClick), задать битовое изображение для кнопки (свойство Glyph), установить ширину кнопки (свойство ButtonWidth) и задать "горячую" клавишу, при нажатии на которую будет эмулироваться нажатие мышкой на кнопку (происходит событие OnButtonClick). Вы можете использовать событие по нажатию кнопки, например, для вызова диалоговой модальной формы, заполнив поля которой пользователь может определить текст строки редактирования. Прямой ввод данных в строку редактирования можно запретить, установив свойство DirectInput в значение False.


TComboEdit See Also
See also

TDateEdit

TDirectoryEdit

TFilenameEdit

TMaskEdit

TRxCalcEdit


TComboEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit


TComboEdit properties
Properties

Run-time only    [image] Key properties

Alignment	DragMode	ParentColor
AutoSelect	EditMask	ParentCtl3D
BorderStyle	Enabled	ParentFont
Button	Font	ParentShowHint
ButtonHint	Glyph	PopupMenu
ButtonWidth	GlyphKind	ReadOnly
CharCase	Height	ShowHint
ClickKey	HelpContext	Showing
Color	Hint	TabOrder
ComponentCount	Left	TabStop
ComponentIndex	MaxLength	Tag
Components	Name	Text
Ctl3D	NumGlyphs	Top
Cursor	OEMConvert	Visible
DirectInput	Owner	Width
DragCursor	Parent


TComboEdit events
Events

Run-time only    [image] Key events

OnButtonClick	OnEndDrag	OnMouseDown
OnChange	OnEnter	OnMouseMove
OnClick	OnExit	OnMouseUp
OnDblClick	OnKeyDown	OnStartDrag
OnDragDrop	OnKeyPress
OnDragOver	OnKeyUp


TComboEdit methods
Methods

Key methods

BeginDrag	FindComponent	Repaint
BringToFront	GetTextBuf	ScreenToClient
ClientToScreen	GetTextLen	SelectAll
CopyToClipboard	Hide	SendToBack
Create	InsertComponent	SetBounds
CutToClipboard	Invalidate	SetFocus
Destroy	PasteFromClipboard	SetTextBuf
DoClick	Perform	Show
Dragging	Refresh	Update
EndDrag	RemoveComponent


Button
Button Property

Applies to

TRxDBComboEdit, TComboEdit components

Declaration

property Button: TRxSpeedButton;

Description

Свойство Button (только-для-чтения) предоставляет вам доступ к кнопке, являющейся составной частью TComboEdit и унаследованных компонент, как к объекту класса TRxSpeedButton. Вы можете напрямую изменять некоторые свойства этой кнопки, если хорошо представляете себе, что Вы собираетесь сделать.


ButtonHint
ButtonHint Property

Applies to

TRxLookupEdit, TRxDBComboEdit, TRxDBCalcEdit, TRxCalcEdit, TFilenameEdit, TDirectoryEdit, TDBDateEdit, TDateEdit, TComboEdit components

Declaration

property ButtonHint: string;

Description

Свойство задает подсказку (Hint) для кнопки, являющейся составной частью TComboEdit и унаследованных компонент.


ButtonWidth
ButtonWidth Property

Applies to

TRxDBComboEdit, TRxDBCalcEdit, TRxCalcEdit, TFilenameEdit, TDirectoryEdit, TDBDateEdit, TDateEdit, TComboEdit components

Declaration

property ButtonWidth: Integer;

Description

Свойство задает ширину кнопки, являющейся составной частью TComboEdit и унаследованных компонент. Если это свойство имеет значение 0, то кнопка не показывается и событие OnButtonClick не вызывается (несмотря на значение свойства ClickKey).


OnButtonClick
OnButtonClick Event

Applies to

TRxLookupEdit, TRxDBComboEdit, TRxDBCalcEdit, TRxCalcEdit, TDateEdit, TComboEdit components

Declaration

property OnButtonClick: TNotifyEvent;

Description

Событие OnButtonClick происходит при нажатии на кнопку, являющуюся составной частью TComboEdit и унаследованных компонент, либо при нажатии "горячих" клавиш на клавиатуре, определенных свойством ClickKey. Вы можете обработать это событие, вызвав, например, диалоговую форму для изменения данных в строке редактирования. Если значение свойства ButtonWidth = 0, то событие OnButtonClick не происходит.


DoClick
DoClick Method

Applies to

TRxLookupEdit, TRxDBComboEdit, TRxDBCalcEdit, TRxCalcEdit, TFilenameEdit, TDirectoryEdit, TDateEdit, TComboEdit components

Declaration

procedure DoClick;

Description

Метод позволяет программно имитировать нажатие на кнопку вызова диалога или выпадающего окна.


TDateEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

ToolEdit

Description

Компонента представляет собой строку редактирования для ввода значений дат. Как наследник TComboEdit, кроме непосредственно строки редактирования имеет кнопку, нажатие которой приводит к появлению либо модальной формы, либо popup-календаря (в зависимости от значения свойства CalendarStyle) для выбора даты. Вы можете запретить ручной ввод даты непосредственно в строке редактирования, установив свойство DirectInput в значение False.


TDateEdit See Also
See also

TComboEdit

TDBDateEdit

TDirectoryEdit

TFilenameEdit

TMaskEdit


TDateEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit

  |

TCustomDateEdit


TDateEdit properties
Properties

Run-time only    [image] Key properties

AutoSelect	DirectInput	ParentShowHint
BlanksChar	DragCursor	PopupAlign
BorderStyle	DragMode	PopupColor
ButtonHint	Enabled	PopupMenu
ButtonWidth	Font	PopupVisible
CalendarHints	Glyph	ReadOnly
CalendarStyle	GlyphKind	ShowHint
CharCase	Height	Showing
CheckOnExit	HelpContext	StartOfWeek
ClickKey	Hint	TabOrder
Color	Left	TabStop
ComponentCount	MaxLength	Tag
ComponentIndex	Name	Text
Components	NumGlyphs	Top
Ctl3D	Owner	Visible
Cursor	Parent	WeekendColor
Date	ParentColor	Weekends
DefaultToday	ParentCtl3D	Width
DialogTitle	ParentFont


TDateEdit events
Events

Run-time only    [image] Key events

OnAcceptDate	OnDragOver	OnKeyUp
OnButtonClick	OnEndDrag	OnMouseDown
OnChange	OnEnter	OnMouseMove
OnClick	OnExit	OnMouseUp
OnDblClick	OnKeyDown	OnStartDrag
OnDragDrop	OnKeyPress


TDateEdit methods
Methods

Key methods

BeginDrag	FindComponent	Repaint
BringToFront	GetDateMask	ScreenToClient
CheckValidDate	GetTextBuf	SelectAll
ClientToScreen	GetTextLen	SendToBack
CopyToClipboard	Hide	SetBounds
Create	InsertComponent	SetFocus
CutToClipboard	Invalidate	SetTextBuf
Destroy	PasteFromClipboard	Show
DoClick	Perform	Update
Dragging	Refresh
EndDrag	RemoveComponent


OnAcceptDate
OnAcceptDate Event

Applies to

TDateEdit component

Declaration

property OnAcceptDate: TExecDateDialog;

Description

Событие OnAcceptDate возникает после того, как пользователь закрыл модальный далог с календарем для выбора даты, либо закрыл выпадающий (popup) календарь. В обработчике этого события вы можете проверить допустимость выбранного значения даты и поменять его. Если диалог был закрыт с результатом mrOk, либо это был popup-календарь, параметр Action имеет значение True, иначе значение False. Вы можете отменить сделанный пользователем выбор, изменив значение параметра Action на False.


CheckValidDate
CheckValidDate Method

Applies to

TDBDateEdit, TDateEdit components

Declaration

procedure CheckValidDate;

Description

Метод служит для проверки правильности ввода даты в компоненты класса TDateEdit, TDBDateEdit.

В случае неправильного значения вызывает исключительную ситуацию (exception) EConvertError и, если возможно, делает строку редактирования активной.


GetDateMask
GetDateMask Method

Applies to

TDBDateEdit, TDateEdit components

Declaration

function GetDateMask: string;

Description

Функция GetDateMask возвращает маску, в соответствие с которой происходит форматирование даты в компонентах TDateEdit и TDBDateEdit. Маска формируется на основании текущих установок Windows с учетом установленного значения глобальной переменной FourDigitYears из модуля DateUtil.


TDirectoryEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

ToolEdit

Description

Компонента представляет собой строку редактирования для ввода имен каталогов файловой системы. Являясь наследником TComboEdit, компонента TDirectoryEdit имеет кнопку, нажатие на которую приводит к открытию модального диалога выбора каталога (используется функция SelectDirectory из модуля FileCtrl). Выбранное имя каталога заносится в строку редактирования, если пользователь нажмет "Ок" в диалоге выбора имени каталога. Вы имеете доступ к выбранному имени каталога как к свойству Text компоненты TDirectoryEdit.

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


TDirectoryEdit See Also
See also

TComboEdit

TDateEdit

TDBDateEdit

TFilenameEdit

TMaskEdit


TDirectoryEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit

  |

TFileDirEdit


TDirectoryEdit properties
Properties

Run-time only    [image] Key properties

AcceptFiles	DragCursor	ParentColor
AutoSelect	DragMode	ParentCtl3D
BorderStyle	EditMask	ParentFont
ButtonHint	Enabled	ParentShowHint
ButtonWidth	Font	PopupMenu
CharCase	Glyph	ReadOnly
ClickKey	GlyphKind	ShowHint
Color	Height	Showing
ComponentCount	HelpContext	TabOrder
ComponentIndex	Hint	TabStop
Components	Left	Tag
Ctl3D	MultipleDirs	Text
Cursor	Name	Top
DialogKind	NumGlyphs	Visible
DialogOptions	Owner	Width
DirectInput	Parent


TDirectoryEdit events
Events

Run-time only    [image] Key events

OnAfterDialog	OnDragOver	OnKeyPress
OnBeforeDialog	OnDropFiles	OnKeyUp
OnChange	OnEndDrag	OnMouseDown
OnClick	OnEnter	OnMouseMove
OnDblClick	OnExit	OnMouseUp
OnDragDrop	OnKeyDown	OnStartDrag


TDirectoryEdit methods
Methods

Key methods

BeginDrag	FindComponent	Repaint
BringToFront	GetTextBuf	ScreenToClient
ClientToScreen	GetTextLen	SelectAll
CopyToClipboard	Hide	SendToBack
Create	InsertComponent	SetBounds
CutToClipboard	Invalidate	SetFocus
Destroy	PasteFromClipboard	SetTextBuf
DoClick	Perform	Show
Dragging	Refresh	Update
EndDrag	RemoveComponent


TDirectoryEdit.DialogKind
DialogKind Property

Applies to

TDirectoryEdit component

Declaration

property DialogKind: TDirDialogKind;

Description

Свойство задает тип диалога для выбора каталога, используемый компонентой TDirectoryEdit. Возможные значения:

• dkVCL - используется стандартный диалог выбора каталога из Delphi VCL (функция SelectDirectory стандартного модуля FileUtil)

• dkWin32 - используется стандартный диалог Win-32 "Browse for Folder". При установке этого значения свойство DialogOptions игнорируется. Работает только в Win95 или NT 4.x и выше, в противном случае используется тот же диалог, что и при значении dkVCL.


TDirectoryEdit.DialogOptions
DialogOptions Property

Applies to

TDirectoryEdit component

Declaration

property DialogOptions: TSelectDirOpts;

Description

Свойство DialogOptions позволяет вам задать режимы для диалога выбора имени каталога. Вы можете установить необходимые свойства появляющегося диалога, присвоив соответствующее значение свойству DialogOptions компоненты TDirectoryEdit.

Примечание

В 32-битной версии при установке свойства DialogKind в значение dkWin32 значение свойства DialogOptions игнороируется.


MultipleDirs
MultipleDirs Property

Applies to

TDirectoryEdit component

Declaration

property MultipleDirs: Boolean;

Description

Если значение свойства MultipleDir равно True, то после вызова диалога выбора каталога имя выбранного каталога будет добавлено к содержимому строки ввода (свойству Text) через точку с запятой (;), если значение этого свойства False (по умолчанию), имя выбранного каталога заменит содержимое строки редактирования.


TFilenameEdit Component

Hierarchy             See also             Properties             Methods             Events

Unit

ToolEdit

Description

Компонента представляет собой строку редактирования для ввода имен файлов. Являясь наследником TComboEdit, компонента TFilenameEdit имеет кнопку, нажатие на которую приводит к открытию модального диалога выбора имени (открытия) файла (используется стандартный диалог открытия файла TOpenDialog). Выбранное имя файла заносится в строку редактирования, если пользователь нажмет "Ок" в диалоге выбора имени файла. Вы имеете доступ к выбранному имени файла как к свойству Text компоненты TFilenameEdit.

Вы можете запретить ручной ввод имени файла непосредственно в строке редактирования, установив свойство DirectInput в значение False.


TFilenameEdit See Also
See also

TComboEdit

TDateEdit

TDBDateEdit

TDirectoryEdit

TMaskEdit


TFilenameEdit Hierarchy
Hierarchy

TObject

  |

TPersistent

  |

TComponent

  |

TControl

  |

TWinControl

  |

TCustomEdit

  |

TCustomMaskEdit

  |

TCustomComboEdit

  |

TFileDirEdit


TFilenameEdit properties
Properties

Run-time only    [image] Key properties

AcceptFiles	DirectInput	NumGlyphs
AutoSelect	DragCursor	Owner
BorderStyle	DragMode	Parent
ButtonHint	EditMask	ParentColor
ButtonWidth	Enabled	ParentCtl3D
CharCase	FileEditStyle	ParentFont
ClickKey	FileName	ParentShowHint
Color	Filter	PopupMenu
ComponentCount	FilterIndex	ReadOnly
ComponentIndex	Font	ShowHint
Components	Glyph	Showing
Ctl3D	GlyphKind	TabOrder
Cursor	Height	TabStop
DefaultExt	HelpContext	Tag
Dialog	Hint	Text
DialogFiles	HistoryList	Top
DialogKind	InitialDir	Visible
DialogOptions	Left	Width
DialogTitle	Name


TFilenameEdit events
Events

Run-time only    [image] Key events

OnAfterDialog	OnDragOver	OnKeyPress
OnBeforeDialog	OnDropFiles	OnKeyUp
OnChange	OnEndDrag	OnMouseDown
OnClick	OnEnter	OnMouseMove
OnDblClick	OnExit	OnMouseUp
OnDragDrop	OnKeyDown	OnStartDrag


TFilenameEdit methods
Methods

Key methods

BeginDrag	FindComponent	Repaint
BringToFront	GetTextBuf	ScreenToClient
ClientToScreen	GetTextLen	SelectAll
CopyToClipboard	Hide	SendToBack
Create	InsertComponent	SetBounds
CutToClipboard	Invalidate	SetFocus
Destroy	PasteFromClipboard	SetTextBuf
DoClick	Perform	Show
Dragging	Refresh	Update
EndDrag	RemoveComponent


AcceptFiles
AcceptFiles Property

Applies to

TFilenameEdit, TDirectoryEdit components

Declaration

property AcceptFiles: Boolean;

Description

Свойство позволяет компонентам TFilenameEdit и TDirectoryEdit принимать файлы и каталоги, перемещаемые из окна FileManager с помощью методов Drag-&-Drop.

При установленном значении этого свойства в True компонента получает и обрабатывает сообщение WM_DROPFILES, устанавливая в свойство Text имя соответствующего файла или каталога. При этом вызывается событие, которое Вы можете обработать с помощью свойства OnDropFiles.


Dialog
Dialog Property

Applies to

TFilenameEdit component

Declaration

property Dialog: TOpenDialog;

Description

Свойство Dialog (только-для-чтения) предоставляет вам прямой доступ к диалогу класса TOpenDialog, который вызывается при нажатии пользователем кнопки компоненты TFilenameEdit. Вы можете напрямую изменять некоторые свойства этого диалога, хотя это и не рекомендуется, так как доступ к свойствам диалога осуществляется через соответствующие свойства компоненты TFilenameEdit.


DialogFiles
DialogFiles Property

Applies to

TFilenameEdit component

Declaration

property DialogFiles: TStrings;

Description

Свойство DialogFiles предоставляет вам доступ к свойству Files диалога выбора файла TOpenDialog.


TFilenameEdit.DialogKind
DialogKind Property

Applies to

TFilenameEdit component

Declaration

property DialogKind: TFileDialogKind;

Description

Свойство задает тип диалога для выбора файла, используемый компонентой TFilenameEdit. Возможные значения:

• dkOpen - TOpenDialog

• dkSave - TSaveDialog

Начиная с версии Delphi 3.0 доступны значения:

• dkOpenPicture - TOpenPictureDialog

• dkSavePicture - TSavePictureDialog


DialogOptions
DialogOptions Property

Applies to

TFilenameEdit component

Declaration

property DialogOptions: TOpenOptions;

Description

Свойство DialogOptions предоставляет вам доступ к свойству Options диалога выбора файла TOpenDialog. Вы можете установить необходимые свойства появляющегося диалога, присвоив соответствующее значение свойству DialogOptions компоненты TFilenameEdit.


TFilenameEdit.FileName
FileName Property

Applies to

TFilenameEdit component

Declaration

property FileName: string;

Description

The FileName property specifies the file name that the TFilenameEdit displays and that appears in the File Name edit box when the pop-up dialog box opens.


OnAfterDialog
OnAfterDialog Event

Applies to

TFilenameEdit, TDirectoryEdit components

Declaration

property OnAfterDialog: TExecOpenDialogEvent;

Description

Событие возникает, когда пользователь закрывает модальный диалог выбора имени файла или каталога. В обработчике события вы можете изменить выбранное имя файла или каталога (параметр AName). Параметр Action определяется способом закрытия диалога - если пользователь нажал кнопку Cancel - параметр Action равен False, если ОК - True.


OnBeforeDialog
OnBeforeDialog Event

Applies to

TFilenameEdit, TDirectoryEdit components

Declaration

property OnBeforeDialog: TExecOpenDialogEvent;

Description

Событие возникает, когда пользователь открывает модальный диалог выбора имени файла или каталога. В обработчике события вы можете изменить имя файла или каталога (параметр AName), передаваемое в диалог. Если вы измените значение параметра Action на False, то этим вы отмените открытие диалога выбора файла или каталога.


OnDropFiles
OnDropFiles Event

Applies to

TFilenameEdit, TDirectoryEdit components

Declaration

property OnDropFiles: TNotifyEvent;

Description

Событие возникает при приеме имени файла или каталога по технологии Drag-&-Drop от Fail Manager при установленном в True значении свойства AcceptFiles.


scAltDown Constant

Unit

ToolEdit

Declaration

const

  scAltDown = scAlt + vk_Down;

Description

Константа задает комбинацию клавиш (Alt+Down) и используется для задания значения по умолчанию свойства ClickKey компоненты TComboEdit и унаследованных компонент.


EComboEditError Type

Unit

ToolEdit

Declaration

type

EComboEditError = class(Exception);

Description

Исключительная ситуация EComboEditError инициируется при ошибках ввода данных в компонентах - наследниках редактора с кнопкой TComboEdit.


TCalendarStyle Type

Unit

ToolEdit

Declaration

type

TCalendarStyle = (csPopup, csDialog);

Description

Тип задает возможные значения свойства CalendarStyle компонент TDateEdit и TDBDateEdit.


TDirDialogKind Type

Unit

ToolEdit

Declaration

type

TDirDialogKind = (dkVCL, dkWin32);

Description

Тип описывает возможные значения свойства DialogKind компоненты TDirectoryEdit.


TExecDateDialog Type

Unit

ToolEdit

Declaration

type

TExecDateDialog = procedure(Sender: TObject; var Date: TDateTime; var Action: Boolean) of object;

Description

Тип определяет формат процедуры-обработчика для события OnAcceptDate компоненты TDateEdit.


TExecOpenDialogEvent Type

Unit

ToolEdit

Declaration

type

TExecOpenDialogEvent = procedure(Sender: TObject; var Name: string; var Action: Boolean) of object;

Description

Тип определяет формат процедуры-обработчика для событий OnAfterDialog и OnBeforeDialog компонент TFilenameEdit и TDirectoryEdit.


TFileDialogKind Type

Unit

ToolEdit

Declaration

type

TFileDialogKind = (dkOpen, dkSave, dkOpenPicture, dkSavePicture);

Description

Тип описывает возможные значения свойства DialogKind компоненты TFilenameEdit. Значения dkOpenPicture, dkSavePicture доступны только в версии Delphi, начиная с 3.0.


TGlyphKind Type

Unit

ToolEdit

Declaration

type

TGlyphKind = (gkCustom, gkDefault, gkDropDown, gkEllipsis);

Description

Тип определяет возможные предопределенные значения для картинки на кнопку в компонентах TComboEdit, TFilenameEdit, TDirectoryEdit, TDateEdit, TDBDateEdit.

- gkCustom - пользовательская картинка, сохраняемая в DFM.

- gkDefault - картинка зависит от конкретного класса компоненты (TFilenameEdit, TDateEdit и т.д.)

- gkDropDown - стрелочка, используемая в выпадающих списках (ComboBox-ах). Запрашивается у Windows.

- gkEllipsis - изображение, означающее обычно вызов диалога (...). Рисуется немного по-разному в зависимости от ширины кнопки.


TPopupAlign Type

Unit

ToolEdit

Declaration

type

TPopupAlign = (epaRight, epaLeft);

Description

Тип определяет возможные значения свойства PopupAlign для компонент TRxCalcEdit, TRxDBCalcEdit, TDateEdit, TDBDateEdit, TLookupEdit.


VCLUtils Unit

The following items are declared in the VCLUtils unit:

Types

TFillDirection

TVertAlignment

Constants

WaitCursor

Procedures and functions

ActivatePrevInstance

ActivateWindow

AllocMemo

AnsiUpperFirstChar

AssignBitmapCell

CenterControl

CenterWindow

ChangeBitmapColor

CompareMem

CopyParentImage

CreateBitmapFromIcon

CreateIconFromBitmap

CreateRotatedFont

CreateTwoColorsBrushPattern

DefineCursor

Delay

DialogUnitsToPixelsX

DialogUnitsToPixelsY

DrawBitmapRectTransparent

DrawBitmapTransparent

DrawCellBitmap

DrawCellText

DrawInvertFrame

FreeMemo

FreeUnusedOLE

GetEnvVar

GetMemoSize

GetWindowsVersion

GradientFillRect

HeightOf

HugeDec

HugeInc

HugeMove

HugeOffset

ImageListDrawDisabled

IsForegroundTask

KillMessage

LoadAniCursor

LoadDLL

MakeBitmap

MakeBitmapID

MakeIcon

MakeIconID

MakeModuleBitmap

MakeModuleIcon

MergeForm

MinimizeText

MsgBox

NotImplemented

PaintInverseRect

PixelsToDialogUnitsX

PixelsToDialogUnitsY

PointInPolyRgn

PointInRect

RegisterServer

ResourceNotFound

ScreenWorkArea

ShadeRect

SplitCommandLine

StartWait

StopWait

WidthOf

Win32Check

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


WaitCursor Constant

Unit

VCLUtils

Declaration

const

  WaitCursor: TCursor = crHourGlass;

Description

Константа задает идентификатор курсора, используемый процедурой StartWait. При вызове процедуры курсор мыши на экране принимает форму, определенную константой WaitCursor.


TFillDirection Type

Unit

VCLUtils

Declaration

type

TFillDirection = (fdTopToBottom, fdBottomToTop, fdLeftToRight, fdRightToLeft);

Description

Тип определяет допустимые значения параметра Direction процедуры GradientFillRect.


TVertAlignment Type

Unit

VCLUtils

Declaration

type

TVertAlignment = (vaTopJustify, vaCenter, vaBottomJustify);

Description

Тип служит для описания возможных значений вертикального выравнивания при отрисовке текста. Используется процедурой DrawCellText.


ActivatePrevInstance Function

Examples

Unit

VCLUtils

Declaration

function ActivatePrevInstance(const MainFormClass, ATitle: string): Boolean;

Description

Функция ActivatePrevInstance предназначена для активизации предыдущей копии приложения. Параметр MainFormClass определяет имя класса главного окна приложения, которое необходимо активизировать. Для вашего приложения - это имя класса главной формы. Если окно такого класса найдено, то оно активизируется, и функция возвращает True. В противном случае функция возвращает False.

Если вы указали второй параметр (ATitle) при вызове функции ActivatePrevInstance, то при поиске окна будет учитываться не только имя класса, но и будет проверяться совпадение заголовка окна со значением ATitle.

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

ВНИМАНИЕ

При запуске приложения из-под среды Delphi функция всегда возвращает False, чтобы Вы могли запускать Ваше приложение в среде по команде Project/Run независимо от того, открыта или нет главная форма проекта в дизайнере Delphi.


ActivatePrevInstance example
Example

Вы можете использовать функцию ActivatePrevInstance в тексте проекта для активизации только одной копии вашего приложения. Если главная форма вашего проекта имеет тип TMainForm:

 begin

   if ActivatePrevInstance(TRxMainProjectForm.ClassName, '') then Exit;

   Application.CreateForm(TRxMainProjectForm, RxMainProjectForm);

   { create other forms }

   Application.Run;

 end;


ActivateWindow Procedure

Examples

Unit

VCLUtils

Declaration

procedure ActivateWindow(Wnd: HWnd);

Description

Процедура ActivateWindow активизирует окно Windows, обработчик которого специфицируется параметром Wnd. Если окно с таким обработчиком найдено в системе, оно восстанавливает свои размеры, если было минимизировано, и становится активным.


ActivateWindow example
Example

 ActivateWindow(Wnd);


AllocMemo Function

Examples

Unit

VCLUtils

Declaration

function AllocMemo(Size: Longint): Pointer;

Description

Функция предназначена для динамического выделения блока памяти размером Size. В отличие от стандартной процедуры GetMem, функция AllocMemo возвращает значение указателя на выделенный блок или Nil, если память выделить не удалось, и может выделять блоки памяти, превосходящие по размеру 64К. Для освобождения выделенной памяти можно использовать процедуру FreeMemo, которой не требуется указывать размер выделенного блока.


AllocMemo example
Example

 var

   P: Pointer;

 begin

   P := AllocMemo(128000);

   try

     { use memory }

   finally

     FreeMemo(P);

   end;

 end;


AnsiUpperFirstChar Function

Examples

Unit

VCLUtils

Declaration

function AnsiUpperFirstChar(const S: string): string;

Description

Функция приводит к верхнему регистру первый символ в переданной строке S, используя набор символов ANSI.


AnsiUpperFirstChar example
Example

 ClientName := AnsiUpperFirstChar(ClientName);


AssignBitmapCell Procedure

Examples

Unit

VCLUtils

Declaration

procedure AssignBitmapCell(Source: TGraphic; Dest: TBitmap; Cols, Rows, Index: Integer);

Description

Процедура копирует прямоугольную область из картинки Source в битовое изображение Dest, исходя из того, что исходная картинка разделена на Cols колонок и Rows строк, и заданная область представляет собой прямоугольную ячейку, определяемую индексом Index.


AssignBitmapCell example
Example

Следующий фрагмент кода загружает из Windows стандартную картинку, содержащую изображения для CheckBox-ов и RadioButton-ов, "вырезает" из нее фрагмент, используемый для рисования "отмеченного" (checked) CheckBox-а, и присваивает его компоненте TSpeedButton:

var

  Bmp, Checks: TBitmap;

begin

  Bmp := TBitmap.Create;

  Checks := MakeModuleBitmap(0, PChar(32759));

  try

    {...}

    AssignBitmapCell(Checks, Bmp, 4, 3, 1);

    SpeedButton1.Glyph := Bmp;

    {...}

  finally

    Bmp.Free;

    Checks.Free;

  end;

end;


CenterControl Procedure

Examples

Unit

VCLUtils

Declaration

procedure CenterControl(Control: TControl);

Description

Процедура центрирует элемент управления Control относительно "родителя" (свойство Parent) по вертикали и горизонтали.

Если Control является дочерней формой MDI, то эта форма центрируется относительно главной формы приложения, ели это обычная форма, то она центрируется относительно экрана.


CenterControl example
Example

 procedure TForm1.FormResize(Sender: TObject);

 begin

   CenterControl(Memo1);

 end;


CenterWindow Procedure

Examples

Unit

VCLUtils

Declaration

procedure CenterWindow(Wnd: HWnd);

Description

Процедура центрирует окно Wnd на экране дисплея.


CenterWindow example
Example

CenterWindow(Form1.Hanle);


ChangeBitmapColor Function

Examples

Unit

VCLUtils

Declaration

function ChangeBitmapColor(Bitmap: TBitmap; Color, NewColor: TColor): TBitmap;

Description

Функция получает в качестве параметра ссылку на объект класса TBitmap, и создает новое графическое изображение, являющееся копией переданного, однако заменяя цвет всех точек изображения, имеющих цвет Color, на NewColor. Возвращает указатель на вновь созданный объект TBitmap.

Вы должны обязательно освободить объект, созданный функцией ChangeBitmapColor, вызвав метод Free.


ChangeBitmapColor example
Example

 var

   Bmp1, Bmp2: TBitmap;

 begin

   {...}

   Bmp2 := ChangeBitmapColor(Bmp1, clOlive, clSilver);

   try

     Bmp1.Assign(Bmp2);

   finally

     Bmp2.Free;

   end;

 end;


CompareMem Function

Examples

Unit

VCLUtils

Declaration

function CompareMem(fpBlock1, fpBlock2: Pointer; Size: Integer): Boolean; assembler;

Description

Функция CompareMem сравнивает содержимое двух блоков памяти по адресам fpBlock1, fpBlock2 длиной Size и возвращает True, если содержимое блоков памяти совпадает, и False в противном случае.


CompareMem example
Example

if CompareMem(fp1, fp2, 1024) then begin

  { ... }

end;


CopyParentImage Procedure

Examples

Unit

VCLUtils

Declaration

procedure CopyParentImage(Control: TControl; Dest: TCanvas);

Description

Процедура копирует в заданный контекст устройства Dest изображение, лежащее под элементом управления Control, т.е. изображение его Parent'а и всех принадлежащих тому же Parent'у элементов - наследников TGraphicControl.


CopyParentImage example
Example

procedure TMyControl.Paint;

begin

  Canvas.FillRect(Bounds(0, 0, Width, Height));

  { copy image from parent and back-level controls }

  CopyParentImage(Self, Canvas);

  DrawBitmapTransparent(Canvas, 0, 0, FImage, FImage.TransparentColor);

end;


CreateBitmapFromIcon Function

Examples

Unit

VCLUtils

Declaration

function CreateBitmapFromIcon(Icon: TIcon; BackColor: TColor): TBitmap;

Description

Функция создает новый объект класса TBitmap, содержащий графическое изображение из иконки, переданной в качестве параметра Icon. Цвет точек (пикселей) изображения, помеченный у иконки как "прозрачный", заменяется на значение параметра BackColor.

После использования вы должны освободить созданный функцией объект, вызвав метод Free.


CreateBitmapFromIcon example
Example

 var

   Bmp: TBitmap;

 begin

   Bmp := CreateBitmapFromIcon(Form1.Icon, clSilver);

   try

     { use bitmap }

   finally

     Bmp.Free;

   end;

 end;


CreateIconFromBitmap Function

Examples

Unit

VCLUtils

Declaration

function CreateIconFromBitmap(Bitmap: TBitmap; TransparentColor: TColor): TIcon;

Description

Функция создает новый объект класса TIcon, содержащий графическое изображение из битового изображения, переданного в качестве параметра Bitmap. Точки исходного изображения, цвет которых совпадает со значением параметра TransparentColor, будут прозрачными в полученной иконке.

После использования вы должны освободить созданный функцией объект, вызвав метод Free.


CreateIconFromBitmap example
Example

 var

   Ico: TIcon;

 begin

   Ico := CreateIconFromBitmap(Image1.Picture.Bitmap, clFuchsia);

   try

     Form1.Icon := Ico;

     Ico.SaveToFile('c:\windows\MyIcon.ico');

   finally

     Ico.Free;

   end;

 end;


CreateRotatedFont Function

Examples

Unit

VCLUtils

Declaration

function CreateRotatedFont(Font: TFont; Angle: Integer): HFont;

Description

Создает "наклонный" шрифт, основываясь на свойствах объекта шрифта, переданного в качестве параметра Font. Угол наклона нового шрифта по отношению к горизонтали задается параметром Angle.


CreateRotatedFont example
Example

var

  Rect: TRect;

const

  Txt = 'Rotated Text';

begin

{...}

  with Canvas do begin

    Brush.Color := clBlue;

    FillRect(Rect);

    Font.Color := clWhite;

    Font.Style := [fsBold];

    Font.Handle := CreateRotatedFont(Font, 90);

    SetBkMode(Handle, TRANSPARENT);

    ExtTextOut(Handle, Rect.Left, Rect.Bottom - 5, ETO_CLIPPED,

      @Rect, Txt, Length(Txt), nil);

  end;

{...}

end;


CreateTwoColorsBrushPattern Function

Examples

Unit

VCLUtils

Declaration

function CreateTwoColorsBrushPattern(Color1, Color2: TColor): TBitmap;

Description

Функция создает битовое изображение, состоящее из точек двух цветов: Color1 и Color2, чередующихся в шахматном порядке. Размер создаваемого изображения - 8х8 пикселей. Вы можете использовать созданный объект для задания кисти (Brush).


CreateTwoColorsBrushPattern example
Example

 var

   Bmp: TBitmap;

  begin

    Bmp := CreateTwoColorsBrushPattern(clBtnFace, clWhite);

    try

      Canvas.Brush.Bitmap := Bmp;

      { ... }

    finally

      Bmp.Free;

    end;

  end;


DefineCursor Function

Examples

Unit

VCLUtils

Declaration

function DefineCursor(Instance: THandle; ResID: PChar): TCursor;

Description

Загружает курсор из ресурса исполняемого модуля и определяет его уникальный индекс в массиве курсоров Screen.Cursors. При успешной загрузке курсора возвращает этот индекс.

Функция сначала ищет курсор среди ресурсов типа RT_CURSOR, а затем (только в 32-разрядной версии), если такой ресурс не найден, среди ресурсов типа RT_ANICURSOR.

Если курсор, определенный именем ResID, не найден, возникает исключение EResNotFound.

После вызова функции DefineCursor Вы можете присвоить возвращенное функцией значение свойству Cursor любого элемента управления.


DefineCursor example
Example

constructor TDrawingComponent.Create(Owner: TComponent);

begin

  inherited Create(Owner);

  Cursor := DefineCursor(HInstance, 'CUR_MYCURSOR');

end;


Delay Procedure

Examples

Unit

VCLUtils

Declaration

procedure Delay(MSecs: Longint);

Description

Процедура вызывает задержку выполнения программы на заданное параметром MSecs число миллисекунд.


Delay example
Example

 StartWait;

 try

   Delay(1000);

 finally

   StopWait;

 end;


DialogUnitsToPixelsX Function

Examples

Unit

VCLUtils

Declaration

function DialogUnitsToPixelsX(DlgUnits: Word): Word;

Description

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


DialogUnitsToPixelsX example
Example

 X := DialogUnitsToPixelsX(X);


DialogUnitsToPixelsY Function

Examples

Unit

VCLUtils

Declaration

function DialogUnitsToPixelsY(DlgUnits: Word): Word;

Description

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


DialogUnitsToPixelsY example
Example

 Y := DialogUnitsToPixelsY(Y);


DrawBitmapRectTransparent Procedure

Examples

Unit

VCLUtils

Declaration

procedure DrawBitmapRectTransparent(Dest: TCanvas; DstX, DstY: Integer; SrcRect: TRect; Bitmap: TBitmap; TransparentColor: TColor);

Description

Процедура DrawBitmapRectTransparent рисует на устройстве Dest прямоугольный участок графического изображения Bitmap, заданный параметром SrcRect. Верхний левый угол изображения размещается в точке с координатами DstX, DstY, при этом цвет точек изображения, имеющих цвет TransparentColor, заменяется на цвет фона, то есть эти точки получаются "прозрачными" при отрисовке.

Если переданный параметр SrcRect задает "пустой" прямоугольник (с шириной или высотой, равной 0), то битовый образ Bitmap будет нарисован целиком. Вы также можете воспользоваться процедурой DrawBitmapTransparent для отрисовки целиком графического изображения на устройстве.


DrawBitmapRectTransparent example
Example

 var

   Bmp: TBitmap;

 begin

   Bmp := Image1.Picture.Bitmap;

   DrawBitmapRectTransparent(PaintBox1.Canvas, 10, 10,

     Rect(0, 0, Bmp.Width div 2, Bmp.Height div 2), Bmp, clOlive);

 end;


DrawBitmapTransparent Procedure

Examples

Unit

VCLUtils

Declaration

procedure DrawBitmapTransparent(Dest: TCanvas; DstX, DstY: Integer; Bitmap: TBitmap; TransparentColor: TColor);

Description

Процедура DrawBitmapTransparent рисует на устройстве Dest графическое изображение Bitmap. Верхний левый угол изображения размещается в точке с координатами DstX, DstY, при этом цвет точек изображения, имеющих цвет TransparentColor, заменяется на цвет фона, то есть эти точки получаются "прозрачными" при отрисовке.

Если вы хотите нарисовать только часть графического изображения, воспользуйтесь процедурой DrawBitmapRectTransparent.


DrawBitmapTransparent example
Example

 var

   Bmp: TBitmap;

 begin

   Bmp := Image1.Picture.Bitmap;

   DrawBitmapTransparent(PaintBox1.Canvas, 10, 10, Bmp, clOlive);

 end;


DrawCellBitmap Procedure

Examples

Unit

VCLUtils

Declaration

procedure DrawCellBitmap(Control: TCustomControl; ACol, ARow: Longint; Bmp: TBitmap; Rect: TRect);

Description

Процедура DrawCellBitmap предназначена для отрисовки битового изображения Bmp в ячейке объекта-наследника TCustomGrid.


DrawCellBitmap example
Example

procedure TForm1.Grid1DrawCell(Sender: TObject; Col, Row: Longint;

  Rect: TRect; State: TGridDrawState);

var

  Bmp: TBitmap;

begin

  Bmp := GetCellBitmap(Col, Row);

  if Bmp <> nil then

    DrawCellBitmap(Grid1, Col, Row, Bmp, Rect);

end;


DrawCellText Procedure

Examples

Unit

VCLUtils

Declaration

procedure DrawCellText(Control: TCustomControl; ACol, ARow: Longint; const S: string; const ARect: TRect; Align: TAlignment; VertAlign: TVertAlignment);

Description

Процедура DrawCellText предназначена для отрисовки строки текста S в ячейке объекта - наследника TCustomGrid.


DrawCellText example
Example

procedure TForm1.DrawGrid1DrawCell(Sender: TObject; Col,

  Row: Longint; Rect: TRect; State: TGridDrawState);

begin

  if (Row >= 0) then begin

    DrawCellText(Sender as TDrawGrid, Col, Row,

      GetCellText(Row), Rect, taLeftJustify, vaCenter);

  end;

end;


DrawInvertFrame Procedure

Examples

Unit

VCLUtils

Declaration

procedure DrawInvertFrame(ScreenRect: TRect; Width: Integer);

Description

Процедура рисует на экране инвертированную рамку, определяемую координатами ScreenRect. Координаты задаются в системе координат всего экрана. Толщина изображаемой рамки (в пикселях) задается параметром Width.


DrawInvertFrame example
Example

var

  P: TPoint;

  R: TRect;

begin

  P := Panel1.ClientToScreen(Point(0, 0));

  R := Bounds(P.X, P.Y, Panel1.Width, Panel1.Height);

  DrawInvertFrame(R, 3);  { Show invert frame }

  { ... }

  DrawInvertFrame(R, 3);  { Hide invert frame }

end;


FreeMemo Procedure

Examples

Unit

VCLUtils

Declaration

procedure FreeMemo(var fpBlock: Pointer);

Description

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


FreeMemo example
Example

 var

   P: Pointer;

 begin

   P := AllocMemo(128000);

   try

     { use memory }

   finally

     FreeMemo(P);

   end;

 end;


FreeUnusedOLE Procedure

Examples

Unit

VCLUtils

Declaration

procedure FreeUnusedOLE;

Description

В 32-разрядной версии библиотеки процедура выгружает библиотеки OLE2, если Вы не предполагаете использовать OLE Automation или TOleContainer в Вашем приложении. Приложения 32-разрядной версии Delphi всегда загружают библиотеки OLE2, однако выгрузив их, Вы можете сэкономить от 200 Кб до 1 Мб памяти. Вызов процедуры можно вставить в файл проекта (.DPR) сразу после "begin" основной программы.

Процедура в 16-битной версии не выполняет никаких действий и предназначена только для последующего переноса приложений в 32-разрядную среду.

ВНИМАНИЕ

Пользуйтесь этой процедурой с большой осторожностью. Не рекомендуется использовать ее в приложениях, работающих с BDE. Выгрузка библиотек OLE может приводить к непредвиденным и необъяснимым ошибкам в приложении.

Если Вы используете эту процедуру и не можете определить причину ошибки в Вашей программе, попробуйте убрать или закомментарить вызов этой процедуры.


FreeUnusedOLE example
Example

program Project1;

uses

  Forms,

  VCLUtils,

  Main in 'MAIN.PAS' {MainForm};

{$R *.RES}

begin

  FreeUnusedOLE;

  Application.CreateForm(TMainForm, MainForm);

  Application.Run;

end;


GetEnvVar Function

Examples

Unit

VCLUtils

Declaration

function GetEnvVar(const VarName: string): string;

Description

Возвращает значение переменной окружения DOS, заданной параметром VarName.


GetEnvVar example
Example

  uses SysUtils, Dialogs, VCLUtils;

  var

    EnvVar: string;

  begin

    EnvVar := GetEnvVar('TEMP');

    ShowMessage(Format('Path of the temporary file is currently: %s',

      [EnvVar]));

  end.


GetMemoSize Function

Examples

Unit

VCLUtils

Declaration

function GetMemoSize(fpBlock: Pointer): Longint;

Description

Функция GetMemoSize возвращает размер блока памяти, выделенного функцией AllocMemo.


GetMemoSize example
Example

 var

   P: Pointer;

   S: Longint;

 begin

   P := AllocMemo(128000);

   try

     { use memory }

     S := GetMemoSize(P);

     { ... }

   finally

     FreeMemo(P);

   end;

 end;


GetWindowsVersion Function

Examples

Unit

VCLUtils

Declaration

function GetWindowsVersion: string;

Description

Функция возвращает версию Windows в виде строки, содержащей название платформы и номер версии операционной системы. Результат может быть использован, например, в диалоговом окне "About".


GetWindowsVersion example
Example

  Label1.Caption := GetWindowsVersion;


GradientFillRect Procedure

Examples

Unit

VCLUtils

Declaration

procedure GradientFillRect(Canvas: TCanvas; Rect: TRect; BeginColor, EndColor: TColor; Direction: TFillDirection; Colors: Byte);

Description

Процедура GradientFillRect рисует прямоугольник Rect на устройстве Canvas, цвет которого плавно изменяется от BeginColor до EndColor в направлении Direction. При рисовании используется число цветов, определенное параметром Colors (от 1 до 255).


GradientFillRect example
Example

 procedure TForm1.FormPaint(Sender: TObject);

 begin

   GradientFillRect(Canvas, ClientRect, clBlue, clBlack,

     fdTopToBottom, 255);

 end;

При отрисовке фона формы таким образом имейте в виду, что вы должны вызвать метод Invalidate или Refresh в обработчике события OnResize этой формы.


HeightOf Function

Examples

Unit

VCLUtils

Declaration

function HeightOf(R: TRect): Integer;

Description

Функция возвращает высоту (в пикселях) переданного прямоугольника R.


HeightOf example
Example

 H := HeightOf(Rect);


HugeDec Procedure

Examples

Unit

VCLUtils

Declaration

procedure HugeDec(var HugePtr: Pointer; Amount: Longint);

Description

Decrement a huge pointer.


HugeDec example
Example

var

  P: Pointer;

  L: Longint;

{...}

  HugeDec(P, L);

{...}


HugeInc Procedure

Examples

Unit

VCLUtils

Declaration

procedure HugeInc(var HugePtr: Pointer; Amount: Longint);

Description

Increment a huge pointer.


HugeInc example
Example

var

  P: Pointer;

  L: Longint;

{...}

  HugeInc(P, L);

{...}


HugeMove Procedure

Examples

Unit

VCLUtils

Declaration

procedure HugeMove(Base: Pointer; Dst, Src, Size: Longint);

Description

Copy memory from Src to Dst, copying Size units from Base+Src to Base+Dst.  The reason to separate the Base pointer from the Dst and Src indexes is to easily compare the indexes to see what direction to copy, without having to muck about with normalizing segments. Offsets and the size are in longwords, for convenience, but you need to convert them to short words, in case the code is running on a 286 machine, which does not support the movsd instruction, just movsw.


HugeMove example
Example

var

  P: Pointer;

  L: Longint;

{...}

  L := 1024 * 82; {82 K}

  HugeMove(P, 0, L, L);

{...}


HugeOffset Function

Examples

Unit

VCLUtils

Declaration

function HugeOffset(HugePtr: Pointer; Amount: Longint): Pointer;

Description

Add an offset to a huge pointer and return the result.


HugeOffset example
Example

P := HugeOffset(P, L);


ImageListDrawDisabled Procedure

Examples

Unit

VCLUtils

Declaration

procedure ImageListDrawDisabled(Images: TImageList; Canvas: TCanvas; X, Y, Index: Integer; HighlightColor, GrayColor: TColor; DrawHighlight: Boolean);

Description

Процедура рисует изображение из списка Images, заданное индексом Index, на устройстве Canvas с координатами X, Y. При рисовании все цвета изображения заменяются на заданные в качестве параметров HighlightColor и GrayColor.

Процедура может быть использована при отрисовке изображения на "запрещенных" (Enabled=False) элементах управления.


ImageListDrawDisabled example
Example

  ImageListDrawDisabled(Images, Canvas, 0, 0, 1, clBtnHighlight,

    clBtnShadow, True);


IsForegroundTask Function

Examples

Unit

VCLUtils

Declaration

function IsForegroundTask: Boolean;

Description

Функция проверяет, является ли приложение, вызвавшее эту функцию, текущей активной (foreground) задачей Windows.


IsForegroundTask example
Example

 procedure Form1.Timer1Timer(Sender: TObject);

 begin

   if IsForegroundTask then

     Label1.Text := 'Active'

   else

     Label1.Text := 'Inactive';

 end;


KillMessage Procedure

Examples

Unit

VCLUtils

Declaration

procedure KillMessage(Wnd: HWnd; Msg: Cardinal);

Description

KillMessage deletes the requested message Msg from the window message queue, but throw back any WM_QUIT messages that PeekMessage standard Windows function may also return.


KillMessage example
Example

  KillMessage(Form1.Handle, Msg.Message);


LoadAniCursor Function

Examples

Unit

VCLUtils

Declaration

function LoadAniCursor(Instance: THandle; ResID: PChar): HCursor;

Description

The LoadAniCursor function loads the specified animated cursor resource from the executable (.EXE or .DLL) file associated with the specified application instance.

Instance parameter identifies an instance of the module whose executable file contains the animated cursor to be loaded.

ResID parameter points to a null-terminated string that contains the name of the animated cursor resource (RT_ANICURSOR type) to be loaded. Alternatively, this parameter can consist of the resource identifier in the low-order word and zero in the high-order word. The MakeIntResource function can also be used to create this value.

If the function succeeds, the return value is the handle of the newly loaded animated cursor. If the function fails, the return value is 0 (zero).


LoadAniCursor example
Example

var

  Cur: HCursor;

begin

  {...}

  Cur := LoadAniCursor(hInstance, 'CUR_COIN');

  if Cur = 0 then

    { error loading cursor }

  else

    Screen.Cursors[200] := Cur;

  {...}

end;


LoadDLL Function

Examples

Unit

VCLUtils

Declaration

function LoadDLL(const LibName: string): THandle;

Description

Функция загружает динамическую библиотеку или модуль, заданный именем LibName. При успешном завершении возвращает обработчик загруженного модуля, в противном случае вызывает исключение (exception) EOutOfResources.


LoadDLL example
Example

{$IFDEF WIN32}

  TUHandle := LoadDLL('TUTIL32.DLL');

{$ELSE}

  TUHandle := LoadDLL('TUTILITY.DLL');

{$ENDIF}


MakeBitmap Function

Examples

Unit

VCLUtils

Declaration

function MakeBitmap(ResID: PChar): TBitmap;

Description

Функция создает объект класса TBitmap из ресурса вашего приложения. Параметр ResID задает строковый идентификатор ресурса типа BITMAP, содержащего графическое изображение. После использования вы должны уничтожить созданный объект, вызвав его метод Free.


MakeBitmap example
Example

 var

   Bmp: TBitmap;

 begin

   Bmp := MakeBitmap('MY_BITMAP');

   try

     { use bitmap }

   finally

     Bmp.Free;

   end;

 end;


MakeBitmapID Function

Examples

Unit

VCLUtils

Declaration

function MakeBitmapID(ResID: Word): TBitmap;

Description

Функция создает объект класса TBitmap из ресурса вашего приложения. Параметр ResID задает числовой идентификатор ресурса типа BITMAP, содержащего графическое изображение. После использования вы должны уничтожить созданный объект, вызвав его метод Free.


MakeBitmapID example
Example

 const

   ResID = 23012;

 var

   Bmp: TBitmap;

 begin

   Bmp := MakeBitmapID(ResID);

   try

     { use bitmap }

   finally

     Bmp.Free;

   end;

 end;


MakeIcon Function

Examples

Unit

VCLUtils

Declaration

function MakeIcon(ResID: PChar): TIcon;

Description

Функция создает объект класса TIcon из ресурса вашего приложения. Параметр ResID задает строковый идентификатор ресурса типа ICON, содержащего иконку. После использования вы должны уничтожить созданный объект, вызвав его метод Free.


MakeIcon example
Example

 var

   Ico: TIcon;

 begin

   Ico := MakeIcon('MY_ICON');

   try

     { use icon }

   finally

     Ico.Free;

   end;

 end;


MakeIconID Function

Examples

Unit

VCLUtils

Declaration

function MakeIconID(ResID: Word): TIcon;

Description

Функция создает объект класса TIcon из ресурса вашего приложения. Параметр ResID задает числовой идентификатор ресурса типа ICON, содержащего иконку.

После использования вы должны уничтожить созданный объект, вызвав его метод Free.


MakeIconID example
Example

 const

   ResID = 23012;

 var

   Ico: TIcon;

 begin

   Ico := MakeIconID(ResID);

   try

     { use icon }

   finally

     Ico.Free;

   end;

 end;


MakeModuleBitmap Function

Examples

Unit

VCLUtils

Declaration

function MakeModuleBitmap(Module: THandle; ResID: PChar): TBitmap;

Description

Функция создает объект класса TBitmap из ресурса любого загруженного модуля (исполняемого файла или DLL). Обработчик модуля, передаваемый в функцию в качестве параметра, возвращается функциями LoadLibrary и LoadModule.

Параметр ResID задает строковый идентификатор ресурса типа BITMAP, содержащего графическое изображение. Если вы используете числовой идентификатор ресурса, воспользуйтесь приведением типов, например

  PChar(24876)

или вызовом

  MakeIntResource(24876).

После использования вы должны уничтожить созданный объект, вызвав его метод Free.


MakeModuleBitmap example
Example

Для загрузки графического изображения, используемого Windows для изображения кнопок с зависимой фиксацией (CheckBox) вы можете использовать следующий текст программы:

 var

   Bmp: TBitmap;

 begin

   Bmp := MakeModuleBitmap(0, PChar(32759));

   try

     { use bitmap }

   finally

     Bmp.Free;

   end;

 end;


MakeModuleIcon Function

Examples

Unit

VCLUtils

Declaration

function MakeModuleIcon(Module: THandle; ResID: PChar): TIcon;

Description

Функция создает объект класса TIcon из ресурса любого загруженного модуля (исполняемого файла или DLL). Обработчик модуля, передаваемый в функцию в качестве параметра, возвращается функциями LoadLibrary и LoadModule.

Параметр ResID задает идентификатор ресурса типа ICON, содержащего иконку. Если вы используете числовой идентификатор ресурса, воспользуйтесь приведением типов, например

  PChar(24876)

или вызовом

  MakeIntResource(24876).

После использования вы должны уничтожить созданный объект, вызвав его метод Free.


MakeModuleIcon example
Example

 var

   Ico: TIcon;

   Module: THandle;

 begin

   Module := LoadLibrary('MY_RES.DLL');

   if Module >= HINSTANCE_ERROR then

   try

     Ico := MakeModuleIcon(Module, MakeIntResource(2));

     try

       { use icon }

     finally

       Ico.Free;

     end;

   finally

     FreeLibrary(Module);

   end;

 end;


MergeForm Procedure

Examples

Unit

VCLUtils

Declaration

procedure MergeForm(AControl: TWinControl; AForm: TForm; Align: TAlign; Show: Boolean);

Description

Процедура предназначена для вставки обычной формы AForm (например, созданной в дизайнере и загруженной из DFM-файла) в элемент управления AControl. Форма вставляется в AControl, как и любой другой элемент управления, с заданным значением Align. Если Align = alNone, то верхний левый угол формы получает координаты (Left, Top), заданные соответствующими свойствами формы. Параметр Show определяет, будет ли свойству Visible формы присвоено значение True сразу же после вставки. Заголовок (caption) формы не отображается.


MergeForm example
Example

MergeForm(TPage(Notebook.Pages.Objects[0]),

  TMyForm.Create(Application), alClient, True);


MinimizeText Function

Examples

Unit

VCLUtils

Declaration

function MinimizeText(const Text: string; Canvas: TCanvas; MaxWidth: Integer): string;

Description

Эта функция может быть использована для того, чтобы сократить текстовую строку Text до длины, позволяющей отобразить ее целиком на устройстве Canvas на участке длиной MaxWidth.

Если переданная строка длинее, чем можно поместить в указанный участок, то функция удаляет несколько последних символов из строки-результата, заменяя их многоточием ('...').


MinimizeText example
Example

  {...}

  Form1.Canvas.TextRect(Rect, Rect.Left, Rect.Top,

    MinimizeText(S, Form1.Canvas, WidthOf(Rect)));

  {...}


MsgBox Function

Examples

Unit

VCLUtils

Declaration

function MsgBox(const Caption, Text: string; Flags: Integer): Integer;

Description

Функция представляет собой оболочку стандартной функции Windows API MessageBox, только в качестве параметров принимает не PChar, а строки в формате языка Pascal.


MsgBox example
Example

 if MsgBox(Application.Title, 'Continue?',

   MB_YESNO + MB_ICONSTOP) = mrYes then

 begin

   { ... }

 end;


NotImplemented Procedure

Examples

Unit

VCLUtils

Declaration

procedure NotImplemented;

Description

Процедура вызывает появление диалогового окна с сообщением

 "Функция не реализована" ("Function not yet implemented"),

после которого происходит исключение (exception) типа EAbort.


NotImplemented example
Example

 procedure TForm1.SaveClick(Sender: TObject);

 begin

   NotImplemented;

 end;


PaintInverseRect Procedure

Examples

Unit

VCLUtils

Declaration

procedure PaintInverseRect(RectOrg, RectEnd: TPoint);

Description

Процедура инвертирует прямоугольник на экране, определенный координатами RectOrg, RectEnd. Координаты задаются в системе координат всего экрана.


PaintInverseRect example
Example

Следующий вызов инвертирует все изображение на экране и затем вернет его в первоначальное состояние:

 PaintInversRect(Point(0, 0), Point(Screen.Width, Screen.Height));

 Delay(2000);

 PaintInversRect(Point(0, 0), Point(Screen.Width, Screen.Height));


PixelsToDialogUnitsX Function

Examples

Unit

VCLUtils

Declaration

function PixelsToDialogUnitsX(PixUnits: Word): Word;

Description

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


PixelsToDialogUnitsX example
Example

  X := PixelsToDialogUnitsX(X);


PixelsToDialogUnitsY Function

Examples

Unit

VCLUtils

Declaration

function PixelsToDialogUnitsY(PixUnits: Word): Word;

Description

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


PixelsToDialogUnitsY example
Example

  Y := PixelsToDialogUnitsY(Y);


PointInPolyRgn Function

Examples

Unit

VCLUtils

Declaration

function PointInPolyRgn(const P: TPoint; const Points: array of TPoint): Boolean;

Description

Функция возвращает True, если точка с координатами P расположена внутри региона, ограниченного фигурой с вершинами, заданными набором точек Points.


PointInPolyRgn example
Example

with MyForm do

  if PointInPolyRgn(Point(X, Y), [Point(Left, Top),

    Point(Left + Width, Top),

    Point(Left + Width div 2, Top + Height div 2)]) then

  begin

    { ... }

  end;


PointInRect Function

Examples

Unit

VCLUtils

Declaration

function PointInRect(const P: TPoint; const R: TRect): Boolean;

Description

Функция возвращает True, если точка с координатами P расположена внутри прямоугольника R.


PointInRect example
Example

 if PointInRect(Point(X, Y), Image1.ClientRect) then begin

   { ... }

 end;


RegisterServer Function

Examples

Unit

VCLUtils

Declaration

function RegisterServer(const ModuleName: string): Boolean;

Description

Функция предназначена для регистрации в Windows элементов управления OLE (OCX, ActiveX), содержащихся в динамических библиотеках - файлах с расширением OCX.

Возвращает True в случае успешной регистрации библиотеки-сервера.

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


RegisterServer example
Example

 RegisterServer('cfx32.ocx');


ResourceNotFound Procedure

Examples

Unit

VCLUtils

Declaration

procedure ResourceNotFound(ResID: PChar);

Description

Процедура предназначена для вывода сообщения об ошибке (с генерацией исключения EResNotFound) при ошибке загрузки ресурса из исполняемого файла.

В случае, если ресурс не удалось загрузить, Вы можете вызвать эту процедуру, передав ей идентификатор ресурса. Это может быть либо строка, либо число, в последнем случае Вы должны воспользоваться прямым приведением типов (например, PChar(230) ).


ResourceNotFound example
Example

procedure LoadCursorRes(ResID: PChar; AssignTo: TCursor);

var

  Handle: HCursor;

begin

  Handle := LoadCursor(hInstance, ResID);

  if Handle = 0 then ResourceNotFound(ResID)

  else Screen.Cursors[AssignTo] := Handle;

end;


ScreenWorkArea Function

Examples

Unit

VCLUtils

Declaration

function ScreenWorkArea: TRect;

Description

Функция возвращает координаты "рабочей области" экрана, т.е. области, не занятой панелью задач Windows (taskbar).


ScreenWorkArea example
Example

var

  R: TRect;

begin

  R := ScreenWorkArea;

  Form1.BoundsRect := R;

end;


ShadeRect Procedure

Examples

Unit

VCLUtils

Declaration

procedure ShadeRect(DC: HDC; const Rect: TRect);

Description

Процедура служит для "штриховки" прямоугольника Rect аналогично тому, как штрихуется область TOleContainer при активизации OLE-объекта.


ShadeRect example
Example

ShadeRect(Canvas.Handle, ARect);


SplitCommandLine Procedure

Examples

Unit

VCLUtils

Declaration

procedure SplitCommandLine(const CmdLine: string; var ExeName, Params: string);

Description

Процедура SplitCommandLine разделяет командную строку запуска любой программы на имя исполняемого файла и строку параметров. Параметры (как и имя исполняемой программы) разделяются между собой пробелами, если параметр включает пробелы (как и имя EXE-файла, если это позволено системой, например Win95), то он должен быть заключен в двойные кавычки.


SplitCommandLine example
Example

После выполнения вызова:

 S := 'MYAPP.EXE "Parameter Name" -K -S';

 SplitCommandLine(S, ExeName, Params);

значения параметров будут:

 ExeName = 'MYAPP.EXE';

 Params = '"Parameter Name" -K -S';


StartWait Procedure

Examples

Unit

VCLUtils

Declaration

procedure StartWait;

Description

Процедура StartWait меняет изображение курсора мыши на экране на то, которое определено типизированной константой WaitCursor (по умолчанию crHourGlass), и увеличивает счетчик вызовов StartWait на 1. Любой вызов процедуры StartWait должен быть скомпенсирован вызовом процедуры StopWait, которая уменьшает счетчик на 1, и восстанавливает курсор по умолчанию при значении счетчика, равном 0. Если к моменту вызова StartWait счетчик ее вызовов больше 0, то изменения вида курсора не происходит.


StartWait example
Example

 StartWait;  { set cursor to WaitCursor }

 try

   { ... }

   StartWait;  { no effect }

   try

     { ... }

   finally

     StopWait; { no effect }

   end;

   { ... }

 finally

   StopWait;  { restore default cursor }

 end;


StopWait Procedure

Examples

Unit

VCLUtils

Declaration

procedure StopWait;

Description

Процедура StopWait восстанавливает изображение курсора мыши на экране по умолчанию, если оно было изменено процедурой StartWait. Однако, если счетчик вызовов StartWait больше 1, то StopWait только уменьшает счетчик на 1 и не изменяет курсор. Восстановление курсора происходит при уменьшении счетчика до 0.


StopWait example
Example

 StartWait;  { set cursor to WaitCursor }

 try

   { ... }

   StartWait;  { no effect }

   try

     { ... }

   finally

     StopWait; { no effect }

   end;

   { ... }

 finally

   StopWait;  { restore default cursor }

 end;


WidthOf Function

Examples

Unit

VCLUtils

Declaration

function WidthOf(R: TRect): Integer;

Description

Функция возвращает ширину (в пикселях) переданного прямоугольника R.


WidthOf example
Example

 W := WidthOf(Rect);


Win32Check Function

Examples

Unit

VCLUtils

Declaration

function Win32Check(RetVal: Bool): Bool;

Description

Процедура предназначена для использования при вызове функций Win32 API, возвращающих значение типа BOOL, которое определяет, успешно ли выполнилась функция Win32 API. Вы можете передать код завершения (True, False) в процедуру Win32Check, которая в случае ошибки вызовет исключительную ситуацию (exception), с текстом сообщения об ошибке, полученным как результат вызова

 SysErrorMessage(GetLastError).

Функция присутствует только в версии RX для Delphi 2.0. В Delphi 3.0 и выше такая функция имеется в модуле SysUtils.


Win32Check example
Example

  Win32Check(CreateDirectory('C:\myworld\private', nil));