ShowGetTextDlg method (LEADDlgEffect Control)

C++ Builder example

Delphi 4.0 example

 

Builder Syntax

int ShowGetTextDlg(TWinControl* AOwnerCtrl);

Delphi Syntax

Function ShowGetTextDlg (AOwnerCtrl: TWinControl ): L_INT;

Overview

Refer to Using Imaging Common Dialogs.

Remarks

Displays the Get Text dialog box, and gets the options for the Text properties.

The layout and action of the dialog depends on the flags set in the DlgFlags property. Possible options are:

Value

Meaning

DLG_TEXT_SHOW_CONTEXTHELP

[$00000001] Dialog should contain a context sensitive help icon.

DLG_TEXT_SHOW_PREVIEW

[$00000002] Show a preview of the image in the dialog. The Common Dialog LEADImage property must be assigned a Main Control containing a valid bitmap before calling this method.

DLG_TEXT_AUTOPREVIEW

[$00000004] Auto preview when options change

DLG_TEXT_SAMPLETEXT

[$00000008] Sample text edit box is an option

DLG_TEXT_STYLE

[$00000010] Text style is an option

DLG_TEXT_COLOR

[$00000020] Text color is an option

DLG_TEXT_BORDERCOLOR

[$00000040] Border color is an option

DLG_TEXT_ALIGN

[$00000080] Alignment is an option

DLG_TEXT_ANGLE

[$00000100] Angle is an option

DLG_TEXT_WORDWRAP

[$00000200] Word-wrap is an option

DLG_TEXT_FONT

[$00000400] Font is an option

DLG_TEXT_FOREIMAGE

[$00000800] Foreground image is an option

DLG_TEXT_BROWSEIMAGE

[$00001000] Browse image button is an option

DLG_TEXT_SHADOWCOLOR

[$00002000] Shadow color is an option

DLG_TEXT_SHADOW_X_Y

[$00004000] Shadow x and y are options

These values may be combined by ORing them.

If you include DLG_TEXT_SHOW_PREVIEW in the DlgFlags property, The Common Dialog LEADImage property must be assigned a Main Control containing a valid bitmap before calling this method.

The following properties are associated specifically with this method:

SampleText property

TextStyle property

TextAlign property

TextWordWrap property

TextHiliteColor property

TextUseForegroundImage property

TextForegroundBitmap property

ShadowXDepth property

ShadowYDepth property

ShadowColor property

TextAngle property

TextFont property

To include a Help button in the dialog, set the ShowHelpButton property to TRUE.

The Get Text dialog can be seen below:

image\GetText.gif

See Also

Elements:

TextWordWrap property, TextAngle property, TextAlign property, TextFont property, TextStyle property, TextHiliteColor property, SampleText property, TextUseForegroundImage property, TextForegroundBitmap property, ShadowXDepth property, ShadowYDepth property, ShadowColor property, DrawTextStr method, TextLeft property, TextTop property, TextWidth property, TextHeight property, DrawTextHeight method, DrawTextWidth method, DlgFlags property, ShowHelpButton property

Topics:

Imaging Common Dialogs: Properties, Methods, and Events