EditMask control – PB Docs 2018

Accelerator

Integer

Specifies the ASCII value of the key you want to
assign as the accelerator key for the control.

AccessibleDescription

String

A description of the control and/or its purpose for
use by accessibility tools such as readers for visually impaired
users.

AccessibleName

String

A label that briefly describes the control, such as
the text in a button or the name of a menu item.

AccessibleRole

AccessibleRole (enumerated)

Describes what kind of user interface element the
control is.

Alignment

Alignment (enumerated)

Specifies the alignment of text in the control.
Values
are:

Center!

Justify!

Left!

Right!

AutoHScroll

Boolean

Specifies whether PowerBuilder automatically
scrolls left or right when data is entered into or deleted from
the control. Values are:

TRUE — Scrolls
horizontally automatically.

FALSE — Does not scroll
automatically.

AutoSkip

Boolean

Specifies whether to skip to the next control when
the last character in the edit mask has been entered. Values
are:

TRUE — Skip to the next control
automatically.

FALSE — Do not skip to the next
control.

AutoVScroll

Boolean

Specifies whether PowerBuilder automatically
scrolls up or down when data is entered into or deleted from the
control. Values are:

TRUE — Scrolls vertically
automatically.

FALSE — Scrolling not
automatic.

BackColor

Long

Specifies the numeric value of the background
color: -2 to 16,777,215. For more information about color, see
the section called “RGB” in PowerScript Reference.

Border

Boolean

Specifies whether the control has a border. Values
are:

TRUE — Control has a border.

FALSE
— Control does not have a border.

BorderStyle

BorderStyle (enumerated)

Specifies the style of the border of the control.
Values
are:

StyleBox!

StyleLowered!

StyleRaised!

StyleShadowBox!

BringToTop

Boolean

Specifies whether PowerBuilder moves the control to
the top of the front-to-back order in the
window:

TRUE — Control moved to
top.

FALSE — Control not moved to
top.

CalendarBackColor

Long

Specifies the numeric value of the background color
of the calendar: -2 to 16,777,215. For more information about
color, see the section called “RGB” in PowerScript Reference. The default is Window
Background.

This property does not work on the
Windows 7/8.1/10 operating system.

CalendarTextColor

Long

Specifies the numeric value of the text color in
the calendar:-2 to 16,777,215. For more information about color,
see the section called “RGB” in PowerScript Reference. The default is Window
Text.

This property does not work on the Windows
7/8.1/10 operating system.

CalendarTitleBackColor

Long

Specifies the numeric value of the background color
of the calendar’s title: -2 to 16,777,215. For more information
about color, see the section called “RGB” in PowerScript Reference.

This property does not work
on the Windows 7/8.1/10 operating system.

CalendarTitleTextColor

Long

Specifies the numeric value of the color used for
text in the calendar’s title: -2 to 16,777,215. For more
information about color, see the section called “RGB” in PowerScript Reference.

This property does not work
on the Windows 7/8.1/10 operating system.

CalendarTrailingTextColor

Long

Specifies the numeric value of the color used for
leading and trailing days in the calendar: -2 to 16,777,215. For
more information about color, see the section called “RGB” in PowerScript Reference.

This property does not work
on the Windows 7/8.1/10 operating system.

ClassDefinition

PowerObject

An object of type PowerObject containing
information about the class definition of the object or
control.

DisplayData

String

Specifies the data that initially displays in the
control.

DisplayOnly

Boolean

Specifies whether the text in the control is
display only and cannot be changed by the user. Values
are:

TRUE — Text is display only.

FALSE
— Text can be changed by user.

DragAuto

Boolean

Specifies whether PowerBuilder puts the control
automatically into Drag mode. Values are:

TRUE —
When the control is clicked, the control is automatically in
Drag mode.

FALSE — When the control is clicked, the
control is not automatically in Drag mode. You have to manually
put the control into Drag mode by using the Drag
function.

DragIcon

String

Specifies the name of the stock icon or the file
containing the icon you want to display when the user drags the
control (the ICO file). The default icon is a box the size of
the control.

When the user drags the control, the
icon displays when the control is over an area in which the
control can be dropped (a valid drop area). When the control is
over an area that is not a valid drop area, the No-Drop icon
displays.

DropDownCalendar

Boolean

Whether a drop-down calendar displays in a control
with a Date or DateTime edit mask. Values are:

Yes
— Drop-down calendar control displays.

No —
(Default) Drop-down calendar control does not
display.

DropDownRight

Boolean

Specifies whether the drop-down calendar is aligned
with the right or left side of the control. Values
are:

TRUE — The calendar is aligned with the right
side of the control.

FALSE — The calendar is
aligned with the left side of the control
(default).

Enabled

Boolean

Specifies whether the control is enabled (can be
selected):

TRUE — Control is
enabled.

FALSE — Control is not
enabled.

FaceName

String

Specifies the name of the typeface in which the
text of the control displays (for example, arial or
courier).

FontCharSet

FontCharSet (enumerated)

Specifies the font character set used for the text
in the control. For a complete list of possible values, see the
list of properties for the FontCharSet variable on the
Enumerated tab page of the Browser.

FontFamily

FontFamily (enumerated)

Specifies the font family (type style) used for the
text in the control. Values
are:

AnyFont!

Decorative!

Modern!

Roman!

Script!

Swiss!

FontPitch

FontPitch (enumerated)

Specifies the pitch (spacing) of the font used for
the text in the control. Values
are:

Default!

Fixed!

Variable!

Height

Integer

Specifies the height of the control, in
PowerBuilder units.

HScrollBar

Boolean

Specifies whether a horizontal scroll bar displays
in the control when all the data cannot be displayed at one
time. Values are:

TRUE — Horizontal scroll bar
displayed.

FALSE — Horizontal scroll bar not
displayed.

HideSelection

Boolean

Specifies whether selected text stays selected
(highlighted) even when the control does not have
focus:

TRUE — Text does not stay
highlighted.

FALSE — Text stays
highlighted.

IgnoreDefaultButton

Boolean

Specifies whether the Clicked event for the
window’s Default command button is triggered when user presses
Enter. Values are:

TRUE — Do not trigger Clicked
event; add new line in control.

FALSE — Trigger
Clicked event; do not add new line in control
(default).

ImeMode

Integer

Specifies the input method editor mode. This
property is relevant only to applications running on a Japanese
version of PowerBuilder.

Increment

Double

Specifies the increment of the spin.

Italic

Boolean

Specifies whether the text in the control is
italic. Values are:

TRUE — Text is
italic.

FALSE — Text is not italic.

Limit

Integer

Specifies the maximum number of characters (0 to
32,767) that can be entered in the control (0 means
unlimited).

Mask

String

Specifies the mask to use to format and edit data
in the control.

MaskDataType

MaskDataType (enumerated)

Specifies the datatype of the control. Values
are:

DateMask!

DateTimeMask!

DecimalMask!

NumericMask!

StringMask!

TimeMask!

MinMax

String

Specifies the minimum and maximum values for the
spin.

Pointer

String

Specifies the name of the stock pointer or the file
containing the pointer used for the control.

RightToLeft

Boolean

Specifies that characters should be displayed in
right-to-left order. The application must be running on an
operating system that supports right-to-left display. Values
are:

TRUE — Characters display in right-to-left
order.

FALSE — Characters display in left-to-right
order.

Spin

Boolean

Specifies whether to scroll through the spin
values. Values are:

TRUE — Scroll through the spin
values.

FALSE — Do not scroll through the spin
values.

TabOrder

Integer

Specifies the tab value of the control within the
window (0 means the user cannot tab to the
control).

TabStop[
]

Integer

Specifies the positions of tab stops in the
control.

Tag

String

Specifies the tag value assigned to the
control.

Text

String

Specifies the text that displays in the
control.

TextColor

Long

Specifies the color to be used for the text in the
control. For more information about color, see the section called “RGB” in PowerScript Reference.

TextCase

TextCase (enumerated)

Specifies the case used to display text the user
enters. Values
are:

AnyCase!

Lower!

Upper!

TextSize

Integer

Specifies the size of the text in the control, in
points. For backward compatibility, the size is stored as a
negative number; for example, 10-point text size is stored as
-10.

Underline

Boolean

Specifies whether the text in the control is
underlined. Values are:

TRUE — Text is
underlined.

FALSE — Text is not
underlined.

UseCodeTable

Boolean

Specifies whether PowerBuilder uses the code table
for the column to validate data. Values are:

TRUE —
Uses code table to validate data.

FALSE — Does not
use code table to validate data.

Visible

Boolean

Specifies whether the control is visible. Values
are:

TRUE — Control is visible.

FALSE
— Control is not visible.

VScrollBar

Boolean

Specifies whether a vertical scroll bar displays in
the control when not all the data can be displayed at one time.
Values are:

TRUE — Vertical scroll bar is
displayed.

FALSE — Vertical scroll bar is not
displayed.

Weight

Integer

Specifies the stroke weight of the text in the
control; for example, 400 for normal or 700 for
bold.

Width

Integer

Specifies the width of the control, in PowerBuilder
units.

X

Integer

Specifies the X position (the distance from the
left edge of the window), in PowerBuilder units.

Y

Integer

Specifies the Y position (the distance from the top
of the window), in PowerBuilder units.

Constructor

Immediately before the Open event occurs in the
window.

Destructor

Immediately after the Close event occurs in the
window.

DragDrop

When a dragged control is dropped on the
control.

DragEnter

When a dragged control enters a target
control.

DragLeave

When a dragged control leaves the
control.

DragWithin

When a dragged control is within the
control.

GetFocus

Just before the control receives focus (before it
is selected and becomes active).

Help

When the user presses the F1 key or drags the
context help button (question mark) from the title bar to a menu
item or control.

LoseFocus

When the control loses focus (becomes
inactive).

Modified

When a control has been changed and loses focus
(becomes inactive).

Other

When a Windows message occurs that is not a
PowerBuilder event.

RButtonDown

When the right mouse button is pressed on the
control.

CanUndo

Boolean

Returns true if the Undo function can be used to
undo the last edit in the control and returns false if it
cannot.

ClassName

String

Returns the name assigned to the
control.

Clear

Integer

Clears the selected text (if any) from the control
but does not place it in the clipboard.

Copy

Integer

Copies (but does not delete) the selected text (if
any) from the control to the clipboard.

Cut

Integer

Cuts (deletes) the selected text (if any) from the
control and places it in the clipboard.

Drag

Integer

Starts or ends the dragging of the
control.

GetContextService

Integer

Creates a reference to a context-specific instance
of the specified service.

GetData

Integer

Obtains the unformatted data in the
control.

GetParent

PowerObject

Returns a reference to the name of the parent
object.

Hide

Integer

Makes the control invisible.

LineCount

Integer

Returns the number of lines in the EditMask in the
window.

LineLength

Integer

Returns the length of the line in which the cursor
is positioned.

Move

Integer

Moves the control to the specified
location.

Paste

Integer

Inserts the contents of the clipboard at the
insertion point in the specified control.

PointerX

Integer

Returns the distance of the pointer from the left
edge of the control.

PointerY

Integer

Returns the distance of the pointer from the top of
the control.

Position

Integer

Returns the position of the insertion point in the
control.

PostEvent

Boolean

Adds the specified event to the end of the message
queue for the control.

Print

Integer

Prints the control.

ReplaceText

Integer

Replaces the currently selected text with the
specified string. If no text is selected, inserts the text at
the insertion point.

Resize

Integer

Changes the width and height of the
control.

Scroll

Integer

Moves the contents of the control up or down the
specified number of lines.

SelectedLength

Integer

Returns the total number of characters and spaces
(length) in the selected text in the control.

SelectedLine

Integer

Returns the number of the line where the insertion
point is located in the control.

SelectedStart

Integer

Returns the position of the first character in the
selected text in the control.

SelectedText

String

Determines what if any text is selected in the
control.

SelectText

Integer

Selects text in the control beginning at the
specified position and continuing for the specified number of
characters.

SetFocus

Integer

Sets focus to the control.

SetMask

Integer

Specifies the contents and datatype of the edit
mask for the control.

SetPosition

Integer

Specifies the position of the control in the
front-to-back order of the window.

SetRedraw

Integer

Controls automatic redrawing of the control after
each change in its properties.

Show

Integer

Makes the control visible.

TextLine

String

Returns the entire text of the line in which the
insertion point is currently located.

TriggerEvent

Integer

Triggers a specified event in the control and
executes the script for the event.

TypeOf

Object

Returns the type of the control.

Undo

Integer

Cancels the previous editing function performed in
the control.