ExpressEditors and DBEditors Reference
ExpressEditors and DBEditors Reference
Table of Contents
TdxStyleController 18
TdxStyleController Properties 19
TdxStyleController Methods 20
TdxStyleController Events 23
TdxEditStyleController 24
TdxEditStyleController Properties 25
TdxEditStyleController Events 29
TdxEditStyle 30
TdxEditStyle Properties 31
TdxEditStyle Methods 36
TdxEditDataDefinition 42
TdxEditDataDefinition Properties 43
TdxEditDataDefinition Methods 44
TdxEditDataDefinition Events 45
TdxInplaceEdit 46
TdxInplaceEdit Properties 47
TdxInplaceEdit Methods 51
TdxInplaceEdit Events 54
TdxInplacePopupControl 56
TdxInplacePopupControl Properties 57
TdxInpacePopupControl Methods 59
TdxInplaceTextEdit 60
TdxInplaceTextEdit Properties 61
TdxInplaceTextEdit Methods 67
TdxInplaceTextEdit Events 76
TdxInplaceMaskEdit 77
TdxInplaceMaskEdit Properties 78
TdxInplaceMaskEdit Methods 81
TdxInplaceMaskEdit Events 88
TdxInplaceMemoEdit 89
TdxInplaceMemoEdit Properties 90
TdxInplaceMemoEdit Methods 94
TdxInplaceMemoEdit Events 95
TdxInplaceDropDownEdit 96
TdxInplaceDropDownEdit Properties 97
TdxInplaceDateEdit 105
TdxInplaceButtonEdit 112
TdxCheckEditStyleController 118
TdxInplaceCheckEdit 121
TdxInplaceImageEdit 128
ExpressEditors&DBEditors by Developer Express
4 Table of Contents
TdxInplaceImageEdit Properties 129
TdxInplaceSpinEdit 134
TdxInplacePickEdit 144
TdxInplaceCalcEdit 150
TdxInplaceHyperLinkEdit 156
TdxInplaceTimeEdit 161
TdxInplaceCurrencyEdit 166
TdxPopupToolBarWindow 173
TdxInplaceGraphicEdit 177
TdxInplaceBlobEdit 188
TdxInplaceMRUEdit 204
TdxInplacePopupEdit 210
TdxPopupEditForm 221
TdxInplaceLookupEdit 226
TdxEditButton 234
TdxEditButtons 238
TCustomdxEdit 241
TdxEdit 245
TCustomdxMaskEdit 249
TdxMaskEdit 253
TCustomdxMemo 257
TdxMemo 261
TCustomdxDateEdit 265
TdxDateEdit 270
TCustomdxButtonEdit 275
TdxButtonEdit 280
TCustomdxCheckEdit 284
TdxCheckEdit 288
TCustomdxImageEdit 292
TdxImageEdit 297
TCustomdxSpinEdit 301
TdxSpinEdit 306
TCustomdxPickEdit 310
TdxPickEdit 315
TCustomdxCalcEdit 319
TdxCalcEdit 324
TCustomdxHyperLinkEdit 328
TdxHyperLinkEdit 332
TCustomdxTimeEdit 336
TdxTimeEdit 341
TCustomdxCurrencyEdit 345
TdxCurrencyEdit 350
TdxGraphicEdit 358
TCustomdxBlobEdit 362
TdxBlobEdit 367
TCustomdxMRUEdit 372
TdxMRUEdit 377
TCustomdxPopupEdit 381
TdxPopupEdit 386
TCustomdxLookupEdit 390
TdxLookupEdit 394
TdxEditDataLink 398
TdxEditDBDataDefinition 401
TCustomdxDBEdit 402
TdxDBEdit 406
TCustomdxDBMaskEdit 410
TdxDBMaskEdit 416
TCustomdxDBMemo 420
TdxDBMemo 425
TCustomdxDBDateEdit 429
TdxDBDateEdit 435
TCustomdxDBButtonEdit 440
TdxDBButtonEdit 446
TCustomdxDBCheckEdit 450
TdxDBCheckEdit 455
TCustomdxDBImageEdit 459
TdxDBImageEdit 465
TCustomdxDBSpinEdit 469
TdxDBSpinEdit 475
TdxDBPickEdit 485
TCustomdxDBCalcEdit 489
TdxDBCalcEdit 495
TCustomdxDBHyperLinkEdit 499
TdxDBHyperLinkEdit 504
TCustomdxDBTimeEdit 508
TdxDBTimeEdit 514
TCustomdxDBCurrencyEdit 518
TdxDBCurrencyEdit 524
TCustomdxDBGraphicEdit 528
TdxDBGraphicEdit 532
TCustomdxDBLookupEdit 536
TdxDBLookupEdit 542
TCustomdxDBBlobEdit 546
TdxDBBlobEdit 552
TCustomdxDBMRUEdit 556
TdxDBMRUEdit 562
TCustomdxDBPopupEdit 567
TdxDBPopupEdit 573
TdxInplaceExtLookupEdit 577
TCustomdxDBExtLookupEdit 583
TdxDBExtLookupEdit 589
Index 594
ExpressEditors&DBEditors
TdxStyleController
This is the core class used to manage the display style of all editors connected to the style controller on the
same form.
Unit
dxCntner
TdxStyleController = class(TComponent)
Description
This class is the ancestor of the TdxEditStyleController class. The TdxEditStyleController class is used
to set specific values for the properties that determine the appearance and behavior of associated
editors. The TdxStyleController class represents the basic methods and properties (AddLink, Changed,
RemoveLink, StyleChanged, Links, OnStyleChanged, BeginUpdate, EndUpdate, Update) used by the
TdxEditStyleController class to manage the appearance of its associated editors.
The TdxEditStyleController class works with editors that support the StyleController property.
Hierarchy
TObject
TPersistent
TComponent
TdxStyleController Properties
Links protected / read only
Description
The Links property is an array, every item of which represents an editor linked to the current style controller.
Each editor connected to the current style controller represents an item in the Links array. When a style
controller property changes, the corresponding style property of all editors in the Links array changes as well.
See also
TdxStyleController.AddLink; TdxStyleController.RemoveLink
TdxStyleController Methods
AddLink protected RemoveLink protected
BeginUpdate public StyleChanged protected
Changed protected Update public
EndUpdate public
AddLink method
Connects the current edit style to a new object.
Description
The AddLink method is used internally to insert a new object specified by the ALink parameter at the end of
the linked object array (represented by the Links property). This method connects the current style controller
to the editor specified by the ALink parameter.
See Also
TdxStyleController.Links; TdxStyleController.RemoveLink
BeginUpdate method
Disables style refresh operations.
procedure BeginUpdate;
Description
Calling the BeginUpdate method disables style property changes until calling the EndUdpate method.
The BeginUpdate and EndUpdate methods work together to prevent multiple updates of editors.
Make certain to call the EndUpdate method after calling the BeginUpdate method. Every call of the
BeginUpdate method increases the internal counter by one. Every call of the EndUpdate method
decreases the internal counter by one. Editor style properties can be set to new values only when the
internal counter is 0.
See Also
TdxStyleController.EndUpdate; TdxStyleController.Update
Changed method
Calls the StyleChanged method for all editors connected to a style controller.
procedure Changed;
Description
The Changed method calls the StyleChanged method for all items of the linked objects array represented by
the Links property. The Changed method is used internally to simultaneously modify similar properties for all
editors connected to the style controller.
Note: It is recommended that you use the Update method instead of the Change method.
See Also
TdxStyleController.StyleChanged; TdxStyleController.OnStyleChanged
EndUpdate method
Enables styles refresh operations.
procedure EndUpdate;
Description
The BeginUpdate and EndUpdate methods work together to prevent numerous updates of editor
styles. Make certain to call the EndUpdate method after calling the BeginUpdate method. Every call of
the BeginUpdate method increases the internal counter by one. Every call of the EndUpdate method
decreases the internal counter by one. Editor style properties can be set to new values only when the
internal counter is 0.
See Also
TdxStyleController.BeginUpdate; TdxStyleController.Update
RemoveLink method
Removes the connection between an editor and the current style controller.
Description
Call the RemoveLink method to remove a specific item (the ALink parameter) from the linked object array
represented by the Links property. Said differently, call this method to remove the connection between the
current style controller and the editor specified by the ALink parameter.
See Also
TdxStyleController.Links; TdxStyleController.AddLink
StyleChanged method
Generates the OnStyleChanged event when changing the current edit style.
Description
The StyleChanged method calls the OnStyleChanged event handler to manipulate the object specified by the
ALink parameter, when changing the current edit style.
See Also
TdxStyleController.OnStyleChanged
Update method
Updates all linked editors when changing edit style.
procedure Update;
Description
Use the Update method to call the Changed method for all linked editors when changing current edit style.
This method can be used if a user writes an OnStyleChanged event handler.
See Also
TdxStyleController.BeginUpdate; TdxStyleController.EndUpdate
TdxStyleController Events
OnStyleChanged protected
OnStyleChanged event
Occurs when changing current edit style.
type
TdxStyleChangedEvent = procedure (Sender: TObject; Link: TObject) of
object;
property OnStyleChanged: TdxStyleChangedEvent;
Description
Write an OnStyleChanged event handler to perform specific actions when changing current edit style.
The Sender parameter specifies the style controller whose event handler is called. The Link
parameter determines the editor linked to the style controller.
See Also
TdxStyleController.StyleChanged
TdxEditStyleController
TdxEditStyleController is used to unify the appearance style of all linked editors.
Unit
dxCntner
TdxEditStyleController = class(TdxStyleController)
Description
TdxEditStyleController is a non-visual component. Use this component to simultaneously change
similar properties of all linked editors and to apply identical style changes to all linked ExpressEditors.
TdxEditStyleController functions as a wrapper of the editor's Style object and contains the same
properties. If a property is not directly set (the appropriate flag is activated in the AssignedValues
property), it is taken from a specific controller.
Hierarchy
TObject
TPersistent
TComponent
TdxStyleController
See Also
TdxStyleController; TdxEditStyle
TdxEditStyleController Properties
BorderColor published / read / write Edges published / read / write
BorderStyle published / read / write HotTrack published / read / write
ButtonStyle published / read / write Shadow published / read / write
ButtonTransparence published / read / write
Description
Use the BorderColor property to read or set the border color property for all linked editors.
See Also
TdxEditStyle.BorderColor; TdxEditStyleController.BorderStyle
type
TdxEditBorderStyle = (xbsNone, xbsSingle, xbsThick, xbsFlat, xbs3D);
property BorderStyle: TdxEditBorderStyle;
Description
Use the BorderStyle property to read or set the border style for all linked editors. Available values
include:
See Also
TdxEditStyle.BorderStyle; TdxEditStyleController.BorderColor
type
TdxEditButtonViewStyle = (btsDefault, bts3D, btsFlat, btsSimple,
btsHotFlat);
property ButtonStyle: TdxEditButtonViewStyle;
Description
Use the ButtonStyle property to read or set the button style for all linked editors. Available values
include:
See Also
TdxEditStyle.ButtonStyle; TdxEditStyleController.ButtonTransparence
type
TdxEditButtonTransparence = (ebtNone, ebtInactive, ebtAlways,
ebtHideInactive);
property ButtonTransparence: TdxEditButtonTransparence;
Description
Use the ButtonTransparence property to read or set button transparency for all linked editors.
Available values include:
See Also
TdxEditStyle.ButtonTransparence; TdxEditStyleController.ButtonStyle
type
TdxEditEdge = (edgLeft, edgTop, edgRight, edgBottom);
TdxEditEdges = set of TdxEditEdge;
property Edges: TdxEditEdges;
Description
Use the Edges property to add or remove a specific border edge for all editors connected to the
current style controller. Available values include:
See Also
TdxEditStyle.Edges
Description
Use the HotTrack property to specify the manner in which an editor responds to mouse movements.
Though the control changes its visual state, it does not receive focus.
Value Example
True
False
See Also
TdxEditStyle.HotTrack
Description
Set the Shadow property to True to display a shadow for all editors connected to the current style
controller.
Value Example
True
False
See Also
TdxEditStyle.Shadow
TdxEditStyleController Events
OnStyleChanged published
OnStyleChanged event
Occurs when changing the current edit style.
type
TdxStyleChangedEvent = procedure (Sender: TObject; Link: TObject) of
object;
property OnStyleChanged;
Description
Use this property to write an OnStyleChanged event handler to perform specific actions when
changing the current edit style. You can use it to implement different colors, fonts, etc. for editors.
The Sender parameter specifies the style controller whose event handler is called. The Link
parameter determines the editor linked to the style controller.
TdxEditStyle
TdxEditStyle describes the style of an editor.
Unit
dxCntner
TdxEditStyle = class(TPersistent)
Description
Use TdxEditStyle to specify the look & feel of an editor.
Hierarchy
TObject
TPersistent
See Also
TdxEditStyleController; TdxStyleController
TdxEditStyle Properties
Edit public / read only ButtonTransparence published / read / write
AssignedValues published / read / write Edges published / read / write
BorderColor published / read / write HotTrack published / read / write
BorderStyle published / read / write Shadow published / read / write
ButtonStyle published / read / write
Description
The Edit property determines the editor connected to the current edit style.
See Also
TdxInplaceEdit
type
TdxEditStyleValue = (svBorderColor, svBorderStyle, svButtonStyle,
svButtonTransparence, svEdges, svHotTrack, svShadow);
TdxEditStyleValues = set of TdxEditStyleValue;
property AssignedValues: TdxEditStyleValues;
Description
The TdxEditStyleValues type defines a set of possible state flags for the AssignedValues property.
Assigned values (except for default values) are used when implementing a style in a component. The
following table lists the possible values for a TdxEditStyleValues object and explains the meaning of
each flag:
Value Description
svBorderColor The BorderColor property has been assigned.
svBorderStyle The BorderStyle property has been assigned.
svButtonStyle The ButtonStyle property has been assigned.
svButtonTransparence The ButtonTransparence property has been assigned.
svEdges The Edges property has been assigned.
svHotTrack The HotTrack property has been assigned.
svShadow The Shadow property has been assigned.
See Also
TdxEditStyle.BorderColor; TdxEditStyle_BorderStyle; TdxEditStyle_ButtonStyle;
TdxEditStyle.ButtonTransparence; TdxEditStyle.Edges; TdxEditStyle.HotTrack;
TdxEditStyle.Shadow
Description
Use this property to read or set the border color for an editor. It affects a control only if the
BorderStyle property is set to xbsSingle or xbsThick.
See Also
TdxEditStyleController.BorderColor
type
TdxEditBorderStyle = (xbsNone, xbsSingle, xbsThick, xbsFlat, xbs3D);
property BorderStyle: TdxEditBorderStyle;
Description
Use this property to read or set the border style of an editor. Available values include:
See Also
TdxEditStyleController.BorderStyle
type
TdxEditButtonViewStyle = (btsDefault, bts3D, btsFlat, btsSimple,
btsHotFlat);
property ButtonStyle: TdxEditButtonViewStyle
Description
Use this property to read or set the button style of an editor. Available values include:
See Also
TdxEditStyleController.ButtonStyle
type
TdxEditButtonTransparence = (ebtNone, ebtInactive, ebtAlways,
ebtHideInactive);
property ButtonTransparence: TdxEditButtonTransparence;
Description
Use this property to read or set the button transparency of an editor. Available values include:
ebtInactive A button is
transparent only
when inactive.
ebtAlways A button is always
transparent.
See Also
TdxEditStyleController.ButtonTransparence
type
TdxEditEdge = (edgLeft, edgTop, edgRight, edgBottom);
TdxEditEdges = set of TdxEditEdge;
property Edges: TdxEditEdges;
Description
Use the Edges property to add or remove editor borders. Available values include:
See Also
TdxEditStyleController.Edges
Description
Set the HotTrack property to True to highlight an editor in response to mouse movements.
Value Example
True
False
See Also
TdxEditStyleController.HotTrack
Description
Set the Shadow property to True to provide a shadow effect for an editor.
Value Example
True
False
See Also
TdxEditStyleController.Shadow
TdxEditStyle Methods
Changed protected DefaultButtonStyle public
EditStyleController protected DefaultButtonTransparence public
Create public DefaultEdges public
Destroy public DefaultHotTrack public
Assign public DefaultShadow public
DefaultBorderColor public GetDefaultEditStyleController public
DefaultBorderStyle public RestoreDefaults public
Changed method
Provides specific actions when changing the style property values.
Description
The Changed method calls the StyleChanged method of a linked editor. The linked editor is specified
by the Edit property of the TdxEditStyle class. The Changed method is used internally to calculate the
editor’s new size and to repaint it.
EditStyleController method
Determines the style controller assigned to a specific editor.
Description
The EditStyleController method returns the TdxEditStyleController class assigned to the
StyleController property of an editor. If the Edit and StyleController properties are not defined, the
EditStyleController method returns nil.
See Also
TdxEditStyleController
Create method
Creates an instance of a TdxEditStyle object and then connects an editor to the default style controller.
Description
The Create method calls the inherited Create method to create an instance of the TdxEditStyle object.
Use the Create method to add a new link to an editor at the end of the linked object array represented
by the Links property of the default style controller. The AEdit parameter specifies the editor
connected to the style controller.
Destroy method
Destroys an instance of the TdxEditStyle object.
Description
The Destroy method removes the connection between an editor and the default style controller. Use
the Destroy method to delete a specific item from the array represented by the Links property of the
current style controller, then call the inherited Destroy method to destroy an instance of the
TdxEditStyle object.
Assign method
Copies the contents of one TdxEditStyle object to another.
Description
Call the Assign method to copy the properties of one edit style to another. The standard form of a call
to Assign is:
Destination.Assign(Source);
DefaultBorderColor method
Specifies the default color of an editor border.
Description
If an editor is connected to a style controller, the DefaultBorderColor method returns the border color
set in this style controller. Otherwise, the DefaultBorderColor method returns the border color of the
default style controller (clWindowFrame).
See Also
TdxEditStyle.BorderColor
DefaultBorderStyle method
Specifies the default style of an editor's border.
type
TdxEditBorderStyle = (xbsNone, xbsSingle, xbsThick, xbsFlat, xbs3D);
function DefaultBorderStyle: TdxEditBorderStyle; virtual;
Description
If an editor is connected to a style controller, the DefaultBorderStyle method returns the border style set in
this style controller. Otherwise, the DefaultBorderStyle method returns the border style defined by the
default style controller (xbs3D). Available values include:
See Also
TdxEditStyle.BorderStyle
DefaultButtonStyle method
Specifies the default style of an editor button.
type
TdxEditButtonViewStyle = (btsDefault, bts3D, btsFlat, btsSimple,
btsHotFlat);
function DefaultButtonStyle: TdxEditButtonViewStyle; virtual;
Description
If an editor is connected to a style controller, the DefaultButtonStyle method returns the button style
set in this style controller. Otherwise, the DefaultButtonStyle method returns the button style defined
by the default style controller (btsDefault). Available values include:
See Also
TdxEditStyle.ButtonStyle
DefaultButtonTransparence method
Specifies the manner in which a button appears within an editor by default.
type
TdxEditButtonTransparence = (ebtNone, ebtInactive, ebtAlways,
ebtHideInactive);
function DefaultButtonTransparence: TdxEditButtonTransparence; virtual;
Description
If an editor is connected to a style controller, the DefaultButtonTransparence method returns the
button transparency value set in this style controller. Otherwise, the DefaultButtonTransparence
method returns the button transparency value defined by the default style cont roller (ebtNone).
Available values include:
ebtInactive A button is
transparent only
when inactive.
ebtAlways A button is always
transparent.
See Also
TdxEditStyle.ButtonTransparence
DefaultEdges method
Specifies which edge of an editor is displayed by default.
type
TdxEditEdge = (edgLeft, edgTop, edgRight, edgBottom);
TdxEditEdges = set of TdxEditEdge;
function DefaultEdges: TdxEditEdges; virtual;
Description
If an editor is connected to a style controller, the DefaultEdges method returns the set of displayed
edges of this style controller. Otherwise, the DefaultEdges method returns the set of displayed edges
defined by the default style controller ([edgLeft, edgTop, edgRight, edgBottom]). Available values
include:
See Also
TdxEditStyle.Edges
DefaultHotTrack method
Returns the default value of the HotTrack property.
Description
If an editor is connected to a style controller, the DefaultHotTrack method returns the value set in this
style controller. Otherwise, the DefaultEdges method returns the value defined by the default style
controller (False ).
See Also
TdxEditStyle.HotTrack
DefaultShadow method
Returns the default value which specifies whether an editor is displayed with a shadow.
Description
If an editor is connected to a style controller, the DefaultShadow method returns the value set in this
style controller. Otherwise, the DefaultShadow method returns the value defined by the default style
controller (False ).
Value Example
False
True
See Also
TdxEditStyle.Shadow
GetDefaultEditStyleController method
Returns the default style controller.
Description
The GetDefaultEditStyleController method returns the value of the DefaultEditStyleController variable.
The value of this variable is the TdxEditStyleController class that is created and initialized with the
default values.
See Also
TdxEditStyleController)
RestoreDefaults method
Restores the default values of the style properties of an editor.
Description
The RestoreDefaults method removes the current values of the style properties of an editor and
restores their default values.
TdxEditDataDefinition
Used by data-aware editors to provide access to a data source.
Unit
dxCntner
TdxEditDataDefinition = class(TPersistent);
Description
TdxEditDataDefinition is used internally to work with data associated with a data-aware editor and
provides access to a data source. If you wish to write your own class that provides access to any
other dataset you have to inherit it from this class. In your own class the virtual protected methods
GetEditValue and SetEditValue must be overridden. Remember to implement proper notification with
the help of the OnActiveChange and OnDataChange events.
Hierarchy
TObject
TPersistent
TdxEditDataDefinition Properties
DisplayValue public / read only
EditValue public / read only
Description
The DisplayValue property contains the value to display.
Specifies the manner in which text is aligned within an editor.
Description
The EditValue property contains the value to edit.
TdxEditDataDefinition Methods
GetEditValue protected
SetEditValue protected
GetEditValue method
Returns the edited value of a data-aware editor.
Description
The GetEditValue method is called to obtain a value for a data-aware editor. This method is called
when initializing an editor. Descendants of TdxEditDataDefinition should override this method to
provide a proper value for edited text.
SetEditValue method
Sets the value for the data source associated with a data-aware editor.
Description
The SetEditValue method is called by a data-aware editor to write an appropriate value determined by
the Value parameter to the data source. Descendants of TdxEditDataDefinition should override this
method to provide a specific action.
You can use this method procedure to raise an exception if the entered value is not correct.
TdxEditDataDefinition Events
OnActiveChange protected
OnDataChange protected
OnActiveChange event
Occurs when changing the data source is activated or created.
type
TdxEditNotifyEvent = procedure of object;
property OnActiveChange: TdxEditNotifyEvent;
Description
Write an OnActiveChange event handler to perform specific actions when the data source has been
opened or closed. The data-aware editor has to adjust its properties according to the properties of the
associated data source.
OnDataChange event
Occurs when the contents of the data source or data source itself have changed.
type
TdxEditNotifyEvent = procedure of object;
property OnDataChange: TdxEditNotifyEvent;
Description
Write an OnDataChange event handler to perform specific actions when the contents of the data
source have changed externally. For instance, when a new value was assigned to a field of the data
source in the following manner: F.AsString := '123'; without using editor's resources.
TdxInplaceEdit
TdxInplaceEdit is the core class for all ExpressEditors.
Unit
dxCntner
TdxInplaceEdit = class(TWinControl);
Description
TdxInplaceEdit is the base class for all ExpressEditors and includes core methods and properties.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
See Also
TdxInplaceMaskEdit; TdxInplaceTextEdit
TdxInplaceEdit Properties
Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read only
Container protected / read only Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write
Description
Use the Alignment property to specify the horizontal placement of a text string within an editor. Text can be
aligned either to the right, left or centered.
Description
The AutoSize property is a Boolean expression that specifies whether the size of an editor is permanent or it
changes together with font size.
Value Description
True An editor can change its height.
Description
The Container property specifies the associated container for an editor if the IsInplace property is
True; Otherwise nil.
See Also
TCustomdxContainer
property Height;
Description
Use the Height property to read or change the height of an editor.
Description
The Modified property is set to True when a user changes the editor’s contents; Otherwise False . If
the contents of an editor are changed programmatically at runtime, this property is not set to True.
Description
The ReadOnly property prevents users from changing data within an editor. By default, ReadOnly is
set to False . This property is protected and descendants can publish it to enable changing data within
the editor. Users can edit data within the editor if the ReadOnly property is False . If ReadOnly is
True, the editor is used for display purposes only.
type
Description
The possible values for the StoredValues property include:
Values Description
svAlignment The value of the Alignment property is stored.
svEditLimit The value of the EditLimit property is stored.
svEditMask The value of the EditMask property is stored.
svIsFloat The value of the IsFloat property is stored.
svMaxValue The value of the MaxValue property is stored.
svMinValue The value of the MinValue property is stored.
svReadOnly The value of the ReadOnly property is stored.
svRequired The value of the Required property is stored.
svDisplayFormat The value of the DisplayFormat property is stored.
Description
The Style property determines the manner in which an editor is displayed on screen. The Style
property represents the TdxEditStyle class that is used to control the appearance of an editor. If an
editor is connected to a style controller, the TdxEditStyle class contains all the properties specified in
the style controller. An editor may have a different value for the same property as the style controller
without breaking the connection with it. In such an instance, a user changes the property and the
TdxEditStyle class sets a specific state flag for the AssignedValues property. This state flag indicates
that the user assigns this property value. Thus, the component uses assigned values - except for the
default (or style controller) values - when implementing its style.
See Also
TdxEditStyle
Description
Use the StyleController property to specify the current style controller linked to an editor. The style
controller is used to set similar properties for all linked editors.
See Also
TdxEditStyleController
TdxInplaceEdit Methods
CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public
CanModify method
Determines whether a user can edit text within an editor.
Description
Descendant editors use the CanModify method internally to determine whether to enable text editing within
an editor. If text editing is enabled, the CanModify method returns True; Otherwise; False .
Deselect method
Removes selection from an editor.
Description
The Deselect method is used internally to remove selection from an editor. TdxInplaceEdit
descendants can override this method to provide a proper deselect mechanism.
See Also
TdxInplaceTextEdit.Deselect
InvalidateEdit method
Repaints a specific editor.
procedure InvalidateEdit;
Description
The InvalidateEdit method is used internally to repaint an editor on screen.
IsEditClass method
Determines whether an editor belongs to the EDIT window class.
Description
The IsEditClass method is used to determine whether an editor belongs to the EDIT window class.
The IsEditClass method always returns False for TdxInplaceEdit.
Reset method
Cancels all non-posted text changes.
procedure Reset;
Description
The Reset method cancels all non-posted text changes when a user presses the Escape key.
RestoreDefaults method
Sets the default value for an editor's properties.
Description
The RestoreDefaults method resets all properties specified via the StoredValues property to default
values.
SelectAll method
Selects all text within an editor.
Description
The SelectAll method is used internally to select the entire contents of an editor when focused.
TdxInplaceEdit descendants can override this method to provide a desired selection mechanism.
See Also
TdxInplaceTextEdit.SelectAll
ValidateEdit method
Raises an exception when an invalid value is entered within an editor.
Description
The ValidateEdit method is used internally by editors to raise exceptions when invalid values are
entered within an editor. This method can be used to generate an OnValidate event.
See Also
TdxInplaceMaskEdit.ValidateEdit
TdxInplaceEdit Events
OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected
OnChange event
Occurs after changing the value within an editor.
type
TNotifyEvent = procedure(Sender: TObject) of object;
property OnChange: TNotifyEvent;
Description
Write an OnChange event handler to perform specific actions when the value within an editor has
changed.
OnMouseEnter event
Occurs when the mouse pointer enters the borders of an editor.
type
TNotifyEvent = procedure(Sender: TObject) of object;
property OnMouseEnter: TNotifyEvent;
Description
Write an OnMouseEnter event handler to perform specific actions when the mouse pointer enters the
borders of an editor.
OnMouseLeave event
Occurs when the mouse pointer leaves the borders of an editor.
type
TNotifyEvent = procedure(Sender: TObject) of object;
property OnMouseLeave: TNotifyEvent;
Description
Write an OnMouseLeave event handler to perform specific actions when the mouse pointer leaves the
editor’s borders.
OnValidate event
Occurs before the editor accepts data.
type
Description
Write an OnValidate event handler to validate data changes made within an editor, before the data is
finally written to the current editor. If the editor is an in-place editor, this event occurs when a user
confirms data input or if the editor is closed and the Modified property is True. If the editor is a
standalone control, this event fires when it loses focus. The OnValidate event is can be generated
manually via the ValidateEdit method.
The EditMask property allows data validation on a character-by-character basis as a user enters it.
The OnValidate event allows an application to validate data as a whole. The Sender parameter
determines the editor whose data is being validated. The ErrorText parameter specifies the text
displayed when an exception is raised. The Accept parameter specifies whether the editor accepts or
cancels the changes. If data is accepted, the Accept parameter is True. Otherwise; it’s False.
TdxInplacePopupControl
TdxInplacePopupControl is the ancestor of the dropdown windows used by editors.
Unit
dxCntner
TdxInplacePopupControl = class(TCustomControl);
Description
Certain editors use dropdown windows to modify their values. The TdxInplacePopupControl class is a
common ancestor for dropdown windows that obtain focus during editing. For instance, the dropdown
windows used by TdxInplaceCalcEdit or TdxInplaceDateEdit are inherited from the
TdxInplacePopupControl class.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TCustomControl
TdxInplacePopupControl Properties
OwnerControl public / read / write Shadow public / read / write
PopupBorderStyle public / read / write ShadowSize public / read / write
OwnerControl: TdxInplaceEdit;
Description
OwnerControl determines the editor that activates a TdxInplacePopupControl instance. OwnerControl
is not a property, but a class member variable.
See Also
TdxInplaceEdit
type
TdxPopupBorderStyle = pbSingle .. pbFlat;
property PopupBorderStyle: TdxPopupBorderStyle;
Description
The PopupBorderStyle proerty is used to specify the border style of the dropdown window activated by
an editor. The values of the popup border style include:
Value Description
pbSingle Single-line border.
pbFlat Flat border with a light 3D effect.
Description
The Shadow property specifies whether a dropdown window has a shadow. If the Value of the
Shadow property is True, the drop down window is displayed with a shadow.
Description
The ShadowSize property specifies the shadow size of the dropdown window activated by an editor in
pixels.
The default value of the shadow size is determined by the following constant:
dxEditShadowSize = 3
TdxInpacePopupControl Methods
HidePopup public
ShowPopup public
HidePopup method
Hides the active dropdown window.
Description
The HidePopup method is called whenever a dropdown window loses focus. The ByMouse parameter
determines whether a dropdown window is closed on mouse click events.
See Also
TdxInplacePopupControl.ShowPopup
ShowPopup method
Activates a dropdown window.
Description
The ShowPopup method is used to display a dropdown window on screen. This method is called
when a user presses a button within an editor cell to modify its data.
See Also
TdxInplacePopupControl.HidePopup
TdxInplaceTextEdit
TdxInplaceTextEdit is an editor with text editing capabilities.
Unit
dxEditor
Description
TdxInplaceTextEdit descends from TdxInplaceEdit. You can inherit TdxInplaceTextEdit if you wish to
create a specific editor with text editing capabilities. If you wish to create an editor with mask support,
you should use TdxInplaceMaskEdit as a base control.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
See Also
TdxInplaceEdit; TdxInplaceMaskEdit
TdxInplaceTextEdit Properties
In TdxInplaceTextEdit
AutoSelect protected / read / write OEMConvert protected / read / write
CanPaste public / read only PasswordChar protected / read / write
CanRedo public / read only SelectionBar protected / read / write
CanUndo public / read only SelLength public / read / write
CharCase protected / read / write SelStart public / read / write
HideSelection protected / read / write SelText public / read / write
MaxLength protected / read / write Text public / read / write
Description
AutoSelect is a protected property that can be published by TdxInplaceTextEdit descendants. If the
AutoSelect property is True, all text is selected when an editor receives focus.
Description
When the CanPaste property is True, a control can accept the contents of the Windows clipboard.
The CanPaste property also controls whether the Paste command is enabled in the context menu.
See Also
TdxInplaceTextEdit.CanRedo; TdxInplaceTextEdit.CanUndo; TdxInplaceTextEdit.Text
Description
Use the CanRedo property to determine whether a user can re-apply a previously cancelled change to
the edited text. If the CanRedo property is True, previously cancelled operations exist and the Redo
operation can be performed. Otherwise, there are no cancelled operations. This property can be
used when enabling or disabling menu items that correspond to the Redo command.
See Also
TdxInplaceTextEdit.CanPaste; TdxInplaceTextEdit.CanUndo; TdxInplaceTextEdit.Text
Description
Read the CanUndo property to determine whether a user has made any changes to the text that can
be undone by calling the Undo method. If the CanUndo property is True, there are completed
operations and the Undo operation can be performed. Otherwise, there are no previously performed
operations. This property can be used when enabling or disabling menu items that correspond to the
Undo command.
See Also
TdxInplaceTextEdit.CanPaste; TdxInplaceTextEdit.CanRedo; TdxInplaceTextEdit.Text
type
TEditCharCase = (ecNormal, ecUpperCase, ecLowerCase);
property CharCase : TEditCharCase;
Description
The CharCase is a protected property that can be published by TdxInplaceTextEdit descendents. Use
the CharCase property to apply a particular case to the contents of a specific editor. Possible
CharCase values include:
Value Description
ecLowerCase Text is converted to lowercase.
ecNormal Text is unaltered.
ecUpperCase Text is converted to UPPERCASE.
When the CharCase property is set to ecLowerCase or ecUpperCase , character case is converted
on the fly when a user types them into an in-place editor. Setting the CharCase property to
ecLowerCase or ecUpperCase changes the actual contents of the text, not just its appearance. All
case information is lost and cannot be recaptured by changing CharCase to ecNormal.
See Also
TdxInplaceEdit.GetDefaultCharCase; TdxInplaceTextEdit.Text
Description
HideSelection is a protected property that can be published by TdxInplaceTextEdit descendants. Set
the HideSelection property to False to allow text to remain selected when an editor loses focus. Set
the HideSelection property to True to display the selection only when the editor has focus. The
HideSelection property is a visual indicator only and does not affect the actual value of the selection.
By default, the HideSelection property for TdxInplaceTextEdit is set to True.
See Also
TdxInplaceTextEdit.SelLength; TdxInplaceTextEdit.SelStart; TdxInplaceTextEdit.SelText;
TdxInplaceTextEdit.SetSelTextBuf
Description
MaxLength is a protected property that can be published by TdxInplaceTextEdit descendants. The
MaxLength property limits the number of characters that can be entered within an editor. A value of 0
indicates that there is no limit to the number of characters that can be entered by a user at runtime.
For instance, you can use the MaxLength property to limit the text length in the editor if this text is to
be copied into a fixed-length buffer. By default, the MaxLength property for TdxInplaceTextEdit is set
to 0.
Note: MaxLength will not truncate existing text, it merely prevents users from adding more text after reaching
the limit of MaxLength characters. Additionally, when MaxLength is 0, there may be limitations
imposed by the operating system on the number of characters that may be entered into an editor.
See Also
TdxInplaceTextEdit.Text; TdxInplaceTextEdit.DoSetMaxLength;
TdxInplaceTextEdit.DefaultMaxLength
Description
OEMConvert is a protected property that can be published by TdxInplaceTextEdit descendants. To
make certain that all characters typed into the editor can be converted to the OEM character set, set
the OEMConvert property to True. These actions automatically convert all characters from ANSI to
OEM and then back to ANSI. Set the MemoOEMConvert property to False to avoid excessive
processing when mapping to the OEM format is not necessary.
The OEMConvert property is most useful for editors used to enter file names when an application does
not use Unicode file names.
See Also
TdxInplaceTextEdit.Text
Description
PasswordChar is a protected property that can be published by TdxInplaceTextEdit descendants. The
PasswordChar property is used to display special characters instead of the text entered by a user. If
the PasswordChar property is set to a null character (ANSI character zero), text is displayed without
modification. If PasswordChar is set to any other character, the edit control displays the
PasswordChar instead of each character as it is typed. The Text property contains the actual value
supplied by the user as it was typed.
Description
SelectionBar is a protected property that can be published by TdxInplaceTextEdit descendants. Use
the SelectionBar property to specify whether an editor displays an indentation within the control. If
SelectionBar is True, edited text is displayed with an indent that is equal to the SelectionBarSize
constant (by default 8).
Description
Use the SelLength property to determine the length of selected text. Setting the SelLength property
changes selected text length beginning from the position specified by the SelStart property.
Note: Setting SelLength to a value greater than the number of characters from SelStart to the end of the text,
results in the selection of all characters from SelStart to the end of the text. Reading the SelLength
property immediately after setting it returns the actual number of selected characters.
See Also
TdxInplaceTextEdit.SelStart; TdxInplaceTextEdit.SelText
Description
Use the SelStart property to determine the position of the first selected character. The SelStart
property is 0 based where 0 indicates the first character. If no text is selected, the SelStart property
indicates cursor position. Set the SelStart property to remove the current selection and place the
cursor just before the character indicated by the supplied value. To select a particular text range, first
set the SelStart property to position the cursor, and then set the SelLength property to extend the
selection.
See Also
TdxInplaceTextEdit.SelLength; TdxInplaceTextEdit.SelText
Description
Read the SelText property to determine the selected text value. Set the SelText property to replace
the selected text with a new string. If there is no selection, but the edit control has focus, set the
SelText property to insert a new string into the text at the cursor.
See Also
TdxInplaceTextEdit.GetSelTextBuf; TdxInplaceTextEdit.ClearSelection; TdxInplaceTextEdit.SelStart;
TdxInplaceTextEdit.SelLength; TdxInplaceTextEdit.SetSelTextBuf; TdxInplaceTextEdit.Text
Description
Read the Text property to obtain text within an editor or set it to specify a new string for an editor.
See Also
TdxInplaceTextEdit.SelText
TdxInplaceTextEdit Methods
TdxInplaceTextEdit
CheckCharCase protected GetTextLenEx public
Clear public IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
DefaultMaxLength public SelectionChange protected
Deselect public SetEditMaxLength protected
DoSetMaxLength protected SetSelection public
GetSelection public SetSelLength protected
GetSelLength protected SetSelStart protected
GetSelStart protected SetSelTextBuf public
GetSelText protected Undo public
GetSelTextBuf public
CheckCharCase method
Checks the char case of the edited text within a text editor.
Description
The CheckCharCase method checks whether the CharCase property is equal to ecNormal. If not, the
CheckCharCase method converts the edited text to upper or lower case based upon the CharCase
property value.
See Also
TdxInplaceTextEdit.CharCase
Clear method
Deletes all text from an editor.
procedure Clear;
Description
Use the Clear method to replace the value of the Text property with an empty string. The Clear
method removes all text. To remove selected text only, use the ClearSelection method.
See Also
TdxInplaceTextEdit.ClearSelection; TdxInplaceTextEdit.Text
ClearSelection method
Deletes the selected text from an editor.
procedure ClearSelection;
Description
Use the ClearSelection method to send a WM_CLEAR message to an editor to delete (clear) the
current selection, if any. The ClearSelection method only removes the selected text. Use the Clear
method to remove all text.
See Also
TdxInplaceTextEdit.Clear; TdxInplaceTextEdit.Text
ClearUndo method
Clears the Undo buffer.
procedure ClearUndo;
Description
Use the ClearUndo method to clear the Undo command buffer. The ClearUndo method sends the
(EM_EMPTYUNDOBUFFER) message to a window.
See Also
TdxInplaceTextEdit.CanUndo
CopyToClipboard method
Copies the selected text from an editor to the Clipboard in CF_TEXT format.
procedure CopyToClipboard;
Description
Call the CopyToClipboard method to replace Clipboard contents with the selected text. The
CopyToClipboard method does not clear the Clipboard if no text is selected. Calling the
CopyToClipboard method performs the same action as sending a WM_COPY message to the edit
control.
See Also
TdxInplaceTextEdit.CutToClipboard; TdxInplaceTextEdit.PasteFromClipboard
CutToClipboard method
Copies the selected text to the Clipboard in CF_TEXT format and deletes the selection from an editor.
procedure CutToClipboard;
Description
Call the CutToClipboard method to replace Clipboard contents with the selected text and remove the
selected text from an editor. If no text is selected, the CutToClipboard method performs no action.
Calling the CutToClipboard method performs the same action as sending a WM_CUT message.
See Also
TdxInplaceTextEdit.CopyToClipboard; TdxInplaceTextEdit.PasteFromClipboard
DefaultMaxLength method
Returns the default value for the maximum number of characters a user can enter within an editor.
Description
A value of 0 indicates that there is no limit on character length. The DefaultMaxLength method returns
a value of 0 if the text editor is not a data-aware control. In other instances, the DefaultMaxLength
method returns the property value of the internal class that specifies the number of characters a user
can type into a data-aware editor.
See Also
TdxInplaceTextEdit.MaxLength
Deselect method
Removes text selection from an editor.
Description
Use the Deselect method to remove text selection from an editor. The Deselect method simply
changes selection; it does not change actual text. Calling the Deselect method performs the same
action as sending an EM_SETSEL message to the editor (to remove the current selection the first
message parameter must be 1).
See Also
TdxInplaceEdit.Deselect
DoSetMaxLength method
Returns the MaxLength property value.
Description
The DoSetMaxLength is a protected method called to set the MaxLength property. Descendants can
override this method to implement additional code when the MaxLength property is set.
The DoSetMaxLength method sends an EM_EXLIMITTEXT message to the editor window. The Value
parameter determines a new value for the MaxLength property.
See Also
TdxInplaceTextEdit.MaxLength
GetSelection method
Returns the selected text from an editor.
Description
Use the GetSelection method to return the selected text from an editor. Calling the GetSelection
method performs the same action as sending an EM_EXGETSEL message to the editor.
See Also
TdxInplaceTextEdit.SetSelection
GetSelLength method
Returns the value of the SelLength property.
Description
The GetSelLength method is called to access the SelLength property. Descendants can override this
protected method to implement additional code when the MaxLength property is accessed.
The GetSelLength method calls the GetSelection method and returns the difference between the initial
and final positions of the selected text. Said differently, the GetSelLength method returns the number
of characters of selected text.
See Also
TdxInplaceTextEdit.SelLength; TdxInplaceTextEdit.SetSelLength
GetSelStart method
Returns the value of the SelStart property.
Description
The GetSelStart method is called to access the SelStart property. Descendants can override this
protected method to implement additional code when the SelStart property is accessed.
The GetSelLength method calls the GetSelection method and returns the initial position of the selected
text.
See Also
TdxInplaceTextEdit.SelStart; TdxInplaceTextEdit.SetSelStart
GetSelText method
Returns the SelText property value.
Description
The GetSelText method is called to access the SelText property. This protected method can be
overridden by descendants to implement additional code when the SelText property is accessed.
The GetSelText method reads the SelText property to determine the selected text string.
See Also
TdxInplaceTextEdit.SelText; TdxInplaceTextEdit.SetSelText')
GetSelTextBuf method
Copies the selected text to a buffer and returns the number of copied characters.
Description
Use the GetSelTextBuf method to copy the selected text to the character buffer referenced by the
Buffer parameter. If there is no selection, the buffer receives an empty string. The GetSelTextBuf
method returns the number of characters actually copied. If the selection contains more characters
than specified by the BufSize parameter, the GetSelTextBuf method returns the number of characters
determined by the BufSize parameter.
See Also
TdxInplaceTextEdit.SetSelTextBuf
GetTextLenEx method
Returns the length of the underlying text.
Description
Call the GetTextLenEx method to determine the length of the underlying text for an editor.
See Also
TdxInplaceTextEdit.Text
IsEditClass method
Determines whether an editor belongs to the EDIT window class.
Description
The IsEditClass method provides a method to determine whether an editor belongs to the EDIT
window class. The IsEditClass method always returns True for TdxInplaceTextEdit.
See Also
TdxInplaceBlobEdit.IsEditClass; TdxInplaceImageEdit.IsEditClass
PasteFromClipboard method
Pastes the contents of the Clipboard into an editor, replacing the current selection.
procedure PasteFromClipboard;
Description
Use the PasteFromClipboard method to replace the selected text with the contents of the Clipboard or
if no text is selected, to insert the Clipboard’s contents at the cursor position. If the Clipboard is empty,
or if it does not contain anything in CF_TEXT format, the PasteFromClipboard method performs no
action. Calling the PasteFromClipboard method performs the same action as sending the
WM_PASTE message to the editor.
See Also
TdxInplaceTextEdit.CopyToClipboard; TdxInplaceTextEdit.CutToClipboard
Redo method
Repeats the previously cancelled operation within an editor.
procedure Redo;
Description
Call the Redo method to repeat the last cancelled action. The Redo method is in effect only after the
Undo command. Calling the Redo method performs the same action as sending the EM_REDO
message to the editor.
See Also
TdxInplaceTextEdit.CanRedo; TdxInplaceTextEdit.CopyToClipboard;
TdxInplaceTextEdit.CutToClipboard; TdxInplaceTextEdit.Undo
RestoreDefaults method
Sets the default property values for an editor.
Description
The RestoreDefaults method calls the inherited RestoreDefaults method, which resets all editor
properties - specified via the StoredValues property of an editor - to their default values. Additionally,
you can use the RestoreDefaults method to restore the default value of the MaxLength property.
SelectAll method
Selects the entire text within an editor.
Description
The SelectAll method overrides the SelectAll method of TdxInplaceEdit. Use the SelectAll method to
select all text within an editor. To select only a portion of text, use the SelStart and SelLength
properties and the SetSelection methods.
See Also
TdxInplaceEdit.SelectAll; TdxInplaceTextEdit.SelLength; TdxInplaceTextEdit.SelStart
SelectionChange method
Generates the OnSelectionChange event.
Description
Use the SelectionChange method to generate the OnSelectionChange event when text selection
within an editor has changed, even if the selection is empty.
See Also
TdxInplaceTextEdit.SelText; TdxInplaceTextEdit.SetSelText; TdxInplaceTextEdit.OnSelectionChange
SetEditMaxLength method
Sets the MaxLength property.
Description
The SetEditMaxLength method sets the MaxLength property according to the Value parameter. This
protected method can be overridden by descendants to implement additional code when the
EditMaxLengthProperty is set.
If the Value parameter is greater than the MaxLength property value, the SetEditMaxLength method
calls the DoSetMaxLength method with the Value parameter; Otherwise the MaxLength property value
does not change.
See Also
TdxInplaceTextEdit.MaxLength
SetSelection method
Selects a portion of text within an editor.
Description
Use the SetSelection method to select a portion of text within an editor. The SetSelection method
selects text from StartPos to EndPos. The StartPos and EndPos parameters are passed to the
SetSelection method and determine the initial and final position of selection.
See Also
TdxInplaceEdit.SelectAll; TdxInplaceTextEdit.SelLength; TdxInplaceTextEdit.SelStart
SetSelLength method
Sets the value of the SelLength property.
Description
The SetSelLength method is called to access the SelLength property. This protected method can be
overridden by descendants to implement additional code when the SelLength property is set.
The SetSelLength method calls the SetSelection method which sends an EM_EXSETSEL message to
the editor window specifying the selection length via the Value parameter.
See Also
TdxInplaceTextEdit.GetSelLength; TdxInplaceTextEdit.SelLength; TdxInplaceTextEdit.SelStart
SetSelStart method
Sets the value of the SelStart property.
Description
The SetSelStart method is called to access the SelStart property. This protected method can be
overridden by descendants to implement additional code when the SelStart property is set.
The SetSelStart method calls the SetSelection method which sends an EM_EXSETSEL message to
the editor window to position the cursor based upon the Value parameter. Said differently, the
SetSelStart method sets the initial position of the selected text.
See Also
TdxInplaceTextEdit.GetSelStart; TdxInplaceTextEdit.SelStart
SetSelTextBuf method
Replaces the selected text with a null-terminated string.
Description
Use the SetSelTextBuf method to replace the current selection with the contents of the null-terminated
string pointed to by the Buffer parameter. If no text is selected, the Buffer’s contents are inserted at
the cursor. The SetSelTextBuf method performs the same action as setting the SelText property with
the exception of taking the PCharacter parameter.
See Also
TdxInplaceTextEdit.GetSelTextBuf
Undo method
Cancels the previously performed operation within an editor.
procedure Undo;
Description
Call the Undo method to cancel changes made to the text of an editor. This method cancels the last
completed action. To determine whether any actions have been performed, check the CanUndo property.
See Also
TdxInplaceTextEdit.CanUndo
TdxInplaceTextEdit Events
TdxInplaceTextEdit
OnSelectionChange protected
OnSelectionChange event
Occurs when a cursor changes its location within an editor.
Description
Write an OnSelectionChange event handler to perform specific actions when an operation is
performed on the contents of an editor.
See Also
TdxInplaceTextEdit.SelectionChange
TdxInplaceMaskEdit
TdxInplaceMaskEdit is an editor with masked text editing capabilities.
Unit
dxEditor
TdxInplaceMaskEdit = class(TdxInplaceTextEdit);
Description
TdxInplaceMaskEdit descends from TdxInplaceTextEdit. It includes additional methods and properties
to manage masked text. A user can inherit from TdxInplaceMaskEdit to create a specific editor with
masked text editing capabilities.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
See Also
TdxInplaceEdit; TdxInplaceTextEdit
TdxInplaceMaskEdit Properties
TdxInplaceMaskEdit
EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text public / read / write
Description
Used internally to restrict the characters a user can enter into a mask editor to valid characters and
formats. If a user attempts to enter an invalid character, the edit control does not accept it. Validation
is performed on a character-by-character basis by the ValidateEdit method.
See Also
TCustomMaskEdit.EditMask; TdxInplaceMaskEdit.ValidateEdit
Description
The EditText property contains the text value for an edit control after it has been formatted by the
EditMask property. Before text is completely entered into a mask editor, the EditText property
includes a blank character for each character that has not yet been entered. As characters are
entered, the entered characters replace the blank characters. If literal mask characters are included in
the text, and no characters are substituted for blanks, the values of EditText and Text are the same.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.Text
Description
If the IgnoreMaskBlank property is True, the editor ignores characters specified as 'blanks' in the
defined mask. It skips spaces and characters defined as 'blank' characters (By default, the
underscore '_' character).
See Also
TCustomMaskEdit.EditText; TCustomMaskEditText
Description
Read the IsMasked property to determine whether the EditMask property is set. If the value of the
IsMasked property is True, an editor has a mask and the text is validated as it is entered at runtime. If
False , the editor does not restrict editing at runtime.
See Also
TdxInplaceMaskEdit.EditMask
Description
Use the Text property to determine the underlying text value before it has been formatted by the mask
edit. In the following scenarios, the Text property value may differ from the EditText property value
that is displayed within the mask editor:
The mask indicates whether the Text property contains blank characters, whether the spaces are
replaced by _, and whether literal characters are removed from the mask. If no mask exists, the Text
property is a string that appears in an editor. When setting the Text property, text value is formatted
using the mask, and the resultant value stored in the EditText property for the purposes of on-screen
display.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetTextLen;
TdxInplaceMaskEdit.IsMasked; TdxInplaceMaskEdit.ReformatText
type
TMaskedState = set of (msMasked, msReEnter, msDBSetText);
property MaskState : TMaskedState;
Description
The MaskState property is used internally to indicate specific actions that have occurred in relation to
the mask. The MaskState property includes the following values:
Value Description
MsMasked A mask has been assigned. If the MaskState property is set to msMasked, then
the IsMasked property is True.
MsReEnter An invalid character is rejected and the next character should be a valid
replacement character.
msDBSetText Text obtained from a database field that should not be validated.
MaskState is exposed as a protected property so that derived classes can maintain and use this state
information in the implementation of properties and methods.
See Also
TCustomMaskEdit.MaskState; TdxInplaceMaskEdit.IsMasked; TdxInplaceMaskEdit.ValidateEdit
TdxInplaceMaskEdit Methods
TdxInplaceMaskEdit
CheckCursor protected GetNextEditChar protected
Clear public GetPriorEditChar protected
DefaultEditMask public GetSel protected
DefaultMaxLength public GetTextLen public
GetBlankText public ReformatText protected
GetDisableCloseEditor protected SetCursor protected
GetEditingText public SetSel protected
GetFirstEditChar protected ValidateEdit public
GetLastEditChar protected ValidateError protected
GetMaxChars protected
CheckCursor method
Moves the cursor to the nearest edited character and selects it if nothing is currently selected.
procedure CheckCursor;
Description
The CheckCursor method is called whenever the position of the cursor has changed. It ensures that
at least one character is always selected. Since editing a masked edit control consists of replacing
blank characters in the mask, there must always be a selection to replace. The selection corresponds
to one or more non-literal characters in the mask, which are either blank or contain characters rejected
by the mask.
See Also
TdxInplaceMaskEdit.GetSel; TdxInplaceMaskEdit.SetCursor; TdxInplaceMaskEdit.SetSel
Clear method
Sets the Text property to an empty string.
procedure Clear;
Description
Use the Clear method to remove all text entered into a masked edit control. The Clear method sets
the value of the Text property to an empty string. It does not clear the EditMask property. If the edit
control has a mask, the EditText property is not empty, but all non-literal characters are replaced by
blanks.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.IsMasked;
TdxInplaceMaskEdit.Reset; TdxInplaceMaskEdit.Text
DefaultEditMask method
Returns the default mask value of a data-aware mask editor.
Description
The DefaultEditMask method returns blank if the DataDefinition property of the mask editor is not assigned.
Otherwise, the DefaultEditMask method returns the value of the EditMask provided by the DataDefinition.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.IsMasked;
TdxInplaceMaskEdit.Reset; TdxInplaceMaskEdit.Text
DefaultMaxLength method
Returns the default maximum length of the text displayed within a mask editor.
Description
The DefaultMaxLength method calls the inherited DefaultMaxLength method if the mask is not applied.
Otherwise, the DefaultMaxLength method returns the number of characters displayed when the mask
is applied.
See Also
TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.Text; TdxInplaceTextEdit.DefaultMaxLength
GetBlankText method
Replaces every non-mask character of edited text with a blank.
Description
The GetBlankText method returns a string that represents the edited text, replacing each non-mask
character with a blank.
See Also
TCustomMaskEdit.EditText; TCustomMaskEdit.IgnoreMaskBlank; TCustomMaskEdit.Text
GetDisableCloseEditor method
Indicates whether an editor allows you to terminate the editing process.
Description
Used internally to check whether text editing within an editor is appropriate to possible values.
GetEditingText method
Returns the characters entered into a mask editor.
Description
If an editor ignores the characters specified as 'blanks' in the defined mask (the IgnoreMaskBlank
property is True), the GetEditingText method returns the EditText property value. Otherwise, the
GetEditingText method returns the value of the Text property. If the value of the EditText property is
equal to the returned value of the GetBlankText method, GetEditingText returns a blank for
TdxInplaceMaskEdit.
See Also
TdxInplaceEdit.GetEditingText; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetBlankText
GetFirstEditChar method
Returns the index of the first non-literal character in the EditMask property value.
Description
The GetFirstEditChar method is used to locate the first position where a user can modify masked text.
0 specifies the first character, 1 specifies the second character, etc. If there is no mask, the
GetFirstEditChar method returns zero.
The GetFirstEditChar method can also be used as a starting point for program processing of all non-
literal characters in the EditText property. You can use the GetNextEditChar method to continue
looping through the edited characters within the EditText property string. The GetLastEditChar
method determines when all non-literal characters have been processed.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetLastEditChar;
TdxInplaceMaskEdit.GetNextEditChar; TdxInplaceMaskEdit.GetPriorEditChar
GetLastEditChar method
Returns the index of the last non-literal character in the EditMask property value.
Description
The GetLastEditChar method is used to locate the last position wherein a user can modify masked
text. 0 specifies the first character, 1 specifies the second character, etc. If there is no mask, the
GetLastEditChar method returns the text length.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetFirstEditChar;
TdxInplaceMaskEdit.GetMaxChars; TdxInplaceMaskEdit.GetNextEditChar;
TdxInplaceMaskEdit.GetPriorEditChar
GetMaxChars method
Returns the length of edited text.
Description
If there is a mask, the GetMaxChars method returns the EditText property string length, including all
blanks. It is similar to MaxLength, because editing in a mask editor consists of replacing non-literal
characters. If there is no mask, the GetMaxChars method returns the text length in the editor. In this
instance, the value returned by the GetMaxChars method may be less than MaxLength, which is the
maximum number of characters that can be entered into an editor.
See Also
TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetLastEditChar; TdxInplaceMaskEdit.MaxLength;
TdxInplaceMaskEdit.Text
GetNextEditChar method
Returns the first index of a non-literal character equal to or greater than the Offset parameter.
Description
The GetNextEditChar method can be used to locate the first position beginning from the Offset
parameter value where a user can modify masked text. 0 specifies the first character, 1 specifies the
second character, etc. If there is no non-literal character beginning from the Offset parameter, this
method returns the MaxLength property value.
You may use the GetNextEditChar method to loop through the modified characters in the masked text,
starting with the value returned by the GetFirstEditChar method and using the GetLastEditChar
method to determine when all non-literal characters are processed.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetFirstEditChar;
TdxInplaceMaskEdit.GetLastEditChar; TdxInplaceMaskEdit.GetPriorEditChar
GetPriorEditChar method
Returns the first index of a non-literal character equal to or less than the Offset parameter.
Description
The GetPriorEditChar method can be used to locate the first position before the Offset parameter
value where a user can modify masked text. 0 specifies the first character, 1 specifies the second
character, etc. If there is no non-literal character before the Offset parameter, the GetPriorEditChar
method returns the index of the first edited character following Offset.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetFirstEditChar;
TdxInplaceMaskEdit.GetLastEditChar; TdxInplaceMaskEdit.GetNextEditChar
GetSel method
Returns the endpoints of the current selection in masked text.
Description
The GetSel method obtains the indexes of the first and last selected characters (the SelStart to the
SelStop parameter accordingly) of EditText, where 0 is the index of the first character. Not all
characters in the selection will necessarily be edited, if the mask contains literal characters. Do not
apply the same indexes when using the Text property, if there is a mask, since the EditText property
value may contain blanks or non-literal characters not found in Text. To programmatically change the
selected text you may use the GetNextEditChar method to cycle through the edited characters of the
selection from the SelStart to the SelStop parameter.
See Also
TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetNextEditChar; TdxInplaceMaskEdit.SetSel;
TdxInplaceMaskEdit.Text; TdxInplaceTextEdit.SelText
GetTextLen method
Returns the length of the underlying text.
Description
Use the GetTextLen method to determine the length of the underlying text for a mask editor. The
underlying text is not formatted by the mask and may differ from EditText displayed within the editor
window.
See Also
TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.MaxLength; TdxInplaceMaskEdit.Text
ReformatText method
Applies a new mask to the underlying text and updates the internal representation of masked text.
Description
The ReformatText method sets the EditMask property at runtime. Th e NewMask parameter specifies
a new value for the EditMask property.
See Also
TdxInplaceMaskEdit.CheckCursor; TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText;
TdxInplaceMaskEdit.MaskState; TdxInplaceMaskEdit.Text
SetCursor method
Moves the cursor to the first edited character at or before the Pos parameter and selects this
character.
Description
The SetCursor method handles positioning of the cursor within the EditText property value so that it is
always on an edited character. It also ensures that at least one character is always selected. Since
editing a masked edit control consists of replacing blank characters in the mask, there must always be
a selection to replace. It corresponds to one or more non-literal characters in the mask, which are
either blank or contain characters for a user to re-enter.
See Also
TdxInplaceMaskEdit.CheckCursor; TdxInplaceMaskEdit.GetPriorEditChar; TdxInplaceMaskEdit.SetSel
SetSel method
Selects the characters in the EditText property from the SelStart to the SelStop parameter.
Description
The SetSel method selects the indicated range of characters within the EditText property’s string
value. If SelStart is the same as SelStop, the SetSel method positions the cursor at the SelStart
character. When using the SetSel method, set the cursor to the edited position if the objective is to
create a selection for a user to replace.
The SetSel method can be used to select non-edited characters that can be then captured by using
the SelText property or by copying to the Clipboard. Once the selection has been captured, call the
CheckCursor method to return the cursor to the edited position.
See Also
TdxInplaceMaskEdit.CheckCursor; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.GetSel;
TdxInplaceMaskEdit.SetCursor; TdxInplaceTextEdit.SelText
ValidateEdit method
Validates the value of the EditText property against the current mask.
Description
The ValidateEdit method attempts to validate the value of the EditText property each time the mask
editor loses focus and after each keystroke. If the value of the EditText property does not match the
EditMask property specifications, the ValidateEdit method calls ValidateError to raise an exception,
and returns the cursor to the first position where EditText did not comply with EditMask.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.ValidateError
ValidateError method
Beeps and raises an EDBEditError exception.
procedure ValidateError;
Description
The ValidateError method is called by the ValidateEdit method when the EditText property value fails
to comply with the EditMask property value.
See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.EditText; TdxInplaceMaskEdit.MaxLength;
TdxInplaceMaskEdit.ValidateEdit
TdxInplaceMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxInplaceMemoEdit
TdxInplaceMemoEdit should be used for the display and editing of multi-line text.
Unit
dxExEdtr
TdxInplaceMemoEdit = class(TdxInplaceTextEdit);
Description
TdxInplaceMemoEdit descends from TdxInplaceTextEdit and allows a user to display and modify
multi-line text. At runtime, users can cut, copy, and paste text to and from a memo editor control.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMemoEdit Properties
TdxInplaceMemoEdit
AutoSize protected / read / write SelectionBar protected / read / write
HideScrollBars protected / read / write WantReturns protected / read / write
Lines public / read / write WantTabs protected / read / write
ScrollBars protected / read / write WordWrap protected / read / write
property AutoSize;
Description
Use this property to determine whether the size of a memo editor control is calculated automatically. If
this property is set to True, then the editor changes size automatically based upon font size.
Description
If the HideScrollBars property is set to False , the TdxInplaceMemoEdit object displays scroll bars.
See Also
TdxInplaceMemoEdit.ScrollBars
Description
Use the Lines property to manipulate text in a memo control on a line-by-line basis. Since the Lines
property is a TStrings object, you can use standard methods to count, add, delet e or replace text lines.
To work with the entire contents of the memo control, use the Text property instead.
See Also
TdxInplaceMemoEdit.WordWrap; TdxInplaceTextEdit.SelText; TdxInplaceTextEdit.Text
type
TScrollStyle = (ssNone, ssHorizontal, ssVertical, ssBoth);
property ScrollBars: TScrollStyle;
Description
This property determines which scroll bars are used in the TdxInplaceMemoEdit object when
modifying data within a memo editor. The following values are available:
Value Meaning
ssNone Memo editor has no scroll bars.
ssHorizontal Memo editor has a horizontal scroll bar at the bottom edge.
ssVertical Memo editor has a vertical scroll bar at the right edge.
ssBoth Memo editor has both horizontal and vertical scroll bars.
See Also
TdxInplaceMemoEdit.HideScrollBars
property SelectionBar;
Description
Selection bar is a region at the leftmost edge of an editor. It allows a user to select the entire contents
of a text line using the mouse. Set the SelectionBar property to True to display it or to False to hide
it. When the selection bar is hidden, a user can select text lines on a character-by-character basis
only.
See Also
TdxInplaceTextEdit.SelectionBar
Description
Setting the WantReturns property to True enables users to enter return characters into text. If WantReturns
is True, pressing the Enter key inserts a return character into the text.
See Also
TdxInplaceMemoEdit.WantTabs; TdxInplaceMemoEdit.WordWrap; TdxInplaceTextEdit.Text
Description
Setting the WantTabs property to True enables users to enter tab characters in text.
See Also
TdxInplaceMemoEdit.WantReturns; TdxInplaceMemoEdit.WordWrap; TdxInplaceTextEdit.Text
Description
Setting the WordWrap property to True automatically wraps text to force it to fit within the client area.
Wrapping is cosmetic only and any new return characters are not inserted.
See Also
TdxInplaceMemoEdit.IsWordWrap; TdxInplaceMemoEdit.Lines; TdxInplaceMemoEdit.ScrollBars;
TdxInplaceMemoEdit.WantReturns; TdxInplaceTextEdit.Text
TdxInplaceMemoEdit Methods
Derived from TdxInplaceTextEdit
CheckCharCase protected GetTextLenEx public
Clear public IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
DefaultMaxLength public SelectionChange protected
Deselect public SetEditMaxLength protected
DoSetMaxLength protected SetSelection public
GetSelection public SetSelLength protected
GetSelLength protected SetSelStart protected
GetSelStart protected SetSelTextBuf public
GetSelText protected Undo public
GetSelTextBuf public
TdxInplaceMemoEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxInplaceDropDownEdit
The TdxInplaceDropDownEdit object represents an editor with a button and a dropdown window.
Unit
dxExEdtr
TdxInplaceDropDownEdit = class(TdxInplaceMaskEdit);
Description
The TdxInplaceDropDownEdit object descends from TdxInplaceMaskEdit. This is the base class for
all editors with an associated dropdown control. It includes a clickable button and additional features
to manage the dropdown control. This editor is used to create different types of editors with the ability
to edit data within the dropdown control.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
See Also
TdxInplaceCalcEdit; TdxInplaceDateEdit; TdxInplaceImageEdit; TdxInplaceLookupEdit;
TdxInplacePickEdit
TdxInplaceDropDownEdit Properties
TdxInplaceDropDownEdit
ButtonGlyph protected / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment protected / read / write
DroppedDown public / read / write PopupBorder protected / read / write
Description
Determines the glyph used for a command button within an editor.
Description
Use the DropDownRows property to determine the number of rows in a dropdown control. The default
value of this property is 7.
See Also
TdxInplaceDropDownEdit.DropDownWidth
Description
Specifies the width of the dropdown window that contains a list of items. The default value of this
property is 0. If this value is less than the value of the Width property, DropDownWidth then equals
Width.
See Also
TdxInplaceDropDownEdit.DropDownRows
Description
Determines whether a dropdown control associated with an editor is activated.
See Also
TdxInplaceDropDownEdit.DropDownWidth
Description
If the ImmediateDropDown property is set to True, a dropdown window is activated immediately after
pressing a key whenever the editor has focus.
See Also
TdxInplaceDropDownEdit.ImmediatePopup
Description
If the ImmediatePopup property is set to False , a single mouse click within the boundaries of the editor
activates the dropdown window.
See Also
TdxInplaceDropDownEdit.ImmediateDropDown
Description
Use the Alignment property to specify the horizontal placement of a dropdown window relative to an
appropriate editor. It can be aligned either to the right, left, or centered.
See Also
TdxInplaceDropDownEdit.ImmediatePopup; TdxInplaceDropDownEdit.PopupBorder;
TdxInplaceDropDownEdit.PopupBorderStyle)
type
TdxPopupBorder = (pbDefault, pbSingle, pbFrame3D, pbFlat);
property PopupBorder: TdxPopupBorder;
Description
Determines the border style of a dropdown control. Possible values include:
See Also
TdxInplaceDropDownEdit.PopupBorderStyle
TdxInplaceDropDownEdit Methods
TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected
DoButtonDown method
Description
The DoButtonDown method is called when pressing an edit button. The IsDown parameter specifies
whether an edit button is pressed. If this parameter is equal to True, it is pressed, if False - it is
released. The Index parameter determines the index of an edit button.
See Also
TdxInplaceDropDownEdit.DoDropDownKeys; TdxInplaceDropDownEdit.DropDown
DoButtonUp method
Description
The DoButtonUp method is called when a user releases an edit button. The Index parameter
determines the index of the edit button.
See Also
TdxInplaceDropDownEdit.DoDropDownKeys; TdxInplaceDropDownEdit.DropDown
DoCloseUp method
Generates the OnCloseUp event.
Description
The DoCloseUp method is called when closing a dropdown window. The Value parameter determines
the value selected within a dropdown window. The Accept parameter determines whether to display
this value within the editor. If the Accept parameter is set to True, this value is displayed.
See Also
TdxInplaceDropDownEdit.DoDropDownKeys; TdxInplaceDropDownEdit.DropDown
DoDropDownKeys method
Activates or deactivates a dropdown control when pressing a specific key.
Description
The DoDropDownKeys method is used internally by editors to manage dropdown state. It closes or
opens a control based upon the pressed key specified by the Key and Shift parameters.
See Also
TdxInplaceDropDownEdit.CloseUp; TdxInplaceDropDownEdit.DropDown
DropDown method
Description
Provides an interface method to activate the dropdown window associated with an editor.
Descendants can override this method to activate a dropdown window as their specific needs dictate.
See Also
TdxInplaceDropDownEdit.CloseUp; TdxInplaceDropDownEdit.DoDropDownKeys
FindListValue method
Description
This method is used internally. It locates the dropdown list value that corresponds to the edited value
before activating a dropdown window. The Value parameter determines the value to locate.
PopupBorderStyle method
type
TdxPopupBorderStyle = pbSingle .. pbFlat;
function PopupBorderStyle: TdxPopupBorderStyle;
Description
Returns the border style of an editor dropdown window. Possible values include:
Values Description
pbFlat Dropdown window has a flat border style.
pbSingle A single line is drawn around a dropdown window.
See Also
TdxInplaceDropDownEdit.PopupBorder
TdxInplaceDropDownEdit Events
TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
OnCloseUp event
Occurs when the dropdown window associated with an editor is closed.
type
TdxDropDownEditCloseUp = procedure(Sender: TObject; var Value: string;
var Accept: Boolean) of object;
property OnCloseUp: TdxDropDownEditCloseUp;
Description
Write an OnCloseUp event handler to perform specific actions when closing a dropdown window. The
Value parameter determines the value selected within a dropdown window. The Accept parameter
determines whether to display this value within the editor. If the Accept parameter is set to True, this
value is displayed.
See Also
TdxInplaceDropDownEdit.DoCloseUp
OnEditButtonClick event
Occurs when a user presses an editor button.
Description
Write an OnEditButtonClick event handler to perform specific actions when a user presses an edit
button within an editor.
TdxInplaceDateEdit
TdxInplaceDateEdit is a button editor with a dropdown calendar control.
Unit
dxExEdtr
TdxInplaceDateEdit = class(TdxInplaceDropDownEdit);
Description
TdxInplaceDateEdit descends from TdxInplaceDropDownEdit. It includes a dropdown calendar
control and additional methods and properties to enhance the feature set of the control. A user can
set dates within this editor via the dropdown calendar or enter dates manually.
TdxInplaceDateEdit also support smart date input. It supports: 'Today', 'Yesterday', 'Tomorrow',
'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'First', 'Second', 'Third',
'Fourth', 'Final', 'Bom', 'Eom', 'Now'. It even supports '+/-' operations, allowing you to enter dates as
follows: "today + 15".
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
See Also
TdxInplaceDropDownEdit
TdxInplaceDateEdit Properties
TdxInplaceDateEdit
Date protected / read / write DateValidation protected / read / write
DateButtons protected / read / write SaveTime protected / read / write
DateOnError protected / read / write UseEditMask protected / read / write
Description
Use the Date property to set or return date.
See Also
TdxInplaceDateEdit.DateChange
type
TDateButton = (btnToday, btnClear);
TDateButtons = set of TDateButton;
property DateButtons: TDateButtons;
Description
Use the DateButtons property to hide or display buttons within a calendar window. Possible values
include:
Values Description
btnToday Sets the current date and closes the calendar.
btnClear Clears the displayed date value and closes the calendar.
See Also
TdxInplaceDateEdit.DateChange
type
TDateOnError = (deToday, deNull);
property DateOnError: TDateOnError;
Description
Use the DateOnError property to set the date assigned to the date edit in case of invalid date input.
Possible values include:
Values Description
deToday The current date is set.
deNull A NULL date is set.
See Also
TdxInplaceDateEdit.DoValidateInput; TdxInplaceDateEdit.DateChange
Description
If the DateValidation property is set to True, the date is validated during entry. Otherwise. It is not.
See Also
TdxInplaceDateEdit.DoValidateInput
Description
Date can be entered into a date editor together with time values. If this property is set to True, the
time value must be explicitly modified when another date is selected within the Calendar.
Description
If the UseEditMask property is set to True, a predefined mask is displayed when entering date
manually. This mask is defined by Windows Regional Settings.
TdxInplaceDateEdit Methods
TdxInplaceDateEdit
DateChange protected DoValidateInput protected
DateChange method
Description
DateChange is used internally. It is called every time a user changes date values within a date editor.
See Also
TdxInplaceDateEdit.OnDateChange
DoValidateInput method
DoValidateInput is an interface method which is called when validating date input.
Description
DoValidateInput is called each time the DateValidation property is set to True and a user enters a date
into the editor. The ADate parameter specifies the date entered. The AText parameter specifies the
text being edited within the editor. If the AError parameter is True, TdxInplaceDateEdit raises an
exception. The AMessage parameter specifies the text that appears in the exception dialog box.
Descendants can override this method to generate the OnDateValidateInput event.
See Also
TdxInplaceDateEdit.DateValidation; TdxInplaceDateEdit.DoValidatiInput;
TdxInplaceDateEdit.OnDateValidateInput
TdxInplaceDateEdit Events
TdxInplaceDateEdit
OnDateChange protected OnDateValidateInput protected
OnDateChange event
Occurs when changing the date within a date editor.
Description
Write an OnDateChange event handler to perform specific actions when changing the date.
See Also
TdxInplaceDateEdit.DateChange
OnDateValidateInput event
Occurs when validating date input within a date editor.
type
TdxDateValidateInput = procedure(Sender: TObject; const AText: string;
var ADate: TDateTime; var AMessage: string; var AError: Boolean) of object;
property OnDateValidateInput: TdxDateValidateInput;
Description
Write an OnDateValidateInput event handler to perform specific actions when validating date input.
See Also
TdxInplaceDateEdit.DoValidateInput
TdxInplaceButtonEdit
Unit
dxExEdtr
TdxInplaceButtonEdit = class(TdxInplaceDropDownEdit);
Description
The TdxInplaceButtonEdit is an editor that can contain one or more embedded buttons that can be
used to execute custom actions.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
See Also
TdxInplaceDropDownEdit
TdxInplaceButtonEdit Properties
TdxInplaceButtonEdit
Buttons protected / read / write ViewStyle protected / read / write
ClickKey protected / read / write
Description
Editors that support button controls can contain several buttons. At design-time, use the items of this
collection property to add, delete, and control the appearance of each button embedded within the
control.
Description
Use the ClickKey property to allow a user to type a key combination instead of clicking the edit button
whose Default property is set to True. When setting shortcuts at design time, the Object Inspector
provides a large list of key combinations to select from.
type
TdxButtonEditViewStyle = (vsStandard, vsHideCursor, vsButtonOnly);
property ViewStyle: TdxButtonEditViewStyle;
Description
Use this property to determine the manner in which an editor is displayed. Possible values include:
TdxInplaceButtonEdit Methods
TdxInplaceButtonEdit
DefaultButtonClick protected
DefaultButtonClick method
Determines the index of the default button.
Description
Call the DefaultButtonClick method to determine the index of the button whose Default property value
is equal to True. The search is performed only among visible buttons.
TdxInplaceButtonEdit Events
TdxInplaceButtonEdit
OnButtonClick protected
OnButtonClick event
Occurs when clicking an edit button within an editor.
type
TdxEditButtonClickEvent = procedure (Sender: TObject; AbsoluteIndex:
Integer) of object;
property OnButtonClick: TdxEditButtonClickEvent;
Description
Write an OnButtonClick event handler to perform specific actions when clicking an editor button. The
AbsolutIndex parameter determines the index of the pressed button. This index is zero-based.
TdxCheckEditStyleController
The TdxCheckEditStyleController allows users to unify the appearance of all linked check editors within a
form.
Unit
dxExEdtr
TdxCheckEditStyleController = class(TdxEditStyleController)
Description
The TdxCheckEditStyleController is a non-visual component. Use the TdxCheckStyleController to
change identical properties of all linked check editors simultaneously. For instance, you can use this
component to maintain a unified style for all check editors.
Hierarchy
TObject
TPersistent
TComponent
TdxStyleController
TdxEditStyleController
TdxCheckEditStyleController Properties
BorderStyle published / read / write
ButtonStyle published / read / write
type
TdxEditBorderStyle = (xbsNone, xbsSingle, xbsThick, xbsFlat, xbs3D);
property BorderStyle;
Description
Use the BorderStyle property to read or set the border style for all linked check editors. Available
values include:
Value Description
xbsNone No visible border.
xbsSingle Single-line border.
xbsThick Single-line border with a thick line.
xbsFlat Flat border with a light 3D effect.
xbs3D Standard border with a 3D effect.
See Also
TdxEditStyleController.BorderStyle
type
TdxEditButtonViewStyle = (btsDefault, bts3D, btsFlat, btsSimple,
btsHotFlat);
property ButtonStyle;
Description
Use the ButtonStyle property to read or set the button style for all linked in-place editors. Available values
include:
Value Description
See Also
TdxEditStyleController.ButtonStyle
TdxInplaceCheckEdit
TdxInplaceCheckEdit is a check box editor.
Unit
dxExEdtr
TdxInplaceCheckEdit = class(TdxInplaceEdit);
Description
TdxInplaceCheckEdit descends from TdxInplaceEdit. It includes a check box and a caption region.
Users can edit data within an editor by checking or unchecking the check box. The caption region
contains the description of the check box.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceCheckEdit Properties
TdxInplaceCheckEdit
AllowGrayed protected / read / write GlyphCount protected / read / write
Checked protected / read / write MultiLine protected / read / write
FullFocusRect protected / read / write NullStyle protected / read / write
Glyph protected / read / write State protected / read / write
Description
Determines whether a check editor has two (checked, unchecked) or three (checked, unchecked and
grayed) states.
See Also
TdxInplaceCheckEdit.State
Description
Use the Checked property to modfy the state of an editor.
See Also
TdxInplaceCheckEdit.State
Description
If the FullFocusRect property is False , a focus rectangle is only drawn around caption text. If the
FullFocusRect property is True, a focus rectangle is drawn around the entire caption region,
regardless of actual caption text size.
Description
Use the Glyph property to specify a custom image for a check box. This bitmap can be used for
different states of an editor based upon the GlyphCount property value.
See Also
TdxInplaceCheckEdit.GlyphCount
Description
Use the GlyphCount property to determine the manner in which an image is used in place of a
standard check box to display checked states.
Values include:
Values Description
0 A glyph is not used. The standard check box is displayed.
1 A full size image is displayed instead of the standard check box.
2 The image is divided into two parts: one part indicates the checked state; the other part
indicates the unchecked state of the check editor.
3 The glyph is divided into three parts. Each part determines the state of the check editor
(grayed, checked, unchecked). Only one part can be dispayed at a time.
6 The glyph is divided into six parts. Each part determines the state of the check editor
(grayed, checked, unchecked) when the check button is pressed and released. Only one
part can be dispayed at a time.
See Also
TdxInplaceCheckEdit.Glyph
Description
If the MultiLine property is set to True, caption text can be displayed across multiple lines.
type
TdxShowNullFieldStyle = (nsUnchecked, nsInactive, nsGrayedChecked);
property NullStyle: TdxShowNullFieldStyle;
Description
Use the NullStyle property to specify the manner in which a check editor is displayed when its value or
the value of the appropriate field is not specified.
Values include:
Values Description
nsUnchecked The check box is drawn unchecked.
nsInactive The check box is drawn as inactive.
nsGrayedChecked The check box is grayed and checked.
type
TdxCheckBoxState = (cbsUnchecked, cbsChecked, cbsGrayed);
property State: TdxCheckBoxState;
Description
Use the State property to set or return the necessary state for a check editor. There are two ways to
change the state of a control: to click the control or to change the State property programmatically.
Values include:
Values Description
cbsUnchecked The check box has no check mark, indicating that a user has not selected it.
cbsChecked The check box has a check mark in it, indicating that a user has selected it.
See Also
TdxInplaceCheckEdit.AllowGrayed; TdxInplaceCheckEdit.Checked; TdxInplaceCheckEdit.Toggle
TdxInplaceCheckEdit Methods
TdxInplaceCheckEdit
InvalidateCheckRect protected Toggle protected
InvalidateCheckRect method
Repaints the check editor region.
procedure InvalidateCheckRect;
Description
The InvalidateCheckRect method is used internaly to refresh the rectangle area of a check editor.
Toggle method
Provides an interface which toggles check box state.
Description
Toggle is a virtual protected method that provides an interface to toggle check box state. This method
is used internally and TdxInplaceCheckEdit descendants can override it to provide an appropriate
switch mechanism.
See Also
TdxInplaceCheckEdit.State
TdxInplaceCheckEdit Events
Derived from TdxInplaceEdit
OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected
TdxInplaceImageEdit
TdxInplaceImageEdit is a button editor with a dropdown control which can include both an image and
a description for a specific value.
Unit
dxExEdtr
TdxInplaceImageEdit = class(TdxInplaceDropDownEdit);
Description
TdxInplaceImageEdit descends from TdxInplaceDropDownEdit. A user can edit data within this editor
by selecting an appropriate value from the dropdown image list.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
See Also
TdxInplaceDropDownEdit
TdxInplaceImageEdit Properties
TdxInplaceImageEdit
DefaultImages protected / read / write LargeImages protected / read / write
Descriptions protected / read / write MultiLineText protected / read / write
ImageIndexes protected / read / write ShowDescription protected / read / write
Images protected / read / write Values protected / read / write
Description
Use the DefaultImages property to specify whether to index items automatically or manually. If the
DefaultImages method returns True, the image indexes in the dropdown list are sequential and
generated automatically. By default, DefaultImages returns True. Descendants can override this
method to specify the manner in which items are indexed.
See Also
TdxInplaceImageEdit.ImageIndexes
Description
This property contains the list of descriptions associated with an image editor.
See Also
TdxInplaceImageEdit.ShowDescription
Description
This property contains the list of image indexes associated with an image editor.
Description
This property contains the list of images associated with an image editor.
Description
TdxInplaceImageEdit can display large images in a dropdown window. The LargeImages property
contains the TImageList object that stores large images.
See Also
TdxInplaceImageEdit.Images
Description
TdxInplaceImageEdit displays a dropdown window, which contains a list of items. Each item consists
of an image and text. If the MultiLineText property is set to True, the description can be displayed
across multiple text lines. By default, MultiLineText is False .
Description
If this property is set to True, then a description is not displayed within an editor, whereas it is present
within the dropdown image window.
See Also
TdxInplaceImageEdit.Description
Description
Contains the values associated with an image editor. The first element of Values corresponds to the
first item in the dropdown window; the second element corresponds to the second item, etc.
TdxInplaceImageEdit Methods
Derived from TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected
TdxInplaceImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxInplaceSpinEdit
TdxInplaceSpinEdit is an editor with spin buttons.
Unit
dxExEdtr
TdxInplaceSpinEdit = class(TdxInplaceMaskEdit);
Description
TdxInplaceSpinEdit descends from TdxInplaceMaskEdit. Users can edit data within this editor via spin
buttons or enter data manually.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit Properties
TdxInplaceSpinEdit
EditorEnabled protected / read / write MinValue protected / read / write
Increment protected / read / write UseCtrlIncrement protected / read / write
IntValue protected / read / write Value protected / read / write
MaxValue protected / read / write ValueType protected / read / write
Description
Use the EditorEnabled property to allow a user to modify data within a spin editor.
Description
Use the Increment property to control the granularity of changes made using the up-down spin
buttons. Set this property to indicate the number of units between the MinValue and MaxValue
properties.
See Also
TdxInplaceSpinEdit.GetIncrement; TdxInplaceSpinEdit.UseCtrlIncrement
Description
Use the IntValue to obtain the integer portion of the edited value.
See Also
TdxInplaceSpinEdit.SetValue; TdxInplaceSpinEdit.Value; TdxInplaceSpinEdit.ValueType
Description
If the MaxValue and MinValue properties are set to 0 or 0.0 simultaneously, a spin editor considers no
limits for maximum and minimum values. Otherwise, the maximum or minimum value that can be
entered is determined by the appropriate property.
See Also
TdxInplaceSpinEdit.MinValue; TdxInplaceSpinEdit.SetEditMaxValue; TdxInplaceSpinEdit.Value
Description
If the MaxValue and MinValue properties are set to 0 or 0.0 simultaneously, a spin editor considers no
limits for maximum and minimum values. Otherwise, the maximum or minimum value that can be
entered is determined by the appropriate property.
See Also
TdxInplaceSpinEdit.MaxValue; TdxInplaceSpinEdit.SetEditMinValue; TdxInplaceSpinEdit.Value
Description
If the UseCtrlIncrement property is set to True, then the Ctrl-Up/Ctrl-Down keys are used to modify an
editor’s value; Otherwise the Up/Down keys are used to increase/decrease the edited value.
See Also
TdxInplaceSpinEdit.GetIncrement; TdxInplaceSpinEdit.Increment
Description
Use the Value property to set or return the currently edited value.
See Also
TdxInplaceSpinEdit.GetValue; TdxInplaceSpinEdit.SetValue; TdxInplaceSpinEdit.ValueType
type
TdxValueType = (vtInt, vtFloat);
property ValueType: TdxValueType;
Description
Use the ValueType property to determine the type of edited value. Possible types include:
Values Description
vtInt The spin editor is used for integer values.
vtFloat The spin editor is used for float values.
The default value is vtInt.
See Also
TdxInplaceSpinEdit.DefaultValueType; TdxInplaceSpinEdit.Value;
TdxInplaceSpinEdit.SetEditValueType
TdxInplaceSpinEdit Methods
TdxInplaceSpinEdit
DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected
DefaultMaxValue method
Limits the maximum value of a spin editor.
Description
The DefaultMaxValue method returns the parameter, which limits the maximum value within a spin
editor.
See Also
TdxInplaceSpinEdit.DefaultMinValue; TdxInplaceSpinEdit.Ma xValue
DefaultMinValue method
Limits the minimum value of a spin editor.
Description
The DefaultMinValue method returns the parameter, which limits the minimum value within a spin
editor.
See Also
TdxInplaceSpinEdit.DefaultMaxValue; TdxInplaceSpinEdit.MinValue
DefaultValueType method
Determines the default spin editor value type.
type
TdxValueType = (vtInt, vtFloat);
function DefaultValueType: TdxValueType; virtual;
Description
This method sets the spin editor value type. Possible types include:
Values Description
vtInt (Default) A spin editor is used for integer values.
vtFloat A spin editor is used for float values.
See Also
TdxInplaceSpinEdit.SetEditValueType; TdxInplaceSpinEdit.ValueType
GetIncrement method
Provides an interface, which returns the increment value.
Description
GetIncrement is a virtual protected method. It provides an interface, which returns the increment value
stored in the Increment property. TdxInplaceSpinEdit descendants can override this method to
provide additional side effects.
See Also
TdxInplaceSpinEdit.Increment
GetValue method
Description
Returns the data edited within a spin editor according to the ValueType property.
See Also
TdxInplaceSpinEdit.SetValue; TdxInplaceSpinEdit.Value; TdxInplaceSpinEdit.ValueType
IsValidChar method
Indicates whether the newly entered char is valid.
Description
IsValidChar is a virtual method. It is used internally to indicate whether the entered char specified by
the Key parameter is valid.
SetEditMaxValue method
Description
Sets a new maximum value for the MaxValue property. The Value parameter specifi es new data.
See Also
TdxInplaceSpinEdit.MaxValue; TdxInplaceSpinEdit.DefaultMaxValue
SetEditMinValue method
Description
Sets a new minimum value for the MinValue property. The Value parameter specifies new data.
See Also
TdxInplaceSpinEdit.MinValue; TdxInplaceSpinEdit.DefaultMinValue
SetEditValueType method
type
TdxValueType = (vtInt, vtFloat);
procedure SetEditValueType(Value: TdxValueType); virtual;
Description
Sets a new type for the ValueType property. Possible types include:
Values Description
vtInt (Default) A spin editor is used for integer values.
vtFloat A spin editor is used for float values.
See Also
TdxInplaceSpinEdit.DefaultValueType; TdxInplaceSpinEdit.ValueType
SetValue method
Description
Sets a new value for a spin edior based upon the maximum and minimum values. The Value
parameter specifies new data.
See Also
TdxInplaceSpinEdit.DefaultMaxValue; TdxInplaceSpinEdit.DefaultMinValue; TdxInplaceSpinEdit.Value
TdxInplaceSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxInplacePickEdit
TdxInplacePickEdit is a button editor with an associated dropdown list box control.
Unit
dxExEdtr
TdxInplacePickEdit = class(TdxInplaceDropDownEdit);
Description
TdxInplacePickEdit descends from TdxInplaceDropDownEdit. It includes a dropdown list box control
with a given set of possible values. Users can edit data within this editor by selecting a specific value
from the dropdown list or enter it manually.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
See Also
TdxInplaceDropDownEdit
TdxInplacePickEdit Properties
TdxInplacePickEdit
CanDeleteText protected / read / write Items protected / read / write
DropDownListStyle protected / read / write Revertable protected / read / write
ItemIndex protected / read / write Sorted protected / read / write
Description
This property is used when the DropDownListStyle property is set to True. If the CanDeleteText
property is set to False , users cannot delete the selected value from the editor. If the CanDeleteText
property is set to True, users can delete the selected value while the item remains in the dropdown
list.
Description
If the DropDownListStyle property is set to True, a pick editor does not allow data editing. Users can
only select a value from the dropdown list. If False , users can select a value from the dropdown list or
edit data directly within the editor.
Description
Use the ItemIndex property to obtain the index of the currently selected item. This index is zero-
based. If this property is set to -1, then none of the list items are selected.
See Also
TdxInplacePickEdit.Items
Description
Use the Items property to add, insert, delete and move items.
See Also
TdxInplacePickEdit.ItemIndex
Description
Set the Revertable property to True to allow a user to cycle through list values by double-clicking an
appropriate mouse button within a pick editor. When the Revertable property is True, list values are
displayed within the editor in their stored order. The display process is cyclical. When the last item in
the list is displayed, a double-click displays the first item in the list.
Description
If the Sorted property is set to True, all values are sorted within a pick list.
TdxInplacePickEdit Methods
Derived from TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected
TdxInplacePickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxInplaceCalcEdit
TdxInplaceCalcEdit is a button editor with an associated calculator control.
Unit
dxExEdtr
TdxInplaceCalcEdit = class(TdxInplaceDropDownEdit);
Description
TdxInplaceCalcEdit descends from TdxInplaceDropDownEdit. It includes a dropdown calculator
control and provides additional methods necessary to ensure consistency between it and the editor
itself. A user can edit data within this editor by calculating the required value via the dropdown
calculator or enter data directly into the edit region.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceCalcEdit Properties
TdxInplaceCalcEdit
BeepOnError protected / read / write QuickClose protected / read / write
ButtonStyle protected / read / write ShowButtonFrame protected / read / write
Precision protected / read / write
Description
The BeepOnError property value is used internally to determine whether a calculator beeps if an error
occurs.
type
TdxButtonStyle = (bsStandard, bsFlat, bsExtraFlat);
property ButtonStyle: TdxButtonStyle;
Description
Use the ButtonStyle property to determine the manner in which calculator buttons are displayed.
Possible styles include:
Values Description
bsStandard Calculator buttons are drawn with a double line border.
bsFlat Calculator buttons are drawn with a single line border.
bsExtraFlat Calculator buttons are drawn without a border.
Description
Determines the total number of digits within a calculator editor. By default precision is 13.
Description
If the QuickClose property is set to True, the dropdown calculator closes when a user presses the '='
keyboard button. By default, the QuickClose property is set to False and pressing the ‘=’ key does not
close it. In any instance, clicking the '=' button of the dropdown calculator DOES NOT close it.
Description
Determines whether an oval frame is drawn around each calculator button. By default,
ShowButtonFrame is False .
TdxInplaceCalcEdit Methods
Derived from TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected
TdxInplaceCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxInplaceHyperLinkEdit
TdxInplaceHyperLinkEdit is an editor that presents its contents as a hyperlink.
Unit
dxExEdtr
TdxInplaceHyperLinkEdit = class(TdxInplaceTextEdit);
Description
TdxInplaceHyperLinkEdit is used to edit, display and activate Internet hyperlinks.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceHyperLinkEdit Properties
TdxInplaceHyperLinkEdit
LinkColor protected / read / write StartKey protected / read / write
SingleClick protected / read / write
Description
Use the LinkColor property to modify the color of a hyperlink. By default, this property is set to clBlue.
Description
If the SingleClick property is set to True, a hyperlink is activated by a single click. If the SingleClick
property is set to False , it is activated by a double click.
Description
Use the StartKey property to define the shortcut used to activate a hyperlink. Pressing this shortcut
performs the same action as clicking a hyperlink within the editor.
TdxInplaceHyperLinkEdit Methods
TdxInplaceHyperLinkEdit
DoStart prote cted
DoStart method
Activates a hyperlink.
Description
If the text within a hyperlink editor is not empty and represents a valid address, this method activates a
hyperlink.
TdxInplaceHyperLinkEdit Events
TdxInplaceHyperLinkEdit
OnStartClick protected
OnStartClick event
Occurs when activating an edited hyperlink.
Description
Write an OnStartClick event handler to perform specific actions when launching a hyperlink.
TdxInplaceTimeEdit
TdxInplaceTimeEdit is an editor with spin buttons.
Unit
dxExEdtr
TdxInplaceTimeEdit = class(TdxInplaceSpinEdit);
Description
TdxInplaceTimeEdit directly descends from TdxInplaceSpinEdit. It is used to edit time values via the
keyboard or spin buttons.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TdxInplaceTimeEdit Properties
TdxInplaceTimeEdit
Time protected / read / write TimeEditFormat protected / read / write
Description
Use the Time property to set or return the time within a time editor.
type
Description
Use the TimeEditFormat property to specify the manner in which time is represented within an editor.
Possible values include:
Values Description
tfHourMinSec Hours, minutes and seconds are displayed within the time editor.
tfHourMin Hours and minutes are displayed within the time editor.
tfHour Hours are displayed within the time editor.
TdxInplaceTimeEdit Methods
Derived from TdxInplaceSpinEdit
DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected
TdxInplaceTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxInplaceCurrencyEdit
TdxInplaceCurrencyEdit allows you to modify currency data within the editor.
Unit
dxExEdtr
TdxInplaceCurrencyEdit = class(TdxInplaceMaskEdit);
Description
TdxInplaceCurrencyEdit displays data using a currency format.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceCurrencyEdit Properties
TdxInplaceCurrencyEdit
DecimalPlaces protected / read / write MinValue protected / read / write
DisplayFormat protected / read / write Value protected / read / write
MaxValue protected / read / write
Description
Specifies the number of digits used for decimal places when a currency editor processes data. The
number of decimal places is dispayed only when the currency editor has focus; Otherwise only two
digits after the decimal point are displayed.
Description
Use the DisplayFormat property to define the format in which a currency value is displayed within a
currency editor. This format is applied when the editor loses its focus.
See Also
TdxInplaceCurrencyEdit.DefaultDisplayFormat
Description
Use the MaxValue property to set the upper limit of a currency value within the editor. If this property
is set to 0, then the upper limit is not specified.
See Also
TdxInplaceCurrencyEdit.MinValue; TdxInplaceCurrencyEdit.Value;
TdxInplaceCurrencyEdit.DefaultMaxValue
Description
Use the MinValue property to set the lower limit of a currency value within the editor. If this property
is set to 0, then the lower limit is not specified.
See Also
TdxInplaceCurrencyEdit.Value; TdxInplaceCurrencyEdit.DefaultMinValue;
TdxInplaceCurrencyEdit.MaxValue
Description
Use this property to set or return the value of a currency editor. This property contains the entered
value without any display formatting.
See Also
TdxInplaceCurrencyEdit.MaxValue; TdxInplaceCurrencyEdit.MinValue
TdxInplaceCurrencyEdit Methods
TdxInplaceCurrencyEdit
DefaultDisplayFormat public DefaultMinValue public
DefaultMaxValue public IsValidChar protected
DefaultDisplayFormat method
Returns the format used to display currency data in a currency editor.
Description
Call this method to obtain the default display fomat. This format is obtained from the DataDefinition if
this editor is data-aware or from system variables (CurrencyDecimals, CurrencyString,
CurrencyFormat).
See Also
TdxInplaceCurrencyEdit.DisplayFormat
DefaultMaxValue method
Returns the maximum value of a currency editor.
Description
When using a data-aware currency editor, the DefaultMaxValue method returns the parameter that
limits the maximum value in the floating-point field associated with a currency editor; Otherwise returns
0.
See Also
TdxInplaceCurrencyEdit.Value; TdxInplaceCurrencyEdit.DefaultMinValue;
TdxInplaceCurrencyEdit.MaxValue
DefaultMinValue method
Returns the minimum value of a currency editor.
Description
When using a data-aware currency editor, the DefaultMinValue method returns the parameter that
limits the minimum value in the floating-point field associated with a currency editor; Otherwise returns
0.
See Also
TdxInplaceCurrencyEdit.DefaultMaxValue; TdxInplaceCurrencyEdit.MinValue;
TdxInplaceCurrencyEdit.Value
IsValidChar method
Indicates whether a given character is valid for currency data entry.
Description
This method returns True, if the Key parameter, which represents a key processed by the editor, is a
valid character; Otherwise the IsValidChar method returns False . Valid characters for currency data
include '- ', '+', '0'…'9', 'e', 'E', and DecimalSeparators.
TdxInplaceCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxPopupToolBarWindow
Use the TdxPopupToolBarWindow object settings to change the behavior of an image toolbar window.
Unit
dxExEdtr
TdxPopupToolBarWindow = class(TPersistent);
Description
Cut, copy, paste, delete, load, save and custom buttons may be displayed within a toolbar window.
Use the OnCustomClick event of the TdxInplaceGraphicEdit to perform specific actions when pressing
the custom button. To make a toolbar invisible, set its Visible property to False.
Hierarchy
TObject
TPersistent
TdxPopupToolBarWindow Properties
Alignment published IsPopupMenu published
Buttons published ShowCaptions published
CustomButtonCaption published Visible published
CustomButtonGlyph published
type
TdxPopupToolBarAlignment = (ptaLeft, ptaRight, ptaTop, ptaBottom);
property Alignment: TdxPopupToolBarAlignment;
Description
Use the Alignment property to set the popup position of an image toolbar. Possible settings include:
Values Description
ptaLeft An image toolbar window appears at the left edge of an image editor.
ptaRight An image toolbar window appears at the right edge of an image editor.
ptaTop An image toolbar window appears at the top of an image editor.
ptaBottom An image toolbar window appears at the bottom of an image editor.
type
TdxPopupToolBarButton = (ptbCut, ptbCopy, ptbPaste, ptbDelete, ptbLoad,
ptbSave, ptbCustom);
TdxPopupToolBarButtons = set of TdxPopupToolBarButton;
property Buttons: TdxPopupToolBarButtons;
Description
Use the Buttons property to make a specific button visible/invisible in an image toolbar. The following
buttons are available.
Values Description
PtbCut When pressed, an image is cut to the Clipboard.
PtbCopy When pressed, an image is copied to the Clipboard.
PtbPaste When pressed, an image is pasted from the Clipboard.
See Also
TdxPopupToolBarWindow.CustomButtonCaption; TdxPopupToolBarWindow.CustomButtonGlyph;
TdxPopupToolBarWindow.ShowCaptions
Description
Set the ShowCaptions property to False to hide the captions of image toolbar buttons.
See Also
TdxPopupToolBarWindow.Buttons
Description
A user can add his/her own custom button to an image toolbar. The CustomButtonCaption property
contains the caption of this button.
See Also
TdxPopupToolBarWindow.Buttons; TdxPopupToolBarWindow.CustomButtonGlyph
Description
A user can add his/her own custom button to an image toolbar. Use the CustomButtonGlyph property
to specify the glyph for this button.
See Also
TdxPopupToolBarWindow.Buttons; TdxPopupToolBarWindow.CustomButtonCaption
Description
Set the IsPopupMenu property to False to display the image toolbar window as a popup toolbar.
Description
Set the Visible property to False to prevent an image toolbar window from being displayed.
TdxInplaceGraphicEdit
TdxInplaceGraphicEdit is an editor that works with images.
Unit
dxExEdtr
TdxInplaceGraphicEdit = class(TdxInplaceEdit);
Description
TdxInplaceGraphicEdit provides properties and methods to work with different image types (*.jpg,
*.jpeg, *.bmp, *.ico, *.emf, *.wmf).
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceGraphicEdit Properties
TdxInplaceGraphicEdit
AutoSize protected / read / write Picture protected / read / write
Center protected / read / write QuickDraw protected / read / write
ClipboardFormat protected / read / write Stretch protected / read / write
CustomFilter protected / read / write ToolbarLayout protected / read / write
CustomGraphic protected / read / write ToolbarPos protected / read / write
DblClickActivate protected / read / write ToolbarPosStored protected / read / write
GraphicTransparency protected / read / write
property AutoSize;
Description
Set the AutoSize property to True before loading a picture to automatically resize a component. If the
AutoSize property is False and picture width or height is larger than the width or height of the graphic
editor box, the picture may be cropped to fit editor box size.
Value Description
True A box can be automatically resized to fully display a picture.
False Only the user can change box size.
Description
If the Center property is True, a picture is centered; Otherwise it is aligned at the top-left corner of a
graphic editor box.
Description
By default, this property sets the format to CF_PICTURE.
Description
Used to define filters for the Load File Dialog window to display specific files in the Files list box. Enter
wildcards and extensions to define your filter. For instance, if this property is set to the “*.BMP” filter,
only files with a .BMP extension are displayed. This property can be specified as Bitmaps|*.bmp and
does not give a reference to the Filter property of the TOpenPictureDialog or the TOpenDialog.
See Also
TdxInplaceGraphicEdit.LoadFromFile
Description
Set the CustomGraphic property to True, if an editor is used to display non-bitmap images, i.e. JPEG,
GIF, ICON, etc. If the CustomGraphic property is False (default value), images are considered as a
TBitmap.
Description
If the DblClickActivate property value is set to True, a double-click event within the editor activates the
associated popup menu (or toolbar). If the DblClickActivate property value is set to False, the
associated popup menu (or toolbar) is activated when the editor receives focus.
type
TdxGraphicEditTransparency = (gtDefault, gtOpaque, gtTransparent);
property GraphicTransparency: TdxGraphicEditTransparency;
Description
Use the GraphicTransparency property to specify the manner in which an image is displayed within an
editor. Set the GraphicTransparency property to gtDefault (the default value) to use settings
appropriate to the graphic itself (transparent for metafiles, opaque for bitmaps). Set the property to
gtOpaque to make the background opaque. Set the property to gtTransparent to make the
background transparent.
Description
Set the Picture property to a TPicture object that contains the picture (icon, metafile, bitmap graphics,
or user-defined graphics) to be displayed within a graphic editor.
See Also
TdxInplaceGraphicEdit.ClearPicture; TdxInplaceGraphicEdit.AssignPicture
Description
Set QuickDraw to specify whether a custom palette should be used when displaying an image. If
False , the palette is used to provide the best possible image quality at the expense of additional
processing time. If True, no special palette is used, which provides faster processing, but results in
poorer picture quality.
Description
When loading an image into a graphic editor, set the Stretch property to True to automatically resize it
to fit within the graphic editor. (Stretch does not impact the image size of icon (.ICO) files.)
Description
The ToolbarLayout property provides access to the TdxPopupToolBarWindow class used to describe
the popup toolbar window that provides shortcuts for menu commands. This toolbar contains Copy,
Cut, Paste, Load and other functions used when working with an image within a graphic editor.
See Also
TdxInplaceGraphicEdit.ToolbarPos; TdxInplaceGraphicEdit.ToolbarPosStored
Description
Use the ToolbarPos property to determine the location of a toolbar window relative to the top-left
corner in pixels.
See Also
TdxInplaceGraphicEdit.ToolbarLayout; TdxInplaceGraphicEdit.ToolbarPosStored
Description
If the ToolbarPosStored property is set to True, the position of a toolbar window is stored. When the
toolbar window is activated, it is displayed at the same position.
See Also
TdxInplaceGraphicEdit.ToolbarLayout; TdxInplaceGraphicEdit.ToolbarPos
TdxInplaceGraphicEdit Methods
TdxInplaceGraphicEdit
AssignPicture protected GetGraphicClass protected
ClearPicture public LoadFromFile public
CopyToClipboard public PasteFromClipboard public
CustomClick protected SaveToFile public
CutToClipboard public
AssignPicture method
Generates the OnAssignPicture event.
Description
Use the AssignPicture method to generate the OnAssignPicture event. Descendants can override it to
perform specific actions.
See Also
TdxInplaceGraphicEdit.OnAssignPicture
ClearPicture method
Clears the picture associated with a graphic editor.
Description
This method is used to clear the image within a graphic editor.
See Also
TdxInplaceGraphicEdit.Picture
CopyToClipboard method
Copies the picture selected within an editor to the Clipboard.
procedure CopyToClipboard;
Description
Use the CopyToClipboard method to replace Clipboard contents with the selected picture. The
CopyToClipboard method does not clear the Clipboard if a picture is not selected.
See Also
TdxInplaceGraphicEdit.PasteFromClipboard; TdxInplaceGraphicEdit.CutToClipboard;
TdxInplaceGraphicEdit.ClipboardFormat
CustomClick method
Provides an interface, which is called when clicking the Custom button.
Description
The CustomClick method calls the OnCustomClick event handler when clicking the Custom button.
Descendants can override this method to generate the OnCustomClick event for the Custom button.
See Also
TdxInplaceGraphicEdit.OnCustomClick
CutToClipboard method
Cuts the selected picture to the Clipboard.
procedure CutToClipboard;
Description
Use the CutToClipboard method to replace Clipboard contents with the selected picture and to delete
the selected picture from a graphic editor. The CutToClipboard method does not clear the Clipboard if
a picture is not selected.
See Also
TdxInplaceGraphicEdit.CopyToClipboard; TdxInplaceGraphicEdit.PasteFromClipboard;
TdxInplaceGraphicEdit.ClipboardFormat
GetGraphicClass method
Determines the image class drawn within a graphic editor.
type
TGraphicClass = class of TGraphic;
function GetGraphicClass: TGraphicClass; virtual;
Description
The GetGraphicClass function returns the image class drawn within a graphic editor. It is called when
the editor draws an image. If GetGraphicClass returns nil, the image is considered a bitmap.
See Also
TdxInplaceGraphicEdit.OnGetGraphicClass
By default, GetGraphicClass returns nil. Descendants override this method to obtain a desired value.
LoadFromFile method
Loads a picture into a graphic editor using the Open dialog.
procedure LoadFromFile;
Description
Use this method to activate the File Open dialog and to select a picture to load into a graphic editor.
See Also
TdxInplaceGraphicEdit.SaveToFile
PasteFromClipboard method
Loads a picture into a graphic editor from the Clipboard.
procedure PasteFromClipboard;
Description
Use this method to load a picture into a graphic editor from the Clipboard.
See Also
TdxInplaceGraphicEdit.CopyToClipboard; TdxInplaceGraphicEdit.CutToClipBoard
SaveToFile method
Saves a picture from a graphic editor to a file via the Save As dialog.
procedure SaveToFile;
Description
Use this method to save a picture from a graphic editor to the file specified by the Save As dialog.
See Also
TdxInplaceGraphicEdit.LoadFromFile
TdxInplaceGraphicEdit Events
TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick protected
OnAssignPicture event
Occurs when assigning a picture to a graphic editor.
type
TdxGraphicEditAssignPictureEvent = procedure(Sender: TObject; var Picture:
TPicture) of object;
property OnAssignPicture: TdxGraphicEditAssignPictureEvent;
Description
Write an OnAssignPicture event handler to perform specific actions when assigning a picture,
specified by the Picture parameter, to a graphic editor.
See Also
TdxInplaceGraphicEdit.AssignPicture
OnCustomClick event
Occurs when clicking the Custom button within a popup toolbar window.
Description
A user can add his\her own button to the popup toolbar via the CustomButtonCaption and
CustomButtonGlyph properties of the TdxPopupToolBarWindow object. Write an OnCustomClick
event handler to perform specific actions when clicking the Custom button.
See Also
TdxInplaceGraphicEdit.CustomClick
OnGetGraphicClass event
Occurs when accessing graphic class.
type
TGraphicClass = class of TGraphic;
Description
Write an OnGetGraphicClass event handler to perform specific actions when accessing graphic class.
See Also
TdxInplaceGraphicEdit.GetGraphicClass
TdxInplaceBlobEdit
TdxInplaceBlobEdit is a button editor with the ability to display and edit BLOB data.
Unit
dxExEdtr
TdxInplaceBlobEdit = class(TdxInplaceDropDownEdit);
Description
TdxInplaceBlobEdit is a TdxInplaceDropDownEdit descendant. It includes additional methods to work
with BLOB data. Using a BLOB editor, you can view and edit Memo BLOBs and view Picture BLOBs.
Additionally, it can automatically determine OLE BLOB type.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
See Also
TdxInplaceDateEdit; TdxInplaceCalcEdit; TdxInplaceImageEdit; TdxInplacePickEdit;
TdxInplaceMemoEdit
TdxInplaceBlobEdit Properties
TdxInplaceBlobEdit
AlwaysSaveText protected / read / write MemoWordWrap protected / read / write
BlobEditKind protected / read / write PictureAutoSize protected / read / write
BlobPaintStyle protected / read / write PictureClipboardFormat protected / read / write
BlobText protected / read / write PictureGraphicClass prote cted / read / write
MemoCharCase protected / read / write PictureFilter protected / read / write
MemoHideScrollBars protected / read / write PictureTransparency protected / read / write
MemoMaxLength protected / read / write PopupWidth protected / read / write
MemoOEMConvert protected / read / write PopupHeght protected / read / write
MemoScrollBars protected / read / write ShowExPopupItems protected / read / write
MemoSelectionBar protected / read / write ShowPicturePopup protected / read / write
MemoWantReturns protected / read / write SizeablePopup protected / read / write
MemoWantTabs protected / read / write Text protected / read / write
Description
Set the AlwaysSaveText property to True to save the entered text when a dropdown window is closed.
See Also
TdxInplaceBlobEdit.Text
type
TdxBlobEditKind = (bekMemo, bekPict, bekOle, bekBlob);
property BlobEditKind: TdxBlobEditKind;
Description
Use the BlobEditKind property to specify BLOB type:
Value Description
bekMemo Represents memo data.
bekPict Represents an image.
bekOle Represents an OLE object.
bekBlob Represents BLOB data.
type
TdxBlobPaintStyle = (bpsDefault, bpsIcon, bpsText);
property BlobPaintStyle: TdxBlobPaintStyle;
Description
Use the BlobPaintStyle property to specify the manner in which BLOB data is displayed within an
editor when a dropdown window is closed:
Value Description
bpsDefault Identification text in braces is used:
(GRAPHIC) - for an image
(MEMO) - for a memo
See Also
TdxInplaceBlobEdit.BlobText
Description
Use the BlobText property to determine the text string dispayed within a BLOB editor. This text is displayed
only when the BlobPaintStyle property is set to bpsText.
See Also
TdxInplaceBlobEdit.BlobPaintStyle; TdxInplaceBlobEdit.Text
type
TEditCharCase = (ecNormal, ecUpperCase, ecLowerCase);
property MemoCharCase: TEditCharCase;
Description
MemoCharCase is a protected property and TdxInplaceTextEdit descendants may publish it to allow
setting of property values at design time. You can use this property to alter the contents of a BLOB
editor. Possible MemoCharCase values include:
Value Description
ecLowerCase Text is converted to lowercase.
ecNormal Text is unaltered.
ecUpperCase Text is converted to UPPERCASE.
See Also
TdxInplaceTextEdit.CharCase
Description
If the MemoHideScrollBars property is set to True, scroll bars are hidden when not in use. This property is
only in effect when the MemoScrollBars property is not set to ssNone.
See Also
TdxInplaceBlobEdit.MemoScrollBars
Description
The MemoMaxLength property determines the maximum length of text edited in a BLOB editor. If the
MemoMaxLength property is 0, there is no limit to the maximum length of memo text in characters.
See Also
TdxInplaceTextEdit.MaxLength
Description
MemoOEMConvert is a protected property and TdxInplaceBlobEdit descendants may publish it to
allow setting of property values at design time. To make certain that all characters typed into an in-
place editor can be converted to the OEM character set, set this property to True. This converts all
characters from ANSI to OEM and then back to ANSI. Set the MemoOEMConvert property to False to
avoid excessive processing when mapping to the OEM format is not necessary. This property is most
useful for editors used to enter file names when an application does not use Unicode file names.
See Also
TdxInplaceTextEdit.OEMConvert
type
TScrollStyle = (ssNone, ssHorizontal, ssVertical, ssBoth);
property MemoScrollBars: TScrollStyle;
Description
Use this property to specify the scroll bars for a dropdown window when it displays memo text.
Value Description
ssNone There are no scroll bars within a dropdown window.
ssHorizontal A horizontal scroll bar is displayed.
ssVertical A vertical scroll bar is displayed.
ssBoth Both the vertical and horizontal scroll bars are displayed.
See Also
TdxInplaceBlobEdit.MemoHideScrollBars
Description
This property is used when a BLOB editor is used as a memo editor. Selection bar is a region at the
leftmost edge of a dropdown window in a BLOB editor. It allows a user to select the entire contents of
individual text lines using a mouse. Set the MemoSelectionBar property to True to display it or False
to hide it. When the selection bar is hidden, a user can select text lines on a character-by -character
basis only.
See Also
TdxInplaceMemoEdit.SelectionBar
Description
Determines whether a BLOB editor dropdown window accepts the RETURN character when pressing the
Enter key on the keyboard.
See Also
TdxInplaceBlobEdit.MemoWantTabs; TdxInplaceMemoEdit.WantReturns
Description
Determines whether a BLOB editor dropdown window accepts the TAB character when pressing the tab key
on the keyboard.
See Also
TdxInplaceBlobEdit.MemoWantReturns; TdxInplaceMemoEdit.WantTabs
Description
Set the MemoWordWrap property to True to wrap words within a dropdown window. This property is
only in effect when the horizontal scroll bar is not displayed.
See Also
TdxInplaceMemoEdit.WordWrap
Description
If the PictureAutoSize property is True, the size of a dropdown window changes to display the entire
picture.
Description
Possible values include:
Value Description
CF_BITMAP Windows bitmap graphic.
CF_METAFILEPICT Windows metafile graphic.
CF_PICTURE A TPicture type object.
See Also
TdxInplaceGraphicEdit.ClipboardFormat
type
TGraphicClass = class (TGraphic);
property PictureGraphicClass: TGraphicClass;
Description
This property contains image type: a bitmap, an icon, etc. If the PictureGraphicClass property is nil
(the default value), the image is considered to be a bitmap.
See Also
TdxInplaceBlobEdit.GetGraphicClass; TdxInplaceBlobEdit.OnGetGraphicClass
Description
Used to define file filters for the Load File Dialog window. Enter wildcards and extensions to define
your filter. For instance, if this property is set to “*.BMP”, only files with a .BMP extension are
displayed.
See Also
TdxInplaceGraphicEdit.CustomFilter
type
TdxGraphicEditTransparency = (gtDefault, gtOpaque, gtTransparent);
property PictureTransparency: TdxGraphicEditTransparency;
Description
Possible values include:
Value Description
gtDefault Default value.
gtOpaque A picture is not transparent.
gtTransparent A picture is transparent.
See Also
TdxInplaceGraphicEdit.GraphicTransparency
Description
Use this property to specify the width of a dropdown window in pixels.
See Also
TdxInplaceBlobEdit.PopupHeight; TdxInplaceBlobEdit.SizeablePopup
Description
Use this property to specify the height of a dropdown window in pixels.
See Also
TdxInplaceBlobEdit.PopupWidth; TdxInplaceBlobEdit.SizeablePopup
Description
If BLOB data is displayed as an image, a BLOB editor can include a popup menu to modify its
contents. The ShowExPopupItems property determines whether the popup menu includes the Save
to file and Load from file extended menu items. If ShowExPopupItems is True, the extended items are
displayed.
Description
Determines whether a popup menu is activated when pressing the right mouse button within a
dropdown window. This popup menu contains Copy and Paste functions to provide easy editing of
BLOB objects.
Description
If this property is set to True, users can change the size of a dropdown window wherein BLOB data is
displayed. When set to sizeable, a sizing grip is displayed at the bottom-right corner of the window.
See Also
TdxInplaceBlobEdit.PopupHeight; TdxInplaceBlobEdit.PopupWidth
Description
Use the Text property to read or set the text string displayed within a dropdown window. The Text value
determines the contents of a dropdown window only when the BlobEditKind property is set to bekMemo
(when the BLOB editor is used as a memo editor).
See Also
TdxInplaceMaskEdit.Text; TdxInplaceBlobEdit_BlobText
TdxInplaceBlobEdit Methods
TdxInplaceBlobEdit
AssignPicture protected SavePopupSize protected
GetGraphicClass protected SetBlobValue protected
IsSizeablePopup protected
AssignPicture method
Generates the OnAssignPicture event.
Description
TdxInplaceBlobEdit descendants can be used to modify any BLOB data, including images, within a BLOB
editor. The AssignPicture method is called when a user saves an edited image. The Picture parameter
specifies the saved image. Descendants can override it to perform specific actions when saving pictures.
See Also
TdxInplaceBlobEdit.OnAssignPicture
GetGraphicClass method
Returns the graphic class for an image and generates the OnGetGraphicClass event.
Description
The GetGraphicClass method returns the class of an image drawn in a graphic editor.
See Also
TdxInplaceBlobEdit.PictureGraphicClass; TdxInplaceBlobEdit.OnGetGraphicClass
IsSizeablePopup method
Provides the interface, which determines whether the dropdown window of a BLOB viewer/editor is sizeable.
Description
IsSizeablePopup is a virtual protected method. It provides the interface, which determines whether a specific
dropdown window is sizeable. This method always returns True for the TdxInplaceBlobEdit class.
TdxInplaceBlobEdit descendants can override this method to provide a proper return value.
See Also
TdxInplaceBlobEdit.SavePopupSize
SavePopupSize method
Provides the interface, which saves the size of the dropdown window of a BLOB viewer/editor.
Description
SavePopupSize is a virtual protected method. It provides the interface, which saves the size of a specific
dropdown window. The W and H parameters determine the current Width and Height of a dropdown
window. TdxInplaceBlobEdit descendants override this method to provide proper window saving
mechanisms.
See Also
TdxInplaceBlobEdit.IsSizeablePopup
SetBlobValue method
Sets the data value for a new BLOB.
Description
Used to set the data value for a new BLOB after the popup control has been closed. This method is in
effect only for Memo and Picture BLOBs.
TdxInplaceBlobEdit Events
TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected
OnAssignPicture event
Occurs when assigning a picture to a BLOB editor.
type
TdxGraphicEditAssignPictureEvent = procedure(Sender: TObject; var
Picture: TPicture) of object;
property OnAssignPicture: TdxGraphicEditAssignPictureEvent;
Description
This event is generated each time a user pastes an image into a dropdown window. The Picture parameter
specifies the pasted image. Write an OnAssignPicture event handler to display specific formats (i.e. JPEG
or GIF) in a dropdown BLOB window.
See Also
TdxInplaceBlobEdit.AssignPicture
OnGetGraphicClass event
Occurs when accessing the graphic class of an image.
type
TGraphicClass = class of TGraphic;
TdxGraphicEditGraphicClassEvent = procedure(Sender: TObject; var
GraphicClass: TGraphicClass) of object;
property OnGetGraphicClass: TdxGraphicEditGraphicClassEvent;
Description
The OnGetGraphicsClass event is generated when a picture is drawn. The GraphicClass parameter
determines the graphic class of an image. Write an OnGetGraphicClass event handler to display different
image types, if necessary.
See Also
TdxInplaceBlobEdit.GetGraphicClass; TdxInplaceBlobEdit.PictureGraphicClass
TdxInplaceMRUEdit
TdxInplaceMRUEdit is a button type editor with the ability to view and edit a list of most recently used
items (MRU).
Unit
dxExEdtr
TdxInplaceMRUEdit = class(TdxInplacePickEdit);
Description
The TdxInplaceMRUEdit class maintains a list of most recently used items. This list is maintained
automatically and additional coding is not necessary. The TdxInplaceMRUEdit class is a
TdxInplacePickEdit descendant and can be used as a pick editor to select a value from a list of most
recently used items.
TdxInplaceMRUEdit is an editor with a button control. It can include one or two clickable buttons.
One of these buttons is always used to activate a dropdown list of items. The other button can be
used to perform specific actions.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TdxInplaceMRUEdit Properties
TdxInplaceMRUEdit
ImmediateDropDown protected / read / write ShowEllipsis protected / read / write
MaxItemCount protected / read / write
Description
If the ImmediateDropDown property is set to True, incremental search is activated and the dropdown
window of the recently used items is automatically displayed when a user begins entering data via the
keyboard.
If the ImmediateDropDown property is set to False , incremental search is activated without displaying the
dropdown window.
See Also
TdxInplaceDropDownEdit.ImmediateDropDown
Description
Use the MaxItemCount property to specify the maximum number of items stored in the dropdown list of a
MRU-editor. A new value is stored as a new item within the dropdown list when the editor loses focus. The
most recently used item is placed at the top of the list. When a new item is placed into the list, it shifts other
items down and becomes the first item.
If the number of stored items within a dropdown list is equal to the value of the MaxItemCount property, the
following operations are performed when a user enters a new value within an editor. The dropdown list hides
its lowest item, all other items are shifted down and the new item is placed at the top of the list. All these
changes are made when the editor loses focus.
If the value of the MaxItemCount property is 0, there is no limit to the number of list items. When the number
of list items becomes greater than the value of the DropDownRows property, a vertical scroll bar appears at
the right edge of the dropdown window.
See Also
TdxInplaceMRUEdit.AddItem
Description
Set the ShowEllipsis property to False, if you do not wish to use and display an additional button within the
editor. If this property is True, you can write an OnButtonClick event handler to perform specific actions
when pressing this button.
TdxInplaceMRUEdit Methods
In TdxInplaceMRUEdit
AddItem public ButtonClick protected
AddItem method
Adds a new item to the dropdown items list.
Description
Call the AddItem method to add a string specified by the Value parameter as a new item to the item
list. If the value specified by the Value parameter is already in the list, it is moved to the top of the list.
See Also
TdxInplaceMRUEdit.MaxItemCount
ButtonClick method
Generates the OnButtonClick event.
Description
The ButtonClick method is used to generate the OnButtonClick event. A user can write an event handler to
perform specific actions when clicking a button.
See Also
TdxInplaceMRUEdit.OnButtonClick
TdxInplaceMRUEdit Events
TdxInplaceMRUEdit
OnButtonClick protected
OnButtonClick event
Occurs when clicking a button within an editor.
Description
Write an OnButtonClick event handler to perform specific actions when clicking the additional (ellipsis)
button.
See Also
TdxINplaceMRUEdit.ButtonClick
TdxInplacePopupEdit
TdxInplacePopupEdit is a button type editor with a dropdown window, which can be used to embed
another control within it.
Unit
dxExEdtr
TdxInplacePopupEdit = class(TdxInplaceDropDownEdit);
Description
TdxInplacePopupEdit is a TdxInplaceDropDownEdit descendant and it inherits its basic methods and
properties. It includes a dropdown window used to host a specific control. At runtime, a user can
work with this control within the dropdown window of the TdxInplacePopupEdit class.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit Properties
TdxInplacePopupEdit
PopupForm public / read only PopupFormCaption protected / read / write
HideEditCursor protected / read / write PopupHeight protected / read / write
PopupAutoSize protected / read / write PopupMinHeight protected / read / write
PopupControl protected / read / write PopupMinWidth protected / read / write
PopupClientEdge protected / read / write PopupSizeable protected / read / write
PopupFlatBorder protected / read / write PopupWidth protected / read / write
PopupFormBorderStyle protected / read / write
Description
The HideEditCursor property specifies whether the value displayed within the edit region of an editor
can be modified. Set the HideEditCursor property to True to hide the edit cursor and to prevent
editing within the popup editor.
Description
The PopupAutoSize property specifies whether a dropdown window automatically changes its size
based upon the size of a control. If True, it is the same size as the control. Otherwise, its width and
height are determined by the PopupWidth and PopupHeight properties.
See Also
TdxPopupEditForm.Sizeable; TdxInplacePopupEdit.PopupSizeable
Description
Use the PopupControl property to specify the control (dropdown control), stored within the dropdown
window of a popup editor. A dropdown control can be any component registered in the IDE and
derived from TControl. This control must be initially invisible, since its position changes when the
dropdown window activates (the control ‘jumps’ from its previous location to the dropdown window).
Description
If the PopupClientEdge property is set to True, a dropdown window has a sunken border.
See Also
TdxInplacePopupEdit.PopupBorderStyle
Description
Set the PopupFlatBorder property to False to provide the 3-D style for a dropdown window's border.
See Also
TdxInplacePopupEdit.PopupBorderStyle
Description
The PopupForm property indicates the popup form, which contains the displayed control and drops
down when a user clicks the combo button within the popup editor.
See Also
TdxPopupEditForm
type
TdxPopupEditFormBorderStyle = (pbsDialog, pbsDialogHelp, pbsSimple,
pbsSysPanel);
property PopupFormBorderStyle: TdxPopupEditFormBorderStyle;
Description
Use this property to specify the border style for a dropdown window. The following values are
available:
Values Description
pbsDialog The Dropdown window has a standard border along with a “Close” button.
pbsDialogHelp The Dropdown window has a standard border along with a “Close” and a
“What’s This?” button.
pbsSimple The Dropdown window has a simple single-line border around the control.
pbsSysPanel The Dropdown window has a single-line border and a status bar at its bottom
with a “Close” button and a sizing grip.
ExpressEditors&DBEditors by Developer Express
214 TdxInplacePopupEdit Properties
This property only impacts dropdown window style. The default value is pbsDialog.
See Also
TdxInplacePopupEdit.PopupFlatBorder; TdxInplacePopupEdit.PopupFormCaption
Description
Use the PopupFormCaption property to determine a dropdown window's caption.
Note: The caption is displayed only when the border style of a dropdown window is equal to pbsDialog or
pbsDialogHelp.
See Also
TdxInplacePopupEdit.PopupBorderStyle
Description
Use the PopupHeight property to determine the height of a popup editor dropdown window. The
PopupHeight property has an integer value, which specifies its height in pixels. This property is not in
effect when the PopupAutoSize property is set to True and it cannot be less than the PopupMinHeight
property.
See Also
TdxInplacePopupEdit.PopupMinHeight; TdxInplacePopupEdit.PopupWidth
Description
Use the PopupMinHeight property to determine the minimum height of a popup editor dropdown
window.
See Also
TdxInplacePopupEdit.PopupHeight; TdxInplacePopupEdit.PopupMinWidth
Description
Use the PopupMinWidth property to specify the minimum width of a popup editor dropdown window.
See Also
TdxInplacePopupEdit.PopupMinHeight; TdxInplacePopupEdit.PopupHeight
Description
Set the PopupSizeable property to False to prevent sizing of a dropdown window at runtime. If the
PopupSizeable property is set to True, a user can change the size of a dropdown window. The
default value is True.
See Also
TdxPopupEditForm.Sizeable
Description
Use the PopupWidth property to determine the width of a popup editor dropdown window. The
PopupWidth property has an integer value, which specifies its width in pixels. This property is not in
effect when the PopupAutoSize property is set to True and it cannot be less than the PopupMinWidth
property. The default value is 250.
See Also
TdxInplacePopupEdit.PopupHeight; TdxInplacePopupEdit.PopupMinWidth
TdxInplacePopupEdit Methods
TdxInplacePopupEdit
CalcSize protected InitializePopup protected
CalcSize method
Calculates the size of a dropdown window.
Description
The CalcSize method is used to calculate the size of a dropdown window. The APopupForm
parameter specifies the popup form represented by the TdxPopupEditForm class.
InitializePopup method
Initializes a dropdown window.
Description
The InitializePopup method is used to initialize the dropdown window before its display. The
InitializePopup method sets the default values for the popup edit form specified by the APopupForm
parameter.
See Also
TdxInplacePopupEdit.OnInitPopup
TdxInplacePopupEdit Events
TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected
OnCloseQuery event
Occurs when a dropdown window is about to be closed.
type
TdxPopupEditCloseQueryEvent = procedure (Sender: TObject; var CanClose:
Boolean) of object;
property OnCloseQuery: TdxPopupEditCloseQueryEvent;
Description
Write an OnCloseQuery event handler to determine whether a dropdown window can be closed. Set
the CanClose parameter within the event handler to False to prevent the closing of the window. The
OnCloseQuery event is generated when pressing the Close button or Alt-F4. For instance, a user can
write an event handler to check whether the edited value is valid.
OnCloseUp event
Occurs immediately after a dropdown window has closed.
type
TdxPopupEditCloseUpEvent = procedure (Sender: TObject; var Text: string;
var Accept: Boolean) of object;
property OnCloseUp: TdxPopupEditCloseUpEvent;
Description
Write an OnCloseUp event handler to confirm or discard any changes made in a popup editor via a
dropdown window. The Text parameter specifies the text edited within the edit region of an editor.
Set the Accept parameter to True to confirm changes in the editor. If the Accept parameter is False,
all changes are canceled.
See Also
TdxPopupEditForm.ClosePopup
OnInitPopup event
Occurs when a dropdown window is about to be initialized.
Description
Write an OnInitPopup event handler to tune the settings of a dropdown window and to determine
which control will be displayed as a dropdown control. This feature allows using different dropdown
windows in different situations via a single popup editor.
See Also
TdxInplacePopupEdit.InitializePopup
OnPopup event
Occurs before displaying a dropdown window.
type
TdxPopupEditPopupEvent = procedure (Sender: TObject; const EditText:
string) of object;
property OnPopup: TdxPopupEditPopupEvent;
Description
Write an OnPopup event handler to initialize data in a dropdown control before activating the
dropdown form. The EditText parameter specifies the text displayed in the popup editor. For
instance, you can use this text to position the cursor at a specific record in a dropdown grid.
See Also
TdxInplacePopupEdit.OnInitPopup
TdxPopupEditForm
TdxPopupEditForm is used as a dropdown window for a popup and extended lookup editor.
Unit
dxExEdtr
TdxPopupEditForm = class(TCustomForm)
Description
Popup and extended lookup editors display a dropdown window to aid in the modification of data
values. They can display any control, including complex forms within the dropdown window. A control
is ‘wrapped’ by the TdxPopupEditForm class.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TScrollingWinControl
TCustomForm
TdxPopupEditForm Properties
ClientEdge public / read / write PopupMinWidth public / read / write
FlatBorder public / read / write Sizeable public / read / write
PopupFormBorderStyle public / read / write SizingCorner protected / read / write
PopupMinHeight public / read / write
Description
If the ClientEdge property is set to True, the popup form has a sunken border.
See Also
TdxPopupEditForm.PopupFormBorderStyle
Description
If the FlatBorder property is set to True, the border has a 2D look. Otherwise, it has a 3D look.
See Also
TdxPopupEditForm.PopupFormBorderStyle
type
TdxPopupEditFormBorderStyle = (pbsDialog, pbsDialogHelp, pbsSimple,
pbsSysPanel);
property PopupFormBorderStyle: TdxPopupEditFormBorderStyle;
Description
Use this property to specify the border style for a dropdown window. The following values are
available:
Values Description
PbsDialog The Dropdown window has a standard border along with a “Close” button.
PbsDialogHelp The Dropdown window has a standard border along with a “Close” and a
“What’s This?” button.
PbsSimple The Dropdown window has a simple single-line border around the control.
PbsSysPanel The Dropdown window has a single-line border and a status bar at its bottom
with a “Close” button and a sizing grip.
This property affects only dropdown window style. The default value is pbsDialog.
See Also
TdxPopupEditForm.PopupFormFlatBorder; TdxPopupEditForm.ClientEdge
Description
Use the PopupMinHeight property to determine the minimum height of the popup form from a popup
editor.
See Also
TdxPopupEditForm.PopupMinWidth
Description
Use the PopupMinWidth property to specify the minimum width of the dropdown window of a popup
editor.
See Also
TdxPopupEditForm.PopupMinHeight
Description
If the Sizeable property is set to True, a user can change the size of a form; Otherwise, form size is
fixed.
See Also
TdxPopupEditForm.SizingCorner
type
TdxCorner = (coTopLeft, coTopRight, coBottomLeft, coBottomRight);
property SizingCorner : TdxCorner;
Description
This property specifies the corner at which the sizing grip is drawn. Possible values include:
Values Description
coTopLeft The sizing grip is displayed at the top-left corner.
coTopRight The sizing grip is displayed at the top-right corner.
coBottomLeft The sizing grip is displayed at the bottom-left corner.
coBottomRight The sizing grip is displayed at the bottom-right corner.
Note: The sizing grip is displayed only when the border style is set to pbsSysPanel and the Sizeable
property is True.
See Also
TdxPopupEditForm.Sizeable
TdxPopupEditForm Methods
ClosePopup public / read / write
ShowPopup public / read / write
ClosePopup method
Closes a popup form.
Description
This method closes a dropdown window. The Accept parameter determines whether the popup form
can be closed. If a popup form contains a button with the mrOk or mrCancel modal result, the popup
form is automatically closed when the button is pressed. The Accept parameter passed to an
OnCloseUp event handler is determined by the modal result of the pressed button.
See Also
TdxPopupEditForm.ShowPopup
ShowPopup method
Displays a popup form on screen.
Description
This method displays a dropdown window on screen. Descendants can override it to activate the
dropdown window based upon their specific programming needs.
See Also
TdxPopupEditForm.ClosePopup
TdxInplaceLookupEdit
TdxInplaceLookupEdit is a button editor with a linked dropdown lookup list.
Unit
dxDBEdtr
TdxInplaceLookupEdit = class(TdxInplaceDropDownEdit);
Description
TdxInplaceLookupEdit descends from TdxInplaceDropDownEdit. It includes a dropdown lookup list
box and provides additional methods for managing the list box. This editor is used to create a lookup
list box from a lookup table. Users can edit data within this editor by selecting the required value from
the pick list or directly entering it into the editor.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
See Also
TdxInplaceDropDownEdit
TdxInplaceLookupEdit Properties
TdxInplaceLookupEdit
CanDeleteText protected / read / write ListSource protected / read / write
ClearKey protected / read / write LookupKeyValue protected / read / write
Field protected / read / write LookupMode protected / read only
KeyFieldName protected / read / write Revertable protected / read / write
ListFieldName protected / read / write
Description
This property is used when the DropDownListStyle property is set to True. If the CanDeleteText
property is set to False , a user cannot delete the selected value from the editor. If the CanDeleteText
property is set to True, users can delete the selected value without removing this item from the
dropdown list.
Description
The ClearKey property specifies the shortcut key combination that clears data values (sets to Null)
within an editor.
Description
Every data-aware editor is associated with a dataset field. The Field property specifies the field
associated with a lookup editor.
See Also
TdxInplaceLookupEdit.ListFieldNames
Description
Use the KeyFieldName property to set the name of the key field for TdxInplaceLookupEdit descendant
objects. The Key Field is used to navigate a data source.
Description
Use the ListFieldName property to specify the fields that appear in a dropdown list. Multiple field
names can appear in the dropdown list. To display multiple field names, you must separate each field
name with a semicolon.
See Also
TdxInplaceLookupEdit.Field
Description
Set this property value to the name of the data source you want to use as a list source for
TdxInplaceLookupEdit descendant objects.
Description
Use the LookupKeyValue property to set the default record displayed within an editor. This property
value specifies the key field value of the default record. The key field is specified by the
KeyFieldName property.
Description
Returns True if a TdxInplaceLookupEdit descendant object corresponds to a lookup field.
Description
Set the Revertable property to True to allow a user to cycle through list values by double-clicking the
appropriate mouse button within a pick editor. When the Revertable property is True, list values are
displayed within the editor in their stored order. The display process is circular. When the last item of
the list is displayed, a double click displays the first item in the list.
TdxInplaceLookupEdit Methods
TdxInplaceLookupEdit
ClearField protected IsEditable public
DoCloseUp protected SetKeyValue protected
DoIncremental protected
ClearField method
Clears data values (sets to Null).
Description
The ClearField method is used to clear the contents of the dataset field associated with a lookup
editor. This method is used internally.
See Also
TdxInplaceLookupEdit.Field
DoCloseUp method
Generates the OnCloseUp event handler when closing a dropdown window.
Description
TdxInplaceLookupEdit uses a dropdown list to modify data in the associated field. The DoCloseUp
method is called when closing a dropdown window with a lookup list. The Value parameter
determines an item selected in the dropdown list. The Accept parameter determines whether the
dropdown window can be closed. Set the Accept parameter within the DoCloseUp procedure to False
to prevent closing. By default, the DoCloseUp method generates the OnCloseUp event handler.
Descendants can override it to perform specific actions when closing a dropdown window.
DoIncremental method
Locates a specific record in a dataset.
Description
The DoIncremental method changes the current value within an editor to the next value within a
lookup dataset. The Distance parameter indicates the number of records to search through. If the
Circle parameter is True, searching resumes from the beginning. Said differently, the cursor moves
from the last record to the first.
IsEditable method
Specifies whether a user can edit values within an editor.
Description
Use the IsEditable method to specify whether an associated field can be edited. This method returns
True if the ReadOnly property is set to False and there is an assigned data field whose FieldKind
property is set to fkLookup.
SetKeyValue method
Sets a new value for data edited within a lookup editor.
Description
The SetKeyValue is a virtual protected method. A new value is specified by the AValue parameter.
TdxInplaceLookupEdit descendants can override this method to provide appropriate mechanisms to
set new data values, i.e. data-aware descendants can save AValue to a dataset field.
See Also
TdxInplaceDBTreeListLookupEdit.SetKeyValue
TdxInplaceLookupEdit Events
TdxInplaceLookupEdit
OnCloseUp protected
OnCloseUp event
Occurs when closing the dropdown window associated with a lookup editor.
type
TdxPickColumnCloseUp = procedure(Sender: TObject; var Value: Variant; var
Accept: Boolean) of object;
property OnCloseUp: TdxPickColumnCloseUp;
Description
Write an OnCloseUp event handler to perform specific actions when closing a dropdown window. The
Value parameter determines the value selected within the dropdown window. The Accept parameter
determines whether to display this value within the editor. If the Accept parameter is set to True, this
value is displayed.
TdxEditButton
Determines the properties and methods of an edit button placed within a button editor.
Unit
dxExEdtr
TdxEditButton = class(TCollectionItem);
Description
TdxEditButton is a collection item belonging to the TdxEditButtons collection. These items are used to
control the appearance and behavior of individual buttons within a TdxButtonEdit control.
Hierarchy
TObject
TPersistent
TCollectionItem
TdxEditButton Properties
Default published / read / write LeftAlignment published / read / write
Glyph published / read / write Visible published / read / write
Kind published / read / write Width published / read / write
Description
Set the Default property to True to specify a button as default. The default button is activated when a
user presses the key combination defined within the ClickKey property.
Description
Determines the glyph for an editor button. The glyph is drawn on the button if the Kind property is set
to bkGlyph.
type
TdxEditButtonKind = (bkEllipsis, bkDown, bkGlyph);
property Kind: TdxEditButtonKind;
Description
Use the Kind property to specify the appearance of a button’s glyph. Possible values include:
Values Description
bkEllipsis A button displays the standard “Ellipsis” glyph.
Description
Set the LeftAlignment property to True to align a button to the left edge of a button editor. If this
property is set to False , the button is displayed at the right edge of the button editor.
True
False
Description
Set the Visible property to False to hide a button. If this property is set to True, the button is displayed
within its editor.
Description
Use the Width property to set the width of an editor button in pixels. If the Width property is set to 0,
both the bkEllipsis and bkDown buttons have a standard width (width is equal to height). For
bkGlyth, the width of the button is determined by the width of the assigned glyph.
TdxEditButton Methods
Assign public
RestoreDefaults public
Assign method
Copies the contents of the source button to a new button.
Description
If the Source parameter is a TdxEditButton object, the Assign method copies the Default, Glyph, Kind,
LeftAlignment, Visible, and Width properties from the source button.
RestoreDefaults method
Restores the default values of a button.
Description
Call the RestoreDefaults method to set all properties of a specific button to default values.
TdxEditButtons
Represents a collection of edit buttons.
Unit
dxExEdtr
TdxEditButtons = class(TCollection);
Description
The TdxEditButtons class maintains a list of buttons represented by the TCollectionItem descendent
TdxEditButton - for an associated control. At design time, you can use the standard collection editor
provided by Delphi or C++ Builder to add, remove, and re-arrange individual TdxButtonEdit items.
Hierarchy
TObject
TPersistent
TCollection
TdxEditButtons Properties
Items public / read / write VisibleCount public / read only
Owner public / read only VisibleItems public / read / write
Description
The Items property is an array of edit buttons. You can access a specific button using the Index
parameter that determines the button's index in the Items array.
Description
Use the Owner property to locate the component to which a specific button belongs.
Description
Use the VisibleCount property to access the total number of visible buttons. The count includes only
those buttons whose visible property is set to true. The VisibleCount property is often used in
conjunction with the VisibleItems property to iterate through the list of visible buttons. Since the
VisibleItems indexed property is 0 based, the index of the last visible button is one less than the
number returned by the VisibleCount property.
Description
The VisibleItems are those buttons within a component whose visible property is set to true. The
index of the VisibleItems property is zero based and is often used in conjunction with the VisibleCount
property to iterate through the list of visible buttons.
TdxEditButtons Methods
DefaultMaxValue public DefaultValueType public
DefaultMinValue public GetIncrement public
Add method
Adds a new button to the button editor.
Description
Call the Add method to create a new instance of the TdxEditButton class. The new item is placed at
the end of the Items array.
GetAbsoluteIndex method
Returns the absolute index of a visible button.
Description
Call the GetAbsoluteIndex method to obtain the absolute index of a button in the Items array based
upon its visible index value.
GetVisibleIndex method
Returns the visible index of a button.
Description
Call the GetVisibleIndex method to obtain the visible index of a button in the VisibleItems array based
upon its absolute index value. If an edit button is invisible within a button editor, the GetVisibleIndex
method returns –1.
RestoreDefaults method
Restores the default values of all buttons within a specific collection.
procedure RestoreDefaults;
Description
Call the RestoreDefaults method to set all properties for all buttons within a button editor (visible and
invisible) to their default values.
TCustomdxEdit
TCustomdxEdit is the ancestor class of the TdxEdit control.
Unit
dxEdLib
TCustomdxEdit = class(TdxInplaceTextEdit);
Description
TCustomdxEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TCustomdxEdit Properties
Derived from TdxInplaceTextEdit
AutoSelect protected / read / write OEMConvert protected / read / write
CanPaste public / read only PasswordChar protected / read / write
CanRedo public / read only SelectionBar protected / read / write
CanUndo public / read only SelLength public / read / write
CharCase protected / read / write SelStart public / read / write
HideSelection protected / read / write SelText public / read / write
MaxLength protected / read / write Text public / read / write
TCustomdxEdit Methods
TCustomdxEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxEdit.
TCustomdxEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxEdit
TdxEdit is an improved version of the Windows single-line edit control.
Unit
dxEdLib
TdxEdit = class(TCustomdxEdit);
Description
TdxEdit controls can be used in applications to display and edit text. TdxEdit implements the generic
behavior introduced in the TCustomdxEdit class. TdxEdit publishes most properties inherited from the
TCustomdxEdit class, but does not introduce any new behaviors. For specialized edit controls, use
other descendant classes of the TCustomdxEdit class or derive from it.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TCustomdxEdit
TdxEdit Properties
Derived from TdxInplaceTextEdit
AutoSelect published / read / write OEMConvert published / read / write
CanPaste public / read only PasswordChar published / read / write
CanRedo public / read only SelectionBar protected / read / write
CanUndo public / read only SelLength public / read / write
CharCase published / read / write SelStart public / read / write
HideSelection published / read / write SelText public / read / write
MaxLength published / read / write Text published / read / write
TdxEdit Methods
Derived from TCustomdxEdit
IsInplace public
TdxEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxMaskEdit
TCustomdxMaskEdit is the ancestor of the TdxMaskEdit control.
Unit
dxEdLib
TCustomdxMaskEdit = class(TdxInplaceMaskEdit);
Description
TCustomdxMaskEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TCustomdxMaskEdit Properties
Derived from TdxInplaceMaskEdit
EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text public / read / write
TCustomdxMaskEdit Methods
TCustomdxMaskEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxMaskEdit.
TCustomdxMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxMaskEdit
TdxMaskEdit is an improved version of the standard edit box that allows the use of different masks for
data validation.
Unit
dxEdLib
TdxMaskEdit = class(TCustomdxMaskEdit);
Description
Use the TdxMaskEdit object to place a masked edit control onto your form. Masked edit controls
validate the text a user enters based upon a specific mask. This mask determines a valid format for
the entered text. The mask can also format the text displayed to the end user.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TCustomdxMaskEdit
TdxMaskEdit Properties
Derived from TdxInplaceMaskEdit
EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank published / read / write Text published / read / write
TdxMaskEdit Methods
Derived from TCustomdxMaskEdit
IsInplace public
TdxMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxMemo
TCustomdxMemo is the ancestor class of the TdxMemo control.
Unit
dxEdLib
TCustomdxMemo = class(TdxInplaceMemoEdit);
Description
TCustomdxMemo contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMemoEdit
TCustomdxMemo Properties
Derived from TdxInplaceMemoEdit
AutoSize protected / read / write SelectionBar protected / read / write
HideScrollBars protected / read / write WantReturns protected / read / write
Lines public / read / write WantTabs protected / read / write
ScrollBars protected / read / write WordWrap prote cted / read / write
TCustomdxMemo Methods
TCustomdxMemo
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxMemo.
TCustomdxMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxMemo
TdxMemo is an edit control that allows editing memo/text data.
Unit
dxEdLib
TdxMemo = class(TCustomdxMemo);
Description
Use TdxMemo to drop a multiline edit control onto a form. Multiline edit box allows a user to enter
more than one text line. Use it in your application to present large blocks of information to the end
user.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMemoEdit
TCustomdxMemo
TdxMemo Properties
Derived from TdxInplaceMemoEdit
AutoSize protected / read / write SelectionBar published / read / write
HideScrollBars published / read / write WantReturns published / read / write
Lines published / read / write WantTabs published / read / write
ScrollBars published / read / write WordWrap published / read / write
TdxMemo Methods
TCustomdxMemo
IsInplace public
TdxMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxDateEdit
TCustomdxDateEdit is the ancestor class of the TdxDateEdit control.
Unit
dxEdLib
TCustomdxDateEdit = class(TdxInplaceDateEdit);
Description
TCustomdxDateEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceDateEdit
TCustomdxDateEdit Properties
Derived from TdxInplaceDateEdit
Date protected / read / write DateValidation protected / read / write
DateButtons protected / read / write SaveTime protected / read / write
DateOnError protected / read / write UseEditMask protected / read / write
TCustomdxDateEdit Methods
TCustomdxDateEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an inplace editor.
Description
The IsInplace method always returns False for TCustomdxDateEdit
TCustomdxDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange protected OnDateValidateInput protected
TdxDateEdit
TdxDateEdit is an edit control with a dropdown calendar.
Unit
dxEdLib
TdxDateEdit = class(TCustomdxDateEdit);
Description
TdxDateEdit is a visual component specifically designed for the display and manipulation of date
information. TdxDateEdit includes a dropdown calendar from which users can select necessary dates.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceDateEdit
TCustomdxDateEdit
TdxDateEdit Properties
Derived from TdxInplaceDateEdit
Date published / read / write DateValidation published / read / write
DateButtons published / read / write SaveTime published / read / write
DateOnError published / read / write UseEditMask published / read / write
TdxDateEdit Methods
Derived from TCustomdxDateEdit
IsInplace public
TdxDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange published OnDateValidateInput published
TCustomdxButtonEdit
TCustomdxButtonEdit is the ancestor class of the TdxButtonEdit control.
Unit
dxEdLib
TCustomdxButtonEdit = class(TdxInplaceButtonEdit);
Description
TCustomdxButtonEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceButtonEdit
TCustomdxButtonEdit Properties
Derived from TdxInplaceButtonEdit
Buttons protected / read / write ViewStyle protected / read / write
ClickKey protected / read / write
TCustomdxButtonEdit Methods
TCustomdxButtonEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an inplace editor.
Description
The IsInplace method always returns False for TCustomdxButtonEdit.
TCustomdxButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick protected
TdxButtonEdit
TdxButtonEdit is a standard edit box with an embedded command button(s).
Unit
dxEdLib
TdxButtonEdit = class(TCustomdxButtonEdit);
Description
The button click action is exposed as an event so that a developer can respond in a manner
appropriate to his/her application.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceButtonEdit
TCustomdxButtonEdit
TdxButtonEdit Properties
Derived from TdxInplaceButtonEdit
Buttons published / read / write ViewStyle published / read / write
ClickKey published / read / write
TdxButtonEdit Methods
Derived from TCustomdxButtonEdit
IsInplace public
TdxButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick published
TCustomdxCheckEdit
TCustomdxCheckEdit is the ancestor class of the TdxCheckEdit control.
Unit
dxEdLib
TCustomdxCheckEdit = class(TdxInplaceCheckEdit);
Description
TCustomdxCheckEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceCheckEdit
TCustomdxCheckEdit Properties
Derived from TdxInplaceCheckEdit
AllowGrayed protected / read / write GlyphCount protected / read / write
Checked protected / read / write MultiLine protected / read / write
FullFocusRect protected / read / write NullStyle protected / read / write
Glyph protected / read / write State protected / read / write
TCustomdxCheckEdit Methods
TCustomdxCheckEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxCheckEdit.
TCustomdxCheckEdit Events
Derived from TdxInplaceEdit
OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected
TdxCheckEdit
TdxCheckEdit is a check box edit control.
Unit
dxEdLib
TdxCheckEdit = class(TCustomdxCheckEdit);
Description
The TdxCheckEdit component is an extended version of the standard check box control. A user can
check the box to select an option, or uncheck it to deselect an option.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceCheckEdit
TCustomdxCheckEdit
TdxCheckEdit Properties
Derived from TdxInplaceCheckEdit
AllowGrayed published / read / write GlyphCount published / read / write
Checked published / read / write MultiLine published / read / write
FullFocusRect published / read / write NullStyle published / read / write
Glyph published / read / write State published / read / write
TdxCheckEdit Methods
Derived from TCustomdxCheckEdit
IsInplace public
TdxCheckEdit Events
Derived from TdxInplaceEdit
OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published
TCustomdxImageEdit
TCustomdxImageEdit is the ancestor class of the TdxImageEdit control.
Unit
dxEdLib
TCustomdxImageEdit = class(TdxInplaceImageEdit);
Description
TCustomdxImageEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceImageEdit
TCustomdxImageEdit Properties
Derived from TdxInplaceImageEdit
DefaultImages protected / read / write LargeImages protected / read / write
Descriptions protected / read / write MultiLineText protected / read / write
ImageIndexes protected / read / write ShowDescription protected / read / write
Images protected / read / write Values protected / read / write
TCustomdxImageEdit Methods
TCustomdxImageEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxImageEdit.
TCustomdxImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxImageEdit
TdxImageEdit is a button editor with a dropdown control, which can include both an image and a
description for a specific value.
Unit
dxEdLib
TdxImageEdit = class(TCustomdxImageEdit);
Description
A user can edit data within this editor by selecting a value from the dropdown image pick list.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceImageEdit
TCustomdxImageE dit
TdxImageEdit Properties
Derived from TdxInplaceImageEdit
DefaultImages published / read / write LargeImages published / read / write
Descriptions published / read / write MultiLineText published / read / write
ImageIndexes published / read / write ShowDescription published / read / write
Images published / read / write Values published / read / write
TdxImageEdit Methods
Derived from TCustomdxImageEdit
IsInplace public
TdxImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TCustomdxSpinEdit
TCustomdxSpinEdit is the ancestor class of the TdxSpinEdit control.
Unit
dxEdLib
TCustomdxSpinEdit = class(TdxInplaceSpinEdit);
Description
TCustomdxSpinEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TCustomdxSpinEdit Properties
Derived from TdxInplaceSpinEdit
EditorEnabled protected / read / write MinValue protected / read / write
Increment protected / read / write UseCtrlIncrement protected / read / write
IntValue protected / read / write Value prote cted / read / write
MaxValue protected / read / write ValueType protected / read / write
TCustomdxSpinEdit Methods
TCustomdxSpinEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxSpinEdit.
TCustomdxSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxSpinEdit
TdxSpinEdit is an editor with spin buttons to increment or decrement numeric values.
Unit
dxEdLib
TdxSpinEdit = class(TCustomdxSpinEdit);
Description
TdxSpinEdit includes a spin button. Users can edit data within this editor by using the spin buttons or
by entering data manually.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TCustomdxSpinEdit
TdxSpinEdit Properties
Derived from TdxInplaceSpinEdit
EditorEnabled published / read / write MinValue published / read / write
Increment published / read / write UseCtrlIncrement protected / read / write
IntValue public / read / write Value published / read / write
MaxValue published / read / write ValueType published / read / write
TdxSpinEdit Methods
Derived from TCustomdxSpinEdit
IsInplace public
TdxSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxPickEdit
TCustomdxPickEdit is the ancestor class of the TdxPickEdit control.
Unit
dxEdLib
TCustomdxPickEdit = class(TdxInplacePickEdit);
Description
TCustomdxPickEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TCustomdxPickEdit Properties
Derived from TdxInplacePickEdit
CanDeleteText protected / read / write Items protected / read / write
DropDownListStyle protected / read / write Revertable protected / read / write
ItemIndex protected / read / write Sorted protected / read / write
TCustomdxPickEdit Methods
TCustomdxPickEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxPickEdit.
TCustomdxPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxPickEdit
TdxPickEdit is a button editor with an associated dropdown list box control, which contains a set of
predefined values.
Unit
dxEdLib
TdxPickEdit = class(TCustomdxPickEdit);
Description
TdxPickEdit allows users to select from a predefined list of values via a dropdown list. It incorporates
a dropdown window, which contains a given set of possible values. Users can edit data within this
editor by selecting a value from the pick list or by entering it manually.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TCustomdxPickEdit
TdxPickEdit Properties
Derived from TdxInplacePickEdit
CanDeleteText published / read / write Items published / read / write
DropDownListStyle published / read / write Revertable published / read / write
ItemIndex protected / read / write Sorted published / read / write
TdxPickEdit Methods
Derived from TCustomdxPickEdit
IsInplace public
TdxPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TCustomdxCalcEdit
TCustomdxCalcEdit is the ancestor class of the TdxCalcEdit control.
Unit
dxEdLib
TCustomdxCalcEdit = class(TdxInplaceCalcEdit);
Description
TCustomdxCalcEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceCalcEdit
TCustomdxCalcEdit Properties
Derived from TdxInplaceCalcEdit
BeepOnError protected / read / write QuickClose protected / read / write
ButtonStyle protected / read / write ShowButtonFrame protected / read / write
Precision protected / read / write
TCustomdxCalcEdit Methods
TCustomdxCalcEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxCalcEdit.
TCustomdxCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxCalcEdit
TdxCalcEdit is a button edit control with a dropdown calculator window.
Unit
dxEdLib
TdxCalcEdit = class(TCustomdxCalcEdit);
Description
TdxCalcEdit incorporates a dropdown calculator control. A user can edit data within this editor by
calculating the required value via the popup calculator or by entering data directly into the editor.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceCalcEdit
TCustomdxCalcEdit
TdxCalcEdit Properties
Derived from TdxInplaceCalcEdit
BeepOnError published / read / write QuickClose published / read / write
ButtonStyle published / read / write ShowButtonFrame published / read / write
Precision published / read / w rite
TdxCalcEdit Methods
Derived from TCustomdxCalcEdit
IsInplace public
TdxCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TCustomdxHyperLinkEdit
TCustomdxHyperLinkEdit is the ancestor class of the TdxHyperLinkEdit control.
Unit
dxEdLib
TCustomdxHyperLinkEdit = class(TdxInplaceHyperLinkEdit);
Description
TCustomdxHyperLinkEdit contains the basic methods and properties that are used to implement
standard behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceHyperLinkEdit
TCustomdxHyperLinkEdit Properties
TCustomdxHyperLinkEdit
ReadOnly protected / read / write
property ReadOnly;
Description
Set the ReadOnly property to False to prevent users from changing data within an editor. By default,
the ReadOnly property is set to True. This property is protected but descendants can publish it to
allow its modification at design time.
TCustomdxHyperLinkEdit Methods
TCustomdxHyperLinkEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxHyperLinkEdit.
TCustomdxHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick protected
TdxHyperLinkEdit
TdxHyperLinkEdit is a hyperlink (URL) editor, which can activate the default web-browser on a user's
system.
Unit
dxEdLib
TdxHyperLinkEdit = class(TCustomdxHyperLinkEdit);
Description
TdxHyperLinkEdit is an editor that presents its contents as hyperlinks. TdxHyperLinkEdit edits and
processes hyperlinks in its edit region.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceHyperLinkEdit
TCustomdxHyperLinkEdit
TdxHyperLinkEdit Properties
Derived from TCustomdxHyperLinkEdit
ReadOnly published / read / write
TdxHyperLinkEdit Methods
TCustomdxHyperLinkEdit
IsInplace public
TdxHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick published
TCustomdxTimeEdit
TCustomdxTimeEdit is the ancestor class of the TdxTimeEdit control.
Unit
dxEdLib
TCustomdxTimeEdit = class(TdxInplaceTimeEdit);
Description
TCustomdxTimeEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TdxInplaceTimeEdit
TCustomdxTimeEdit Properties
Derived from TdxInplaceTimeEdit
Time protected / read / write TimeEditFormat protected / read / write
TCustomdxTimeEdit Methods
TCustomdxTimeEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an inplace editor.
Description
The IsInplace method always returns False for TCustomdxTimeEdit.
TCustomdxTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxTimeEdit
TdxTimeEdit represents an editor to view and modify time values.
Unit
dxEdLib
TdxTimeEdit = class(TCustomdxTimeEdit);
Description
TdxTimeEdit is used to edit time values via the keyboard or spin buttons.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TdxInplaceTimeEdit
TCustomdxTimeEdit
TdxTimeEdit Properties
Derived from TdxInplaceTimeEdit
Time published / read / write TimeEditFormat published / read / write
TdxTimeEdit Methods
Derived from TCustomdxTimeEdit
IsInplace public
TdxTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxCurrencyEdit
TCustomdxCurrencyEdit is the ancestor class of the TdxCurrencyEdit control.
Unit
dxEdLib
TCustomdxCurrencyEdit = class(TdxInplaceCurrencyEdit);
Description
TCustomdxCurrencyEdit contains the basic methods and properties that are used to implement
standard behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceCurrencyEdit
TCustomdxCurrencyEdit Properties
Derived from TdxInplaceCurrencyEdit
DecimalPlaces protected / read / write MinValue protected / read / write
DisplayFormat protected / read / write Value protected / read / write
MaxValue protected / read / write
TCustomdxCurrencyEdit Methods
TCustomdxCurrencyEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxCurrencyEdit.
TCustomdxCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxCurrencyEdit
TdxCurrencyEdit displays and edits currency values based upon regional settings.
Unit
dxEdLib
TdxCurrencyEdit = class(TCustomdxCurrencyEdit);
Description
TdxCurrencyEdit displays data using a currency format. TdxCurrencyEdit allows you to modify
currency data within its edit region.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceCurrencyEdit
TCustomdxCurrencyEdit
TdxCurrencyEdit Properties
Derived from TdxInplaceCurrencyEdit
DecimalPlaces published / read / write MinValue published / read / write
DisplayFormat published / read / write Value published / read / write
MaxValue published / read / write
TdxCurrencyEdit Methods
Derived from TCustomdxCurrencyEdit
IsInplace public
TdxCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxGraphicEdit
TCustomdxGraphicEdit is the ancestor class of the TdxGraphicEdit control.
Unit
dxEdLib
TCustomdxGraphicEdit = class(TdxInplaceGraphicEdit);
Description
TCustomdxGraphicEdit contains the basic methods and properties that are used to implement
standard behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceGraphicEdit
TCustomdxGraphicEdit Properties
Derived from TdxInplaceGraphicEdit
AutoSize protected / read / write Picture protected / read / write
Center protected / read / write QuickDraw protected / read / write
ClipboardFormat protected / read / write Stretch protected / read / write
CustomFilter protected / read / write ToolbarLayout protected / read / write
CustomGraphic protected / read / write ToolbarPos protected / read / write
DblClickActivate protected / read / write ToolbarPosStored protected / read / write
GraphicTransparency protected / read / write
TCustomdxGraphicEdit Methods
TCustomdxGraphicEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxGraphicEdit.
TCustomdxGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick protected
TdxGraphicEdit
TdxGraphicEdit displays graphics within its edit region.
Unit
dxEdLib
TdxGraphicEdit = class(TCustomdxGraphicEdit);
Description
TdxGraphicEdit incorporates a popup menu (or a toolbar), which is used to provide shortcuts for
comman menu commands. This popup menu (toolbar) displays a Cut, Copy, Paste, Delete, Load,
Save, and Custom button.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceGraphicEdit
TCustomdxGraphicEdit
TdxGraphicEdit Properties
Derived from TdxInplaceGraphicEdit
AutoSize published / read / write Picture published / read / write
Center published / read / write QuickDraw published / read / write
ClipboardFormat public / read / write Stretch published / read / write
CustomFilter published / read / write ToolbarLayout published / read / write
CustomGraphic protected / read / write ToolbarPos public / read / write
DblClickActivate published / read / write ToolbarPosStored published / read / write
GraphicTransparency published / read / write
TdxGraphicEdit Methods
TCustomdxGraphicEdit
IsInplace public
TdxGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick published
TCustomdxBlobEdit
TCustomdxBlobEdit is the ancestor class of the TdxBlobEdit control.
Unit
dxEdLib
TCustomdxBlobEdit = class(TdxInplaceBlobEdit);
Description
TCustomdxBlobEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceBlobEdit
TCustomdxBlobEdit Properties
Derived from TdxInplaceBlobEdit
AlwaysSaveText protected / read / write MemoWordWrap protected / read / write
BlobEditKind protected / read / write PictureAutoSize protected / read / write
BlobPaintStyle protected / read / write PictureClipboardFormat protected / read / write
BlobText protected / read / write PictureGraphicClass protected / read / write
MemoCharCase protected / read / write PictureFilter protected / read / write
MemoHideScrollBars protected / read / write PictureTransparency protected / read / write
MemoMaxLength protected / read / write PopupWidth protected / read / write
MemoOEMConvert protected / read / write PopupHeght protected / read / write
MemoScrollBars protected / read / write ShowExPopupItems protected / read / write
MemoSelectionBar protected / read / write ShowPicturePopup protected / read / write
MemoWantReturns protected / read / write SizeablePopup protected / read / write
MemoWantTabs protected / read / write Text protected / read / write
TCustomdxBlobEdit Methods
TCustomdxBlobEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxBlobEdit.
TCustomdxBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected
TdxBlobEdit
TdxBlobEdit is a button type editor with the ability to display and edit BLOB data. The contents of
BLOBs are displayed within a sizeable dropdown window.
Unit
dxEdLib
TdxBlobEdit = class(TCustomdxBlobEdit);
Description
TdxBlobEdit inherits specific methods to manipulate BLOB data. It supports both the display and the
editing of a Memo BLOB and the display of a Picture BLOB. It can automatically determine OLE
BLOB data.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceBlobEdit
TCustomdxBlobEdit
TdxBlobEdit Properties
Derived from TdxInplaceBlobEdit
AlwaysSaveText published / read / write MemoWordWrap published / read / write
BlobEditKind published / read / write PictureAutoSize published / read / write
BlobPaintStyle published / read / write PictureClipboardFormat publi? / read / write
BlobText published / read / write PictureGraphicClass publi? / read / write
MemoCharCase published / read / write PictureFilter published / read / write
MemoHideScrollBars published / read / write PictureTransparency published / read / write
MemoMaxLength published / read / write PopupWidth published / read / write
MemoOEMConvert published / read / write PopupHeght published / read / write
MemoScrollBars published / read / write ShowExPopupItems published / read / write
MemoSelectionBar published / read / write ShowPicturePopup published / read / write
MemoWantReturns published / read / write SizeablePopup published / read / write
MemoWantTabs published / read / write Text publi? / read / write
TdxBlobEdit Methods
Derived from TCustomdxBlobEdit
IsInplace public
TdxBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected
TCustomdxMRUEdit
TCustomdxMRUEdit is the ancestor class of the TdxMRUEdit control.
Unit
dxEdLib
TCustomdxMRUEdit = class(TdxInplaceMRUEdit);
Description
TCustomdxMRUEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TdxInplaceMRUEdit
TCustomdxMRUEdit Properties
Derived from TdxInplaceMRUEdit
ImmediateDropDown protected / read / write ShowEllipsis protected / read / write
MaxItemCount protected / read / write
TCustomdxMRUEdit Methods
TCustomdxMRUEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxMRUEdit.
TCustomdxMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick protected
TdxMRUEdit
TdxMRUEdit is a button type editor with the ability to display and edit a list of the most recently used
(MRU) items.
Unit
dxEdLib
TdxMRUEdit = class(TCustomdxMRUEdit);
Description
TdxMRUEdit maintains a list of most recently used items. This list is automatically maintained by the
editor, so no additional coding is necessary. TdxMRUEdit can be used as a pick editor to select a
value from a list of most recently used items.
TdxMRUEdit is an editor with a button control. It can include one or two clickable buttons. One of
these buttons is always used to activate a dropdown list of items. The other button can be
programmed by a user to perform specific operations. If you wish to create a specific editor which
maintains a list of the most recently used items, you have to inherit a new editor from the
TCustomdxMRUEdit class, not from TdxMRUEdit.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TdxInplaceMRUEdit
TCustomdxMRUEdit
TdxMRUEdit Properties
Derived from TdxInplaceMRUEdit
ImmediateDropDown published / read / write ShowEllipsis published / read / write
MaxItemCount published / read / write
TdxMRUEdit Methods
Derived from TCustomdxMRUEdit
IsInplace public
TdxMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick published
TCustomdxPopupEdit
TCustomdxPopupEdit is the ancestor class of the TdxPopupEdit control.
Unit
dxEdLib
TCustomdxPopupEdit = class(TdxInplacePopupEdit);
Description
TCustomdxPopupEdit contains the basic methods and properties that are used to implement standard
behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit
TCustomdxPopupEdit Properties
Derived from TdxInplacePopupEdit
PopupForm public / read only PopupFormCaption protected / read / write
HideEditCursor protected / read / write PopupHeight protected / read / write
PopupAutoSize protected / read / write PopupMinHeight protected / read / write
PopupControl protected / read / write PopupMinWidth protected / read / write
PopupClientEdge protected / read / write PopupSizeable protected / read / write
PopupFlatBorder protected / read / write PopupWidth protected / read / write
PopupFormBorderStyle protected / read / write
TCustomdxPopupEdit Methods
TCustomdxPopupEdit
IsInplace public
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxPopupEdit.
TCustomdxPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected
TdxPopupEdit
TdxPopupEdit is a button type editor with a dropdown window which can display another control.
Unit
dxEdLib
TdxPopupEdit = class(TCustomdxPopupEdit);
Description
The TdxPopupEdit incorporates a dropdown window used to host a specific control. At runtime, a
user can work with this embedded control within the dropdown window of the TdxPopupEdit
component.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit
TCustomdxPopupEdit
TdxPopupEdit Properties
Derived from TdxInplacePopupEdit
PopupForm public / read only PopupFormCaption published / read / write
HideEditCursor published / read / write PopupHeight published / read / write
PopupAutoSize published / read / write PopupMinHeight published / read / write
PopupControl published / read / write PopupMinWidth published / read / write
PopupClientEdge published / read / write PopupSizeable published / read / write
PopupFlatBorder published / read / write PopupWidth published / read / write
PopupFormBorderStyle published / read / write
TdxPopupEdit Methods
Derived from TCustomdxPopupEdit
IsInplace public
TdxPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery published OnInitPopup published
OnCloseUp published OnPopup published
TCustomdxLookupEdit
TCustomdxLookupEdit is the class from which a TdxLookupEdit component is derived.
Unit
dxDBELib
TCustomdxLookupEdit = class(TCustomdxDBLookupEdit);
Description
TCustomdxLookupEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxLookupEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceLookupEdit
TCustomdxDBLookupEdit
TCustomdxLookupEdit Properties
Derived from TCustomdxDBLookupEdit
DataField protected / read / write
DataSource protected / read / write
TCustomdxLookupEdit Methods
Derived from TCustomdxDBLookupEdit
Create public
IsInplace public
TCustomdxLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp protected
TdxLookupEdit
TdxLookupEdit represents a control with a linked dropdown lookup list.
Unit
dxDBELib
TdxLookupEdit = class(TCustomdxLookupEdit);
Description
The TdxLookupEdit component is used to create an unbound lookup list box from a lookup table.
Unbound mode gives you the ability to edit field values using a dropdown list with field values from the
same data source. Users can edit data within this component by selecting the required value from the
lookup list or by entering it directly into the editor.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceLookupEdit
TCustomdxDBLookupEdit
TCustomdxLookupEdit
TdxLookupEdit Properties
Derived from TCustomdxDBLookupEdit
DataField protected / read / write
DataSource protected / read / write
TdxLookupEdit Methods
Derived from TCustomdxDBLookupEdit
Create public
IsInplace public
TdxLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp protected
TdxEditDataLink
TdxEditDataLink is a class used by data-aware editors to coordinate TDataSource and TDataSet
actions, and to respond to data events.
Unit
dxDBELib
TdxEditDataLink = class(TDataLink);
Description
Use the TdxEditDataLink and its descendants to leverage common functionality that is necessary for
the proper operation of data-aware controls. This class provides most of the necessary functionality to
implement a datasource property in the control that contains it and respond to data events.
The constructor of a data-aware object should call the TdxEditDataLink constructor and initialize any
relevant properties. The data-aware object can then link to TDataSource using the DataSource
property of TdxEditDataLink.
Hierarchy
TObject
TPersistent
TDataLink
TdxEditDataLink Properties
Field public / read / write
FieldName publisc / read / write
Description
Specifies the field component controlled by the TdxEditDataLink object.
Description
Use the FieldName property to set the FieldName property of a data-aware editor.
TdxEditDataLink Methods
Create public
Modified public
Reset public
Create method
Creates a TdxEditDataLink instance.
Description
The Create method is called from the constructor of any data-aware object that uses TdxEditDataLink
to implement its DataSource property.
Modified method
Determines whether data associated with an editor is modified.
procedure Modified;
Description
Sets the value of the private variable, which indicates a modification has taken place, to True.
Reset method
Ignores all pending changes and generates the OnDataChange event.
procedure Reset;
Description
An editor that owns the TdxEditDataLink object calls its Reset method to cancel edits to a field. The
Reset method calls the OnDataChange (or OnLayOutChange) event handler without writing any
pending changes to the underlying record in the dataset.
TdxEditDBDataDefinition
TdxEditDBDataDefinition is a class used by data-aware editors to implement a data source.
Unit
dxDBELib
TdxEditDBDataDefinition = class(TdxEditDataDefinition);
Description
Use the TdxEditDBDataDefinition to work with data associated with a data-aware editor. This class
provides access to the standard DataSet. If you wish to provide access to any other dataset, you
should not inherit a class from TdxEditDBDataDefinition but instead from the TdxEditDataDefinition
class.
Hierarchy
TObject
TPersistent
TdxEditDataDefinition
TCustomdxDBEdit
TCustomdxDBEdit is the class from which a TdxDBEdit control is derived.
Unit
dxDBELib
TCustomdxDBEdit = class(TCustomdxEdit);
Description
TCustomdxDBEdit contains the core properties and methods that are used to implement standard
behaviors inherited by TdxDBEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TCustomdxEdit
TCustomdxDBEdit Properties
TCustomdxDBEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains data. The
TDataSource component specified in the DataSource property provides access to the dataset that
contains this field.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access for the editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBEdit Methods
TCustomdxDBEdit
Create public
Create method
Creates a TCustomdxDBEdit instance.
Description
Call Create to create and initialize a TCustomdxDBEdit instance. Derived objects that override the
Create method must call the inherited Create method before performing any additional initialization.
TCustomdxDBEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxDBEdit
TdxDBEdit represents a single-line edit control that can display and edit fields in a dataset.
Unit
dxDBELib
TdxDBEdit = class(TCustomdxDBEdit);
Description
The TdxDBEdit component allows editing database fields that contain only a single text line. If a field
contains lengthy data, it is best to use the TdxDBMemo component.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TCustomdxEdit
TCustomdxDBEdit
TdxDBEdit Properties
Derived from TCustomdxDBEdit
DataField published / read / write DataSource published / read / write
TdxDBEdit Methods
Derived from TCustomdxDBEdit
Create public
TdxDBEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxDBMaskEdit
TCustomdxDBMaskEdit is the class from which a TdxDBMaskEdit control is derived.
Unit
dxDBELib
TCustomdxDBMaskEdit = class(TCustomdxMaskEdit);
Description
TCustomdxDBMaskEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBMaskEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TCustomdxMaskEdit
TCustomdxDBMaskEdit Properties
TCustomdxDBMaskEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset wherein
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access for the editor. You should set both the DataSource and DataField
properties to connect the editor to the appropriate field.
TCustomdxDBMaskEdit Methods
TCustomdxDBMaskEdit
Create public
Create method
Creates a TCustomdxDBMaskEdit instance.
Description
Call the Create method to create and initialize a TCustomdxDBMaskEdit instance. Derived objects
that override the Create method must call the inherited Create method before performing any
additional initialization.
TCustomdxDBMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxDBMaskEdit
TdxDBMaskEdit implements a generic masked edit control that can display and edit fields in a dataset.
Unit
dxDBELib
TdxDBMaskEdit = class(TCustomdxDBMaskEdit);
Description
Maked edit controls validate text entered by users and format them for display. TdxDBMaskEdit
implements the generic behavior introduced in TCustomdxDBMaskEdit and publishes most of the
properties and methods inherited from TCustomdxDBMaskEdit, but does not introduce any new
behavior.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TCustomdxMaskEdit
TCustomdxDBMaskEdit
TdxDBMaskEdit Properties
Derived from TCustomdxDBMaskEdit
DataField published / read / write DataSource published / read / write
TdxDBMaskEdit Methods
Derived from TCustomdxDBMaskEdit
Create public
TdxDBMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxDBMemo
TCustomdxDBMemo is the class from which a TdxDBMemo control is derived.
Unit
dxDBELib
TCustomdxDBMemo = class(TCustomdxMemo);
Description
TCustomdxDBMemo contains the basic properties and methods that are used to implement standard
behaviors inherited by TdxDBMemo.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMemoEdit
TCustomdxMemo
TCustomdxDBMemo Properties
TCustomdxDBMemo
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access for this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBMemo Methods
TCustomdxDBMemo
Create public
Create method
Creates a TCustomdxDBMemo instance.
Description
Call Create to create and initialize a TCustomdxDBMemo instance. Derived objects that override the
Create method must call the inherited Create method before performing any additional initialization.
TCustomdxDBMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxDBMemo
TdxDBMemo represents a multi-line edit control that can display and edit dataset fields.
Unit
dxDBELib
TdxDBMemo = class(TCustomdxDBMemo);
Description
Use the TdxDBMemo component to allow users to edit fields with lengthy textual data or to simply
display the contents of such fields with the help of the Text property.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMemoEdit
TCustomdxMemo
TCustomdxDBMemo
TdxDBMemo Properties
Derived from TCustomdxDBMemo
DataField published / read / write DataSource published / read / write
TdxDBMemo Methods
Derived from TCustomdxDBMemo
Create public
TdxDBMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxDBDateEdit
TCustomdxDBDateEdit is the class from which a TdxDBDateEdit control is derived.
Unit
dxDBELib
TCustomdxDBDateEdit = class(TCustomdxDateEdit);
Description
TCustomdxDBDateEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBDateEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceDateEdit
TCustomdxDateEdit
TCustomdxDBDateEdit Properties
TCustomdxDBDateEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access for this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBDateEdit Methods
TCustomdxDBDateEdit
Create public
Create method
Creates a TCustomdxDBDateEdit instance.
Description
Call Create to create and initialize a TCustomdxDBDateEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange protected OnDateValidateInput protected
TdxDBDateEdit
TdxDBDateEdit is a button editor with an associated dropdown calendar control used to display and
edit date information in a dataset.
Unit
dxDBELib
TdxDBDateEdit = class(TCustomdxDBDateEdit);
Description
A user can edit data within this editor by selecting the required date value from the dropdown calendar
or by entering it manually.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceDateEdit
TCustomdxDateEdit
TCustomdxDBDateEdit
TdxDBDateEdit Properties
Derived from TCustomdxDBDateEdit
DataField published / read / write DataSource published / read / write
TdxDBDateEdit Methods
TCustomdxDBDateEdit
Create public
TdxDBDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange published OnDateValidateInput published
TCustomdxDBButtonEdit
TCustomdxDBButtonEdit is the class from which the TdxDBButtonEdit component is derived.
Unit
dxDBELib
TCustomdxDBButtonEdit = class(TCustomdxButtonEdit);
Description
TCustomdxDBButtonEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBButtonEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceButtonEdit
TCustomdxButtonEdit
TCustomdxDBButtonEdit Properties
TCustomdxDBButtonEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBButtonEdit Methods
TCustomdxDBButtonEdit
Create public
Create method
Creates a TCustomdxDBButtonEdit instance.
Description
Call Create to create and initialize a TCustomdxDBButtonEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick protected
TdxDBButtonEdit
TdxDBButtonEdit is a single-line editor that can display and edit fields in the dataset with embedded
button controls.
Unit
dxDBELib
TdxDBButtonEdit = class(TCustomdxDBButtonEdit);
Description
Use the TdxDBButtonEdit component to edit an individual field in an underlying dataset. This
component can contain one or more clickable buttons that can be used to execute custom actions.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceButtonEdit
TCustomdxButtonEdit
TCustomdxDBButtonEdit
TdxDBButtonEdit Properties
TCustomdxDBButtonEdit
DataField published / read / write DataSource published / read / write
TdxDBButtonEdit Methods
Derived from TCustomdxDBButtonEdit
Create public
TdxDBButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick published
TCustomdxDBCheckEdit
TCustomdxDBCheckEdit is the class from which a TdxDBCheckEdit component is derived.
Unit
dxDBELib
TCustomdxDBCheckEdit = class(TCustomdxCheckEdit);
Description
TCustomdxDBCheckEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBCheckEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceCheckEdit
TCustomdxCheckEdit
TCustomdxDBCheckEdit Properties
TCustomdxDBCheckEdit
DataField protected / read / write ValueGrayed protected / read / write
DataSource protected / read / write ValueUnchecked protected / read / write
ValueChecked protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access for this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
Description
Use the ValueChecked property to specify the field value represented by the check box when it is
checked. When a user checks the check box, the field value is set to ValueChecked.
Description
Use the ValueGrayed property to specify the field value represented by the check box when it is
grayed.
Description
Use the ValueUnchecked property to specify the field value represented by the check box when it is
unchecked. When a user unchecks the check box, the field value is set to ValueUnchecked.
TCustomdxDBCheckEdit Methods
TCustomdxDBCheckEdit
Create public LoadDisplayValue protected
Create method
Creates a TCustomdxDBCheckEdit instance.
Description
Call Create to create and initialize a TCustomdxDBCheckEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
LoadDisplayValue method
Used to obtain the text string edited within a data-aware editor.
Description
This method assigns the value returned by the DataDefinition.GetEditValue function to the Data
parameter.
TCustomdxDBCheckEdit Events
Derived from TdxInplaceEdit
OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected
TdxDBCheckEdit
TdxDBCheckEdit is a check box component that works with dataset fields.
Unit
dxDBELib
TdxDBCheckEdit = class(TCustomdxDBCheckEdit);
Description
A user can edit data within a database field by checking or unchecking a check box. You can employ
the TdxDBCheckEdit component to edit Boolean fields.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceCheckEdit
TCustomdxCheckEdit
TCustomdxDBCheckEdit
TdxDBCheckEdit Properties
Derived from TCustomdxDBCheckEdit
DataField published / read / write ValueGrayed published / read / write
DataSource published / read / write ValueUnchecked published / read / write
ValueChecked published / read / write
TdxDBCheckEdit Methods
Derived from TCustomdxDBCheckEdit
Create public LoadDisplayValue protected
TdxDBCheckEdit Events
Derived from TdxInplaceEdit
OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published
TCustomdxDBImageEdit
TCustomdxDBImageEdit is the class from which a TdxDBImageEdit control is derived.
Unit
dxDBELib
TCustomdxDBImageEdit = class(TCustomdxImageEdit);
Description
TCustomdxDBImageEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBImageEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceImageEdit
TCustomdxImageEdit
TCustomdxDBImageEdit Properties
TCustomdxDBImageEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBImageEdit Methods
TCustomdxDBImageEdit
Create public
Create method
Creates a TCustomdxDBImageEdit instance.
Description
Call Create to create and initialize a TCustomdxDBImageEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxDBImageEdit
TdxDBImageEdit is a component with a dropdown control which can include both an image and a
description for a specific field value.
Unit
dxDBELib
TdxDBImageEdit = class(TCustomdxDBImageEdit);
Description
A user can edit the data of an associated field by selecting the required value from a dropdown image
pick list.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceImageEdit
TCustomdxImageEdit
TCustomdxDBImageEdit
TdxDBImageEdit Properties
Derived from TCustomdxDBImageEdit
DataField published / read / write DataSource published / read / write
TdxDBImageEdit Methods
Derived from TCustomdxDBImageEdit
Create public
TdxDBImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TCustomdxDBSpinEdit
TCustomdxDBSpinEdit is the class from which a TdxDBSpinEdit control is derived.
Unit
dxDBELib
TCustomdxDBSpinEdit = class(TCustomdxSpinEdit);
Description
TCustomdxDBSpinEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBSpinEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TCustomdxSpinEdit
TCustomdxDBSpinEdit Properties
TCustomdxDBSpinEdit
DataField protected / read / write
DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBSpinEdit Methods
TCustomdxDBSpinEdit
Create public
Create method
Creates a TCustomdxDBSpinEdit instance.
Description
Call Create to create and initialize a TCustomdxDBSpinEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxDBSpinEdit
TdxDBSpinEdit is a component with spin buttons used to display and edit dataset fields.
Unit
dxDBELib
TdxDBSpinEdit = class(TCustomdxDBSpinEdit);
Description
Users can edit data in an associated field via the SpinEdit using spin buttons or manually entering the
desired value within the editor.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TCustomdxSpinEdit
TCustomdxDBSpinEdit
TdxDBSpinEdit Properties
Derived from TCustomdxDBSpinEdit
DataField published / read / write DataSource published / read / write
TdxDBSpinEdit Methods
Derived from TCustomdxDBSpinEdit
Create public
TdxDBSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxDBPickEdit
TCustomdxDBPickEdit is the class from which a TdxDBPickEdit control is derived.
Unit
dxDBELib
TCustomdxDBPickEdit = class(TCustomdxPickEdit);
Description
TCustomdxDBPickEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBPickEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TCustomdxPickEdit
TCustomdxDBPickEdit Properties
TCustomdxDBPickEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBPickEdit Methods
TCustomdxDBPickEdit
Create public
Create method
Creates a TCustomdxDBPickEdit instance.
Description
Call Create to create and initialize a TCustomdxDBPickEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxDBPickEdit
TdxDBPickEdit is a component with an associated dropdown list box control which contains a set of
possible values.
Unit
dxDBELib
TdxDBPickEdit = class(TCustomdxDBPickEdit);
Description
Users can edit the data of an associated field by selecting the required value from the pick list or by
entering it manually.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TCustomdxPickEdit
TCustomdxDBPickEdit
TdxDBPickEdit Properties
Derived from TCustomdxDBPickEdit
DataField published / read / write DataSource published / read / write
TdxDBPickEdit Methods
Derived from TCustomdxDBPickEdit
Create public
TdxDBPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TCustomdxDBCalcEdit
TCustomdxDBCalcEdit is the class from which a TdxDBCalcEdit control is derived.
Unit
dxDBELib
TCustomdxDBCalcEdit = class(TCustomdxCalcEdit);
Description
TCustomdxDBCalcEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBCalcEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceCalcEdit
TCustomdxCalcEdit
TCustomdxDBCalcEdit Properties
TCustomdxDBCalcEdit
DataField protected / read / write
DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBCalcEdit Methods
TCustomdxDBCalcEdit
Create public
Create method
Creates a TCustomdxDBCalcEdit instance.
Description
Call Create to create and initialize a TCustomdxDBCalcEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TdxDBCalcEdit
TdxDBCalcEdit is a component with an associated calculator control.
Unit
dxDBELib
TdxDBCalcEdit = class(TCustomdxDBCalcEdit);
Description
A user can edit the data of an associated dataset field by calculating the required value via the popup
calculator or entering data directly into the editor.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceCalcEdit
TCustomdxCalcEdit
TCustomdxDBCalcEdit
TdxDBCalcEdit Properties
Derived from TCustomdxDBCalcEdit
DataField published / read / write DataSource published / read / write
TdxDBCalcEdit Methods
Derived from TCustomdxDBCalcEdit
Create public
TdxDBCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected
TCustomdxDBHyperLinkEdit
TCustomdxDBHyperLinkEdit is the class from which a TdxDBHyperLinkEdit control is derived.
Unit
dxDBELib
TCustomdxDBHyperLinkEdit = class(TCustomdxHyperLinkEdit);
Description
TCustomdxDBHyperLinkEdit contains the basic methods and properties that are used to implement
standard behavior inherited by TdxDBHyperLinkEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceHyperLinkEdit
TCustomdxHyperLinkEdit
TCustomdxDBHyperLinkEdit Properties
TCustomdxDBHyperLinkEdit
DataField protected / read / write
DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBHyperLinkEdit Methods
TCustomdxDBHyperLinkEdit
Create public
Create method
Creates a TCustomdxDBHyperLinkEdit instance.
Description
Call Create to create and initialize a TCustomdxDBHyperLinkEdit instance. Derived objects that
override the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick protected
TdxDBHyperLinkEdit
TdxDBHyperLinkEdit represents data from an associated dataset field as a hyperlink.
Unit
dxDBELib
TdxDBHyperLinkEdit = class(TCustomdxDBHyperLinkEdit);
Description
The TdxDBHyperLinkEdit component edits and processes hyperlinks associated with a dataset field.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceHyperLinkEdit
TCustomdxHyperLinkEdit
TCustomdxDBHyperLinkEdit
TdxDBHyperLinkEdit Properties
Derived from TCustomdxDBHyperLinkEdit
DataField published / read / write DataSource published / read / write
TdxDBHyperLinkEdit Methods
Derived from TCustomdxDBHyperLinkEdit
Create public
TdxDBHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick published
TCustomdxDBTimeEdit
TCustomdxDBTimeEdit is the class from which a TdxDBTimeEdit component is derived.
Unit
dxDBELib
TCustomdxDBTimeEdit = class(TCustomdxTimeEdit);
Description
TCustomdxDBTimeEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBTimeEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TdxInplaceTimeEdit
TCustomdxTimeEdit
TCustomdxDBTimeEdit Properties
TCustomdxDBTimeEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBTimeEdit Methods
TCustomdxDBTimeEdit
Create public
Create method
Creates a TCustomdxDBTimeEdit instance.
Description
Call Create to create and initialize a TCustomdxDBTimeEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxDBTimeEdit
TdxDBSpinEdit represents an editor with spin buttons used to display and edit time values.
Unit
dxDBELib
TdxDBTimeEdit = class(TCustomdxDBTimeEdit);
Description
TdxDBTimeEdit is used to edit time values using both the keyboard and/or spin buttons.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceSpinEdit
TdxInplaceTimeEdit
TCustomdxTimeEdit
TCustomdxDBTimeEdit
TdxDBTimeEdit Properties
Derived from TCustomdxDBTimeEdit
DataField published / read / write DataSource published / read / write
TdxDBTimeEdit Methods
Derived from TCustomdxDBTimeEdit
Create public
TdxDBTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxDBCurrencyEdit
TCustomdxDBCurrencyEdit is the class from which a TdxDBCurrencyEdit component is derived.
Unit
dxDBELib
TCustomdxDBCurrencyEdit = class(TCustomdxCurrencyEdit);
Description
TCustomdxDBCurrencyEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBCurrencyEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceCurrencyEdit
TCustomdxCurrencyEdit
TCustomdxDBCurrencyEdit Properties
TCustomdxDBCurrencyEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBCurrencyEdit Methods
TCustomdxDBCurrencyEdit
Create public
Create method
Creates a TCustomdxDBCurrencyEdit instance.
Description
Call Create to create and initialize a TCustomdxDBCurrencyEdit instance. Derived objects that
override the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected
TdxDBCurrencyEdit
TdxDBCurrencyEdit allows users to modify currency data.
Unit
dxDBELib
TdxDBCurrencyEdit = class(TCustomdxDBCurrencyEdit);
Description
The TdxDBCurrencyEdit component displays and edits currency formatted data.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceCurrencyEdit
TCustomdxCurrencyEdit
TCustomdxDBCurrencyEdit
TdxDBCurrencyEdit Properties
Derived from TCustomdxDBCurrrencyEdit
DataField published / read / write DataSource published / read / write
TdxDBCurrencyEdit Methods
Derived from TCustomdxDBCurrencyEdit
Create public
TdxDBCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published
TCustomdxDBGraphicEdit
TCustomdxDBGraphicEdit is the class from which a TdxDBGraphicEdit component is derived.
Unit
dxDBELib
TCustomdxDBGraphicEdit = class(TCustomdxGraphicEdit);
Description
TCustomdxDBGraphicEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBGraphicEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceGraphicEdit
TCustomdxGraphicEdit
TCustomdxDBGraphicEdit Properties
TCustomdxDBGraphicEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBGraphicEdit Methods
TCustomdxDBGraphicEdit
Create public
Create method
Creates a TCustomdxDBGraphicEdit instance.
Description
Call Create to create and initialize a TCustomdxDBGraphicEdit instance. Derived objects that
override the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick protected
TdxDBGraphicEdit
TdxDBGraphicEdit represents an editor that displays images obtained from a database field.
Unit
dxDBELib
TdxDBGraphicEdit = class(TCustomdxDBGraphicEdit);
Description
TdxDBGraphicEdit is an edit component with a dropdown window that contains an image from a
specific database field.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceGraphicEdit
TCustomdxGraphicEdit
TCustomdxDBGraphicEdit
TdxDBGraphicEdit Properties
Derived from TCustomdxDBGraphicEdit
DataField published / read / write DataSource published / read / write
TdxDBGraphicEdit Methods
Derived from TCustomdxDBGraphicEdit
Create public
TdxDBGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture published OnGetGraphicClass published
OnCustomClick published
TCustomdxDBLookupEdit
TCustomdxDBLookupEdit is the class from which a TdxDBLookupEdit component is derived.
Unit
dxDBELib
TCustomdxDBLookupEdit = class(TdxInplaceLookupEdit);
Description
TCustomdxDBLookupEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBLookupEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceLookupEdit
TCustomdxDBLookupEdit Properties
TCustomdxDBLookupEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBLookupEdit Methods
TCustomdxDBLookupEdit
Create public IsInplace public
Create method
Creates a TCustomdxDBLookupEdit instance.
Description
Call Create to create and initialize a TCustomdxDBLookupEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
IsInplace method
Description
The IsInplace method always returns False for TCustomdxDBLookupEdit.
TCustomdxDBLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp protected
TdxDBLookupEdit
TdxDBLookupEdit represents a control with a linked dropdown lookup list.
Unit
dxDBELib
TdxDBLookupEdit = class(TCustomdxDBLookupEdit);
Description
The TdxDBLookupEdit component is used to create a lookup list box from a lookup table. Users can
edit data within this component by selecting the required value from the lookup list or by entering it
directly into the editor. This component uses the dropdown list to modify data in an associated field.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceLookupEdit
TCustomdxDBLookupEdit
TdxDBLookupEdit Properties
Derived from TCustomdxDBLookupEdit
DataField published / read / write DataSource published / read / write
TdxDBLookupEdit Methods
Derived from TCustomdxDBLookupEdit
Create public IsInplace public
TdxDBLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp published
TCustomdxDBBlobEdit
TCustomdxDBBlobEdit is the class from which a TdxDBBlobEdit component is derived.
Unit
dxDBELib
TCustomdxDBBlobEdit = class(TCustomdxBlobEdit);
Description
TCustomdxDBBlobEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBBlobEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceBlobEdit
TCustomdxBlobEdit
TCustomdxDBBlobEdit Properties
TCustomdxDBBlobEdit
BlobKind protected / read / write DataSource protected / read / write
DataField protected / read / write
type
TdxBlobKind = (bkAuto, bkBlob, bkMemo, bkPict, bkOle);
property BlobKind: TdxBlobKind;
Description
Use the BlobKind property to specify the type of BLOB field associated with the editor. Possible
values include:
Value Description
bkAuto The editor recognizes the type of a BLOB field automatically (can contain all the
following values).
bkBlob Binary Large Object field (ftBlob).
bkMemo Text memo field (ftMemo) or formatted text memo field (ftFmtMemo).
bkPict Bitmap field (ftGraphic).
bkOle Paradox OLE field (ftParadoxOle) or dBase OLE field (ftDBaseOle).
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBBlobEdit Methods
TCustomdxDBBlobEdit
AssignEditProperties protected IsInplace public
Create public
AssignEditProperties method
Description
Calls the CalcBlobEditKind method and obtaines the associated field type and returns the appropriate
value for the BlobEditKind property.
Create method
Creates a TCustomdxDBBlobEdit instance.
Description
Call Create to create and initialize a TCustomdxDBBlobEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
IsInplace method
Description
Always returns False for TCustomdxDBBlobEdit.
TCustomdxDBBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected
TdxDBBlobEdit
TdxDBBlobEdit represents a control that displays and edits BLOB data.
Unit
dxDBELib
TdxDBBlobEdit = class(TCustomdxDBBlobEdit);
Description
The TdxDBBlobEdit component allows a user to display and edit Memo BLOBs or display Picture
BLOBs contained within a field. It can also automatically determine the type of OLE BLOBs.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplaceBlobEdit
TCustomdxBlobEdit
TCustomdxDBBlobEdit
TdxDBBlobEdit Properties
Derived from TCustomdxDBBlobEdit
BlobKind published / read / write DataSource published / read / write
DataField published / read / write
TdxDBBlobEdit Methods
Derived from TCustomdxDBBlobEdit
AssignEditProperties protected IsInplace public
Create public
TdxDBBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture published OnGetGraphicClass published
TCustomdxDBMRUEdit
TCustomdxDBMRUEdit defines the basic methods and properties for TdxDBMRUEdit.
Unit
dxDBELib
TCustomdxDBMRUEdit = class(TCustomdxMRUEdit);
Description
TCustomdxDBMRUEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBMRUEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TdxInplaceMRUEdit
TCustomdxMRUEdit
TCustomdxDBMRUEdit Properties
TCustomdxDBMRUEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBMRUEdit Methods
TCustomdxDBMRUEdit
Create public
Create method
Creates a TCustomdxDBMRUEdit instance.
Description
Call Create to create and initialize a TCustomdxDBMRUEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick protected
TdxDBMRUEdit
TdxDBMRUEdit is a button type date-aware editor that can list and edit a summary of the most
recently used (MRU) items.
Unit
dxDBELib
TdxDBMRUEdit = class(TCustomdxDBMRUEdit);
Description
The TdxDBMRUEdit component maintains a list of the most recently used items. This list is
automatically maintained by the editor, so no additional coding is necessary on your part. While
TdxDBMRUEdit descends from TdxInplacePickEdit, it can be used as a pick editor to search most
recently entered values within the MRU items list.
TdxDBMRUEdit is an editor with a button control. It can include one or two clickable button controls.
One of these buttons is always used to display the dropdown items list. The other button can be used
to perform other actions. If you wish to create a specific editor that maintains a MRU list, you should
inherit TCustomdxDBMRUEdit.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePickEdit
TdxInplaceMRUEdit
TCustomdxMRUEdit
TCustomdxDBMRUEdit
TdxDBMRUEdit Properties
Derived from TCustomdxDBMRUEdit
DataField published / read / write DataSource published / read / write
TdxDBMRUEdit Methods
Derived from TCustomdxDBMRUEdit
Create public
TdxDBMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick published
TCustomdxDBPopupEdit
TCustomdxDBPopupEdit is the class from which a TdxDBPopupEdit control is derived.
Unit
dxDBELib
TCustomdxDBPopupEdit = class(TCustomdxPopupEdit);
Description
TCustomdxDBPopupEdit contains the basic properties and methods that are used to implement
standard behaviors inherited by TdxDBPopupEdit.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit
TCustomdxPopupEdit
TCustomdxDBPopupEdit Properties
TCustomdxDBPopupEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBPopupEdit Methods
TCustomdxDBPopupEdit
Create public
Create method
Creates a TCustomdxDBPopupEdit instance.
Description
Call Create to create and initialize a TCustomdxDBPopupEdit instance. Derived objects that override
the Create method must call the inherited Create method before performing any additional
initialization.
TCustomdxDBPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected
TdxDBPopupEdit
TdxPopupEdit is a button type editor with a dropdown window which can display another control.
Unit
dxDBELib
TdxDBPopupEdit = class(TCustomdxDBPopupEdit);
Description
The TdxPopupEdit component maintains a dropdown window used to host a specific control. At
runtime, a user can work with this embedded control within the dropdown window of the TdxPopupEdit
component. This component uses the result value of the embedded control to modify data in an
associated field.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit
TCustomdxPopupEdit
TCustomdxDBPopupEdit
TdxDBPopupEdit Properties
Derived from TCustomdxDBPopupEdit
DataField published / read / write DataSource published / read / write
TdxDBPopupEdit Methods
Derived from TCustomdxDBPopupEdit
Create public
TdxDBPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery published OnInitPopup published
OnCloseUp published OnPopup published
TdxInplaceExtLookupEdit
Represents an editor that modifies data via a dropdown window which contains the
ExpressQuantumGrid.
Unit
dxExGrEd
TdxInplaceExtLookupEdit = class(TdxInplacePopupEdit);
Description
Use TdxInplaceExtLookupEdit to create an extended lookup editor. When activating a dropdown
window, the extended lookup editor displays an instance of the TdxDBGrid class, which can
implement all ExpressQuantumGrid features. This dropdown grid automatically supports incremental
search.
TdxInplaceExtLookupEdit applies the TdxDBGridLayout object to define the look and feel of a grid
within the dropdown window.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit
TdxInplaceExtLookupEdit Properties
TdxInplaceExtLookupEdit
CanDeleteText protected / read / write Field protected / read / write
ChooseByDblClick protected / read / write PickListField protected / read / write
ClearKey protected / read / write UseDefaultSettings protected / read / write
DBGridLayout protected / read / write
Description
If the CanDeleteText property is set to False , users cannot delete the selected value from an editor.
If the CanDeleteText property is set to True, users can delete the selected value without removing this
item from the dropdown list.
Description
If the ChooseByDblClick property is set to True, a user can set a new value for an editor by double-
clicking a row displayed within the dropdown window.
Description
When a user starts editing within an editor, he or she can press this shortcut key to quickly clear the
contents of the editor.
Description
TdxInplaceExtLookupEdit uses a specific layout to create a grid within the dropdown window. Use this
property to specify this layout.
Description
Every column in a data-aware grid is associated with a dataset field. This property specifies the field
associated with a column.
Description
Generally, a grid within a dropdown window includes multiple columns, but only one of them can be
used to select the value for the editor. The PickListField property specifies which column in the
dropdown grid to be used as the basis of the editor's value.
Description
The Grid layout editor allows you to customize the characteristics of a dropdown grid to meet specific
application requirements. If the UseDefaultSettings property is True, the dropdown grid uses several
predefined settings for its properties: The BorderStyle property is set to bsNone. Both the Editing
and ColumnMoving options are disabled and the InvertSelect, MouseScroll and AutoSearch options
are enabled.
TdxInplaceExtLookupEdit Methods
Derived from TdxInplacePopupEdit
CalcSize protected InitializePopup protected
TdxInplaceExtLookupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected
TCustomdxDBExtLookupEdit
TCustomdxDBExtLookupEdit is the ancestor class of the TdxExtLookupEdit control.
Unit
dxExGrEd
TCustomdxDBExtLookupEdit = class(TdxInplaceExtLookupEdit);
Description
TCustomdxDBExtLookupEdit contains the basic methods and properties that are used to implement
standard behaviors inherited by all its descendants.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit
TdxInplaceExtLookupEdit
TCustomdxDBExtLookupEdit Properties
TCustomdxDBExtLookupEdit
DataField protected / read / write DataSource protected / read / write
Description
Use the DataField property to determine the field name from which an editor obtains its data. The
TDataSource component specified in the DataSource property provides access to the dataset in which
this field is located.
If the DataField property refers to a database field that contains integer or floating-point data, only
integer or floating-point data can be entered within the editor. Invalid characters are not accepted.
Description
Use the DataSource property to specify the data source component for a data-aware editor. This data
source provides data access to this editor. You should set both the DataSource and DataField
properties to connect the editor to a specific field.
TCustomdxDBExtLookupEdit Methods
TCustomdxDBExtLookupEdit
Create public IsInplace public
Create method
Creates a TCustomdxDBExtLookupEdit instance.
Description
Call Create to create and initialize a TCustomdxDBExtLookupEdit instance. Derived objects that
override the Create method must call the inherited Create method before performing any additional
initialization.
IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.
Description
The IsInplace method always returns False for TCustomdxDBExtLookupEdit.
TCustomdxDBExtLookupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected
TdxDBExtLookupEdit
Represents an extended lookup editor whose dropdown window includes the ExpressQuantumGrid.
Unit
dxExGrEd
TdxDBExtLookupEdit = class(TCustomdxDBExtLookupEdit);
Description
When activating a dropdown window, an extended lookup editor displays the TdxDBGrid object, which
can implement all ExpressQuantumGrid features. The dropdown grid automatically supports
incremental search.
TdxDBExtLookupEdit applies TdxDBGridLayout objects to define the look and feel of a grid within the
dropdown window.
Note: Inplace and standalone editors of the ExpressQuantumGrid Suite require Windows RichEdit
component 2.0 or higher to work properly. If the editors on your or client's machine do not work, make
certain that the riched20.dll library is in the Windows system folder (Windows \System or
WINNT\System32). Copy the specified DLL to fix the problem.
Hierarchy
TObject
TPersistent
TComponent
TControl
TWinControl
TdxInplaceEdit
TdxInplaceTextEdit
TdxInplaceMaskEdit
TdxInplaceDropDownEdit
TdxInplacePopupEdit
TdxInplaceExtLookupEdit
TCustomdxDBExtLookupEdit
TdxDBExtLookupEdit Properties
Derived from TCustomdxDBExtLookupEdit
DataField published / read / write DataSource published / read / write
TdxDBExtLookupEdit Methods
Derived from TCustomdxDBExtLookupEdit
Create public IsInplace public
TdxDBExtLookupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery published OnInitPopup published
OnCloseUp published OnPopup published
Index
CopyToClipboard...................................................... 68, 183, 184
A Create36, 400, 404, 414, 423, 433, 444, 453, 463, 473, 483, 493, 502,
512, 521, 530, 540, 550, 560, 571, 587
Add.......................................................................................240
TCustomdxDBBlobEdit......................................................550
AddItem .........................................................................207, 208 TCustomdxDBButtonEdit ...................................................444
AddLink................................................................................. 20 TCustomdxDBCheckEdit ....................................................453
Alignment..............................................................................174
TCustomdxDBDateEdit ......................................................433
TdxPopupToolBarWindow..................................................174 TCustomdxDBEdit .............................................................404
AllowGrayed..........................................................................122 TCustomdxDBImageEdit....................................................463
TdxInplaceCheckEdit .........................................................122
TCustomdxDBMaskEdit.....................................................413
AlwaysSaveText.....................................................................189
TCustomdxDBMemo..........................................................423
Assign ............................................................................. 37, 237 T dxEditDataLink................................................................400
TdxEditStyle....................................................................... 37 CustomButtonCaption.............................................................175
AssignEditProperties........................................................549, 550
CustomButtonGlyph ...............................................................175
AssignedValues....................................................................... 31
CustomClick ..........................................................................184
AssignPicture..................................................................183, 199 CustomFilter ..........................................................................179
AutoSelect CustomGraphic......................................................................179
TdxInplaceTextEdit ............................................................. 61
CustomGraphic......................................................................179
AutoSize..................................................................... 47, 90, 178
CutToClipboard......................................................................184
TdxInplaceMemoEdit .......................................................... 90
D
B
DataField403, 411, 421, 430, 441, 451, 460, 470, 480, 490, 500, 509,
BeepOnError..........................................................................151
519, 529, 537, 548, 557, 568, 585
TdxInplaceCalcEdit ............................................................151 TCustomdxDBButtonEdit ...................................................441
BeginUpdate........................................................................... 20 TCustomdxDBCheckEdit ....................................................451
BlobEditKind.........................................................................190
TCustomdxDBDateEdit ......................................................430
BlobKind...............................................................................548
TCustomdxDBEdit .............................................................403
BlobPaintStyle.......................................................................190 TCustomdxDBImageEdit....................................................460
BlobText................................................................................191 TCustomdxDBMaskEdit.....................................................411
BorderStyle...................................................................... 25, 119
TCustomdxDBMemo..........................................................421
TdxCheckEditStyleController..............................................119
DataSource....403, 411, 421, 431, 442, 451, 461, 471, 481, 491, 500,
ButtonClick............................................................................208 510, 520, 529, 538, 548, 558, 569, 585
ButtonGlyph........................................................................... 97 TCustomdxDBButtonEdit ...................................................442
TdxInplaceDropDownEdit.................................................... 97
TCustomdxDBCheckEdit ....................................................451
Buttons...........................................................................113, 174
TCustomdxDBDateEdit ......................................................431
TdxInplaceButtonEdit .........................................................113 TCustomdxDBEdit .............................................................403
ButtonStyle............................................................. 119, 120, 152 TCustomdxDBImageEdit....................................................461
TdxCheckEditStyleController..............................................119
TCustomdxDBMaskEdit.....................................................411
TdxInplaceCalcEdit ............................................................152 TCustomdxDBMemo..........................................................421
C Date......................................................................................106
TdxInplaceDateEdit............................................................106
CalcSize .........................................................................217, 218 DateButtons...........................................................................107
CanDeleteText ........................................................ 145, 227, 578 TdxInplaceDateEdit............................................................107
TdxInplaceLookupEdit .......................................................228 DateChange ...........................................................................110
TdxInplacePickEdit ............................................................145 TdxInplaceDateEdit............................................................109
CanPaste................................................................................. 61 DateOnError..........................................................................107
CanRedo................................................................................. 62 TdxInplaceDateEdit............................................................107
CanUndo ................................................................................ 62 DateValidation .......................................................................107
Center....................................................................................178 TdxInplaceDateEdit............................................................107
TdxInplaceGraphicEdit.......................................................178 DBGridLayout .......................................................................579
Changed................................................................................. 36 DblClickActivate.............................................................179, 180
TdxEditStyle....................................................................... 36 DecimalPlaces........................................................................167
CharCase ........................................................................... 62, 63 TdxInplaceCurrencyEdit .....................................................167
TdxInplaceTextEdit ........................................................ 62, 63 Default ..................................................................................235
CheckCursor ........................................................................... 81 DefaultBorderColor................................................................. 37
TdxInplaceMaskEdit............................................................ 81 DefaultBorderStyle.................................................................. 38
Checked.................................................................................122 DefaultButtonClick.................................................................116
TdxInplaceCheckEdit .........................................................122 TdxInplaceButtonEdit .........................................................115
ChooseByDblClick.................................................................579 DefaultButtonStyle.................................................................. 38
Clear...................................................................................... 82 DefaultDisplayFormat .............................................................170
TdxInplaceMaskEdit............................................................ 82 TdxInplaceCurrencyEdit .....................................................170
ClearField.......................................................................230, 231 DefaultEdges........................................................................... 40
ClearKey ........................................................................228, 579 DefaultEditMask...................................................................... 82
ClearPicture ...........................................................................183 TdxInplaceMaskEdit............................................................ 82
ClearSelection......................................................................... 68 DefaultHotTrack...................................................................... 40
ClickKey ...............................................................................114 DefaultImages........................................................................129
TdxInplaceButtonEdit .........................................................113 TdxInplaceImageEdit..........................................................129
ClientEdge.............................................................................222 DefaultMaxLengt h.............................................................. 69, 82
ClipboardFormat ....................................................................179 TdxInplaceMaskEdit............................................................ 82
ClosePopup............................................................................225 DefaultMaxValue ............................................................140, 171
MaxItemCount .......................................................................206 R
MaxLength............................................................................. 63
MaxValue.......................................................................136, 168 ReadOnly......................................................................... 48, 329
MemoCharCase......................................................................191 ReformatText.......................................................................... 86
MemoHideScrollBars..............................................................192 RemoveLink........................................................................... 21
MemoMaxLength...................................................................192 Reset.....................................................................................400
MemoOEMConvert ................................................................192 TdxEditDataLink................................................................400
MemoScrollBars.....................................................................193 RestoreDefaults...............................................................237, 240
MemoSelectionBar.................................................................193 Revertable.......................................................................147, 229
MemoWantReturns.................................................................194
MemoWantTabs.....................................................................194 S
MemoWordWrap....................................................................194 SavePopupSize.......................................................................200
MinValue........................................................................136, 168 SaveTime...............................................................................108
Modified................................................................................400
SaveToFile.............................................................................185
TdxEditDataLink................................................................400
ScrollBars............................................................................... 91
MultiLine...............................................................................124 SelectAll............................................................................ 52, 73
MultiLineText........................................................................131 SelectionBar............................................................................ 91
N SelLength ............................................................................... 65
SelStart................................................................................... 65
NullStyle...............................................................................124 SelText................................................................................... 65
SetBlobValue .........................................................................201
O SetCursor................................................................................ 86
SetEditMaxValue....................................................................141
OEMConvert........................................................................... 64 SeteditMinValue.....................................................................141
OnActiveChange ..................................................................... 45 SetEditValue ........................................................................... 44
OnAssignPicture..............................................................186, 202 SetEditVlueType....................................................................142
OnButtonClick ................................................................117, 209 SetKeyValue ...................................................................231, 232
OnCloseQuery........................................................................219 SetSel..................................................................................... 87
OnCloseUp ............................................................. 104, 219, 233 SetSelLength........................................................................... 74
OnCustomClick......................................................................186 SetSelStart .............................................................................. 74
OnDataChange........................................................................ 45 SetSelTextBuf......................................................................... 75
OnDateChange.......................................................................111 SetValue ................................................................................142
OnDateValidateInput ..............................................................111 Shadow.............................................................................. 28, 35
OnEditButtonClick .................................................................104 ShowButtonFrame..................................................................152
OnGetGraphicClass.........................................................186, 202 ShowCaptions........................................................................175
OnInitPopup...........................................................................220 ShowDescription ....................................................................131
OnPopup................................................................................220 ShowEllipsis..........................................................................206
OnSelectionChange.................................................................. 76 ShowExPopupItems................................................................197
OnStartClick ..........................................................................160 ShowPicturePopup..................................................................197
OnStyleChanged...................................................................... 29 ShowPopup...................................................................... 59, 225
Owner...................................................................................239 SingleClick............................................................................157
OwnerControl......................................................................... 57 Sizeable.................................................................................224
SizeablePopup ........................................................................197
P
SizingCorner..........................................................................224
PasswordChar......................................................................... 64 Sorted....................................................................................147
PasteFromClipboard.......................................................... 72, 185 StartKey ................................................................................157
PickListField..........................................................................580 State......................................................................................124
Picture...................................................................................180 Stretch...................................................................................181
PictureAutoSize......................................................................194
PictureClipboardFormat ..........................................................195 T
PictureFilter ...........................................................................195 TCustomdxBlobEdit ...............................................................365
PictureGraphicClass................................................................195 IsInplace............................................................................365
PictureTransparency................................................................196 TCustomdxButtonEdit......................................................275, 278
PopupAlignment...................................................................... 99 IsInplace............................................................................278
PopupAutoSize.......................................................................212 TCustomdxCalcEdit.........................................................319, 321
PopupBorder........................................................................... 99 IsInplace............................................................................321
PopupBorderStyle...................................................................103 TCustomdxCheckEdit ......................................................284, 286
PopupClientEdge....................................................................212 IsInplace............................................................................286
PopupControl.........................................................................212 TCustomdxCurrencyEdit ..................................................345, 347
PopupFlatBorder....................................................................213 IsInplace............................................................................347
PopupForm ............................................................................213 TCustomdxDateEdit.........................................................265, 268
PopupFormBorderStyle....................................................213, 222 IsInplace............................................................................268
PopupFormCaption.................................................................214 TCustomdxDBBlobEdit ..........................................................546
PopupHeight ...................................................................196, 214 AssignEditProperties..........................................................549
PopupMinHeight ....................................................................214 BlobKind...........................................................................548
PopupMinHieght ....................................................................223 Create...............................................................................550
PopupMinWidth..............................................................215, 223 DataField...........................................................................548
PopupSizeable........................................................................215 DataSource........................................................................548
PopupWidth....................................................................196, 215 IsInplace............................................................................550
Precision................................................................................152 TCustomdxDBButtonEdit.................................. 440, 441, 442, 444
Q Create...............................................................................444
DataField....................................................................441, 442
QuickClose............................................................................152 DataSource........................................................................442
QuickDraw............................................................................180 TCustomdxDBCalcEdit...........................................................489