0% found this document useful (0 votes)
47 views600 pages

ExpressEditors and DBEditors Reference

Uploaded by

ingi.svair
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
47 views600 pages

ExpressEditors and DBEditors Reference

Uploaded by

ingi.svair
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 600

2 Table of Contents

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 3

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

TdxInplaceDropDownEdit Methods 101

TdxInplaceDropDownEdit Events 104

TdxInplaceDateEdit 105

TdxInplaceDateEdit Properties 106

TdxInplaceDateEdit Methods 109

TdxInplaceDateEdit Events 111

TdxInplaceButtonEdit 112

TdxInplaceButtonEdit Properties 113

TdxInplaceButtonEdit Methods 115

TdxInplaceButtonEdit Events 117

TdxCheckEditStyleController 118

TdxCheckEditStyleController Properties 119

TdxInplaceCheckEdit 121

TdxInplaceCheckEdit Properties 122

TdxInplaceCheckEdit Methods 126

TdxInplaceCheckEdit Events 127

TdxInplaceImageEdit 128
ExpressEditors&DBEditors by Developer Express
4 Table of Contents
TdxInplaceImageEdit Properties 129

TdxInplaceImageEdit Methods 132

TdxInplaceImageEdit Events 133

TdxInplaceSpinEdit 134

TdxInplaceSpinEdit Properties 135

TdxInplaceSpinEdit Methods 139

TdxInplaceSpinEdit Events 143

TdxInplacePickEdit 144

TdxInplacePickEdit Properties 145

TdxInplacePickEdit Methods 148

TdxInplacePickEdit Events 149

TdxInplaceCalcEdit 150

TdxInplaceCalcEdit Properties 151

TdxInplaceCalcEdit Methods 154

TdxInplaceCalcEdit Events 155

TdxInplaceHyperLinkEdit 156

TdxInplaceHyperLinkEdit Properties 157

TdxInplaceHyperLinkEdit Methods 159

TdxInplaceHyperLinkEdit Events 160

TdxInplaceTimeEdit 161

TdxInplaceTimeEdit Properties 162

TdxInplaceTimeEdit Methods 164

TdxInplaceTimeEdit Events 165

TdxInplaceCurrencyEdit 166

TdxInplaceCurrencyEdit Properties 167

TdxInplaceCurrencyEdit Methods 170

TdxInplaceCurrencyEdit Events 172

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 5

TdxPopupToolBarWindow 173

TdxPopupToolBarWindow Properties 174

TdxInplaceGraphicEdit 177

TdxInplaceGraphicEdit Properties 178

TdxInplaceGraphicEdit Methods 183

TdxInplaceGraphicEdit Events 186

TdxInplaceBlobEdit 188

TdxInplaceBlobEdit Properties 189

TdxInplaceBlobEdit Methods 199

TdxInplaceBlobEdit Events 202

TdxInplaceMRUEdit 204

TdxInplaceMRUEdit Properties 205

TdxInplaceMRUEdit Methods 207

TdxInplaceMRUEdit Events 209

TdxInplacePopupEdit 210

TdxInplacePopupEdit Properties 211

TdxInplacePopupEdit Methods 217

TdxInplacePopupEdit Events 219

TdxPopupEditForm 221

TdxPopupEditForm Properties 222

TdxPopupEditForm Methods 225

TdxInplaceLookupEdit 226

TdxInplaceLookupEdit Properties 227

TdxInplaceLookupEdit Methods 230

TdxInplaceLookupEdit Events 233

TdxEditButton 234

TdxEditButton Properties 235


ExpressEditors&DBEditors by Developer Express
6 Table of Contents
TdxEditButton Methods 237

TdxEditButtons 238

TdxEditButtons Properties 239

TdxEditButtons Methods 240

TCustomdxEdit 241

TCustomdxEdit Properties 242

TCustomdxEdit Methods 243

TCustomdxEdit Events 244

TdxEdit 245

TdxEdit Properties 246

TdxEdit Methods 247

TdxEdit Events 248

TCustomdxMaskEdit 249

TCustomdxMaskEdit Properties 250

TCustomdxMaskEdit Methods 251

TCustomdxMaskEdit Events 252

TdxMaskEdit 253

TdxMaskEdit Properties 254

TdxMaskEdit Methods 255

TdxMaskEdit Events 256

TCustomdxMemo 257

TCustomdxMemo Properties 258

TCustomdxMemo Methods 259

TCustomdxMemo Events 260

TdxMemo 261

TdxMemo Properties 262

TdxMemo Methods 263

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 7

TdxMemo Events 264

TCustomdxDateEdit 265

TCustomdxDateEdit Properties 266

TCustomdxDateEdit Methods 267

TCustomdxDateEdit Events 269

TdxDateEdit 270

TdxDateEdit Properties 272

TdxDateEdit Methods 273

TdxDateEdit Events 274

TCustomdxButtonEdit 275

TCustomdxButtonEdit Properties 276

TCustomdxButtonEdit Methods 277

TCustomdxButtonEdit Events 279

TdxButtonEdit 280

TdxButtonEdit Properties 281

TdxButtonEdit Methods 282

TdxButtonEdit Events 283

TCustomdxCheckEdit 284

TCustomdxCheckEdit Properties 285

TCustomdxCheckEdit Methods 286

TCustomdxCheckEdit Events 287

TdxCheckEdit 288

TdxCheckEdit Properties 289

TdxCheckEdit Methods 290

TdxCheckEdit Events 291

TCustomdxImageEdit 292

TCustomdxImageEdit Properties 293


ExpressEditors&DBEditors by Developer Express
8 Table of Contents
TCustomdxImageEdit Methods 294

TCustomdxImageEdit Events 296

TdxImageEdit 297

TdxImageEdit Properties 298

TdxImageEdit Methods 299

TdxImageEdit Events 300

TCustomdxSpinEdit 301

TCustomdxSpinEdit Properties 302

TCustomdxSpinEdit Methods 303

TCustomdxSpinEdit Events 305

TdxSpinEdit 306

TdxSpinEdit Properties 307

TdxSpinEdit Methods 308

TdxSpinEdit Events 309

TCustomdxPickEdit 310

TCustomdxPickEdit Properties 311

TCustomdxPickEdit Methods 312

TCustomdxPickEdit Events 314

TdxPickEdit 315

TdxPickEdit Properties 316

TdxPickEdit Methods 317

TdxPickEdit Events 318

TCustomdxCalcEdit 319

TCustomdxCalcEdit Properties 320

TCustomdxCalcEdit Methods 321

TCustomdxCalcEdit Events 323

TdxCalcEdit 324

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 9

TdxCalcEdit Properties 325

TdxCalcEdit Methods 326

TdxCalcEdit Events 327

TCustomdxHyperLinkEdit 328

TCustomdxHyperLinkEdit Properties 329

TCustomdxHyperLinkEdit Methods 330

TCustomdxHyperLinkEdit Events 331

TdxHyperLinkEdit 332

TdxHyperLinkEdit Properties 333

TdxHyperLinkEdit Methods 334

TdxHyperLinkEdit Events 335

TCustomdxTimeEdit 336

TCustomdxTimeEdit Properties 337

TCustomdxTimeEdit Methods 338

TCustomdxTimeEdit Events 340

TdxTimeEdit 341

TdxTimeEdit Properties 342

TdxTimeEdit Methods 343

TdxTimeEdit Events 344

TCustomdxCurrencyEdit 345

TCustomdxCurrencyEdit Properties 346

TCustomdxCurrencyEdit Methods 347

TCustomdxCurrencyEdit Events 349

TdxCurrencyEdit 350

TdxCurrencyEdit Properties 351

TdxCurrencyEdit Methods 352

TdxCurrencyEdit Events 353


ExpressEditors&DBEditors by Developer Express
10 Table of Contents
TCustomdxGraphicEdit 354

TCustomdxGraphicEdit Properties 355

TCustomdxGraphicEdit Methods 356

TCustomdxGraphicEdit Events 357

TdxGraphicEdit 358

TdxGraphicEdit Properties 359

TdxGraphicEdit Methods 360

TdxGraphicEdit Events 361

TCustomdxBlobEdit 362

TCustomdxBlobEdit Properties 363

TCustomdxBlobEdit Methods 364

TCustomdxBlobEdit Events 366

TdxBlobEdit 367

TdxBlobEdit Properties 369

TdxBlobEdit Methods 370

TdxBlobEdit Events 371

TCustomdxMRUEdit 372

TCustomdxMRUEdit Properties 373

TCustomdxMRUEdit Methods 374

TCustomdxMRUEdit Events 376

TdxMRUEdit 377

TdxMRUEdit Properties 378

TdxMRUEdit Methods 379

TdxMRUEdit Events 380

TCustomdxPopupEdit 381

TCustomdxPopupEdit Properties 382

TCustomdxPopupEdit Methods 383

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 11

TCustomdxPopupEdit Events 385

TdxPopupEdit 386

TdxPopupEdit Properties 387

TdxPopupEdit Methods 388

TdxPopupEdit Events 389

TCustomdxLookupEdit 390

TCustomdxLookupEdit Properties 391

TCustomdxLookupEdit Methods 392

TCustomdxLookupEdit Events 393

TdxLookupEdit 394

TdxLookupEdit Properties 395

TdxLookupEdit Methods 396

TdxLookupEdit Events 397

TdxEditDataLink 398

TdxEditDataLink Properties 399

TdxEditDataLink Methods 400

TdxEditDBDataDefinition 401

TCustomdxDBEdit 402

TCustomdxDBEdit Properties 403

TCustomdxDBEdit Methods 404

TCustomdxDBEdit Events 405

TdxDBEdit 406

TdxDBEdit Properties 407

TdxDBEdit Methods 408

TdxDBEdit Events 409

TCustomdxDBMaskEdit 410

TCustomdxDBMaskEdit Properties 411


ExpressEditors&DBEditors by Developer Express
12 Table of Contents
TCustomdxDBMaskEdit Methods 413

TCustomdxDBMaskEdit Events 415

TdxDBMaskEdit 416

TdxDBMaskEdit Properties 417

TdxDBMaskEdit Methods 418

TdxDBMaskEdit Events 419

TCustomdxDBMemo 420

TCustomdxDBMemo Properties 421

TCustomdxDBMemo Methods 423

TCustomdxDBMemo Events 424

TdxDBMemo 425

TdxDBMemo Properties 426

TdxDBMemo Methods 427

TdxDBMemo Events 428

TCustomdxDBDateEdit 429

TCustomdxDBDateEdit Properties 430

TCustomdxDBDateEdit Methods 432

TCustomdxDBDateEdit Events 434

TdxDBDateEdit 435

TdxDBDateEdit Properties 437

TdxDBDateEdit Methods 438

TdxDBDateEdit Events 439

TCustomdxDBButtonEdit 440

TCustomdxDBButtonEdit Properties 441

TCustomdxDBButtonEdit Methods 443

TCustomdxDBButtonEdit Events 445

TdxDBButtonEdit 446

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 13

TdxDBButtonEdit Properties 447

TdxDBButtonEdit Methods 448

TdxDBButtonEdit Events 449

TCustomdxDBCheckEdit 450

TCustomdxDBCheckEdit Properties 451

TCustomdxDBCheckEdit Methods 453

TCustomdxDBCheckEdit Events 454

TdxDBCheckEdit 455

TdxDBCheckEdit Properties 456

TdxDBCheckEdit Methods 457

TdxDBCheckEdit Events 458

TCustomdxDBImageEdit 459

TCustomdxDBImageEdit Properties 460

TCustomdxDBImageEdit Methods 462

TCustomdxDBImageEdit Events 464

TdxDBImageEdit 465

TdxDBImageEdit Properties 466

TdxDBImageEdit Methods 467

TdxDBImageEdit Events 468

TCustomdxDBSpinEdit 469

TCustomdxDBSpinEdit Properties 470

TCustomdxDBSpinEdit Methods 472

TCustomdxDBSpinEdit Events 474

TdxDBSpinEdit 475

TdxDBSpinEdit Properties 476

TdxDBSpinEdit Methods 477

TdxDBSpinEdit Events 478


ExpressEditors&DBEditors by Developer Express
14 Table of Contents
TCustomdxDBPickEdit 479

TCustomdxDBPickEdit Properties 480

TCustomdxDBPickEdit Methods 482

TCustomdxDBPickEdit Events 484

TdxDBPickEdit 485

TdxDBPickEdit Properties 486

TdxDBPickEdit Methods 487

TdxDBPickEdit Events 488

TCustomdxDBCalcEdit 489

TCustomdxDBCalcEdit Properties 490

TCustomdxDBCalcEdit Methods 492

TCustomdxDBCalcEdit Events 494

TdxDBCalcEdit 495

TdxDBCalcEdit Properties 496

TdxDBCalcEdit Methods 497

TdxDBCalcEdit Events 498

TCustomdxDBHyperLinkEdit 499

TCustomdxDBHyperLinkEdit Properties 500

TCustomdxDBHyperLinkEdit Methods 502

TCustomdxDBHyperLinkEdit Events 503

TdxDBHyperLinkEdit 504

TdxDBHyperLinkEdit Properties 505

TdxDBHyperLinkEdit Methods 506

TdxDBHyperLinkEdit Events 507

TCustomdxDBTimeEdit 508

TCustomdxDBTimeEdit Properties 509

TCustomdxDBTimeEdit Methods 511

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 15

TCustomdxDBTimeEdit Events 513

TdxDBTimeEdit 514

TdxDBTimeEdit Properties 515

TdxDBTimeEdit Methods 516

TdxDBTimeEdit Events 517

TCustomdxDBCurrencyEdit 518

TCustomdxDBCurrencyEdit Properties 519

TCustomdxDBCurrencyEdit Methods 521

TCustomdxDBCurrencyEdit Events 523

TdxDBCurrencyEdit 524

TdxDBCurrencyEdit Properties 525

TdxDBCurrencyEdit Methods 526

TdxDBCurrencyEdit Events 527

TCustomdxDBGraphicEdit 528

TCustomdxDBGraphicEdit Properties 529

TCustomdxDBGraphicEdit Methods 530

TCustomdxDBGraphicEdit Events 531

TdxDBGraphicEdit 532

TdxDBGraphicEdit Properties 533

TdxDBGraphicEdit Methods 534

TdxDBGraphicEdit Events 535

TCustomdxDBLookupEdit 536

TCustomdxDBLookupEdit Properties 537

TCustomdxDBLookupEdit Methods 539

TCustomdxDBLookupEdit Events 541

TdxDBLookupEdit 542

TdxDBLookupEdit Properties 543


ExpressEditors&DBEditors by Developer Express
16 Table of Contents
TdxDBLookupEdit Methods 544

TdxDBLookupEdit Events 545

TCustomdxDBBlobEdit 546

TCustomdxDBBlobEdit Properties 547

TCustomdxDBBlobEdit Methods 549

TCustomdxDBBlobEdit Events 551

TdxDBBlobEdit 552

TdxDBBlobEdit Properties 553

TdxDBBlobEdit Methods 554

TdxDBBlobEdit Events 555

TCustomdxDBMRUEdit 556

TCustomdxDBMRUEdit Properties 557

TCustomdxDBMRUEdit Methods 559

TCustomdxDBMRUEdit Events 561

TdxDBMRUEdit 562

TdxDBMRUEdit Properties 564

TdxDBMRUEdit Methods 565

TdxDBMRUEdit Events 566

TCustomdxDBPopupEdit 567

TCustomdxDBPopupEdit Properties 568

TCustomdxDBPopupEdit Methods 570

TCustomdxDBPopupEdit Events 572

TdxDBPopupEdit 573

TdxDBPopupEdit Properties 574

TdxDBPopupEdit Methods 575

TdxDBPopupEdit Events 576

TdxInplaceExtLookupEdit 577

Copyright © 2000 Developer Express Inc. www.devexpress.com


ExpressEditors&DBEditors 17

TdxInplaceExtLookupEdit Properties 578

TdxInplaceExtLookupEdit Methods 581

TdxInplaceExtLookupEdit Events 582

TCustomdxDBExtLookupEdit 583

TCustomdxDBExtLookupEdit Properties 584

TCustomdxDBExtLookupEdit Methods 586

TCustomdxDBExtLookupEdit Events 588

TdxDBExtLookupEdit 589

TdxDBExtLookupEdit Properties 591

TdxDBExtLookupEdit Methods 592

TdxDBExtLookupEdit Events 593

Index 594

ExpressEditors&DBEditors by Developer Express


18 TdxStyleController

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


Links property 19

TdxStyleController Properties
Links protected / read only

Links property read only


Contains a list of objects linked to the current style controller.

property Links: TList;

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

ExpressEditors&DBEditors by Developer Express


20 TdxStyleController Methods

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.

procedure AddLink(ALink: TObject); virtual;

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.

Note: It is best to use the StyleController property of TdxEditStyleController.

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;

Copyright © 2000 Developer Express Inc. www.devexpress.com


EndUpdate method 21

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.

procedure RemoveLink(ALink: TObject); virtual;

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.

procedure StyleChanged(ALink: TObject); virtual;

ExpressEditors&DBEditors by Developer Express


22 TdxStyleController Methods

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnStyleChanged event 23

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

ExpressEditors&DBEditors by Developer Express


24 TdxEditStyleController

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


BorderColor property 25

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

BorderColor property read / write


Specifies border color for all editors connected to the current style controller.

property BorderColor: TColor;

Description
Use the BorderColor property to read or set the border color property for all linked editors.

The default value is clWindowFrame.

See Also
TdxEditStyle.BorderColor; TdxEditStyleController.BorderStyle

BorderStyle property read / write


Specifies border style for all editors connected to a style controller.

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:

Value Description Example


xbsNone No visible border.

xbsSingle Single-line border.

xbsThick Single-line border with a thick line.

xbsFlat Flat border with a light 3D effect.

ExpressEditors&DBEditors by Developer Express


26 TdxEditStyleController Properties

xbs3D Standard border with a 3D effect.

See Also
TdxEditStyle.BorderStyle; TdxEditStyleController.BorderColor

ButtonStyle property read / write


Specifies button style for all editors connected to a style controller.

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:

Value Description Example


btsDefault Default button style.

bts3D Standard button with a 3D effect.

btsFlat Flat button with a light 3D effect.

btsSimple Simple button without a 3D effect and with a transparent


border.

btsHotFlat Flat button without a 3D effect and with a single-line


border.

See Also
TdxEditStyle.ButtonStyle; TdxEditStyleController.ButtonTransparence

ButtonTransparence property read / write


Specifies button transparency for all editors connected to the current style controller.

type
TdxEditButtonTransparence = (ebtNone, ebtInactive, ebtAlways,
ebtHideInactive);
property ButtonTransparence: TdxEditButtonTransparence;

Copyright © 2000 Developer Express Inc. www.devexpress.com


Edges property 27

Description
Use the ButtonTransparence property to read or set button transparency for all linked editors.
Available values include:

Value Description Active Inactive


ebtNone A button is not transparent.

ebtInactive A button is transparent only


when inactive.

ebtAlways A button is always


transparent.

ebtHideInactive A button is invisible when


inactive.

See Also
TdxEditStyle.ButtonTransparence; TdxEditStyleController.ButtonStyle

Edges property read / write


Specifies the border edge for all linked editors.

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:

Value Description Example


edgLeft True The leftmost border edge is visible.

False The leftmost border edge is invisible.

edgTop True The topmost border edge is visible.

False The top border edge is invisible.

edgRight True The rightmost border edge is visible.

False The rightmost border edge is


invisible.
edgBottom True The bottom border edge is visible.

False The bottom border edge is invisible.

ExpressEditors&DBEditors by Developer Express


28 TdxEditStyleController Properties

See Also
TdxEditStyle.Edges

HotTrack property read / write


Specifies whether an editor is highlighted when the mouse is placed over it.

property HotTrack: Boolean;

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

The default value is False .

See Also
TdxEditStyle.HotTrack

Shadow property read / write


Specifies whether to display a shadow for all linked editors.

property Shadow: Boolean;

Description
Set the Shadow property to True to display a shadow for all editors connected to the current style
controller.

Value Example
True

False

The default value is False .

See Also
TdxEditStyle.Shadow

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnStyleChanged event 29

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.

ExpressEditors&DBEditors by Developer Express


30 TdxEditStyle

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


Edit property 31

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

Edit property read only


Determines the editor associated with an edit style.

property Edit: TdxInplaceEdit;

Description
The Edit property determines the editor connected to the current edit style.

See Also
TdxInplaceEdit

AssignedValues property read / write


Specifies which properties are assigned to an editor.

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.

ExpressEditors&DBEditors by Developer Express


32

See Also
TdxEditStyle.BorderColor; TdxEditStyle_BorderStyle; TdxEditStyle_ButtonStyle;
TdxEditStyle.ButtonTransparence; TdxEditStyle.Edges; TdxEditStyle.HotTrack;
TdxEditStyle.Shadow

BorderColor property read / write


Specifies the border color of an editor.

property BorderColor: TColor;

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

BorderStyle property read / write


Specifies the border style of an editor.

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:

Value Description Example


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

Copyright © 2000 Developer Express Inc. www.devexpress.com


ButtonStyle property 33

ButtonStyle property read / write


Specifies the button style of an editor.

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:

Value Description Example


btsDefault Default button style.

bts3D Standard button with a 3D effect.

btsFlat Flat button with a light 3D effect.

btsSimple Simple button without a 3D effect and


with a transparent border.

btsHotFlat Flat button without a 3D effect and with a


single-line border.

See Also
TdxEditStyleController.ButtonStyle

ButtonTransparence property read / write


Specifies the button transparency of an editor.

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:

Value Description Active Inactive


ebtNone A button is not
transparent.

ExpressEditors&DBEditors by Developer Express


34

ebtInactive A button is
transparent only
when inactive.
ebtAlways A button is always
transparent.

ebtHideInactive A button is invisible


when inactive.

See Also
TdxEditStyleController.ButtonTransparence

Edges property read / write


Specifies the displayed edges of an editor.

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:

Value Description Example


edgLeft True The leftmost border edge is visible.

False The leftmost border edge is invisible.

edgTop True The topmost border edge is visible.

False The topmost border edge is invisible.

edgRight True The rightmost border edge is visible.

False The rightmost border edge is


invisible.
edgBottom True The bottom border edge is visible.

False The bottom border edge is invisible.

See Also
TdxEditStyleController.Edges

HotTrack property read / write


Specifies whether an editor item is highlighted when the mouse is placed over it.

property HotTrack: Boolean;

Copyright © 2000 Developer Express Inc. www.devexpress.com


Shadow property 35

Description
Set the HotTrack property to True to highlight an editor in response to mouse movements.

Value Example
True

False

See Also
TdxEditStyleController.HotTrack

Shadow property read / write


Specifies whether to display a shadow for an editor.

property Shadow: Boolean;

Description
Set the Shadow property to True to provide a shadow effect for an editor.

Value Example
True

False

The default value is False .

See Also
TdxEditStyleController.Shadow

ExpressEditors&DBEditors by Developer Express


36 TdxEditStyle Methods

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.

procedure Changed; virtual;

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.

function EditStyleController: TdxEditStyleController;

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.

constructor Create(AEdit: TdxInplaceEdit);

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


Destroy method 37

Destroy method
Destroys an instance of the TdxEditStyle object.

destructor Destroy; override;

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.

procedure Assign(Source: TPersistent); override;

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);

This forces Destination to copy the contents of Source to itself.

DefaultBorderColor method
Specifies the default color of an editor border.

function DefaultBorderColor: TColor; virtual;

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;

ExpressEditors&DBEditors by Developer Express


38 TdxEditStyle Methods

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:

Value Description Example


xbs3D Standard border with a 3D effect.

xbsNone No visible border.

xbsSingle Single-line border.

xbsThick Single-line border with a thick line.

xbsFlat Flat border with a light 3D effect.

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:

Value Description Example


btsDefault Default button style.

bts3D Standard button with a 3D effect.

btsFlat Flat button with a light 3D effect.

btsSimple Simple button without a 3D effect and with


a transparent border.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DefaultButtonTransparence method 39

btsHotFlat Flat button without a 3D effect and with a


single-line border.

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:

Value Description Active Inactive


ebtNone A button is not
transparent.

ebtInactive A button is
transparent only
when inactive.
ebtAlways A button is always
transparent.

ebtHideInactive A button is invisible


when inactive.

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;

ExpressEditors&DBEditors by Developer Express


40 TdxEditStyle Methods

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:

Value Description Example


edgLeft True The leftmost border edge is visible.

False The leftmost border edge is invisible.

edgTop True The topmost border edge is visible.

False The topmost border edge is invisible.

edgRight True The rightmost border edge is visible.

False The rightmost border edge is


invisible.
edgBottom True The bottom border edge is visible.

False The bottom border edge is invisible.

See Also
TdxEditStyle.Edges

DefaultHotTrack method
Returns the default value of the HotTrack property.

function DefaultHotTrack: Boolean; virtual;

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.

function DefaultShadow: Boolean; virtual;

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 ).

Copyright © 2000 Developer Express Inc. www.devexpress.com


GetDefaultEditStyleController method 41

Value Example
False

True

See Also
TdxEditStyle.Shadow

GetDefaultEditStyleController method
Returns the default style controller.

class function GetDefaultEditStyleController: TdxEditStyleController;


virtual;

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.

procedure RestoreDefaults; virtual;

Description
The RestoreDefaults method removes the current values of the style properties of an editor and
restores their default values.

ExpressEditors&DBEditors by Developer Express


42 TdxEditDataDefinition

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DisplayValue property 43

TdxEditDataDefinition Properties
DisplayValue public / read only
EditValue public / read only

DisplayValue property read only


Contains the value which is displayed within a data-aware editor.

property DisplayValue: Variant;

Description
The DisplayValue property contains the value to display.
Specifies the manner in which text is aligned within an editor.

property Alignment: TAlignment;

EditValue property read only


Contains the value which is being edited within a data-aware editor.

property EditValue: Variant;

Description
The EditValue property contains the value to edit.

ExpressEditors&DBEditors by Developer Express


44 TdxEditDataDefinition Methods

TdxEditDataDefinition Methods
GetEditValue protected
SetEditValue protected

GetEditValue method
Returns the edited value of a data-aware editor.

function GetEditValue: Variant; virtual;

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.

procedure SetEditValue(const Value: Variant); virtual;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnActiveChange event 45

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.

ExpressEditors&DBEditors by Developer Express


46 TdxInplaceEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


Alignment property 47

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

Alignment property read / write


Specifies the manner in which text is aligned within an editor.

property Alignment: TAlignment;

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.

Value Meaning Example


taLeftJustify Text is left justified: all lines begin at the left
edge of an editor.
taCenter Text is centered within an editor.

taRightJustify Text is right justified: all lines end at the


right edge of an editor.

AutoSize property read / write


Determines whether an editor's auto size is enabled.

property AutoSize: Boolean;

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.

False An editor cannot change its height.

ExpressEditors&DBEditors by Developer Express


48 TdxInplaceEdit Properties

Container property read only


Refers to the TCustomdxContainer control applied to an editor as a container.

property Container : TCustomdxContainer;

Description
The Container property specifies the associated container for an editor if the IsInplace property is
True; Otherwise nil.

See Also
TCustomdxContainer

Height property read / write


Specifies the vertical size of an editor in pixels.

property Height;

Description
Use the Height property to read or change the height of an editor.

Modified property read / write


Determines whether the editor’s contents are modified.

property Modified: Boolean;

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.

ReadOnly property read / write


Indicates whether an editor is used for display purposes only or whether users can edit data within it.

property ReadOnly : Boolean;

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.

StoredValues property read only


Contains a list of stored values that describe the look & feel and functionality of an editor.

type

Copyright © 2000 Developer Express Inc. www.devexpress.com


Style property 49

TdxEditStoredValue = (svAlignment, svEditLimit, svEditMask, svIsFloat,


svMaxValue, svMinValue, svReadOnly, svRequired, svDisplayFormat);
TdxEditStoredValues = set of TdxEditStoredValue;
property StoredValues: TdxEditStoredValues;

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.

Style property read / write


Contains a set of properties that define the appearance of an editor.

property Style: TdxEditStyle;

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

StyleController property read / write


Specifies the style controller linked to an editor.

property StyleController: TdxEditStyleController;

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.

ExpressEditors&DBEditors by Developer Express


50 TdxInplaceEdit Properties

See Also
TdxEditStyleController

Copyright © 2000 Developer Express Inc. www.devexpress.com


CanModify method 51

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.

function CanModify: Boolean; virtual;

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.

procedure Deselect; virtual;

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.

function IsEditClass: Boolean; virtual;

ExpressEditors&DBEditors by Developer Express


52 TdxInplaceEdit Methods

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.

procedure RestoreDefaults; virtual;

Description
The RestoreDefaults method resets all properties specified via the StoredValues property to default
values.

SelectAll method
Selects all text within an editor.

procedure SelectAll; virtual;

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.

procedure ValidateEdit; virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


53

ExpressEditors&DBEditors by Developer Express


54 TdxInplaceEdit Events

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


55

TdxEditValidateEvent = procedure (Sender: TObject; var ErrorText: string;


var Accept: Boolean) of object;
property OnValidate: TdxEditValidateEvent;

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.

ExpressEditors&DBEditors by Developer Express


56 TdxInplacePopupControl

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


OwnerControl property 57

TdxInplacePopupControl Properties
OwnerControl public / read / write Shadow public / read / write
PopupBorderStyle public / read / write ShadowSize public / read / write

OwnerControl property 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

PopupBorderStyle property read / write


Specifies the border style of a dropdown window.

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.

The default value of the border style is pbSingle.

Shadow property read / write


Specifies whether to display a shadow.

property Shadow: Boolean;

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.

ExpressEditors&DBEditors by Developer Express


58 TdxInplacePopupControl Properties

The default value is False .


ShadowSize property read / write
Specifies shadow size.

property ShadowSize: Integer;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


HidePopup method 59

TdxInpacePopupControl Methods
HidePopup public
ShowPopup public

HidePopup method
Hides the active dropdown window.

procedure HidePopup(ByMouse: Boolean); virtual;

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.

procedure ShowPopup; virtual;

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

ExpressEditors&DBEditors by Developer Express


60 TdxInplaceTextEdit

TdxInplaceTextEdit
TdxInplaceTextEdit is an editor with text editing capabilities.

Unit
dxEditor

TdxInplaceTextEdit = class(TdxInplaceEdit, IUnknown, IRichEditOleCallback);

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


AutoSelect property 61

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

AutoSelect property read / write


Determines whether the entire text string is automatically selected when an editor receives focus.

property AutoSelect : Boolean;

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.

By default, the AutoSelect property is set to True for TdxInplaceTextEdit.

CanPaste property read only


Indicates whether a user can paste Clipboard contents into an editor.

property CanPaste: Boolean;

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

CanRedo property read only


Indicates whether cancelled operations exist within the current.

ExpressEditors&DBEditors by Developer Express


62 TdxInplaceTextEdit Properties
property CanRedo: Boolean;

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

CanUndo property read only


Indicates whether there are any completed operations that can be undone within the current editor.

property CanUndo: Boolean;

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

CharCase property read / write


Determines text case within an editor.

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


HideSelection property 63

By default, the CharCase property for TdxInplaceTextEdit is set to ecNormal.

See Also
TdxInplaceEdit.GetDefaultCharCase; TdxInplaceTextEdit.Text

HideSelection property read / write


Specifies whether text remains selected when focus moves to another control.

property HideSelection : Boolean;

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

MaxLength property read / write


Determines the maximum number of characters a user can enter within an editor.

property MaxLength : Integer;

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

OEMConvert property read / write


Determines whether the characters typed in an editor are converted from ANSI to OEM and then back
to ANSI.

ExpressEditors&DBEditors by Developer Express


64 TdxInplaceTextEdit Properties

property OEMConvert : Boolean;

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.

By default, the OEMConvert property for TdxInplaceTextEdit is set to False .

See Also
TdxInplaceTextEdit.Text

PasswordChar property read / write


Indicates the character to display instead of the actual text typed within an editor.

property PasswordChar : Char;

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.

By default, the PasswordChar property for TdxInplaceTextEdit is set to a null.

SelectionBar property read / write


Specifies whether the edited text is indented within an editor.

property SelectionBar: Boolean;

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).

SelLength property read / write


Determines the number of selected characters.

Copyright © 2000 Developer Express Inc. www.devexpress.com


SelStart property 65

property SelLength : Integer;

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

SelStart property read / write


Determines the position of the first selected character.

property SelStart : Integer;

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

SelText property read / write


Determines the selected portion of text within an editor.

property SelText : string;

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

Text property read / write


Contains the currently displayed text string within an editor.

ExpressEditors&DBEditors by Developer Express


66 TdxInplaceTextEdit Properties
property 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

Copyright © 2000 Developer Express Inc. www.devexpress.com


CheckCharCase method 67

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

CheckCharCase method
Checks the char case of the edited text within a text editor.

procedure CheckCharCase; virtual;

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.

ExpressEditors&DBEditors by Developer Express


68 TdxInplaceTextEdit Methods

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DefaultMaxLength method 69

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.

function DefaultMaxLength: Integer, virtual;

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.

procedure Deselect; override;

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.

procedure DoSetMaxLength(Value: Integer); virtual;

ExpressEditors&DBEditors by Developer Express


70 TdxInplaceTextEdit Methods

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.

function GetSelection: TCharRange;

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.

function GetSelLength: Integer; virtual;

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.

function GetSelStart: Integer; virtual;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


GetSelText method 71

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.

function GetSelText: string; virtual;

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.

function GetSelTextBuf(Buffer: PChar; BufSize: Integer): Integer; virtual;

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.

function GetTextLenEx: Integer;

Description
Call the GetTextLenEx method to determine the length of the underlying text for an editor.

See Also
TdxInplaceTextEdit.Text

ExpressEditors&DBEditors by Developer Express


72 TdxInplaceTextEdit Methods

IsEditClass method
Determines whether an editor belongs to the EDIT window class.

function IsEditClass: Boolean; virtual;

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.

procedure RestoreDefaults; override;

Copyright © 2000 Developer Express Inc. www.devexpress.com


SelectAll method 73

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.

procedure SelectAll; override;

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.

procedure SelectionChange; virtual;

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.

procedure SetEditMaxLength(Value: Integer); virtual;

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

ExpressEditors&DBEditors by Developer Express


74 TdxInplaceTextEdit Methods

SetSelection method
Selects a portion of text within an editor.

procedure SetSelection(StartPos, EndPos: Longint; ScrollCaret: Boolean);

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.

procedure SetSelLength(Value: Integer); virtual;

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.

procedure SetSelStart(Value: Integer); virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


SetSelTextBuf method 75

SetSelTextBuf method
Replaces the selected text with a null-terminated string.

procedure SetSelTextBuf(Buffer: PChar);

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

ExpressEditors&DBEditors by Developer Express


76 TdxInplaceTextEdit Events

TdxInplaceTextEdit Events
TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

OnSelectionChange event
Occurs when a cursor changes its location within an editor.

property OnSelectionChange: TNotifyEvent;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


77

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

ExpressEditors&DBEditors by Developer Express


78 TdxInplaceMaskEdit Properties

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

EditMask property read / write


Specifies the mask that enforces the entry of valid text for a mask editor.

property EditMask : string;

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

EditText property read / write


Specifies the text displayed within a mask editor.

property EditText : string;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


IgnoreMaskBlank property 79

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.

Note: RunTime property.

See Also
TdxInplaceMaskEdit.EditMask; TdxInplaceMaskEdit.Text

IgnoreMaskBlank property read / write


Used internally to determine the method used to validate entered text.

property IgnoreMaskBlank: Boolean;

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

IsMasked property read only


Indicates whether a mask exists for a mask editor.

property IsMasked : Boolean;

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

Text property read / write


Represents the underlying text for a mask editor before a mask is applied.

property Text : string;

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:

ExpressEditors&DBEditors by Developer Express


80 TdxInplaceMaskEdit Properties

- the mask specifies that literal characters should be removed,


- the mask includes spaces,
- the mask includes characters that have not yet been filled in by a user.

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

MaskState property read / write


Specifies the manner in which a mask is applied.

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


CheckCursor method 81

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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

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.

ExpressEditors&DBEditors by Developer Express


82 TdxInplaceMaskEdit Methods

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.

function DefaultEditMask: string; virtual;

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.

function DefaultMaxLength: Integer; override;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


GetBlankText method 83

GetBlankText method
Replaces every non-mask character of edited text with a blank.

function GetBlankText: string;

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.

function GetDisableCloseEditor: Boolean; override;

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.

function GetEditingText: string; override;

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.

function GetFirstEditChar: Integer;

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.

ExpressEditors&DBEditors by Developer Express


84 TdxInplaceMaskEdit Methods

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.

function GetLastEditChar: Integer;

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.

function GetMaxChars: Integer;

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.

function GetNextEditChar(Offset: Integer): Integer;

Copyright © 2000 Developer Express Inc. www.devexpress.com


GetPriorEditChar method 85

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.

function GetPriorEditChar(Offset: Integer): Integer;

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.

procedure GetSel(var SelStart: Integer; var SelStop: Integer); virtual;

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

ExpressEditors&DBEditors by Developer Express


86 TdxInplaceMaskEdit Methods

GetTextLen method
Returns the length of the underlying text.

function GetTextLen: Integer;

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.

procedure ReformatText(const NewMask: string);

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.

procedure SetCursor(Pos: Integer);

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


ValidateEdit method 87

procedure SetSel(SelStart: Integer; SelStop: Integer);

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.

procedure ValidateEdit; override;

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

ExpressEditors&DBEditors by Developer Express


88 TdxInplaceMaskEdit Events

TdxInplaceMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


89

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

ExpressEditors&DBEditors by Developer Express


90 TdxInplaceMemoEdit Properties

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

Derived from TdxInplaceTextEdit


AutoSelect protected / read / write OEMConvert protected / read / write
CanPaste public / read only PasswordChar protected / read / write
CanRedo public / read only SelLength public / read / write
CanUndo public / read only SelStart public / read / write
CharCase protected / read / write SelText public / read / write
HideSelection protected / read / write Text public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
Container protected / read / write StoredValues protected / read / write
Height published / read / write Style public / read / write
Modified public / read / write StyleController protected / read / write

AutoSize property read / write


Specifies whether a control automatically sizes itself to display all its contents.

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.

The default value is False .

HideScrollBars property read / write


Determines whether a TdxInplaceMemoEdit object displays scroll bars.

property HideScrollBars: Boolean;

Description
If the HideScrollBars property is set to False , the TdxInplaceMemoEdit object displays scroll bars.

The default value is True.

Copyright © 2000 Developer Express Inc. www.devexpress.com


Lines property 91

See Also
TdxInplaceMemoEdit.ScrollBars

Lines property read / write


Contains the text lines in a memo control.

property Lines: TStrings;

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

ScrollBars property read / write


Determines whether a TdxInplaceMemoEdit object uses scroll bars.

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.

The default value is ssNone.

See Also
TdxInplaceMemoEdit.HideScrollBars

SelectionBar property read / write


Specifies whether the selection bar is displayed at the leftmost edge of a memo editor.

property SelectionBar;

ExpressEditors&DBEditors by Developer Express


92 TdxInplaceMemoEdit Properties

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.

The default value is True.

See Also
TdxInplaceTextEdit.SelectionBar

WantReturns property read / write


Determines whether a user can insert carriage returns into text.

property WantReturns: Boolean;

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.

The default value is True.

See Also
TdxInplaceMemoEdit.WantTabs; TdxInplaceMemoEdit.WordWrap; TdxInplaceTextEdit.Text

WantTabs property read / write


Determines whether a user can insert tab characters in text.

property WantTabs: Boolean;

Description
Setting the WantTabs property to True enables users to enter tab characters in text.

The default value is False .

See Also
TdxInplaceMemoEdit.WantReturns; TdxInplaceMemoEdit.WordWrap; TdxInplaceTextEdit.Text

WordWrap property read / write


Determines whether a memo editor wraps words at the right margin.

property WordWrap: Boolean;

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 93

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.

The default value is True.

See Also
TdxInplaceMemoEdit.IsWordWrap; TdxInplaceMemoEdit.Lines; TdxInplaceMemoEdit.ScrollBars;
TdxInplaceMemoEdit.WantReturns; TdxInplaceTextEdit.Text

ExpressEditors&DBEditors by Developer Express


94 TdxInplaceMemoEdit Methods

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 95

TdxInplaceMemoEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


96 TdxInplaceDropDownEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


ButtonGlyph property 97

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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ButtonGlyph property read / write


Specifies button glyph.

property ButtonGlyph: TBitmap;

Description
Determines the glyph used for a command button within an editor.

DropDownRows property read / write


Specifies the number of rows in a dropdown control.

property DropDownRows: Integer;

ExpressEditors&DBEditors by Developer Express


98 TdxInplaceDropDownEdit Properties

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

DropDownWidth property read / write


Specifies the width of a dropdown window.

property DropDownWidth: Integer;

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

DroppedDown property read / write


Specifies whether a dropdown window is displayed.

property DroppedDown: Boolean;

Description
Determines whether a dropdown control associated with an editor is activated.

See Also
TdxInplaceDropDownEdit.DropDownWidth

ImmediateDropDown property read / write


Determines whether a dropdown window is immediately displayed after pressing a key.

property ImmediateDropDown: Boolean;

Description
If the ImmediateDropDown property is set to True, a dropdown window is activated immediately after
pressing a key whenever the editor has focus.

The default value is True.

See Also
TdxInplaceDropDownEdit.ImmediatePopup

Copyright © 2000 Developer Express Inc. www.devexpress.com


ImmediatePopup property 99

ImmediatePopup property read / write


Determines whether a dropdown window is immediately displayed after a mouse click event.

property ImmediatePopup: Boolean;

Description
If the ImmediatePopup property is set to False , a single mouse click within the boundaries of the editor
activates the dropdown window.

The default value is False .

See Also
TdxInplaceDropDownEdit.ImmediateDropDown

PopupAlignment property read / write


Specifies the manner in which a dropdown window is aligned relative to an editor.

property PopupAlignment: TAlignment;

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.

The default value is taLeftJustify.

See Also
TdxInplaceDropDownEdit.ImmediatePopup; TdxInplaceDropDownEdit.PopupBorder;
TdxInplaceDropDownEdit.PopupBorderStyle)

PopupBorder property read / write


Determines the border style of a dropdown window.

type
TdxPopupBorder = (pbDefault, pbSingle, pbFrame3D, pbFlat);
property PopupBorder: TdxPopupBorder;

Description
Determines the border style of a dropdown control. Possible values include:

ExpressEditors&DBEditors by Developer Express


100 TdxInplaceDropDownEdit Properties

Values Description Example


pbDefault Default border style.

pbSingle Single border style.

pbFrame3D 3D border style.

pbFlat Light 3D border style.

The default value is pbDefault.

See Also
TdxInplaceDropDownEdit.PopupBorderStyle

Copyright © 2000 Developer Express Inc. www.devexpress.com


DoButtonDown method 101

TdxInplaceDropDownEdit Methods
TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

DoButtonDown method

procedure DoButtonDown(IsDown: Boolean; Index: Integer); virtual;

ExpressEditors&DBEditors by Developer Express


102 TdxInplaceDropDownEdit Methods

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

procedure DoButtonUp(Index: Integer); virtual;

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.

procedure DoCloseUp(var Value: string; var Accept: Boolean); virtual;

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.

procedure DoDropDownKeys(var Key: Word; Shift: TShiftState); virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DropDown method 103

DropDown method

procedure DropDown; virtual;

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

procedure FindListValue(const Value : String); virtual;

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

ExpressEditors&DBEditors by Developer Express


104 TdxInplaceDropDownEdit E vents

TdxInplaceDropDownEdit Events
TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate 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.

property OnEditButtonClick: TNotifyEvent;

Description
Write an OnEditButtonClick event handler to perform specific actions when a user presses an edit
button within an editor.

Copyright © 2000 Developer Express Inc. www.devexpress.com


105

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

ExpressEditors&DBEditors by Developer Express


106 TdxInplaceDateEdit Properties

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Date property read / write


Determines the currently displayed date value.

property Date: TDateTime;

Description
Use the Date property to set or return date.

See Also
TdxInplaceDateEdit.DateChange

Copyright © 2000 Developer Express Inc. www.devexpress.com


DateButtons property 107

DateButtons property read / write


Specifies the buttons to display within the dropdown window of an editor.

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

DateOnError property read / write


Determines the date to be assigned to an editor in case of invalid date input.

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

DateValidation property read / write


Specifies whether input date requires validation.

property DateValidation: Boolean;

ExpressEditors&DBEditors by Developer Express


108 TdxInplaceDateEdit Properties

Description
If the DateValidation property is set to True, the date is validated during entry. Otherwise. It is not.

See Also
TdxInplaceDateEdit.DoValidateInput

SaveTime property read / write


Specifies whether time is stored in the editor.

property SaveTime: Boolean;

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.

UseEditMask property read / write


Specifies whether a date editor uses a predefined mask to validate date input.

property UseEditMask: Boolean;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DateChange method 109

TdxInplaceDateEdit Methods
TdxInplaceDateEdit
DateChange protected DoValidateInput protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

DateChange method

procedure DateChange(Sender: TObject);

ExpressEditors&DBEditors by Developer Express


110 TdxInplaceDateEdit Methods

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.

procedure DoValidateInput(const AText: string; var ADate: TDateTime; var


AMessage: string; var AError: Boolean); virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnDateChange event 111

TdxInplaceDateEdit Events
TdxInplaceDateEdit
OnDateChange protected OnDateValidateInput protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

OnDateChange event
Occurs when changing the date within a date editor.

property OnDateChange: TNotifyEvent;

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

ExpressEditors&DBEditors by Developer Express


112 TdxInplaceButtonEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


Buttons property 113

TdxInplaceButtonEdit Properties
TdxInplaceButtonEdit
Buttons protected / read / write ViewStyle protected / read / write
ClickKey protected / read / write

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / w rite
IgnoreMaskBlank protected / read / write Text public / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Buttons property read / write


Determines a collection of buttons.

property Buttons: TdxEditButtons;

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.

ClickKey property read / write


Specifies the key combination users can enter to quickly access an edit button's functionality.

ExpressEditors&DBEditors by Developer Express


114 TdxInplaceButtonEdit Properties

property ClickKey: TShortCut;

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.

ViewStyle property read / write


Determines the appearance of a specific button editor.

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:

Value Description Example


vsStandard Text within an editor can be modified.

vsHideCursor Text within an editor cannot be modified.

vsButtonOnly There is no text within an editor, only buttons.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DefaultButtonClick method 115

TdxInplaceButtonEdit Methods
TdxInplaceButtonEdit
DefaultButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

DefaultButtonClick method
Determines the index of the default button.

ExpressEditors&DBEditors by Developer Express


116 TdxInplaceButtonEdit Methods
procedure DefaultButtonClick; virtual;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnButtonClick event 117

TdxInplaceButtonEdit Events
TdxInplaceButtonEdit
OnButtonClick protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate 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.

ExpressEditors&DBEditors by Developer Express


118 TdxCheckEditStyleController

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


BorderStyle property 119

TdxCheckEditStyleController Properties
BorderStyle published / read / write
ButtonStyle published / read / write

BorderStyle property read / write


Specifies the border style for all check editors connected to a style controller.

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.

By default, the ButtonStyle property is xbsNone.

See Also
TdxEditStyleController.BorderStyle

ButtonStyle property read / write


Specifies the button style for all check editors connected to a style controller.

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

ExpressEditors&DBEditors by Developer Express


120 TdxCheckEditStyleController Properties

btsDefault Default button style.


bts3D Standard button with a 3D effect.
btsFlat Flat button with a light 3D effect.
btsSimple Simple button without a 3D effect and with a transparent border.
btsHotFlat Flat button without a 3D effect and with a single-line border.

By default, the ButtonStyle property is bts3D.

See Also
TdxEditStyleController.ButtonStyle

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 121

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

ExpressEditors&DBEditors by Developer Express


122 TdxInplaceCheckEdit Properties

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / w rite
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

AllowGrayed property read / write


Determines whether a check editor has two or three states.

property AllowGrayed: Boolean;

Description
Determines whether a check editor has two (checked, unchecked) or three (checked, unchecked and
grayed) states.

See Also
TdxInplaceCheckEdit.State

Checked property read / write


Specifies whether the check box within an editor is checked.

property Checked: Boolean;

Description
Use the Checked property to modfy the state of an editor.

See Also
TdxInplaceCheckEdit.State

FullFocusRect property read / write


Specifies the manner in which the rectangle is drawn around the caption region of a check editor.

property FullFocusRect: Boolean;

Copyright © 2000 Developer Express Inc. www.devexpress.com


Glyph property 123

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.

The default value of the FullFocusRect property is False .

Glyph property read / write


Determines the glyph displayed instead of the editor check box.

property Glyph: TBitmap;

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

GlyphCount property read / write


Specifies the manner in which an image is used to represent a check box.

property GlyphCount: Integer;

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.

When using this property, you should use 0, 3, or 6.

See Also
TdxInplaceCheckEdit.Glyph

ExpressEditors&DBEditors by Developer Express


124 TdxInplaceCheckEdit Properties

MultiLine property read / write


Determines whether the caption region of a check editor can include multiple lines.

property MultiLine: Boolean;

Description
If the MultiLine property is set to True, caption text can be displayed across multiple lines.

By default, MultiLine is False .

NullStyle property read / write


Determines the display style for the check box when the value of a check editor is null.

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.

The default value is nsGrayedChecked.

Note: This property is used when the AllowGrayed property is True.

State property read / write


Specifies the current state of a check edit control.

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 125

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.

cbsGrayed The check box is grayed.

The default value is cbsUnchecked.

See Also
TdxInplaceCheckEdit.AllowGrayed; TdxInplaceCheckEdit.Checked; TdxInplaceCheckEdit.Toggle

ExpressEditors&DBEditors by Developer Express


126 TdxInplaceCheckEdit Methods

TdxInplaceCheckEdit Methods
TdxInplaceCheckEdit
InvalidateCheckRect protected Toggle protected

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

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.

procedure Toggle; virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


127

TdxInplaceCheckEdit Events
Derived from TdxInplaceEdit
OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


128 TdxInplaceImageEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DefaultImages property 129

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DefaultImages property read / write


Specifies the manner in which image indexes are calculated in a dropdown items list.

property DefaultImages: Boolean;

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.

ExpressEditors&DBEditors by Developer Express


130 TdxInplaceImageEdit Properties

See Also
TdxInplaceImageEdit.ImageIndexes

Descriptions property read / write


Contains a list of image descriptions.

property Descriptions: TStrings;

Description
This property contains the list of descriptions associated with an image editor.

See Also
TdxInplaceImageEdit.ShowDescription

ImageIndexes property read / write


Contains a list of image indexes.

property ImageIndexes: TStrings;

Description
This property contains the list of image indexes associated with an image editor.

Images property read / write


Contains a list of images.

property Images: TImageList;

Description
This property contains the list of images associated with an image editor.

LargeImages property read / write


Contains a list of large images.

property LargeImages: TImageList;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


MultiLineText property 131

MultiLineText property read / write


Determines whether dropdown list text can include multiple lines.

property MultiLineText: Boolean;

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 .

ShowDescription property read / write


Specifies whether descriptions are displayed within an editor.

property ShowDescription: Boolean;

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

Values property read / write


Specifies the values that correspond to the dropdown window image items.

property Values: TStrings;

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.

ExpressEditors&DBEditors by Developer Express


132 TdxInplaceImageEdit Methods

TdxInplaceImageEdit Methods
Derived from TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 133

TdxInplaceImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


134 TdxInplaceSpinEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


EditorEnabled property 135

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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / w rite
Height published / read / write StyleController protected / read / write
Modified public / read / write

EditorEnabled property read / write


Determines whether an editor is enabled.

property EditorEnabled: Boolean;

Description
Use the EditorEnabled property to allow a user to modify data within a spin editor.

By default, the EditorEnabled property is True.

Increment property read / write


Containes the increment value.

property Increment: Double;

ExpressEditors&DBEditors by Developer Express


136 TdxInplaceSpinEdit Properties

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

IntValue property read / write


Represents the integer portion of the currently edited value.

property IntValue: Integer;

Description
Use the IntValue to obtain the integer portion of the edited value.

See Also
TdxInplaceSpinEdit.SetValue; TdxInplaceSpinEdit.Value; TdxInplaceSpinEdit.ValueType

MaxValue property read / write


Specifies the maximum value a user can set within a spin editor.

property MaxValue: Double;

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

MinValue property read / write


Specifies the minimum value a user can set within a spin editor.

property MinValue: Double;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


UseCtrlIncrement property 137

UseCtrlIncrement property read / write


Determines the manner in which keyboard keys are used to change an editor’s value.

property UseCtrlIncrement: Boolean;

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.

By default, the UseCtrlIncrement property is False .

See Also
TdxInplaceSpinEdit.GetIncrement; TdxInplaceSpinEdit.Increment

Value property read / write


Determines the currently edited value within a spin editor.

property Value: Double;

Description
Use the Value property to set or return the currently edited value.

See Also
TdxInplaceSpinEdit.GetValue; TdxInplaceSpinEdit.SetValue; TdxInplaceSpinEdit.ValueType

ValueType property read / write


Determines spin editor value type.

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

ExpressEditors&DBEditors by Developer Express


138 TdxInplaceSpinEdit Properties

Copyright © 2000 Developer Express Inc. www.devexpress.com


DefaultMaxValue method 139

TdxInplaceSpinEdit Methods
TdxInplaceSpinEdit
DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

DefaultMaxValue method
Limits the maximum value of a spin editor.

function DefaultMaxValue: Double; virtual;

ExpressEditors&DBEditors by Developer Express


140 TdxInplaceSpinEdit Methods

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.

function DefaultMinValue: Double; virtual;

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.

function GetIncrement: Double; virtual;

Copyright © 2000 Developer Express Inc. www.devexpress.com


GetValue method 141

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

function GetValue: Double; virtual;

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.

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

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

procedure SetEditMaxValue(Value: Double); virtual;

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

procedure SetEditMinValue(Value: Double); virtual;

Description
Sets a new minimum value for the MinValue property. The Value parameter specifies new data.

ExpressEditors&DBEditors by Developer Express


142 TdxInplaceSpinEdit Methods

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

procedure SetValue(Value: Double); virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


143

TdxInplaceSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


144 TdxInplacePickEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


CanDeleteText property 145

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

CanDeleteText property read / write


Specifies whether a user can delete the displayed value.

property CanDeleteText: Boolean;

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.

ExpressEditors&DBEditors by Developer Express


146 TdxInplacePickEdit Properties

The default value is False .

DropDownListStyle property read / write


Determines whether a user can edit data within a pick editor or can only select a value from the
dropdown list.

property DropDownListStyle: Boolean;

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.

The default value is False .

ItemIndex property read / write


Determines the index of the displayed item.

property ItemIndex: Integer;

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

Items property read / write


Contains the strings that appear in the dropdown list box of a pick editor.

property Items: TStrings;

Description
Use the Items property to add, insert, delete and move items.

See Also
TdxInplacePickEdit.ItemIndex

Revertable property read / write


Specifies whether a user can cycle through list values by double-clicking with the mouse.

property Revertable: Boolean;

Copyright © 2000 Developer Express Inc. www.devexpress.com


Sorted property 147

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.

The default value is False .

Sorted property read / write


Specifies whether list values are sorted.

property Sorted: Boolean;

Description
If the Sorted property is set to True, all values are sorted within a pick list.

The default value is False .

ExpressEditors&DBEditors by Developer Express


148 TdxInplacePickEdit Methods

TdxInplacePickEdit Methods
Derived from TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 149

TdxInplacePickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


150 TdxInplaceCalcEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


BeepOnError property 151

TdxInplaceCalcEdit Properties
TdxInplaceCalcEdit
BeepOnError protected / read / write QuickClose protected / read / write
ButtonStyle protected / read / write ShowButtonFrame protected / read / write
Precision protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

BeepOnError property read / write


Specifies whether a calculator beeps if an error occurs.

property BeepOnError: Boolean;

Description
The BeepOnError property value is used internally to determine whether a calculator beeps if an error
occurs.

By default, the BeepOnError property is True.

ExpressEditors&DBEditors by Developer Express


152 TdxInplaceCalcEdit Properties

ButtonStyle property read / write


Determines calculator button style.

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.

By default, this property value is equal to bsStandard.

Precision property read / write


Specifies calculation precision.

property Precision: Byte;

Description
Determines the total number of digits within a calculator editor. By default precision is 13.

QuickClose property read / write


Specifies alternate ways in which to close a dropdown calculator.

property QuickClose: Boolean;

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.

ShowButtonFrame property read / write


Determines whether buttons are drawn with an oval frame.

property ShowButtonFrame: Boolean;

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 153

Description
Determines whether an oval frame is drawn around each calculator button. By default,
ShowButtonFrame is False .

ExpressEditors&DBEditors by Developer Express


154 TdxInplaceCalcEdit Methods

TdxInplaceCalcEdit Methods
Derived from TdxInplaceDropDownEdit
DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 155

TdxInplaceCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


156 TdxInplaceHyperLinkEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


LinkColor property 157

TdxInplaceHyperLinkEdit Properties
TdxInplaceHyperLinkEdit
LinkColor protected / read / write StartKey protected / read / write
SingleClick protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

LinkColor property read / write


Specifies the text color of a hyperlink within an editor.

property LinkColor: TColor;

Description
Use the LinkColor property to modify the color of a hyperlink. By default, this property is set to clBlue.

SingleClick property read / write


Specifies the manner in which a hyperlink is activated.

property SingleClick: Boolean;

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.

By default, SingleClick is False .

StartKey property read / write


Specifies the shortcut used to activate a hyperlink.

ExpressEditors&DBEditors by Developer Express


158 TdxInplaceHyperLinkEdit Properties

property StartKey: TShortCut;

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.

By default, the StartKey is Ctrl+Enter.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DoStart method 159

TdxInplaceHyperLinkEdit Methods
TdxInplaceHyperLinkEdit
DoStart prote cted

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
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

DoStart method
Activates a hyperlink.

procedure DoStart; virtual;

Description
If the text within a hyperlink editor is not empty and represents a valid address, this method activates a
hyperlink.

ExpressEditors&DBEditors by Developer Express


160 TdxInplaceHyperLinkEdit Events

TdxInplaceHyperLinkEdit Events
TdxInplaceHyperLinkEdit
OnStartClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

OnStartClick event
Occurs when activating an edited hyperlink.

property OnStartClick: TNotifyEvent;

Description
Write an OnStartClick event handler to perform specific actions when launching a hyperlink.

Copyright © 2000 Developer Express Inc. www.devexpress.com


161

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

ExpressEditors&DBEditors by Developer Express


162 TdxInplaceTimeEdit Properties

TdxInplaceTimeEdit Properties
TdxInplaceTimeEdit
Time protected / read / write TimeEditFormat protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Time property read / write


Contains currently edited time values.

property Time: TTime;

Description
Use the Time property to set or return the time within a time editor.

TimeEditFormat property read / write


Specifies time format.

type

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 163

TdxTimeEditFormat = (tfHourMinSec, tfHourMin, tfHour);


property TimeEditFormat : TdxTimeEditFormat;

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.

The default value is tfHourMinSec.

ExpressEditors&DBEditors by Developer Express


164 TdxInplaceTimeEdit Methods

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

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase prote cted IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 165

TdxInplaceTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


166 TdxInplaceCurrencyEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DecimalPlaces property 167

TdxInplaceCurrencyEdit Properties
TdxInplaceCurrencyEdit
DecimalPlaces protected / read / write MinValue protected / read / write
DisplayFormat protected / read / write Value protected / read / write
MaxValue protected / read / write

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DecimalPlaces property read / write


Specifies the number of decimal places.

property DecimalPlaces: Integer;

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.

The default value for this property is 2.

DisplayFormat property read / write


Determines the manner in which currency values are formatted.

property DisplayFormat: string;

ExpressEditors&DBEditors by Developer Express


168 TdxInplaceCurrencyEdit Properties

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.

The default format string is ‘$,0.00;-$,0.00’.

See Also
TdxInplaceCurrencyEdit.DefaultDisplayFormat

MaxValue property read / write


Determines maximum currency value.

property MaxValue: Double;

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.

The default value for this property is 0.

See Also
TdxInplaceCurrencyEdit.MinValue; TdxInplaceCurrencyEdit.Value;
TdxInplaceCurrencyEdit.DefaultMaxValue

MinValue property read / write


Determines minimum currency value.

property MinValue: Double;

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.

The default value for this property is 0.

See Also
TdxInplaceCurrencyEdit.Value; TdxInplaceCurrencyEdit.DefaultMinValue;
TdxInplaceCurrencyEdit.MaxValue

Value property read / write


Determines current value.

property Value: Double;

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 169

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

ExpressEditors&DBEditors by Developer Express


170 TdxInplaceCurrencyEdit Methods

TdxInplaceCurrencyEdit Methods
TdxInplaceCurrencyEdit
DefaultDisplayFormat public DefaultMinValue public
DefaultMaxValue public IsValidChar protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

DefaultDisplayFormat method
Returns the format used to display currency data in a currency editor.

function DefaultDisplayFormat: string; virtual;

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).

Copyright © 2000 Developer Express Inc. www.devexpress.com


DefaultMaxValue method 171

See Also
TdxInplaceCurrencyEdit.DisplayFormat

DefaultMaxValue method
Returns the maximum value of a currency editor.

function DefaultMaxValue: Double; virtual;

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.

function DefaultMinValue: Double; virtual;

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.

function IsValidChar(Key: Char): Boolean;

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.

ExpressEditors&DBEditors by Developer Express


172 TdxInplaceCurrencyEdit Events

TdxInplaceCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protecte d

Copyright © 2000 Developer Express Inc. www.devexpress.com


173

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

ExpressEditors&DBEditors by Developer Express


174 TdxPopupToolBarWindow Properties

TdxPopupToolBarWindow Properties
Alignment published IsPopupMenu published
Buttons published ShowCaptions published
CustomButtonCaption published Visible published
CustomButtonGlyph published

Alignment property read / write


Determines the position of an image toolbar relative to an image editor.

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.

The default value is ptaBottom.

Buttons property read / write


Specifies the buttons displayed within an image toolbar.

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


ShowCaptions property 175

PtbDelete When pressed, an image is deleted.


PtbLoad When pressed, a file dialog is activated to load an image.
PtbSave When pressed, a save file dialog is displayed.
PtbCustom When pressed, users can define a button with a specific behavior.

Use the CustomButtonCaption, CustomButtonGlyph properties and the OnCustomClick event to


define the appearance and behavior of a custom button.

See Also
TdxPopupToolBarWindow.CustomButtonCaption; TdxPopupToolBarWindow.CustomButtonGlyph;
TdxPopupToolBarWindow.ShowCaptions

ShowCaptions property read / write


Determines whether the button captions of a toolbar are displayed.

property ShowCaptions: Boolean;

Description
Set the ShowCaptions property to False to hide the captions of image toolbar buttons.

The deault value is True.

See Also
TdxPopupToolBarWindow.Buttons

CustomButtonCaption property read / write


Specifies the caption of a custom button.

property CustomButtonCaption: string;

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

CustomButtonGlyph property read / write


Specifies the glyph for a custom button.

property CustomButtonGlyph: TBitmap;

ExpressEditors&DBEditors by Developer Express


176 TdxPopupToolBarWindow Properties

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

IsPopupMenu property read / write


Specifies whether a toolbar window is displayed as a popup menu.

property IsPopupMenu: Boolean;

Description
Set the IsPopupMenu property to False to display the image toolbar window as a popup toolbar.

By default, the IsPopupMenu property is True.

Visible property read / write


Specifies whether a toolbar window can be displayed.

property Visible: Boolean;

Description
Set the Visible property to False to prevent an image toolbar window from being displayed.

The default value is True.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 177

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

ExpressEditors&DBEditors by Developer Express


178 TdxInplaceGraphicEdit Properties

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / w rite
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

AutoSize property read / write


Specifies whether it is possible to automatically resize a graphic editor box to fully display its contents.

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.

By default, the AutoSize property is False .

Center property read / write


Determines whether a picture is aligned by its center within the editor box.

property Center: Boolean;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


ClipboardFormat property 179

By default, the Center property is True.

ClipboardFormat property read / write


Specifies Clipboard format.

property ClipboardFormat: Word;

Description
By default, this property sets the format to CF_PICTURE.

CustomFilter property read / write


Determines the filter used to display specific files in the Files list box when loading graphics.

property CustomFilter: string;

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

CustomGraphic property read / write


Determines whether a graphic editor displays custom images.

property CustomGraphic: Boolean;

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.

DblClickActivate property read / write


Specifies whether a popup menu can be activated by a double-click event within an editor.

property DblClickActivate: Boolean;

ExpressEditors&DBEditors by Developer Express


180 TdxInplaceGraphicEdit Properties

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.

By default, the DblClickActivate property is True.

GraphicTransparency property read / write


Determines graphic transparency type.

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.

Picture property read / write


Determines the image that appears within a graphic editor.

property Picture: TPicture;

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

QuickDraw property read / write


Specifies whether an image is displayed using a palette.

property QuickDraw: Boolean;

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.

By default, the QuickDraw property is False .

Copyright © 2000 Developer Express Inc. www.devexpress.com


Stretch property 181

Stretch property read / write


Determines whether loaded graphics fit within a graphic editor box.

property Stretch: Boolean;

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.)

By default, the Stretch property is False .

ToolbarLayout property read / write


Determines the layout of the popup toolbar window used to provide shortcuts for menu commands.

property ToolbarLayout: TdxPopupToolBarWindow;

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

ToolbarPos property read / write


Defines a toolbar window location on-screen in pixels.

property ToolbarPos: TPoint;

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

ToolbarPosStored property read / write


Determines whether the position of a toolbar window is stored.

property ToolbarPosStored: Boolean;

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.

ExpressEditors&DBEditors by Developer Express


182 TdxInplaceGraphicEdit Properties

By default, the ToolbarPosStored property is True.

See Also
TdxInplaceGraphicEdit.ToolbarLayout; TdxInplaceGraphicEdit.ToolbarPos

Copyright © 2000 Developer Express Inc. www.devexpress.com


AssignPicture method 183

TdxInplaceGraphicEdit Methods
TdxInplaceGraphicEdit
AssignPicture protected GetGraphicClass protected
ClearPicture public LoadFromFile public
CopyToClipboard public PasteFromClipboard public
CustomClick protected SaveToFile public
CutToClipboard public

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

AssignPicture method
Generates the OnAssignPicture event.

procedure AssignPicture(Picture: TPicture); virtual;

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.

procedure ClearPicture; virtual;

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;

ExpressEditors&DBEditors by Developer Express


184 TdxInplaceGraphicEdit Methods

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.

procedure CustomClick; virtual;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


LoadFromFile method 185

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

ExpressEditors&DBEditors by Developer Express


186 TdxInplaceGraphicEdit Events

TdxInplaceGraphicEdit Events
TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate 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.

property OnCustomClick: TNotifyEvent;

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;

Copyright © 2000 Developer Express Inc. www.devexpress.com


187

TdxGraphicEditGraphicClassEvent = procedure(Sender: TObject; var


GraphicClass: TGraphicClass) of object;
property OnGetGraphicClass: TdxGraphicEditGraphicClassEvent;

Description
Write an OnGetGraphicClass event handler to perform specific actions when accessing graphic class.

See Also
TdxInplaceGraphicEdit.GetGraphicClass

ExpressEditors&DBEditors by Developer Express


188 TdxInplaceBlobEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


AlwaysSaveText property 189

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

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

AlwaysSaveText property read / write


Specifies whether the text entered into a dropdown window is saved.

ExpressEditors&DBEditors by Developer Express


190 TdxInplaceBlobEdit Properties

property AlwaysSaveText: Boolean;

Description
Set the AlwaysSaveText property to True to save the entered text when a dropdown window is closed.

The default value is True.

See Also
TdxInplaceBlobEdit.Text

BlobEditKind property read / write


Determines the BLOB data associated with a BLOB editor.

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.

The default value is bekMemo.

BlobPaintStyle property read / write

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


BlobText property 191

bpsIcon Identification icon is used.


bpsText Identification text is used.

The default value is bpsIcon.

See Also
TdxInplaceBlobEdit.BlobText

BlobText property read / write


Contains the text string displayed within an editor.

property BlobText: string;

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

MemoCharCase property read / write


Determines text case within a BLOB memo editor.

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.

When the MemoCharCase property is set to ecLowerCase or ecUpperCase , character case is


converted when a user enters text into an in-place editor. Modifying the MemoCharCase 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 the MemoCharCase property to
ecNormal.

By default, this property is set to ecNormal.

ExpressEditors&DBEditors by Developer Express


192 TdxInplaceBlobEdit Properties

See Also
TdxInplaceTextEdit.CharCase

MemoHideScrollBars property read / write


Specifies whether scroll bars are displayed in a dropdown window.

property MemoHideScrollBars: Boolean;

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.

The default value is True.

See Also
TdxInplaceBlobEdit.MemoScrollBars

MemoMaxLength property read / write


Determines the maximum length of memo text in characters.

property MemoMaxLength: Integer;

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.

The default value is 0.

See Also
TdxInplaceTextEdit.MaxLength

MemoOEMConvert property read / write


Determines whether the characters typed in a dropdown window of a BLOB editor are converted from ANSI
to OEM and then back.

property MemoOEMConvert: Boolean;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


MemoScrollBars property 193

By default, this property for TdxInplaceBlobEdit is set to False .

See Also
TdxInplaceTextEdit.OEMConvert

MemoScrollBars property read / write


Specifies which scroll bars are displayed within a dropdown window.

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.

The default value is ssNone.

See Also
TdxInplaceBlobEdit.MemoHideScrollBars

MemoSelectionBar property read / write


Specifies whether the selection bar is displayed at the leftmost edge of a dropdown window.

property MemoSelectionBar: Boolean;

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.

The default value is True.

See Also
TdxInplaceMemoEdit.SelectionBar

ExpressEditors&DBEditors by Developer Express


194 TdxInplaceBlobEdit Properties

MemoWantReturns property read / write


Determines whether the RETURN character is accepted during editing.

property MemoWantReturns: Boolean;

Description
Determines whether a BLOB editor dropdown window accepts the RETURN character when pressing the
Enter key on the keyboard.

The default value is True.

See Also
TdxInplaceBlobEdit.MemoWantTabs; TdxInplaceMemoEdit.WantReturns

MemoWantTabs property read / write


Determines whether the TAB character is accepted during editing.

property MemoWantTabs: Boolean;

Description
Determines whether a BLOB editor dropdown window accepts the TAB character when pressing the tab key
on the keyboard.

The default value is True.

See Also
TdxInplaceBlobEdit.MemoWantReturns; TdxInplaceMemoEdit.WantTabs

MemoWordWrap property read / write


Determines whether to wrap words in a dropdown window when it displays a memo.

property MemoWordWrap: Boolean;

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.

The default value is True.

See Also
TdxInplaceMemoEdit.WordWrap

PictureAutoSize property read / write


Determines whether a dropdown window has the same size as the picture from BLOB data.

Copyright © 2000 Developer Express Inc. www.devexpress.com


PictureClipboardFormat property 195

property PictureAutoSize: Boolean;

Description
If the PictureAutoSize property is True, the size of a dropdown window changes to display the entire
picture.

The default value is True.

PictureClipboardFormat property read / write


Specifies the format of Clipboard data.

property PictureClipboardFormat: Word;

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

PictureGraphicClass property read / write


Determines edited image type.

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

PictureFilter property read / write


Determines the filter used to display specific files in the Files list box when selecting a picture to load.

property PictureFilter: string;

ExpressEditors&DBEditors by Developer Express


196 TdxInplaceBlobEdit Properties

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

PictureTransparency property read / write


Determines whether a picture can be transparent.

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.

The default value is gtDefault.

See Also
TdxInplaceGraphicEdit.GraphicTransparency

PopupWidth property read / write


Determines the width of a dropdown window for a BLOB editor.

property PopupWidth: Integer;

Description
Use this property to specify the width of a dropdown window in pixels.

The default value is 200.

See Also
TdxInplaceBlobEdit.PopupHeight; TdxInplaceBlobEdit.SizeablePopup

PopupHeight property read / write


Specifies the height of a dropdown window.

Copyright © 2000 Developer Express Inc. www.devexpress.com


ShowExPopupItems property 197

property PopupHeight: Integer;

Description
Use this property to specify the height of a dropdown window in pixels.

The default value is 140.

See Also
TdxInplaceBlobEdit.PopupWidth; TdxInplaceBlobEdit.SizeablePopup

ShowExPopupItems property read / write


Determines whether a popup menu includes extended items.

property ShowExPopupItems: Boolean;

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.

By default, the ShowExPopupItems property is True.

ShowPicturePopup property read / write


Determines whether a popup menu is displayed when pressing the right mouse button within a dropdown
window.

property ShowPicturePopup: Boolean;

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.

By default, ShowPicturePopup is True.

SizeablePopup property read / write


Determines whether a dropdown window is sizeable.

property SizeablePopup: Boolean;

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.

ExpressEditors&DBEditors by Developer Express


198 TdxInplaceBlobEdit Properties

The default value is True.

See Also
TdxInplaceBlobEdit.PopupHeight; TdxInplaceBlobEdit.PopupWidth

Text property read / write


Contains the text displayed within a dropdown window.

property Text: string;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


AssignPicture method 199

TdxInplaceBlobEdit Methods
TdxInplaceBlobEdit
AssignPicture protected SavePopupSize protected
GetGraphicClass protected SetBlobValue protected
IsSizeablePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protecte d FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

AssignPicture method
Generates the OnAssignPicture event.

ExpressEditors&DBEditors by Developer Express


200 TdxInplaceBlobEdit Methods

procedure AssignPicture(Picture: TPicture); virtual;

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.

function GetGraphicClass: TGraphicClass; virtual;

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.

function IsSizeablePopup: Boolean; virtual;

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.

procedure SavePopupSize(W, H: Integer); virtual;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


SetBlobValue method 201

See Also
TdxInplaceBlobEdit.IsSizeablePopup

SetBlobValue method
Sets the data value for a new BLOB.

procedure SetBlobValue(Sender: TObject); virtual;

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.

ExpressEditors&DBEditors by Developer Express


202 TdxInplaceBlobEdit Events

TdxInplaceBlobEdit Events
TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate 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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


203

See Also
TdxInplaceBlobEdit.GetGraphicClass; TdxInplaceBlobEdit.PictureGraphicClass

ExpressEditors&DBEditors by Developer Express


204 TdxInplaceMRUEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


ImmediateDropDown property 205

TdxInplaceMRUEdit Properties
TdxInplaceMRUEdit
ImmediateDropDown protected / read / write ShowEllipsis protected / read / write
MaxItemCount protected / read / write

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ImmediateDropDown property read / write


Specifies whether a dropdown control opens immediately after pressing a key.

property ImmediateDropDown: Boolean;

ExpressEditors&DBEditors by Developer Express


206 TdxInplaceMRUEdit Properties

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.

The default value of this property is False .

See Also
TdxInplaceDropDownEdit.ImmediateDropDown

MaxItemCount property read / write


Determines the maximum number of items in a dropdown list.

property MaxItemCount: Integer;

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

ShowEllipsis property read / write


Determines whether an additional button is displayed within an editor.

property ShowEllipsis: Boolean;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


AddItem method 207

TdxInplaceMRUEdit Methods
In TdxInplaceMRUEdit
AddItem public ButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

AddItem method
Adds a new item to the dropdown items list.

ExpressEditors&DBEditors by Developer Express


208 TdxInplaceMRUEdit Methods
procedure AddItem(const Value: string); virtual;

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.

procedure ButtonClick; virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnButtonClick event 209

TdxInplaceMRUEdit Events
TdxInplaceMRUEdit
OnButtonClick protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

OnButtonClick event
Occurs when clicking a button within an editor.

property OnButtonClick: TNotifyEvent;

Description
Write an OnButtonClick event handler to perform specific actions when clicking the additional (ellipsis)
button.

See Also
TdxINplaceMRUEdit.ButtonClick

ExpressEditors&DBEditors by Developer Express


210 TdxInplacePopupEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


HideEditCursor property 211

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

HideEditCursor property read / write


Specifies whether an edit cursor is displayed within a popup editor.

property HideEditCursor: Boolean;

ExpressEditors&DBEditors by Developer Express


212 TdxInplacePopupEdit Properties

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.

The default value is False .

PopupAutoSize property read / write


Specifies whether a dropdown window is of the same size as a popup control.

property PopupAutoSize: Boolean;

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.

The default value is True.

See Also
TdxPopupEditForm.Sizeable; TdxInplacePopupEdit.PopupSizeable

PopupControl property read / write


Specifies the control to be displayed within a dropdown window.

property PopupControl: TControl;

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).

PopupClientEdge property read / write


Specifies the border style of a dropdown window.

property PopupClientEdge: Boolean;

Description
If the PopupClientEdge property is set to True, a dropdown window has a sunken border.

The default value is False .

See Also
TdxInplacePopupEdit.PopupBorderStyle

Copyright © 2000 Developer Express Inc. www.devexpress.com


PopupFlatBorder property 213

PopupFlatBorder property read / write


Specifies whether the dropdown window border is flat.

property PopupFlatBorder: Boolean;

Description
Set the PopupFlatBorder property to False to provide the 3-D style for a dropdown window's border.

The default value is True.

See Also
TdxInplacePopupEdit.PopupBorderStyle

PopupForm property read only


Specifies the popup form used as a dropdown window for a popup editor.

property PopupForm: TdxPopupEditForm;

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

PopupFormBorderStyle property read / write


Specifies the border style for a dropdown window.

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

with a “Close” button and a sizing grip.

This property only impacts dropdown window style. The default value is pbsDialog.

See Also
TdxInplacePopupEdit.PopupFlatBorder; TdxInplacePopupEdit.PopupFormCaption

PopupFormCaption property read / write


Determines the caption of a dropdown window.

property PopupFormCaption: string;

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

PopupHeight property read / write


Determines the height of a dropdown window.

property PopupHeight: Integer;

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.

The default value is 200.

See Also
TdxInplacePopupEdit.PopupMinHeight; TdxInplacePopupEdit.PopupWidth

PopupMinHeight property read / write


Determines the minimum height of a dropdown window.

property PopupMinHeight: Integer;

Description
Use the PopupMinHeight property to determine the minimum height of a popup editor dropdown
window.

Copyright © 2000 Developer Express Inc. www.devexpress.com


PopupMinWidth property 215

The default value is 100.

See Also
TdxInplacePopupEdit.PopupHeight; TdxInplacePopupEdit.PopupMinWidth

PopupMinWidth property read / write


Determines the minimum width of a dropdown window.

property PopupMinWidth: Integer;

Description
Use the PopupMinWidth property to specify the minimum width of a popup editor dropdown window.

The default value is 100.

See Also
TdxInplacePopupEdit.PopupMinHeight; TdxInplacePopupEdit.PopupHeight

PopupSizeable property read / write


Specifies whether the size of a dropdown window can be changed.

property PopupSizeable: Boolean;

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

PopupWidth property read / write


Determines the width of a popup form.

property PopupWidth: Integer;

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.

ExpressEditors&DBEditors by Developer Express


216 TdxInplacePopupEdit Properties

See Also
TdxInplacePopupEdit.PopupHeight; TdxInplacePopupEdit.PopupMinWidth

Copyright © 2000 Developer Express Inc. www.devexpress.com


CalcSize method 217

TdxInplacePopupEdit Methods
TdxInplacePopupEdit
CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

CalcSize method
Calculates the size of a dropdown window.

procedure CalcSize(APopupForm: TdxPopupEditForm); virtual;

ExpressEditors&DBEditors by Developer Express


218 TdxInplacePopupEdit Methods

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.

procedure InitializePopup(APopupForm: TdxPopupEditForm); virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnCloseQuery event 219

TdxInplacePopupEdit Events
TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate 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.

ExpressEditors&DBEditors by Developer Express


220 TdxInplacePopupEdit Events

See Also
TdxPopupEditForm.ClosePopup

OnInitPopup event
Occurs when a dropdown window is about to be initialized.

property OnInitPopup: TNotifyEvent;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


221

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

ExpressEditors&DBEditors by Developer Express


222 TdxPopupEditForm Properties

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

ClientEdge property read / write


Specifies the border style for a popup form.

property ClientEdge: Boolean;

Description
If the ClientEdge property is set to True, the popup form has a sunken border.

The default value is False .

See Also
TdxPopupEditForm.PopupFormBorderStyle

FlatBorder property read / write


Specifies the border style for a popup form.

property FlatBorder: Boolean;

Description
If the FlatBorder property is set to True, the border has a 2D look. Otherwise, it has a 3D look.

The default value is True.

See Also
TdxPopupEditForm.PopupFormBorderStyle

PopupFormBorderStyle property read / write


Specifies the border style for a dropdown window.

type
TdxPopupEditFormBorderStyle = (pbsDialog, pbsDialogHelp, pbsSimple,
pbsSysPanel);
property PopupFormBorderStyle: TdxPopupEditFormBorderStyle;

Copyright © 2000 Developer Express Inc. www.devexpress.com


PopupMinHeight property 223

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

PopupMinHeight property read / write


Determines the minimum height of a popup form.

property PopupMinHeight: Integer;

Description
Use the PopupMinHeight property to determine the minimum height of the popup form from a popup
editor.

The default value is 100.

See Also
TdxPopupEditForm.PopupMinWidth

PopupMinWidth property read / write


Determines the minimum width of a dropdown window.

property PopupMinWidth: Integer;

Description
Use the PopupMinWidth property to specify the minimum width of the dropdown window of a popup
editor.

The default value is 100.

See Also
TdxPopupEditForm.PopupMinHeight

ExpressEditors&DBEditors by Developer Express


224 TdxPopupEditForm Properties

Sizeable property read / write


Specifies whether a popup form is sizeable.

property Sizeable : Boolean;

Description
If the Sizeable property is set to True, a user can change the size of a form; Otherwise, form size is
fixed.

By default, the Sizeable property is set to True.

See Also
TdxPopupEditForm.SizingCorner

SizingCorner property read / write


Specifies the location of the sizing grip.

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


ClosePopup method 225

TdxPopupEditForm Methods
ClosePopup public / read / write
ShowPopup public / read / write

ClosePopup method
Closes a popup form.

procedure ClosePopup(Accept: Boolean); virtual;

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.

procedure ShowPopup; virtual;

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

ExpressEditors&DBEditors by Developer Express


226 TdxInplaceLookupEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


CanDeleteText property 227

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

CanDeleteText property read / write


Specifies whether a user can delete the displayed value.

property CanDeleteText: Boolean;

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.

ExpressEditors&DBEditors by Developer Express


228 TdxInplaceLookupEdit Properties

The default value is False .

Note: The DropDownListStyle property is always set to True for TdxInplaceLookupEdit.

ClearKey property read / write


Specifies the short cut that clears the editor's value.

property ClearKey: TShortCut;

Description
The ClearKey property specifies the shortcut key combination that clears data values (sets to Null)
within an editor.

Field property read / write


Determines the field associated with a lookup editor.

property Field: TField;

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

KeyFieldName property read / write


Specifies the name of the key field.

property KeyFieldName: string;

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.

ListFieldName property read / write


Determines field names in a lookup list.

property ListFieldName: string;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


ListSource property 229

See Also
TdxInplaceLookupEdit.Field

ListSource property read / write


Specifies the data source used for TdxInplaceLookupEdit descendant objects.

property ListSource: TDataSource;

Description
Set this property value to the name of the data source you want to use as a list source for
TdxInplaceLookupEdit descendant objects.

LookupKeyValue property read / write


Specifies the key field for the default record of an editor.

property LookupKeyValue: Variant;

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.

LookupMode property read only


Specifies whether a TdxInplaceLookupEdit descendant object corresponds to a lookup field.

property LookupMode: Boolean;

Description
Returns True if a TdxInplaceLookupEdit descendant object corresponds to a lookup field.

Revertable property read / write


Specifies whether a user can cycle through lookup list values via a double click event.

property Revertable: Boolean;

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.

The default value is False .

ExpressEditors&DBEditors by Developer Express


230 TdxInplaceLookupEdit Methods

TdxInplaceLookupEdit Methods
TdxInplaceLookupEdit
ClearField protected IsEditable public
DoCloseUp protected SetKeyValue protected
DoIncremental protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoDropDownKeys protected PopupBorderStyle public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ClearField method
Clears data values (sets to Null).

Copyright © 2000 Developer Express Inc. www.devexpress.com


DoCloseUp method 231

procedure ClearField; virtual;

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.

procedure DoCloseUp(var Value: Variant; var Accept: Boolean); virtual;

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.

procedure DoIncremental(Distance: Integer; Circle: Boolean); virtual;

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.

function IsEditable: Boolean;

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.

ExpressEditors&DBEditors by Developer Express


232 TdxInplaceLookupEdit Methods
procedure SetKeyValue(AValue : Variant); virtual;

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


OnCloseUp event 233

TdxInplaceLookupEdit Events
TdxInplaceLookupEdit
OnCloseUp protected

Derived from TdxInplaceDropDownEdit


OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate 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.

ExpressEditors&DBEditors by Developer Express


234 TdxEditButton

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


Default property 235

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

Default property read / write


Specifies whether a button is the default button.

property Default: Boolean;

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.

Glyph property read / write


Specifies the image drawn within a specific edit button.

property Glyph: TBitmap;

Description
Determines the glyph for an editor button. The glyph is drawn on the button if the Kind property is set
to bkGlyph.

Kind property read / write


Determines edit button type.

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.

bkDown A button displays the standard “Down” glyph.

bkGlyph A custom glyph is displayed.

The default value is bkEllipsis.

ExpressEditors&DBEditors by Developer Express


236 TdxEditButton Properties

LeftAlignment property read / write


Specifies the location of an edit button within its associated editor.

property LeftAlignment: Boolean;

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

The default value is False .

Visible property read / write


Specifies whether a button is displayed within its editor.

property Visible: Boolean;

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.

The default value is True.

Width property read / write


Determines button width.

property Width: Integer;

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.

The default value is 0.

Copyright © 2000 Developer Express Inc. www.devexpress.com


Assign method 237

TdxEditButton Methods
Assign public
RestoreDefaults public

Assign method
Copies the contents of the source button to a new button.

procedure Assign(Source: TPersistent); override;

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.

procedure RestoreDefaults; virtual;

Description
Call the RestoreDefaults method to set all properties of a specific button to default values.

ExpressEditors&DBEditors by Developer Express


238 TdxEditButtons

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


Items property 239

TdxEditButtons Properties
Items public / read / write VisibleCount public / read only
Owner public / read only VisibleItems public / read / write

Items property read / write


Specifies the list of edit buttons a given collection owns.

property Items[Index: Integer]: TdxEditButton;

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.

Owner property read only


Specifies the owner of an edit button.

property Owner: TComponent;

Description
Use the Owner property to locate the component to which a specific button belongs.

VisibleCount property read only


Determines the number of visible buttons in a button editor.

property VisibleCount: Integer;

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.

VisibleItems property read / write


Specifies the list of visible edit buttons within a button editor.

property VisibleItems[Index: Integer]: TdxEditButton;

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.

ExpressEditors&DBEditors by Developer Express


240 TdxEditButtons Methods

TdxEditButtons Methods
DefaultMaxValue public DefaultValueType public
DefaultMinValue public GetIncrement public

Add method
Adds a new button to the button editor.

function Add: TdxEditButton;

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.

function GetAbsoluteIndex(VisibleIndex: Integer): Integer;

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.

function GetVisibleIndex(AbsoluteIndex: Integer): Integer;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


241

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

ExpressEditors&DBEditors by Developer Express


242 TCustomdxEdit Properties

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 243

TCustomdxEdit Methods
TCustomdxEdit
IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxEdit.

ExpressEditors&DBEditors by Developer Express


244 TCustomdxEdit Events

TCustomdxEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


245

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

ExpressEditors&DBEditors by Developer Express


246 TdxEdit Properties

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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / w rite StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


247

TdxEdit Methods
Derived from TCustomdxEdit
IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

ExpressEditors&DBEditors by Developer Express


248 TdxEdit Events

TdxEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


249

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

ExpressEditors&DBEditors by Developer Express


250 TCustomdxMaskEdit Properties

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 251

TCustomdxMaskEdit Methods
TCustomdxMaskEdit
IsInplace public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxMaskEdit.

ExpressEditors&DBEditors by Developer Express


252 TCustomdxMaskEdit Events

TCustomdxMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


253

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.

TdxMaskEdit implements the generic behavior introduced in TCustomdxMaskEdit. TdxMaskEdit


publishes most properties and methods inherited from TCustomdxMaskEdit, but does not introduce
any new behaviors.

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

ExpressEditors&DBEditors by Developer Express


254 TdxMaskEdit Properties

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

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


255

TdxMaskEdit Methods
Derived from TCustomdxMaskEdit
IsInplace public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


256 TdxMaskEdit Events

TdxMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


257

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

ExpressEditors&DBEditors by Developer Express


258 TCustomdxMemo Properties

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

Derived from TdxInplaceTextEdit


AutoSelect protected / read / write OEMConvert protected / read / write
CanPaste public / read only PasswordChar protected / read / write
CanRedo public / read only SelLength public / read / write
CanUndo public / read only SelStart public / read / write
CharCase protected / read / write SelText public / read / write
HideSelection protected / read / write Text public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
Container protected / read / write StoredValues protected / read / write
Height published / read / write Style public / read / write
Modified public / read / write StyleController protected / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 259

TCustomdxMemo Methods
TCustomdxMemo
IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxMemo.

ExpressEditors&DBEditors by Developer Express


260 TCustomdxMemo Events

TCustomdxMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


261

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.

TdxMemo implements the generic behavior introduced in TCustomdxMemo. TdxMemo publishes


most properties inherited from TCustomdxMemo, but does not introduce any new behaviors.

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

ExpressEditors&DBEditors by Developer Express


262 TdxMemo Properties

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

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert published / read / write
CanPaste public / read only PasswordChar published / read / write
CanRedo public / read only SelLength public / read / write
CanUndo public / read only SelStart public / read / write
CharCase published / read / write SelText public / read / write
HideSelection published / read / write Text public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
Container protected / read / write StoredValues protected / read / write
Height published / read / write Style published / read / write
Modified public / read / write StyleController published / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


263

TdxMemo Methods
TCustomdxMemo
IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

ExpressEditors&DBEditors by Developer Express


264 TdxMemo Events

TdxMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


265

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

ExpressEditors&DBEditors by Developer Express


266 TCustomdxDateEdit Properties

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


267

TCustomdxDateEdit Methods
TCustomdxDateEdit
IsInplace public

Derived from TdxInplaceDateEdit


DateChange protected DoValidateInput protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


268 TCustomdxDateEdit Methods

IsInplace method
Determines whether the edit control is used as a standalone control or as an inplace editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxDateEdit

Copyright © 2000 Developer Express Inc. www.devexpress.com


269

TCustomdxDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange protected OnDateValidateInput protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protecte d

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


270 TdxDateEdit

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.

TdxDateEdit implements the generic behavior introduced in TCustomdxDateEdit. TdxDateEdit


publishes most properties inherited from TCustomdxDateEdit, but does not introduce any new
behaviors.

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


271

TdxInplaceDropDownEdit
TdxInplaceDateEdit
TCustomdxDateEdit

ExpressEditors&DBEditors by Developer Express


272 TdxDateEdit Properties

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

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

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / read / write
CanPaste public / read only PasswordChar protected / read / write
CanRedo public / read only SelectionBar protected / read / w rite
CanUndo public / read only SelLength public / read / write
CharCase protected / read / write SelStart public / read / write
HideSelection published / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


273

TdxDateEdit Methods
Derived from TCustomdxDateEdit
IsInplace public

Derived from TdxInplaceDateEdit


DateChange protected DoValidateInput protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


274 TdxDateEdit Events

TdxDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange published OnDateValidateInput published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


275

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

ExpressEditors&DBEditors by Developer Express


276 TCustomdxButtonEdit Properties

TCustomdxButtonEdit Properties
Derived from TdxInplaceButtonEdit
Buttons protected / read / write ViewStyle protected / read / write
ClickKey protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


277

TCustomdxButtonEdit Methods
TCustomdxButtonEdit
IsInplace public

Derived from TdxInplaceButtonEdit


DefaultButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protecte d
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


278 TCustomdxButtonEdit Methods

IsInplace method
Determines whether the edit control is used as a standalone control or as an inplace editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxButtonEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


279

TCustomdxButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


280 TdxButtonEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


281

TdxButtonEdit Properties
Derived from TdxInplaceButtonEdit
Buttons published / read / write ViewStyle published / read / write
ClickKey published / read / write

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


282 TdxButtonEdit Methods

TdxButtonEdit Methods
Derived from TCustomdxButtonEdit
IsInplace public

Derived from TdxInplaceButtonEdit


DefaultButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from TdxInplaceMaskEdit


CheckCursor protected GetNextEditChar protected
Clear public GetPriorEditChar protected
DefaultEditMask public GetSel protected
DefaultMaxLength public GetTextLen public
GetBlankText public ReformatText protected
GetDisableCloseEditor prote cted SetCursor protected
GetEditingText public SetSel prote cted
GetFirstEditChar protected ValidateEdit public
GetLastEditChar protected ValidateError protected
GetMaxChars protected

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


283

TdxButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


284 TCustomdxCheckEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


285

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


286 TCustomdxCheckEdit Methods

TCustomdxCheckEdit Methods
TCustomdxCheckEdit
IsInplace public

Derived from TdxInplaceCheckEdit


InvalidateCheckRect protected Toggle protected

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxCheckEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


287

TCustomdxCheckEdit Events
Derived from TdxInplaceEdit
OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


288 TdxCheckEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


289

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

Derived from TdxInplaceEdit


Alignment publis hed / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / w rite
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


290 TdxCheckEdit Methods

TdxCheckEdit Methods
Derived from TCustomdxCheckEdit
IsInplace public

Derived from TdxInplaceCheckEdit


InvalidateCheckRect protected Toggle protected

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


291

TdxCheckEdit Events
Derived from TdxInplaceEdit
OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


292 TCustomdxImageEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


293

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


294 TCustomdxImageEdit Methods

TCustomdxImageEdit Methods
TCustomdxImageEdit
IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Copyright © 2000 Developer Express Inc. www.devexpress.com


295

Description
The IsInplace method always returns False for TCustomdxImageEdit.

ExpressEditors&DBEditors by Developer Express


296 TCustomdxImageEdit Events

TCustomdxImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


297

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

ExpressEditors&DBEditors by Developer Express


298 TdxImageEdit Properties

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows published / read / write ImmediatePopup protected / read / write
DropDownWidth published / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


299

TdxImageEdit Methods
Derived from TCustomdxImageEdit
IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protecte d
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


300 TdxImageEdit Events

TdxImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


301

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

ExpressEditors&DBEditors by Developer Express


302 TCustomdxSpinEdit Properties

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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 303

TCustomdxSpinEdit Methods
TCustomdxSpinEdit
IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

ExpressEditors&DBEditors by Developer Express


304 TCustomdxSpinEdit Methods

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxSpinEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


305

TCustomdxSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


306 TdxSpinEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


307

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

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

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelStart public / read / write
HideSelection published / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues prote cted / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


308 TdxSpinEdit Methods

TdxSpinEdit Methods
Derived from TCustomdxSpinEdit
IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


309

TdxSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


310 TCustomdxPickEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


311

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


312 TCustomdxPickEdit Methods

TCustomdxPickEdit Methods
TCustomdxPickEdit
IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Copyright © 2000 Developer Express Inc. www.devexpress.com


313

Description
The IsInplace method always returns False for TCustomdxPickEdit.

ExpressEditors&DBEditors by Developer Express


314 TCustomdxPickEdit Events

TCustomdxPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


315

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

ExpressEditors&DBEditors by Developer Express


316 TdxPickEdit Properties

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown published / read / write
DropDownRows published / read / write ImmediatePopup protected / read / write
DropDownWidth published / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


317

TdxPickEdit Methods
Derived from TCustomdxPickEdit
IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protecte d SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


318 TdxPickEdit Events

TdxPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


319

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

ExpressEditors&DBEditors by Developer Express


320 TCustomdxCalcEdit Properties

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph protected / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment prote cted / read / write
DroppedDown public / read / write PopupBorder protected / read / write

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 321

TCustomdxCalcEdit Methods
TCustomdxCalcEdit
IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

ExpressEditors&DBEditors by Developer Express


322 TCustomdxCalcEdit Methods
class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxCalcEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


323

TCustomdxCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


324 TdxCalcEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


325

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelStart public / read / write
HideSelection published / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


326 TdxCalcEdit Methods

TdxCalcEdit Methods
Derived from TCustomdxCalcEdit
IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


327

TdxCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


328 TCustomdxHyperLinkEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


ReadOnly property 329

TCustomdxHyperLinkEdit Properties
TCustomdxHyperLinkEdit
ReadOnly protected / read / write

Derived from TdxInplaceHyperLinkEdit


LinkColor protected / read / write StartKey protected / read / write
SingleClick protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write Modified public / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write

ReadOnly property read / write


Indicates whether an editor is used for display purposes only.

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.

ExpressEditors&DBEditors by Developer Express


330 TCustomdxHyperLinkEdit Methods

TCustomdxHyperLinkEdit Methods
TCustomdxHyperLinkEdit
IsInplace public

Derived from TdxInplaceHyperLinkEdit


DoStart protected

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
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxHyperLinkEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


331

TCustomdxHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


332 TdxHyperLinkEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


333

TdxHyperLinkEdit Properties
Derived from TCustomdxHyperLinkEdit
ReadOnly published / read / write

Derived from TdxInplaceHyperLinkEdit


LinkColor published / read / write StartKey published / read / write
SingleClick published / read / write

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

Derived from TdxInplaceEdit


Alignment published / read / write Modified public / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write

ExpressEditors&DBEditors by Developer Express


334 TdxHyperLinkEdit Methods

TdxHyperLinkEdit Methods
TCustomdxHyperLinkEdit
IsInplace public

Derived from TdxInplaceHyperLinkEdit


DoStart protected

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
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


335

TdxHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick published

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


336 TCustomdxTimeEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


337

TCustomdxTimeEdit Properties
Derived from TdxInplaceTimeEdit
Time protected / read / write TimeEditFormat protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


338 TCustomdxTimeEdit Methods

TCustomdxTimeEdit Methods
TCustomdxTimeEdit
IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an inplace editor.

Copyright © 2000 Developer Express Inc. www.devexpress.com


339

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxTimeEdit.

ExpressEditors&DBEditors by Developer Express


340 TCustomdxTimeEdit Events

TCustomdxTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


341

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

ExpressEditors&DBEditors by Developer Express


342 TdxTimeEdit Properties

TdxTimeEdit Properties
Derived from TdxInplaceTimeEdit
Time published / read / write TimeEditFormat published / read / write

Derived from 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

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

Derived from TdxInplaceTextEdit


AutoSelect published / 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 published / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


343

TdxTimeEdit Methods
Derived from TCustomdxTimeEdit
IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


344 TdxTimeEdit Events

TdxTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


345

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

ExpressEditors&DBEditors by Developer Express


346 TCustomdxCurrencyEdit Properties

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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 347

TCustomdxCurrencyEdit Methods
TCustomdxCurrencyEdit
IsInplace public

Derived from TdxInplaceCurrencyEdit


DefaultDisplayFormat public DefaultMinValue public
DefaultMaxValue public IsValidChar protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

ExpressEditors&DBEditors by Developer Express


348 TCustomdxCurrencyEdit Methods

Description
The IsInplace method always returns False for TCustomdxCurrencyEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


349

TCustomdxCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


350 TdxCurrencyEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


351

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

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

Derived from TdxInplaceTextEdit


AutoSelect published / 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 / w rite SelStart public / read / w rite
HideSelection published / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


352 TdxCurrencyEdit Methods

TdxCurrencyEdit Methods
Derived from TCustomdxCurrencyEdit
IsInplace public

Derived from TdxInplaceCurrencyEdit


DefaultDisplayFormat public DefaultMinValue public
DefaultMaxValue public IsValidChar protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


353

TdxCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


354 TCustomdxGraphicEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


355

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / w rite
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


356 TCustomdxGraphicEdit Methods

TCustomdxGraphicEdit Methods
TCustomdxGraphicEdit
IsInplace public

Derived from TdxInplaceGraphicEdit


AssignPicture protected GetGraphicClass protected
ClearPicture public LoadFromFile public
CopyToClipboard public PasteFromClipboard public
CustomClick protected SaveToFile public
CutToClipboard public

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxGraphicEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


357

TCustomdxGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


358 TdxGraphicEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


359

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly published / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


360 TdxGraphicEdit Methods

TdxGraphicEdit Methods
TCustomdxGraphicEdit
IsInplace public

Derived from TdxInplaceGraphicEdit


AssignPicture protected GetGraphicClass protected
ClearPicture public LoadFromFile public
CopyToClipboard public PasteFromClipboard public
CustomClick protected SaveToFile public
CutToClipboard public

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


361

TdxGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


362 TCustomdxBlobEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


363

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

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


364 TCustomdxBlobEdit Methods

TCustomdxBlobEdit Methods
TCustomdxBlobEdit
IsInplace public

Derived from TdxInplaceBlobEdit


AssignPicture protected SavePopupSize protected
GetGraphicClass protected SetBlobValue protected
IsSizeablePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protecte d SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 365

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxBlobEdit.

ExpressEditors&DBEditors by Developer Express


366 TCustomdxBlobEdit Events

TCustomdxBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


367

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

ExpressEditors&DBEditors by Developer Express


368 TdxBlobEdit

Copyright © 2000 Developer Express Inc. www.devexpress.com


369

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph protected / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write

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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


370 TdxBlobEdit Methods

TdxBlobEdit Methods
Derived from TCustomdxBlobEdit
IsInplace public

Derived from TdxInplaceBlobEdit


AssignPicture protected SavePopupSize protected
GetGraphicClass protected SetBlobValue protecte d
IsSizeablePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


371

TdxBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


372 TCustomdxMRUEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


373

TCustomdxMRUEdit Properties
Derived from TdxInplaceMRUEdit
ImmediateDropDown protected / read / write ShowEllipsis protected / read / write
MaxItemCount protected / read / write

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

Derived from 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

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

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 prote cted / read / write

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


374 TCustomdxMRUEdit Methods

TCustomdxMRUEdit Methods
TCustomdxMRUEdit
IsInplace public

Derived from TdxInplaceMRUEdit


AddItem public ButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


IsInplace method 375

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxMRUEdit.

ExpressEditors&DBEditors by Developer Express


376 TCustomdxMRUEdit Events

TCustomdxMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


377

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

ExpressEditors&DBEditors by Developer Express


378 TdxMRUEdit Properties

TdxMRUEdit Properties
Derived from TdxInplaceMRUEdit
ImmediateDropDown published / read / write ShowEllipsis published / read / write
MaxItemCount published / read / write

Derived from TdxInplacePickEdit


CanDeleteText published / read / write Items published / read / write
DropDownListStyle published / read / write Revertable published / read / write
ItemIndex public / read / write Sorted protected / read / write

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRow s published / read / write ImmediatePopup protected / read / write
DropDownWidth published / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


379

TdxMRUEdit Methods
Derived from TCustomdxMRUEdit
IsInplace public

Derived from TdxInplaceMRUEdit


AddItem public ButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


380 TdxMRUEdit Events

TdxMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


381

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

ExpressEditors&DBEditors by Developer Express


382 TCustomdxPopupEdit Properties

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph protecte d / 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


383

TCustomdxPopupEdit Methods
TCustomdxPopupEdit
IsInplace public

Derived from TdxInplacePopupEdit


CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEd itClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


384 TCustomdxPopupEdit Methods

IsInplace method
Determines whether the edit control is used as a standalone control or as an in-place editor.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxPopupEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


385

TCustomdxPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


386 TdxPopupEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


387

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder protected / read / write

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


388 TdxPopupEdit Methods

TdxPopupEdit Methods
Derived from TCustomdxPopupEdit
IsInplace public

Derived from TdxInplacePopupEdit


CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


389

TdxPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery published OnInitPopup published
OnCloseUp published OnPopup published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


390 TCustomdxLookupEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


391

TCustomdxLookupEdit Properties
Derived from TCustomdxDBLookupEdit
DataField protected / read / write
DataSource protected / read / write

Derived from TdxInplaceLookupEdit


CanDeleteText protected / read / write LookupMode protected / read only
ClearKey protected / read / write LookupKeyValue protected / read / write
Field protected / read / write ListSource protected / read / write
KeyFieldNa me protected / read / write Revertable protected / read / write
ListFieldName protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


392 TCustomdxLookupEdit Methods

TCustomdxLookupEdit Methods
Derived from TCustomdxDBLookupEdit
Create public
IsInplace public

Derived from TdxInplaceLookupEdit


ClearField protected IsEditable public
DoCloseUp protected SetKeyValue protected
DoIncremental protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoDropDownKeys protected PopupBorderStyle public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectionChange protected
Deselect public SelectAll public
DoSetMaxLength protecte d SetSelection public
GetSelection public SetEditMaxLength protected
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


393

TCustomdxLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp protected

Derived from TdxInplaceDropDownEdit


OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange prote cted OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


394 TdxLookupEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


395

TdxLookupEdit Properties
Derived from TCustomdxDBLookupEdit
DataField protected / read / write
DataSource protected / read / write

Derived from TdxInplaceLookupEdit


CanDeleteText protected / read / write LookupMode public / read only
ClearKey protected / read / write LookupKeyValue except Delphi 4 public / read / write
Field protected / read / write LookupKeyValue for Delphi 4 published / read / write
KeyFieldName published / read / write ListSource published / read / write
ListFieldName protected / read / write Revertable protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


396 TdxLookupEdit Methods

TdxLookupEdit Methods
Derived from TCustomdxDBLookupEdit
Create public
IsInplace public

Derived from TdxInplaceLookupEdit


ClearField protected IsEditable public
DoCloseUp protected SetKeyValue protected
DoIncremental protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoDropDownKeys protected PopupBorderStyle public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectionChange protected
Deselect public SelectAll public
DoSetMaxLength protected SetSelection public
GetSelection public SetEditMaxLength protected
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


397

TdxLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp protected

Derived from TdxInplaceDropDownEdit


OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


398 TdxEditDataLink

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


Field property 399

TdxEditDataLink Properties
Field public / read / write
FieldName publisc / read / write

Field property read / write


Determines the field associated with an editor.

property Field: TField;

Description
Specifies the field component controlled by the TdxEditDataLink object.

FieldName property read / write


Specifies the field name bound to a TdxEditDataLink control.

property FieldName: string;

Description
Use the FieldName property to set the FieldName property of a data-aware editor.

ExpressEditors&DBEditors by Developer Express


400 TdxEditDataLink Methods

TdxEditDataLink Methods
Create public
Modified public
Reset public

Create method
Creates a TdxEditDataLink instance.

constructor Create(ADBDataDefinition: TdxEditDBDataDefinition);

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


401

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

ExpressEditors&DBEditors by Developer Express


402 TCustomdxDBEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 403

TCustomdxDBEdit Properties
TCustomdxDBEdit
DataField protected / read / write DataSource protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


404 TCustomdxDBEdit Methods

TCustomdxDBEdit Methods
TCustomdxDBEdit
Create public

Derived from TCustomdxEdit


IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

Create method
Creates a TCustomdxDBEdit instance.

constructor Create(AOwner: TComponent); override;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


405

TCustomdxDBEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


406 TdxDBEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


407

TdxDBEdit Properties
Derived from TCustomdxDBEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 public / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


408 TdxDBEdit Methods

TdxDBEdit Methods
Derived from TCustomdxDBEdit
Create public

Derived from TCustomdxEdit


IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


409

TdxDBEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


410 TCustomdxDBMaskEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 411

TCustomdxDBMaskEdit Properties
TCustomdxDBMaskEdit
DataField protected / read / write DataSource protected / read / write

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

ExpressEditors&DBEditors by Developer Express


412 TCustomdxDBMaskEdit Properties

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 413

TCustomdxDBMaskEdit Methods
TCustomdxDBMaskEdit
Create public

Derived from TCustomdxMaskEdit


IsInplace public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Create method
Creates a TCustomdxDBMaskEdit instance.

constructor Create(AOwner: TComponent); override;

ExpressEditors&DBEditors by Developer Express


414 TCustomdxDBMaskEdit Methods

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


415

TCustomdxDBMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


416 TdxDBMaskEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


417

TdxDBMaskEdit Properties
Derived from TCustomdxDBMaskEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank published / read / write Text public / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


418 TdxDBMaskEdit Methods

TdxDBMaskEdit Methods
Derived from TCustomdxDBMaskEdit
Create public

Derived from TCustomdxMaskEdit


IsInplace public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


419

TdxDBMaskEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


420 TCustomdxDBMemo

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 421

TCustomdxDBMemo Properties
TCustomdxDBMemo
DataField protected / read / write DataSource protected / read / write

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 protected / read / write

Derived from TdxInplaceTextEdit


AutoSelect protected / read / write OEMConvert protected / read / write
CanPaste public / read only PasswordChar protected / read / write
CanRedo public / read only SelLength public / read / write
CanUndo public / read only SelStart public / read / write
CharCase protected / read / write SelText public / read / write
HideSelection protected / read / write Text public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
Container protected / read / write StoredValues protected / read / write
Height published / read / write Style public / read / write
Modified public / read / write StyleController protected / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

ExpressEditors&DBEditors by Developer Express


422 TCustomdxDBMemo Properties

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 423

TCustomdxDBMemo Methods
TCustomdxDBMemo
Create public

Derived from TCustomdxMemo


IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

Create method
Creates a TCustomdxDBMemo instance.

constructor Create(AOwner: TComponent); override;

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.

ExpressEditors&DBEditors by Developer Express


424 TCustomdxDBMemo Events

TCustomdxDBMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


425

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

ExpressEditors&DBEditors by Developer Express


426 TdxDBMemo Properties

TdxDBMemo Properties
Derived from TCustomdxDBMemo
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceMemoEdit


AutoSize protected / read / write SelectionBar published / read / write
HideScrollBars published / read / write WantReturns published / read / write
Lines public / read / write WantTabs published / read / write
ScrollBars published / read / write WordWrap published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert published / read / write
CanPaste public / read only PasswordChar published / read / write
CanRedo public / read only SelLength public / read / write
CanUndo public / read only SelStart public / read / write
CharCase published / read / write SelText public / read / write
HideSelection published / read / write Text public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
Container protected / read / write StoredValues protected / read / write
Height published / read / write Style published / read / write
Modified public / read / write StyleController published / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


427

TdxDBMemo Methods
Derived from TCustomdxDBMemo
Create public

Derived from TCustomdxMemo


IsInplace public

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

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

ExpressEditors&DBEditors by Developer Express


428 TdxDBMemo Events

TdxDBMemo Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


429

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

ExpressEditors&DBEditors by Developer Express


430 TCustomdxDBDateEdit Properties

TCustomdxDBDateEdit Properties
TCustomdxDBDateEdit
DataField protected / read / write DataSource protected / read / write

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protecte d / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataSource property 431

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


432 TCustomdxDBDateEdit Methods

TCustomdxDBDateEdit Methods
TCustomdxDBDateEdit
Create public

Derived from TCustomdxDateEdit


IsInplace public

Derived from TdxInplaceDateEdit


DateChange protected DoValidateInput protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 433

Create method
Creates a TCustomdxDBDateEdit instance.

constructor Create(AOwner: TComponent); override;

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.

ExpressEditors&DBEditors by Developer Express


434 TCustomdxDBDateEdit Events

TCustomdxDBDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange protected OnDateValidateInput protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


435

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

ExpressEditors&DBEditors by Developer Express


436 TdxDBDateEdit

Copyright © 2000 Developer Express Inc. www.devexpress.com


437

TdxDBDateEdit Properties
Derived from TCustomdxDBDateEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceDateEdit


Date public / read / write DateValidation published / read / write
DateButtons published / read / write SaveTime published / read / write
DateOnError published / read / write UseEditMask published / read / write

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

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

Derived from TdxInplaceTextEdit


AutoSelect published / 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 published / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


438 TdxDBDateEdit Methods

TdxDBDateEdit Methods
TCustomdxDBDateEdit
Create public

Derived from TCustomdxDateEdit


IsInplace public

Derived from TdxInplaceDateEdit


DateChange protected DoValidateInput protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


439

TdxDBDateEdit Events
Derived from TdxInplaceDateEdit
OnDateChange published OnDateValidateInput published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


440 TCustomdxDBButtonEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 441

TCustomdxDBButtonEdit Properties
TCustomdxDBButtonEdit
DataField protected / read / write DataSource protected / read / write

Derived from TdxInplaceButtonEdit


Buttons protected / read / write ViewStyle protected / read / write
ClickKey protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

ExpressEditors&DBEditors by Developer Express


442 TCustomdxDBButtonEdit Properties

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 443

TCustomdxDBButtonEdit Methods
TCustomdxDBButtonEdit
Create public

Derived from TCustomdxButtonEdit


IsInplace public

Derived from TdxInplaceButtonEdit


DefaultButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKey s protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


444 TCustomdxDBButtonEdit Methods

Create method
Creates a TCustomdxDBButtonEdit instance.

constructor Create(AOwner: TComponent); override;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


445

TCustomdxDBButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


446 TdxDBButtonEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


447

TdxDBButtonEdit Properties
TCustomdxDBButtonEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceButtonEdit


Buttons published / read / write ViewStyle published / read / write
ClickKey published / read / write

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text public / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


448 TdxDBButtonEdit Methods

TdxDBButtonEdit Methods
Derived from TCustomdxDBButtonEdit
Create public

Derived from TCustomdxButtonEdit


IsInplace public

Derived from TdxInplaceButtonEdit


DefaultButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


449

TdxDBButtonEdit Events
Derived from TdxInplaceButtonEdit
OnButtonClick published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


450 TCustomdxDBCheckEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 451

TCustomdxDBCheckEdit Properties
TCustomdxDBCheckEdit
DataField protected / read / write ValueGrayed protected / read / write
DataSource protected / read / write ValueUnchecked protected / read / write
ValueChecked protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


452 TCustomdxDBCheckEdit Properties

ValueChecked property read / write


Specifies the field value that corresponds to the checked state of a checkbox.

property ValueChecked: string;

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.

ValueGrayed property read / write


Specifies the field value that corresponds to the grayed state of a checkbox.

property ValueGrayed: string;

Description
Use the ValueGrayed property to specify the field value represented by the check box when it is
grayed.

ValueUnchecked property read / write


Specifies the field value that corresponds to the unchecked state of a checkbox.

property ValueUnchecked: string;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 453

TCustomdxDBCheckEdit Methods
TCustomdxDBCheckEdit
Create public LoadDisplayValue protected

Derived from TCustomdxCheckEdit


IsInplace public

Derived from TdxInplaceCheckEdit


InvalidateCheckRect protected Toggle protected

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

Create method
Creates a TCustomdxDBCheckEdit instance.

constructor Create(AOwner: TComponent); override;

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.

procedure LoadDisplayValue(var Data: Variant; IsPaintCopy: Boolean);


override;

Description
This method assigns the value returned by the DataDefinition.GetEditValue function to the Data
parameter.

ExpressEditors&DBEditors by Developer Express


454 TCustomdxDBCheckEdit Events

TCustomdxDBCheckEdit Events
Derived from TdxInplaceEdit
OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


455

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

ExpressEditors&DBEditors by Developer Express


456 TdxDBCheckEdit Properties

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

Derived from TdxInplaceCheckEdit


AllowGrayed published / read / write GlyphCount published / read / write
Checked protected / read / write MultiLine published / read / write
FullFocusRect published / read / write NullStyle published / read / write
Glyph published / read / write State protected / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


457

TdxDBCheckEdit Methods
Derived from TCustomdxDBCheckEdit
Create public LoadDisplayValue protected

Derived from TCustomdxCheckEdit


IsInplace public

Derived from TdxInplaceCheckEdit


InvalidateCheckRect protected Toggle protected

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

ExpressEditors&DBEditors by Developer Express


458 TdxDBCheckEdit Events

TdxDBCheckEdit Events
Derived from TdxInplaceEdit
OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


459

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

ExpressEditors&DBEditors by Developer Express


460 TCustomdxDBImageEdit Properties

TCustomdxDBImageEdit Properties
TCustomdxDBImageEdit
DataField protected / read / write DataSource protected / read / write

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataSource property 461

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


462 TCustomdxDBImageEdit Methods

TCustomdxDBImageEdit Methods
TCustomdxDBImageEdit
Create public

Derived from TCustomdxImageEdit


IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 463

Create method
Creates a TCustomdxDBImageEdit instance.

constructor Create(AOwner: TComponent); override;

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.

ExpressEditors&DBEditors by Developer Express


464 TCustomdxDBImageEdit Events

TCustomdxDBImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


465

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

ExpressEditors&DBEditors by Developer Express


466 TdxDBImageEdit Properties

TdxDBImageEdit Properties
Derived from TCustomdxDBImageEdit
DataField published / read / write DataSource published / read / write

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows published / read / write ImmediatePopup protected / read / write
DropDownWidth published / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

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

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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


467

TdxDBImageEdit Methods
Derived from TCustomdxDBImageEdit
Create public

Derived from TCustomdxImageEdit


IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


468 TdxDBImageEdit Events

TdxDBImageEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


469

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

ExpressEditors&DBEditors by Developer Express


470 TCustomdxDBSpinEdit Properties

TCustomdxDBSpinEdit Properties
TCustomdxDBSpinEdit
DataField protected / read / write
DataSource protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataSource property 471

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


472 TCustomdxDBSpinEdit Methods

TCustomdxDBSpinEdit Methods
TCustomdxDBSpinEdit
Create public

Derived from TCustomdxSpinEdit


IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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 protecte d

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 473

Create method
Creates a TCustomdxDBSpinEdit instance.

constructor Create(AOwner: TComponent); override;

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.

ExpressEditors&DBEditors by Developer Express


474 TCustomdxDBSpinEdit Events

TCustomdxDBSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


475

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

ExpressEditors&DBEditors by Developer Express


476 TdxDBSpinEdit Properties

TdxDBSpinEdit Properties
Derived from TCustomdxDBSpinEdit
DataField published / read / write DataSource published / read / write

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

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

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelStart public / read / write
HideSelection published / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


477

TdxDBSpinEdit Methods
Derived from TCustomdxDBSpinEdit
Create public

Derived from TCustomdxSpinEdit


IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


478 TdxDBSpinEdit Events

TdxDBSpinEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


479

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

ExpressEditors&DBEditors by Developer Express


480 TCustomdxDBPickEdit Properties

TCustomdxDBPickEdit Properties
TCustomdxDBPickEdit
DataField protected / read / write DataSource protected / read / write

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataSource property 481

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


482 TCustomdxDBPickEdit Methods

TCustomdxDBPickEdit Methods
TCustomdxDBPickEdit
Create public

Derived from TCustomdxPickEdit


IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 483

Create method
Creates a TCustomdxDBPickEdit instance.

constructor Create(AOwner: TComponent); override;

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.

ExpressEditors&DBEditors by Developer Express


484 TCustomdxDBPickEdit Events

TCustomdxDBPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


485

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

ExpressEditors&DBEditors by Developer Express


486 TdxDBPickEdit Properties

TdxDBPickEdit Properties
Derived from TCustomdxDBPickEdit
DataField published / read / write DataSource published / read / write

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown published / read / write
DropDownRows published / read / write ImmediatePopup protected / read / write
DropDownWidth published / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


487

TdxDBPickEdit Methods
Derived from TCustomdxDBPickEdit
Create public

Derived from TCustomdxPickEdit


IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


488 TdxDBPickEdit Events

TdxDBPickEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


489

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

ExpressEditors&DBEditors by Developer Express


490 TCustomdxDBCalcEdit Properties

TCustomdxDBCalcEdit Properties
TCustomdxDBCalcEdit
DataField protected / read / write
DataSource protected / read / write

Derived from TdxInplaceCalcEdit


BeepOnError protected / read / write QuickClose protected / read / write
ButtonStyle protected / read / write ShowButtonFrame protected / read / write
Precision protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataSource property 491

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


492 TCustomdxDBCalcEdit Methods

TCustomdxDBCalcEdit Methods
TCustomdxDBCalcEdit
Create public

Derived from TCustomdxCalcEdit


IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 493

Create method
Creates a TCustomdxDBCalcEdit instance.

constructor Create(AOwner: TComponent); override;

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.

ExpressEditors&DBEditors by Developer Express


494 TCustomdxDBCalcEdit Events

TCustomdxDBCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


495

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

ExpressEditors&DBEditors by Developer Express


496 TdxDBCalcEdit Properties

TdxDBCalcEdit Properties
Derived from TCustomdxDBCalcEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceCalcEdit


BeepOnError published / read / write QuickClose published / read / write
ButtonStyle published / read / write ShowButtonFrame published / read / write
Precision published / read / write

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text published / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelStart public / read / write
HideSelection published / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


497

TdxDBCalcEdit Methods
Derived from TCustomdxDBCalcEdit
Create public

Derived from TCustomdxCalcEdit


IsInplace public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


498 TdxDBCalcEdit Events

TdxDBCalcEdit Events
Derived from TdxInplaceDropDownEdit
OnCloseUp protected OnEditButtonClick protected

.Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


499

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

ExpressEditors&DBEditors by Developer Express


500 TCustomdxDBHyperLinkEdit Properties

TCustomdxDBHyperLinkEdit Properties
TCustomdxDBHyperLinkEdit
DataField protected / read / write
DataSource protected / read / write

Derived from TCustomdxHyperLinkEdit


ReadOnly protected / read / write

Derived from TdxInplaceHyperLinkEdit


LinkColor protected / read / write StartKey protected / read / write
SingleClick protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write Modified public / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 501

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


502 TCustomdxDBHyperLinkEdit Methods

TCustomdxDBHyperLinkEdit Methods
TCustomdxDBHyperLinkEdit
Create public

Derived from TCustomdxHyperLinkEdit


DoStart protected

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
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

Create method
Creates a TCustomdxDBHyperLinkEdit instance.

constructor Create(AOwner: TComponent); override;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


503

TCustomdxDBHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange prote cted OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


504 TdxDBHyperLinkEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


505

TdxDBHyperLinkEdit Properties
Derived from TCustomdxDBHyperLinkEdit
DataField published / read / write DataSource published / read / write

Derived from TCustomdxHyperLinkEdit


ReadOnly published / read / write

Derived from TdxInplaceHyperLinkEdit


LinkColor published / read / write StartKey published / read / write
SingleClick published / read / write

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

Derived from TdxInplaceEdit


Alignment published / read / write Modified public / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write

ExpressEditors&DBEditors by Developer Express


506 TdxDBHyperLinkEdit Methods

TdxDBHyperLinkEdit Methods
Derived from TCustomdxDBHyperLinkEdit
Create public

Derived from TCustomdxHyperLinkEdit


IsInplace public

Derived from TdxInplaceHyperLinkEdit


DoStart protected

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
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public ValidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


507

TdxDBHyperLinkEdit Events
Derived from TdxInplaceHyperLinkEdit
OnStartClick published

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


508 TCustomdxDBTimeEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 509

TCustomdxDBTimeEdit Properties
TCustomdxDBTimeEdit
DataField protected / read / write DataSource protected / read / write

Derived from TdxInplaceTimeEdit


Time protected / read / write TimeEditFormat protected / read / write

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / w rite StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

ExpressEditors&DBEditors by Developer Express


510 TCustomdxDBTimeEdit Properties

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 511

TCustomdxDBTimeEdit Methods
TCustomdxDBTimeEdit
Create public

Derived from TCustomdxTimeEdit


IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


512 TCustomdxDB TimeEdit Methods

Create method
Creates a TCustomdxDBTimeEdit instance.

constructor Create(AOwner: TComponent); override;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


513

TCustomdxDBTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


514 TdxDBTimeEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


515

TdxDBTimeEdit Properties
Derived from TCustomdxDBTimeEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceTimeEdit


Time published / read / write TimeEditFormat published / read / write

Derived from 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

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

Derived from TdxInplaceTextEdit


AutoSelect published / 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 publis hed / read / write SelText public / read / write
MaxLength protected / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


516 TdxDBTimeEdit Methods

TdxDBTimeEdit Methods
Derived from TCustomdxDBTimeEdit
Create public

Derived from TCustomdxTimeEdit


IsInplace public

Derived from TdxInplaceSpinEdit


DefaultMaxValue public IsValidChar protected
DefaultMinValue public SetEditMaxValue protected
DefaultValueType public SetEditMinValue protected
GetIncrement protected SetEditValueType protected
GetValue protected SetValue protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


517

TdxDBTimeEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


518 TCustomdxDBCurrencyEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 519

TCustomdxDBCurrencyEdit Properties
TCustomdxDBCurrencyEdit
DataField protected / read / write DataSource protected / read / write

Derived from TdxInplaceCurrencyEdit


DecimalPlaces protected / read / write MinValue protected / read / write
DisplayFormat protected / read / write Value protected / read / write
MaxValue protected / read / write

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

ExpressEditors&DBEditors by Developer Express


520 TCustomdxDBCurrencyEdit Properties

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 521

TCustomdxDBCurrencyEdit Methods
TCustomdxDBCurrencyEdit
Create public

Derived from TCustomdxCurrencyEdit


IsInplace public

Derived from TdxInplaceCurrencyEdit


DefaultDisplayFormat public DefaultMinValue public
DefaultMaxValue public IsValidChar protected

Derived from TdxInplaceMaskEdit


CheckCursor prote cted GetNextEditChar protected
Clear public GetPr iorEditChar 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Create method
Creates a TCustomdxDBCurrencyEdit instance.

ExpressEditors&DBEditors by Developer Express


522

constructor Create(AOwner: TComponent); override;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


523

TCustomdxDBCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


524 TdxDBCurrencyEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


525

TdxDBCurrencyEdit Properties
Derived from TCustomdxDBCurrrencyEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceCurrencyEdit


DecimalPlaces published / read / write MinValue published / read / write
DisplayFormat published / read / write Value published / read / write
MaxValue published / read / write

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

Derived from TdxInplaceTextEdit


AutoSelect published / 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 published / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


526 TdxDBCurrencyEdit Methods

TdxDBCurrencyEdit Methods
Derived from TCustomdxDBCurrencyEdit
Create public

Derived from TCustomdxCurrencyEdit


IsInplace public

Derived from TdxInplaceCurrencyEdit


DefaultDisplayFormat public DefaultMinValue public
DefaultMaxValue public IsValidChar protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


527

TdxDBCurrencyEdit Events
Derived from TdxInplaceTextEdit
OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


528 TCustomdxDBGraphicEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 529

TCustomdxDBGraphicEdit Properties
TCustomdxDBGraphicEdit
DataField protected / read / write DataSource protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
Container protected / read / write StoredValues protected / read / write
Height published / read / write Style public / read / write
Modified public / read / write StyleController protected / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


530

TCustomdxDBGraphicEdit Methods
TCustomdxDBGraphicEdit
Create public

Derived from TCustomdxGraphicEdit


IsInplace public

Derived from TdxInplaceGraphicEdit


AssignPicture protected GetGraphicClass protected
ClearPicture public LoadFromFile public
CopyToClipboard public PasteFromClipboard public
CustomClick protected SaveToFile public
CutToClipboard public

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

Create method
Creates a TCustomdxDBGraphicEdit instance.

constructor Create(AOwner: TComponent); override;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


531

TCustomdxDBGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture protected OnGetGraphicClass protected
OnCustomClick protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


532 TdxDBGraphicEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


533

TdxDBGraphicEdit Properties
Derived from TCustomdxDBGraphicEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceGraphicEdit


AutoSize protected / read / write Picture public / 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 published / read / write ToolbarPos public / read / write
DblClickActivate published / read / write ToolbarPosStored published / read / write
GraphicTransparency published / read / write

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly published / read / write
Container protected / read / write StoredValues protected / read / write
Height published / read / write Style published / read / write
Modified public / read / write StyleController published / read / write

ExpressEditors&DBEditors by Developer Express


534 TdxDBGraphicEdit Methods

TdxDBGraphicEdit Methods
Derived from TCustomdxDBGraphicEdit
Create public

Derived from TCustomdxGraphicEdit


IsInplace public

Derived from TdxInplaceGraphicEdit


AssignPicture protected GetGraphicClass protected
ClearPicture public LoadFromFile public
CopyToClipboard public PasteFromClipboard public
CustomClick protected SaveToFile public
CutToClipboard public

Derived from TdxInplaceEdit


CanModify public Reset public
Deselect public RestoreDefaults public
InvalidateEdit public SelectAll public
IsEditClass public ValidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


535

TdxDBGraphicEdit Events
Derived from TdxInplaceGraphicEdit
OnAssignPicture published OnGetGraphicClass published
OnCustomClick published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


536 TCustomdxDBLookupEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 537

TCustomdxDBLookupEdit Properties
TCustomdxDBLookupEdit
DataField protected / read / write DataSource protected / read / write

Derived from 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

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked published / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text public / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

ExpressEditors&DBEditors by Developer Express


538

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 539

TCustomdxDBLookupEdit Methods
TCustomdxDBLookupEdit
Create public IsInplace public

Derived from TdxInplaceLookupEdit


ClearField protected IsEditable public
DoCloseUp protected SetKeyValue protected
DoIncremental protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoDropDownKeys protected PopupBorderStyle public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


540

Create method
Creates a TCustomdxDBLookupEdit instance.

constructor Create(AOwner: TComponent); override;

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

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxDBLookupEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


541

TCustomdxDBLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp protected

Derived from TdxInplaceDropDownEdit


OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


542 TdxDBLookupEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


543

TdxDBLookupEdit Properties
Derived from TCustomdxDBLookupEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceLookupEdit


CanDeleteText published / read / write ListSource published / read / write
ClearKey published / read / write LookupKeyValue published / read / write
Field protected / read / write LookupMode published / read only
KeyFieldName published / read / write Revertable published / read / write
ListFieldName published / read / w rite

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown published / read / write
DropDownRows published / read / write ImmediatePopup protected / read / write
DropDownWidth published / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked published / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text public / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / 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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


544 TdxDBLookupEdit Methods

TdxDBLookupEdit Methods
Derived from TCustomdxDBLookupEdit
Create public IsInplace public

Derived from TdxInplaceLookupEdit


ClearField protected IsEditable public
DoCloseUp protected SetKeyValue protected
DoIncremental protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoDropDownKeys protected PopupBorderStyle public

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


545

TdxDBLookupEdit Events
Derived from TdxInplaceLookupEdit
OnCloseUp published

Derived from TdxInplaceDropDownEdit


OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


546 TCustomdxDBBlobEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


547

TCustomdxDBBlobEdit Properties
TCustomdxDBBlobEdit
BlobKind protected / read / write DataSource protected / read / write
DataField protected / read / write

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

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


548

BlobKind property read / write


Specifies the type of BLOB field.

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).

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


AssignEditProperties method 549

TCustomdxDBBlobEdit Methods
TCustomdxDBBlobEdit
AssignEditProperties protected IsInplace public
Create public

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

AssignEditProperties method

ExpressEditors&DBEditors by Developer Express


550
procedure AssignEditProperties; override;

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.

constructor Create(AOwner: TComponent); override;

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

class function IsInplace: Boolean; override;

Description
Always returns False for TCustomdxDBBlobEdit.

Copyright © 2000 Developer Express Inc. www.devexpress.com


551

TCustomdxDBBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture protected OnGetGraphicClass protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


552 TdxDBBlobEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


553

TdxDBBlobEdit Properties
Derived from TCustomdxDBBlobEdit
BlobKind published / read / write DataSource published / read / write
DataField published / read / write

Derived from TdxInplaceBlobEdit


AlwaysSaveText published / read / write MemoWordWrap published / read / write
BlobEditKind protected / read / write PictureAutoSize published / read / write
BlobPaintStyle published / read / write PictureClipboardFormat publi? / read / write
BlobText protected / 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

Derived from TdxInplaceDropDownEdit


ButtonGlyph protected / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder published / read / write

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write

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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container prote cted / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


554 TdxDBBlobEdit Methods

TdxDBBlobEdit Methods
Derived from TCustomdxDBBlobEdit
AssignEditProperties protected IsInplace public
Create public

Derived from TdxInplaceBlobEdit


AssignPicture protected SavePopupSize protected
GetGraphicClass protected SetBlobValue protected
IsSizeablePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


555

TdxDBBlobEdit Events
Derived from TdxInplaceBlobEdit
OnAssignPicture published OnGetGraphicClass published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEd itButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


556 TCustomdxDBMRUEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 557

TCustomdxDBMRUEdit Properties
TCustomdxDBMRUEdit
DataField protected / read / write DataSource protected / read / write

Derived from TdxInplaceMRUEdit


ImmediateDropDown protected / read / write ShowEllipsis protected / read / write
MaxItemCount protecte d / read / write

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

ExpressEditors&DBEditors by Developer Express


558

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 559

TCustomdxDBMRUEdit Methods
TCustomdxDBMRUEdit
Create public

Derived from TCustomdxMRUEdit


IsInplace public

Derived from TdxInplaceMRUEdit


AddItem public ButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


560 TCustomdxDBMRUEdit Methods

Create method
Creates a TCustomdxDBMRUEdit instance.

constructor Create(AOwner: TComponent); override;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


561

TCustomdxDBMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

ExpressEditors&DBEditors by Developer Express


562 TdxDBMRUEdit

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


563

ExpressEditors&DBEditors by Developer Express


564 TdxDBMRUEdit Properties

TdxDBMRUEdit Properties
Derived from TCustomdxDBMRUEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceMRUEdit


ImmediateDropDown published / read / write ShowEllipsis published / read / write
MaxItemCount published / read / write

Derived from TdxInplacePickEdit


CanDeleteText published / read / write Items published / read / write
DropDownListStyle published / read / write Revertable published / read / write
ItemIndex public / read / write Sorted protected / read / write

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediatePopup protected / read / write
DropDownRows published / read / write PopupAlignment published / read / write
DropDownWidth published / read / w rite PopupBorder published / read / write
DroppedDown public / read / write

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text protected / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


565

TdxDBMRUEdit Methods
Derived from TCustomdxDBMRUEdit
Create public

Derived from TCustomdxMRUEdit


IsInplace public

Derived from TdxInplaceMRUEdit


AddItem public ButtonClick protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


566 TdxDBMRUEdit Events

TdxDBMRUEdit Events
Derived from TdxInplaceMRUEdit
OnButtonClick published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


567

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

ExpressEditors&DBEditors by Developer Express


568 TCustomdxDBPopupEdit Properties

TCustomdxDBPopupEdit Properties
TCustomdxDBPopupEdit
DataField protected / read / write DataSource protected / read / write

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataSource property 569

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


570 TCustomdxDBPopupEdit Methods

TCustomdxDBPopupEdit Methods
TCustomdxDBPopupEdit
Create public

Derived from TCustomdxPopupEdit


IsInplace public

Derived from TdxInplacePopupEdit


CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from TdxInplaceMaskEdit


CheckCursor protected GetNextEditChar protecte d
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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 571

Create method
Creates a TCustomdxDBPopupEdit instance.

constructor Create(AOwner: TComponent); override;

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.

ExpressEditors&DBEditors by Developer Express


572 TCustomdxDBPopupEdit Events

TCustomdxDBPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


573

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

ExpressEditors&DBEditors by Developer Express


574 TdxDBPopupEdit Properties

TdxDBPopupEdit Properties
Derived from TCustomdxDBPopupEdit
DataField published / read / write DataSource published / read / write

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 / w rite PopupMinWidth published / read / write
PopupClientEdge published / read / write PopupSizeable published / read / write
PopupFlatBorder published / read / write PopupWidth published / read / write
PopupFormBorderStyle published / read / write

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown protected / read / write
DropDownRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment published / read / write
DroppedDown public / read / write PopupBorder protected / read / write

Derived from TdxInplaceMaskEdit


EditMask published / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text public / read / write

Derived from TdxInplaceTextEdit


AutoSelect published / read / write OEMConvert protected / 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 protected / read / write SelText public / read / write
MaxLength published / read / write

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


575

TdxDBPopupEdit Methods
Derived from TCustomdxDBPopupEdit
Create public

Derived from TCustomdxPopupEdit


IsInplace public

Derived from TdxInplacePopupEdit


CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


576 TdxDBPopupEdit Events

TdxDBPopupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery published OnInitPopup published
OnCloseUp published OnPopup published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected
OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

Copyright © 2000 Developer Express Inc. www.devexpress.com


577

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

ExpressEditors&DBEditors by Developer Express


578 TdxInplaceExtLookupEdit Properties

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

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

Derived from 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

Derived from TdxInplaceMaskEdit


EditMask protected / read / write IsMasked public / read only
EditText public / read / write MaskState protected / read / write
IgnoreMaskBlank protected / read / write Text protected / read / write

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

CanDeleteText property read / write


Specifies whether a user can delete the value displayed within an editor.

Copyright © 2000 Developer Express Inc. www.devexpress.com


ChooseByDblClick property 579

property CanDeleteText: Boolean;

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.

The default value is False .

ChooseByDblClick property read / write


Specifies whether a double click within a grid cell selects a given value.

property ChooseByDblClick: Boolean;

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.

ClearKey property read / write


Specifies the shortcut used to clear an editor's value.

property ClearKey: TShortCut;

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.

DBGridLayout property read / write


Determines the grid layout used for a dropdown window.

property DBGridLayout: TdxDBGridLayout;

Description
TdxInplaceExtLookupEdit uses a specific layout to create a grid within the dropdown window. Use this
property to specify this layout.

Field property read / write


Determines the field associated with a column.

property Field: TField;

ExpressEditors&DBEditors by Developer Express


580 TdxInplaceExtLookupEdit Properties

Description
Every column in a data-aware grid is associated with a dataset field. This property specifies the field
associated with a column.

PickListField property read / write


Specifies the field whose data is added to the current cell of a grid.

property PickListField: string;

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.

UseDefaultSettings property read / write


Determines dropdown grid style.

property UseDefaultSettings: Boolean;

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.

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 581

TdxInplaceExtLookupEdit Methods
Derived from TdxInplacePopupEdit
CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

ExpressEditors&DBEditors by Developer Express


582 TdxInplaceExtLookupEdit Events

TdxInplaceExtLookupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protecte d
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


read / write 583

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

ExpressEditors&DBEditors by Developer Express


584 TCustomdxDBExtLookupEdit Properties

TCustomdxDBExtLookupEdit Properties
TCustomdxDBExtLookupEdit
DataField protected / read / write DataSource protected / read / write

Derived from 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

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

Derived from 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

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

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

Derived from TdxInplaceEdit


Alignment protected / read / write ReadOnly protected / read / write
AutoSize protected / read / write StoredValues protected / read / write
Container protected / read / write Style public / read / write
Height published / read / write StyleController protected / read / write
Modified public / read / write

Copyright © 2000 Developer Express Inc. www.devexpress.com


DataField property 585

DataField property read / write


Determines the field from which an edit control displays its data.

property DataField: string;

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.

DataSource property read / write


Links an edit control to a dataset.

property DataSource: TDataSource;

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.

ExpressEditors&DBEditors by Developer Express


586 TCustomdxDBExtLookupEdit Methods

TCustomdxDBExtLookupEdit Methods
TCustomdxDBExtLookupEdit
Create public IsInplace public

Derived from TdxInplacePopupEdit


CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protecte d
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


Create method 587

Create method
Creates a TCustomdxDBExtLookupEdit instance.

constructor Create(AOwner: TComponent); override;

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.

class function IsInplace: Boolean; override;

Description
The IsInplace method always returns False for TCustomdxDBExtLookupEdit.

ExpressEditors&DBEditors by Developer Express


588 TCustomdxDBExtLookupEdit Events

TCustomdxDBExtLookupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery protected OnInitPopup protected
OnCloseUp protected OnPopup protected

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange protected

Derived from TdxInplaceEdit


OnChange protected OnMouseLeave protected
OnMouseEnter protected OnValidate protected

Copyright © 2000 Developer Express Inc. www.devexpress.com


589

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

ExpressEditors&DBEditors by Developer Express


590 TdxDBExtLookupEdit

Copyright © 2000 Developer Express Inc. www.devexpress.com


591

TdxDBExtLookupEdit Properties
Derived from TCustomdxDBExtLookupEdit
DataField published / read / write DataSource published / read / write

Derived from TdxInplaceExtLookupEdit


CanDeleteText published / read / write Field protected / read / write
ChooseByDblClick published / read / write PickListField published / read / write
ClearKey published / read / write UseDefaultSettings published / read / write
DBGridLayout published / read / write

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

Derived from TdxInplaceDropDownEdit


ButtonGlyph published / read / write ImmediateDropDown published / read / write
DropDow nRows protected / read / write ImmediatePopup protected / read / write
DropDownWidth protected / read / write PopupAlignment protected / read / write
DroppedDown public / read / write PopupBorder protected / read / write

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

Derived from TdxInplaceTextEdit


AutoSelect published / 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

Derived from TdxInplaceEdit


Alignment published / read / write ReadOnly published / read / write
AutoSize published / read / write StoredValues protected / read / write
Container protected / read / write Style published / read / write
Height published / read / write StyleController published / read / write
Modified public / read / write

ExpressEditors&DBEditors by Developer Express


592 TdxDBExtLookupEdit Methods

TdxDBExtLookupEdit Methods
Derived from TCustomdxDBExtLookupEdit
Create public IsInplace public

Derived from TdxInplacePopupEdit


CalcSize protected InitializePopup protected

Derived from TdxInplaceDropDownEdit


DoButtonDown protected DropDown protected
DoButtonUp protected FindListValue protected
DoCloseUp protected PopupBorderStyle public
DoDropDownKeys protected

Derived from 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

Derived from TdxInplaceTextEdit


CheckCharCase protected IsEditClass public
ClearSelection public PasteFromClipboard public
ClearUndo public Redo public
CopyToClipboard public RestoreDefaults public
CutToClipboard public SelectAll public
Deselect public SelectionChange protected
DoSetMaxLength protected SetEditMaxLength protected
GetSelection public SetSelection public
GetSelLength protected SetSelLength protected
GetSelStart protected SetSelStart protected
GetSelText protected SetSelTextBuf public
GetSelTextBuf public Undo public
GetTextLenEx public

Derived from TdxInplaceEdit


CanModify public Reset public
InvalidateEdit public

Copyright © 2000 Developer Express Inc. www.devexpress.com


593

TdxDBExtLookupEdit Events
Derived from TdxInplacePopupEdit
OnCloseQuery published OnInitPopup published
OnCloseUp published OnPopup published

Derived from TdxInplaceDropDownEdit


OnCloseUp protected OnEditButtonClick protected

Derived from TdxInplaceTextEdit


OnSelectionChange published

Derived from TdxInplaceEdit


OnChange published OnMouseLeave published
OnMouseEnter published OnValidate published

ExpressEditors&DBEditors by Developer Express


594 Index

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


595

TdxInplaceCurrencyEdit ..................................................... 171 GetValue ............................................................................... 141


TdxInplaceSpinEdit............................................................ 139 GetVisibleIndex..................................................................... 240
DefaultMinValue............................................................. 140, 171 Glyph............................................................................. 123, 235
TdxInplaceCurrencyEdit ..................................................... 171 GlyphCount........................................................................... 123
TdxInplaceSpinEdit............................................................ 140 GraphicTransparency.............................................................. 180
DefaultValueType .................................................................. 140
TdxInplaceSpinEdit............................................................ 140 H
Descriptions........................................................................... 130
HideEditCursor...................................................................... 211
TdxInplaceImageEdit ......................................................... 130
Deselect ............................................................................ 51, 69 HidePopup...............................................................................59
TdxInplaceEdit ....................................................................51 HideScrollBars.........................................................................90
HideSelection...........................................................................63
DisplayFormat ....................................................................... 168
HotTrack........................................................................... 28, 35
TdxInplaceCurrencyEdit ..................................................... 167
DisplayValue ...........................................................................43 I
DoButtonDown...................................................................... 101
TdxInplaceDropDownEdit .................................................. 101 ImageIndexes......................................................................... 130
DoButtonUp .......................................................................... 102 Images.................................................................................. 130
TdxInplaceDropDownEdit .................................................. 102 ImmediateDropDown .................................................98, 205, 206
DoCloseUp..................................................................... 102, 231 ImmediatePopup ......................................................................99
TdxInplaceDropDownEdit .................................................. 102 Increment .............................................................................. 135
TdxInplaceLookupEdit....................................................... 231 InitializePopup ....................................................................... 218
DoDropDownKeys................................................................. 102 IntValue ................................................................................ 136
TdxInplaceDropDownEdit .................................................. 102 InvalidateCheckRect............................................................... 126
DoIncremental....................................................................... 231 InvalidateEdit...........................................................................51
DoStart.................................................................................. 159 IsEditable.............................................................................. 231
TdxInplaceHyperLinkEdit................................................... 159 IsEditClass ..............................................................................72
DoValidateInput..................................................................... 110 IsInplace. 243, 251, 259, 268, 278, 286, 295, 304, 313, 322, 330, 339,
TdxInplaceDateEdit ........................................................... 110 348, 356, 365, 375, 384, 540, 550, 587
DropDown............................................................................. 103 TCustomdxBlobEdit........................................................... 365
TdxInplaceDropDownEdit .................................................. 103 TCustomdxButtonEdit ........................................................ 278
DropDownListStyle................................................................ 146 TCustomdxCalcEdit........................................................... 322
TdxInplacePickEdit ............................................................ 146 TCustomdxCheckEdit......................................................... 286
DropDownRows.......................................................................97 TCustomdxCurrencyEdit .................................................... 348
DropDownWidth......................................................................98 TCustomdxDateEdit ........................................................... 268
DroppedDown..........................................................................98 TCustomdxDBBlobEdit...................................................... 550
TCustomdxEdit.................................................................. 243
E TCustomdxGraphicEdit...................................................... 356
EditMask .................................................................................78 TCustomdxHyperLinkEdit .................................................. 330
EditorEnabled........................................................................ 135 TCustomdxImageEdit......................................................... 295
TCustomdxMaskEdit.......................................................... 251
EditStyleController...................................................................36
EditText ............................................................................ 78, 79 TCustomdxMemo .............................................................. 259
EditValue ................................................................................43 TCustomdxMRUEdit.......................................................... 375
TCustomdxPickEdit ........................................................... 313
EndUpdate...............................................................................21
TCustomdxPopupEdit......................................................... 384
F TCustomdxSpinEdit........................................................... 304
TCustomdxTimeEdit.......................................................... 338
Field ................................................................228, 399, 579, 580 IsMasked.................................................................................79
TdxEditDataLink ............................................................... 399 IsPopupMenu......................................................................... 176
FieldName............................................................................. 399 IsSizeablePopup..................................................................... 200
TdxEditDataLink ............................................................... 399 IsValidChar.................................................................... 141, 171
FindListValue ........................................................................ 103 ItemIndex.............................................................................. 146
FlatBorder ............................................................................. 222 Items.............................................................................. 146, 239
FullFocusRect ........................................................................ 122
K
G
KeyFieldName....................................................................... 228
GetAbsoluteIndex................................................................... 240 Kind...................................................................................... 235
GetBlankText...........................................................................83
GetDefaultEditStyleController...................................................41 L
GetDisableCloseEditor..............................................................83
GetEditingText.........................................................................83 LargeImages.......................................................................... 130
LeftAlignment........................................................................ 236
GetEditValue ...........................................................................44
Lines.......................................................................................91
GetFirstEditChar................................................................ 83, 84
GetGraphicClass......................................................184, 185, 200 LinkColor.............................................................................. 157
GetIncrement......................................................................... 141 Links.......................................................................................19
ListFieldName....................................................................... 228
GetLastEditChar.......................................................................84
GetMaxChars...........................................................................84 ListSource............................................................................. 229
GetNextEditChar......................................................................85 LoadDisplayValue.................................................................. 453
TCustomdxDBCheckEdit.................................................... 453
GetPriorEditChar......................................................................85
LoadFromFile........................................................................ 185
GetSel.....................................................................................85
GetSelLength...........................................................................70 LookupKeyValue ................................................................... 229
GetSelStart ..............................................................................70 LookupMode ......................................................................... 229
GetSelText ..............................................................................71 M
GetSelTextBuf.........................................................................71
GetTextLen.............................................................................86 MaskState................................................................................80

ExpressEditors&DBEditors by Developer Express


596 Index

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

Copyright © 2000 Developer Express Inc. www.devexpress.com


597

Create............................................................................... 493 IsInplace........................................................................... 243


DataField.......................................................................... 490 TCustomdxGraphicEdit ................................................... 354, 356
DataSource........................................................................ 491 IsInplace........................................................................... 356
TCustomdxDBCheckEdit ...................................450, 451, 452, 453 TCustomdxHyperLinkEdit ............................................... 328, 330
Create............................................................................... 453 IsInplace........................................................................... 330
DataField.......................................................................... 451 TCustomdxImageEdit ...................................................... 292, 294
DataSource........................................................................ 451 IsInplace........................................................................... 294
ValueChecked................................................................... 452 TCustomdxMaskEdit ....................................................... 249, 251
ValueGrayed..................................................................... 452 IsInplace........................................................................... 251
ValueUnchecked................................................................ 452 TCustomdxMemo............................................................ 257, 259
TCustomdxDBCheckEdit IsInplace........................................................................... 259
LoadDisplayValue ............................................................. 453 TCustomdxMRUEdit ....................................................... 372, 375
TCustomdxDBCurrencyEdit.................................................... 518 IsInplace........................................................................... 375
Create............................................................................... 521 TCustomdxPickEdit......................................................... 310, 312
DataField.......................................................................... 519 IsInplace........................................................................... 312
DataSource........................................................................ 520 TCustomdxPopupEdit ............................................................. 384
TCustomdxDBDateEdit .....................................429, 430, 431, 433 IsInplace........................................................................... 384
Create............................................................................... 433 TCustomdxSpinEdit ........................................................ 301, 303
DataField................................................................... 430, 431 IsInplace........................................................................... 303
DataSource........................................................................ 431 TCustomdxTimeEdit ....................................................... 336, 339
TCustomdxDBEdit ...................................................402, 403, 404 IsInplace........................................................................... 338
Create............................................................................... 404 TdxBlobEdit.......................................................................... 367
DataField.......................................................................... 403 TdxButtonEdit ....................................................................... 280
DataSource........................................................................ 403 TdxCalcEdit .......................................................................... 324
TCustomdxDBExtLookupEdit .......................................... 583, 587 TdxCheckEdit ........................................................................ 288
Create............................................................................... 587 TdxCheckEditStyleController........................................... 118, 119
DataField.......................................................................... 585 BorderStyle....................................................................... 119
DataSource........................................................................ 585 ButtonStyle....................................................................... 119
IsInplace........................................................................... 587 TdxCurrencyEdit.................................................................... 350
TCustomdxDBGraphicEdit...................................................... 528 TdxDateEdit .......................................................................... 270
Create............................................................................... 530 TdxDBBlobEdit..................................................................... 552
DataField.......................................................................... 529 TdxDBButtonEdit .................................................................. 446
DataSource........................................................................ 529 TdxDBCalcEdit...................................................................... 495
TCustomdxDBHyperLinkEdit ................................................. 499 TdxDBCheckEdit ................................................................... 455
Create............................................................................... 502 TdxDBCurrencyEdit............................................................... 524
DataField.......................................................................... 500 TdxDBDateEdit ..................................................................... 435
DataSource........................................................................ 500 TdxDBEdit ............................................................................ 406
TCustomdxDBImageEdit...................................459, 460, 461, 463 TdxDBExtLookupEdit ............................................................ 589
Create............................................................................... 463 TdxDBGraphicEdit................................................................. 532
DataField.......................................................................... 461 TdxDBHyperLinkEdit ............................................................ 504
DataSource........................................................................ 461 TdxDBImageEdit ................................................................... 465
TCustomdxDBLookupEdit ............................................... 536, 540 TdxDBLookupEdit ................................................................. 542
Create............................................................................... 540 TdxDBMaskEdit.................................................................... 416
DataField.......................................................................... 537 TdxDBMemo......................................................................... 425
DataSource........................................................................ 538 TdxDBMRUEdit .................................................................... 562
IsInplace........................................................................... 540 TdxDBPickEdit...................................................................... 485
TCustomdxDBMaskEdit....................................410, 411, 413, 414 TdxDBPopupEdit ................................................................... 573
Create............................................................................... 413 TdxDBSpinEdit...................................................................... 475
DataField.......................................................................... 411 TdxDBTimeEdit..................................................................... 514
DataSource........................................................................ 412 TdxEdit ................................................................................. 245
TCustomdxDBMemo................................................420, 421, 423 TdxEditButton ................................................................ 234, 237
Create............................................................................... 423 Assign .............................................................................. 237
DataField.......................................................................... 421 Default.............................................................................. 235
DataSource........................................................................ 422 Glyph ............................................................................... 235
TCustomdxDBMRUEdit ......................................................... 556 Kind................................................................................. 235
Create............................................................................... 560 LeftAlignment ................................................................... 236
DataField.......................................................................... 557 RestoreDefaults................................................................. 237
DataSource........................................................................ 558 Visible .............................................................................. 236
TCustomdxDBPickEdit........................................................... 479 Width ............................................................................... 236
Create............................................................................... 483 TdxEditButtons...................................................................... 238
DataField.......................................................................... 480 Add .................................................................................. 240
DataSource........................................................................ 481 GetAbsoluteIndex .............................................................. 240
TCustomdxDBPopupEdit ........................................................ 567 GetVisibleIndex................................................................. 240
Create............................................................................... 571 Items................................................................................ 239
DataField.......................................................................... 568 Owner............................................................................... 239
DataSource........................................................................ 569 RestoreDefaults................................................................. 240
TCustomdxDBSpinEdit .......................................................... 469 VisibleCount..................................................................... 239
Create............................................................................... 473 VisibleItems...................................................................... 239
DataField.......................................................................... 470 TdxEditDataDefinition
DataSource........................................................................ 471 DisplayValue.......................................................................43
TCustomdxDBTimeEdit ......................................................... 508 EditValue............................................................................43
Create............................................................................... 512 GetEditValue.......................................................................44
DataField.......................................................................... 509 OnActiveChange..................................................................45
DataSource........................................................................ 510 OnDataChange ....................................................................45
TCustomdxEdit ............................................................... 241, 243 SetEditValue .......................................................................44

ExpressEditors&DBEditors by Developer Express


598 Index

TdxEditDataLink..................................................... 398, 399, 400 State..................................................................................124


Create...............................................................................400 Toggle...............................................................................126
Field .................................................................................399 TdxInplaceCurrencyEdit..........................................................166
FieldName.........................................................................399 DecimalPlaces....................................................................167
Modified...........................................................................400 DefaultDisplayFormat.........................................................170
Reset.................................................................................400 DefaultMaxValue...............................................................171
TdxEditDBDataDefinition.......................................................401 DefaultMinValue................................................................171
TdxEditStyle.................................................................30, 36, 37 DisplayFormat ...................................................................167
DefaultButtonTransparence.................................................. 39 IsValidChar.......................................................................171
DefaultShadow.................................................................... 40 MaxValue..........................................................................168
Destroy.............................................................................. 37 MinValue ..........................................................................168
Edges................................................................................. 34 Value .........................................................................168, 169
Edit.................................................................................... 31 TdxInplaceDateEdit................................................................105
RestoreDefaults................................................................... 41 Date..................................................................................106
TdxEditStyleController............................................................ 24 DateButtons.......................................................................107
BorderColor........................................................................ 25 DateChange.......................................................................109
ButtonStyle......................................................................... 26 DateOnError......................................................................107
ButtonTransparence............................................................. 27 DateValidation...................................................................108
Edges................................................................................. 27 DoValidateInput.................................................................110
TdxGraphicEdit ......................................................................358 OnDateChange...................................................................111
TdxHyperLinkEdit..................................................................332 OnDateValidateInput ..........................................................111
TdxImageEdit ........................................................................297 SaveTime ..........................................................................108
TdxInplaceBlobEdit ................................................................188 UseEditMask .....................................................................108
AlwaysSaveText ................................................................189 TdxInplaceDropDownEdit ........................................................ 96
AssignPicture.....................................................................199 ButtonGlyph....................................................................... 97
BlobEditKind.....................................................................190 DoButtonDown..................................................................101
BlobPaintStyle...................................................................190 DoButtonUp ......................................................................102
BlobText ...........................................................................191 DoCloseUp........................................................................102
GetGraphicClass................................................................200 DoDropDownKeys.............................................................102
IsSizeablePopup.................................................................200 DropDown.........................................................................103
MemoCharCase..................................................................191 DropDownRows.................................................................. 97
MemoHideScrollBars.........................................................192 DropDownWidth................................................................. 98
MemoMaxLength...............................................................192 DroppedDown..................................................................... 98
MemoOEMConvert ............................................................192 FindListValue ....................................................................103
MemoScrollBars................................................................193 ImmediateDropDown .......................................................... 98
MemoSelectionBar.............................................................193 ImmediatePopup ................................................................. 99
MemoWantReturns.............................................................194 OnCloseUp........................................................................104
MemoWantTabs.................................................................194 OnEditButtonClick.............................................................104
MemoWordWrap ...............................................................194 PopupAlignment ................................................................. 99
OnAssignPicture................................................................202 PopupBorder....................................................................... 99
OnGetGraphicClass............................................................202 PopupBorderStyle..............................................................103
PictureAutoSize..........................................................194, 195 TdxInplaceEdit ........................................................................ 46
PictureClipboardFormat ......................................................195 Alignment .......................................................................... 47
PictureFilter.......................................................................195 CanModify ......................................................................... 51
PictureGraphicClass ...........................................................195 Container............................................................................ 48
PictureTransparency ...........................................................196 Height................................................................................ 48
PopupHeight......................................................................196 IsEditClass ......................................................................... 52
PopupWidth.......................................................................196 Modified............................................................................ 48
SavePopupSize...................................................................200 OnChange .......................................................................... 54
SetBlobValue.....................................................................201 OnMouseEnter.................................................................... 54
ShowExPopupItems............................................................197 OnMouseLeave................................................................... 54
ShowPicturePopup .............................................................197 OnValidate......................................................................... 55
SizeablePopup....................................................................197 Reset.................................................................................. 52
Text..................................................................................198 RestoreDefaults................................................................... 52
TdxInplaceButtonEdit .............................................................112 StoredValues....................................................................... 49
Buttons..............................................................................113 Style.................................................................................. 49
ClickKey...........................................................................113 StyleController.................................................................... 49
DefaultButtonClick.............................................................115 TdxInplaceExtLookupEdit ................................................577, 579
OnButtonClick...................................................................117 CanDeleteText............................................................578, 579
ViewStyle..........................................................................114 ChooseByDblClick.............................................................579
TdxInplaceCalcEdit ................................................................150 ClearKey...........................................................................579
BeepOnError......................................................................151 DBGridLayout...................................................................579
ButtonStyle........................................................................152 Field .................................................................................579
Precision...........................................................................152 PickListField .....................................................................580
QuickClose........................................................................152 UseDefaultSettings.............................................................580
ShowButtonFrame..............................................................153 TdxInplaceGraphicEdit ...........................................................177
TdxInplaceCheckEdit..............................................................121 AssignPicture.....................................................................183
AllowGrayed.....................................................................122 AutoSize ...........................................................................178
Checked............................................................................122 Center ........................................................................178, 179
FullFocusRect ....................................................................123 ClearPicture.......................................................................183
Glyph................................................................................123 ClipboardFormat ................................................................179
GlyphCount.......................................................................123 CopyToClipboard...............................................................183
InvalidateCheckRect...........................................................126 CustomClick......................................................................184
MultiLine ..........................................................................124 CustomFilter......................................................................179
NullStyle...........................................................................124 CustomGraphic..................................................................179

Copyright © 2000 Developer Express Inc. www.devexpress.com


599

CutToClipboard................................................................. 184 HideScrollBars....................................................................90


DblClickActivate............................................................... 179 Lines ..................................................................................91
GetGraphicClass................................................................ 184 ScrollBars...........................................................................91
GraphicTransparency.......................................................... 180 SelectionBar.................................................................. 91, 92
LoadFromFile.................................................................... 185 WantReturns........................................................................92
OnAssignPicture................................................................ 186 WantTabs............................................................................92
OnCustomClick ................................................................. 186 WordWrap ..........................................................................92
OnGetGraphicClass............................................................ 186 TdxInplaceMRUEdit .............................................................. 204
PasteFromClipboard........................................................... 185 AddItem............................................................................ 207
Pictur e .............................................................................. 180 ButtonClick....................................................................... 208
QuickDraw........................................................................ 180 ImmediateDropDown......................................................... 205
SaveToFile........................................................................ 185 MaxItemCount................................................................... 206
Stretch .............................................................................. 181 OnButtonClick................................................................... 209
ToolbarLayout ................................................................... 181 ShowEllipsis...................................................................... 206
ToolbarPos........................................................................ 181 TdxInplacePickEdit ................................................................ 144
ToolbarPosStored........................................................ 181, 182 CanDeleteText................................................................... 145
TdxInplaceHyperLinkEdit ....................................................... 156 DropDownListStyle........................................................... 146
DoStart ............................................................................. 159 ItemIndex.......................................................................... 146
LinkColor.......................................................................... 157 Items................................................................................ 146
OnStartClick...................................................................... 160 Revertable......................................................................... 146
SingleClick........................................................................ 157 Sorted............................................................................... 147
StartKey............................................................................ 158 TdxInplacePopupControl...........................................................56
TdxInplaceImageEdit.............................................................. 128 PopupBorderStyle................................................................57
DefaultImages................................................................... 129 Shadow...............................................................................57
Descriptions...................................................................... 130 ShadowSize.........................................................................58
ImageIndexes.................................................................... 130 TdxInplacePopupEdit ............................................................. 210
Images.............................................................................. 130 CaclSize............................................................................ 217
LargeImages...................................................................... 130 HideEditCursor........................................................... 211, 212
MultiLineText ................................................................... 131 InitializePopup................................................................... 218
ShowDescription................................................................ 131 OnCloseQuery................................................................... 219
Values .............................................................................. 131 OnCloseUp........................................................................ 219
TdxInplaceLookupEdit ........................................................... 226 OnInitPopup...................................................................... 220
CanDeleteText................................................................... 227 OnPopup ........................................................................... 220
ClearField......................................................................... 230 PopupAutoSize.................................................................. 212
ClearKey........................................................................... 228 PopupClientedge................................................................ 212
DoCloseUp........................................................................ 231 PopupClientEdge ............................................................... 212
DoIncremental................................................................... 231 PopupControl.................................................................... 212
Field................................................................................. 228 PopupFlatBorder................................................................ 213
IsEditable.......................................................................... 231 PopupForm........................................................................ 213
KeyFieldName................................................................... 228 PopupFormBorderStyle...................................................... 213
ListFieldName................................................................... 228 PopupFormCaption ............................................................ 214
ListSource......................................................................... 229 PopupHeight...................................................................... 214
LookupKeyValue............................................................... 229 PopupMinHeight................................................................ 214
LookupMode..................................................................... 229 PopupMinWidth................................................................ 215
OnCloseUp........................................................................ 233 PopupSizeable................................................................... 215
Revertable......................................................................... 229 PopupWidth ...................................................................... 215
SetKeyValue ..................................................................... 231 TdxInplaceSpinEdit ................................................................ 134
TdxInplaceMaskEdit.................................................................77 DefaultMaxValue............................................................... 139
CheckCursor........................................................................81 DefaultMinValue ............................................................... 140
Clear...................................................................................82 DefaultValueType.............................................................. 140
DefaultEditMask ..................................................................82 EditorEnabled.................................................................... 135
DefaultMaxLength...............................................................82 GetIncrement..................................................................... 140
EditMaskK..........................................................................78 GetValue........................................................................... 141
EditText..............................................................................78 Increment................................................................... 135, 136
GetBlankText ......................................................................83 IntValue............................................................................ 136
GetDisableCloseEditor.........................................................83 IsValidChar....................................................................... 141
GetEditingText ....................................................................83 MaxValue ......................................................................... 136
GetFirstEditChar..................................................................83 MinValue.......................................................................... 136
GetLastEditChar ..................................................................84 SetEditMaxValue............................................................... 141
GetMaxChars......................................................................84 SeteditMinValue ................................................................ 141
GetNextEditChar.................................................................84 SetEditVlueType................................................................ 142
GetPriorEditChar .................................................................85 SetValue ........................................................................... 142
GetSel.................................................................................85 UseCtrlIncrement............................................................... 137
GetTextLen.........................................................................86 Value ................................................................................ 137
IgnoreMaskBlank.................................................................79 ValueType......................................................................... 137
IsMasked.............................................................................79 TdxInplaceTextEdit ..................................................................60
MaskState...........................................................................80 AutoSelect...........................................................................61
ReformatText ......................................................................86 CheckCharCase...................................................................67
SetCursor............................................................................86 Clear...................................................................................67
SetSel .................................................................................86 ClearUndo...........................................................................68
Text....................................................................................79 CutToClipboard...................................................................69
ValidateEdit ........................................................................87 DoSetMaxLength.................................................................70
ValidateError.......................................................................87 GetSelection........................................................................70
TdxInplaceMemoEdit ...............................................................89 GetTextLenEx .....................................................................71
AutoSize.............................................................................90 OnSelectionChange..............................................................76

ExpressEditors&DBEditors by Developer Express


600 Index

Redo .................................................................................. 72 StyleChanged...................................................................... 22


RestoreDefaults.............................................................. 72, 73 TdxTimeEdit ..........................................................................341
SelectionBar ....................................................................... 64 Text ................................................................ 65, 66, 79, 80, 198
SelectionChange.................................................................. 73 Time .....................................................................................162
SetEditMaxLength............................................................... 73 TimeEditFormat .....................................................................162
SetSelection........................................................................ 74 Toggle...................................................................................126
Undo.................................................................................. 75 ToolbarLayout........................................................................181
TdxInplaceTimeEdit ...............................................................161 ToolbarPos.............................................................................181
Time.................................................................................162 ToolbarPosStored...................................................................181
TimeEditFormat .................................................................163
TdxMaskEdit .........................................................................253 U
TdxMemo..............................................................................261
Update.................................................................................... 22
TdxMRUEdit .........................................................................377
TdxPickEdit ...........................................................................315 UseCtrlIncrement....................................................................137
TdxPopupEdit ........................................................................386 UseDefaultSettings .................................................................580
UseEditMask..........................................................................108
TdxPopupEditForm.................................................................221
ClientEdge.........................................................................222 V
ClosePopup .......................................................................225
FlatBorder .........................................................................222 ValidateEdit ....................................................................... 52, 87
PopupFormBorderStyle.......................................................222 ValidateError.......................................................................... 87
PopupMinHeight................................................................223 Value..............................................................................137, 168
PopupMinHieght................................................................223 ValueChecked........................................................................452
PopupMinWidth.................................................................223 TCustomdxDBCheckEdit ....................................................452
ShowPopup .......................................................................225 ValueGrayed..........................................................................452
Sizeable.............................................................................224 TCustomdxDBCheckEdit ....................................................452
SizingCorner......................................................................224 Values ...................................................................................131
TdxPopupToolBarWindow ValueType .............................................................................137
CustomButtonGlyph...........................................................175 ValueUnchecked.....................................................................452
IsPopupMenu.....................................................................176 TCustomdxDBCheckEdit ....................................................452
TdxPopupToolBarWindow......................................................173 ViewStyle..............................................................................114
Alignment .........................................................................174 Visible............................................................................176, 236
Buttons..............................................................................174 VisibleCount..........................................................................239
CustomButtonCaption.........................................................175 VisibleItems...........................................................................239
CustomButtonGlyph...........................................................176
IsPopupMenu.....................................................................176 W
ShowCaptions....................................................................175
Visible ..............................................................................176 WantReturns........................................................................... 92
TdxSpinEdit...........................................................................306 WantTabs ............................................................................... 92
TdxStyleController.................................................................. 18 Width....................................................................................236
Changed........................................................................ 20, 21 WordWrap.............................................................................. 93
OnStyleChanged................................................................. 23

Copyright © 2000 Developer Express Inc. www.devexpress.com

You might also like