SalDataField
PPJ.Runtime.Windows.SalDataField
Last updated
PPJ.Runtime.Windows.SalDataField
Last updated
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Web.49 (4.9.0.0)
Represents an editable control that allows the user to enter text.
Constructs a SalDataField object.
CultureInfo: Returns/Sets the culture to use for this control.
DataType: Value type of the text box control. (Default: String)
SalDateTime: DateTime value property.
String: Returns or sets the input mask. (Default: "")
String: Format string. (Default: "")
Boolean: Value type of the text box control. (Default: False)
String: Hides the Mask property from the designer. We use EditMask for compatibility with PPJ WinForms.
MaskedTextProvider: Returns the mask provider associated with this instance of the control.
SalNamedProperties: Returns the collection of named properties.
SalNumber: Number value property.
String: Returns/Sets the text of the data field. This is overridden to remove the edit mask. (Default: "")
MaskFormat: Returns or sets a value that determines whether literals and prompt characters are included in the formatted string. (Default: IncludeLiterals)
Brings a window to the top of all overlapping windows.
Returns: SalBoolean.
Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.
Returns: SalBoolean.
Clears the value from a data field, multiline field, or table window column.
Returns: SalBoolean.
Clears a window's cursor.
| Parameter | Type | Description |
|---|---|---|
nType |
Returns: SalBoolean.
Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
Returns: SalBoolean.
Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.
Returns: SalBoolean.
Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window in the outline. The label control must have a mnemonic. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.
Returns: SalBoolean.
Enables keyboard and mouse input to a window.
Returns: SalBoolean.
Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window in the outline.
Returns: SalBoolean.
This function finds a child window of a given name in the specified window.
| Parameter | Type | Description |
|---|---|---|
sWindowName |
Returns: SalWindowHandle.
Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
Returns: SalNumber.
Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.
| Parameter | Type | Description |
|---|---|---|
nFormUnits | ||
bVertical |
Returns: SalNumber.
Return the name of a window's class as a string.
Returns: SalString.
Returns an object's type.
Returns: SalNumber.
Returns the maximum length of a data field, multiline text field, or table window column.
Returns: SalNumber.
Returns a data field's or table window column's data type.
Returns: SalNumber.
Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.
| Parameter | Type | Description |
|---|---|---|
nTypeMask |
Returns: SalWindowHandle.
| Parameter | Type | Description |
|---|---|---|
sName | ||
nSize | ||
nEnhancement |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
sPicture |
Returns: SalBoolean.
Gets the picture format of a data field or table window column.
Returns: SalString.
Returns the current format of a data field or table window column.
Returns: SalNumber.
| Parameter | Type | Description |
|---|---|---|
sText | ||
bFormat |
Returns: SalBoolean.
Copies the contents of a data field or table window column to a string. This function also lets you copy the format of the data.
| Parameter | Type | Description |
|---|---|---|
bFormat |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
sMask |
Returns: SalBoolean.
Gets the input mask of a data field or table window column.
Returns: SalString.
Retrieves the window handle of the label (label control) that is associated with the hWndTarget parameter. There must be a mnemonic in that label, and it must immediately precede hWndTarget in the outline, or this function will fail.
Returns: SalWindowHandle.
| Parameter | Type | Description |
|---|---|---|
sText | ||
nMaxLength |
Returns: SalNumber.
Retrieves the text of the label associated to a control. Important: The label control does not require a mnemonic for the functions listed above to operate.
| Parameter | Type | Description |
|---|---|---|
nMaxLength |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
nX | ||
nY |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
sText |
Returns: SalBoolean.
Gets the name of an object.
Returns: SalString.
Returns the handle of the next child window that matches a specified type.
| Parameter | Type | Description |
|---|---|---|
nTypeMask |
Returns: SalWindowHandle.
Returns the handle of an object's parent window.
Returns: SalWindowHandle.
| Parameter | Type | Description |
|---|---|---|
sName | ||
sValue |
Returns: SalBoolean.
Gets the value of a named property.
| Parameter | Type | Description |
|---|---|---|
sName |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
nWidth | ||
nHeight |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
sText | ||
nMaxLen |
Returns: SalNumber.
Retrieves the text of a window.
| Parameter | Type | Description |
|---|---|---|
nMaxLen |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
sText |
Returns: SalBoolean.
Unmasks the text from a masked edit control.
Returns: SalString.
Gets a window's color.
| Parameter | Type | Description |
|---|---|---|
nColorIndex |
Returns: SalNumber.
Returns a window's current state.
Returns: SalNumber.
Hides a window.
Returns: SalBoolean.
Hides a window and its associated label.
Returns: SalBoolean.
Causes a window to be repainted.
Returns: SalBoolean.
Determines whether a window is an instance of the specified class.
| Parameter | Type | Description |
|---|---|---|
tClass |
Returns: SalBoolean.
Verifies whether a data field, multiline text field, or table window column is null or empty.
Returns: SalBoolean.
Determines whether a window is enabled for mouse and keyboard input.
Returns: SalBoolean.
Returns the setting of the Field Edit Flag for a data field, multiline field, combo box, table window's context row cell, or picture.
Returns: SalBoolean.
Validates the contents of a data field or table window column using the current profile.
Returns: SalBoolean.
Verifies whether a data field, multiline text field, or table window column contains a valid date/time value. For multiline text fields, the date/time value must be the only item in the field.
Returns: SalBoolean.
Verifies whether a data field, multiline text field, or table window column contains a valid decimal value. For multiline text fields, the decimal value must be the only item in the field.
Returns: SalBoolean.
Verifies whether a data field, multiline text field, or table window column contains a valid integer value. For multiline text fields, the integer value must be the only item in the field.
Returns: SalBoolean.
Verifies whether a data field, multiline text field, or table window column contains a valid numeric value. Valid numbers are integers or floating point numbers, negative and positive. For multiline text fields, the numeric value must be the only item in the field.
Returns: SalBoolean.
Determines whether a window is currently visible.
Returns: SalBoolean.
Destroys an object's system timer.
| Parameter | Type | Description |
|---|---|---|
nIDEvent |
Returns: SalBoolean.
Moves a window a given number of form units on the X and Y axes relative to its current position.
Returns: SalBoolean.
Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.
| Parameter | Type | Description |
|---|---|---|
nNumPixels | ||
bVertical |
Returns: SalNumber.
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
Returns: SalBoolean.
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
Returns: SalNumber.
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Sets a window's cursor.
Returns: SalBoolean.
Sets a window's cursor from a string variable.
Returns: SalBoolean.
Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.
Returns: SalBoolean.
Sets a limit on the number of characters that a user can enter into a data field, multiline text field, or table window column.
| Parameter | Type | Description |
|---|---|---|
length |
Returns: SalBoolean.
Sets the focus to a specified window.
Returns: SalWindowHandle.
Sets a window's font, font size, and font enhancements.
Returns: SalBoolean.
Sets the picture format of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
sPicture |
Returns: SalBoolean.
Sets a data field's or table window column's format.
| Parameter | Type | Description |
|---|---|---|
nFormat |
Returns: SalBoolean.
Sets the input mask of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
sMask |
Returns: SalBoolean.
Sets the text of the associated label control.
| Parameter | Type | Description |
|---|---|---|
sText |
Returns: SalBoolean.
Moves a window to a new position (x, y) on the X and Y axes.
Returns: SalBoolean.
Sets or clears the field edit flag for an editable data field, combo box, multiline text field, table window column, or picture.
| Parameter | Type | Description |
|---|---|---|
bSet |
Returns: SalBoolean.
Sets the value of a named property.
Returns: SalBoolean.
Resizes a window.
Returns: SalBoolean.
Copies a string to a data field or table window column. After copying the string to the field, formats the string.
| Parameter | Type | Description |
|---|---|---|
sValue | ||
bFormat |
Returns: SalBoolean.
Sets the text of a window.
| Parameter | Type | Description |
|---|---|---|
sText |
Returns: SalBoolean.
Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.
Returns: SalBoolean.
Sets a window's color.
Returns: SalBoolean.
Makes a window visible.
Returns: SalBoolean.
Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.
Returns: SalBoolean.
Creates pop-up menus at runtime.
| Parameter | Type | Description |
|---|---|---|
sMenuName | ||
nFlags | ||
nX | ||
nY | ||
callback |
Returns: SalBoolean.
Creates pop-up menus at runtime.
| Parameter | Type | Description |
|---|---|---|
menuType | ||
nFlags | ||
nX | ||
nY | ||
callback |
Returns: SalBoolean.
Forces the update of a window.
Returns: SalBoolean.
Validates and formats a data field's or table window column's contents.
Returns: SalBoolean.
Validates and formats a data field's or table window column's contents.
| Parameter | Type | Description |
|---|---|---|
nValidate |
Returns: SalBoolean.
| Name | Description |
|---|---|
All SAL controls implement this interface. | |
SAL Editable controls implement this interface | |
All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface. |
