SalDataField

PPJ.Runtime.Windows.SalDataField

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

DataField implementation.

public class SalDataField : TextBox, ISalWindow, ISalEditControl, ISalControl, IConvertible

Constructors

Constructs a SalDataField object.

Properties

Color: Overrides the BackColor property to be able to install our ShouldSerializeBackColor() function.

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: Indicates the edit mask to apply to the text while editing. (Default: "")

Boolean: Enables/Disables the built-in spell checker. (Default: False)

String: Format string. (Default: "")

Control: Returns/Sets the label associated with this control.

Int32: Gets or sets the maximum number of characters the user can type or paste into the text box control. (Default: 32767)

SalNamedProperties: Returns the collection of named properties.

SalNumber: Number value property.

String: Overrides the SelectedText property to take in consideration that the edit mask, if applied, may shorten the string returned by the Text property.

String: Returns/Sets the text of the data field. This is overridden to remove the edit mask.

String: Returns/Sets the watermark to use for this control. (Default: "")

Methods

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, multi line field, or table window column.

Returns: SalBoolean.

Clears a window's cursor.

ParameterTypeDescription

type

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.

ParameterTypeDescription

windowName

Returns: SalWindowHandle.

Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.

ParameterTypeDescription

msg

mywParam

mylParam

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.

ParameterTypeDescription

formUnits

The number of form units.

vertical

If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.

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, multi line 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.

ParameterTypeDescription

typeMask

One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

ParameterTypeDescription

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.

ParameterTypeDescription

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.

ParameterTypeDescription

bFormat

Returns: SalString.

ParameterTypeDescription

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.

ParameterTypeDescription

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.

ParameterTypeDescription

nMaxLength

Returns: SalString.

ParameterTypeDescription

x

y

Returns: SalBoolean.

ParameterTypeDescription

text

Returns: SalBoolean.

Gets the name of an object.

Returns: SalString.

Returns the handle of the next child window that matches a specified type.

ParameterTypeDescription

typeMask

One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

ParameterTypeDescription

name

value

Returns: SalBoolean.

Gets the value of a named property.

ParameterTypeDescription

name

Returns: SalString.

ParameterTypeDescription

width

height

Returns: SalBoolean.

ParameterTypeDescription

text

maxLen

Returns: SalNumber.

Retrieves the text of a window.

ParameterTypeDescription

maxLen

Returns: SalString.

ParameterTypeDescription

sText

Returns: SalBoolean.

Unmasks the text from a masked edit control.

Returns: SalString.

Gets a window's color.

ParameterTypeDescription

colorIndex

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.

ParameterTypeDescription

typeClass

Returns: SalBoolean.

Verifies whether a data field, multi line 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, multi line 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, multi line text field, or table window column contains a valid date/time value. For multi line text fields, the date/time value must be the only item in the field.

Returns: SalBoolean.

Verifies whether a data field, multi line text field, or table window column contains a valid decimal value. For multi line text fields, the decimal value must be the only item in the field.

ParameterTypeDescription

nPrecision

nScale

Returns: SalBoolean.

Verifies whether a data field, multi line text field, or table window column contains a valid integer value. For multi line text fields, the integer value must be the only item in the field.

Returns: SalBoolean.

Verifies whether a data field, multi line text field, or table window column contains a valid numeric value. Valid numbers are integers or floating point numbers, negative and positive. For multi line 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.

ParameterTypeDescription

idEvent

Returns: SalBoolean.

Moves a window a given number of form units on the X and Y axes relative to its current position.

ParameterTypeDescription

xOffset

yOffset

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.

ParameterTypeDescription

numPixels

vertical

If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.

Returns: SalNumber.

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalNumber.

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

ParameterTypeDescription

sMenuName

nFlags

Returns: SalBoolean.

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

ParameterTypeDescription

menuType

flags

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resource

type

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resourceId

type

Returns: SalBoolean.

Sets a window's cursor from a string variable.

ParameterTypeDescription

blob

type

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.

ParameterTypeDescription

file

type

Returns: SalBoolean.

Sets a limit on the number of characters that a user can enter into a data field, multi line text field, or table window column.

ParameterTypeDescription

length

Returns: SalBoolean.

Sets the focus to a specified window.

Returns: SalWindowHandle.

Sets a window's font, font size, and font enhancements.

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

Sets the picture format of a data field or table window column.

ParameterTypeDescription

sPicture

Returns: SalBoolean.

Sets a data field's or table window column's format.

ParameterTypeDescription

nFormat

Returns: SalBoolean.

Sets the input mask of a data field or table window column.

ParameterTypeDescription

sMask

Returns: SalBoolean.

Sets the text of the associated label control.

ParameterTypeDescription

sText

Returns: SalBoolean.

Moves a window to a new position (x, y) on the X and Y axes.

ParameterTypeDescription

x

y

Returns: SalBoolean.

Sets or clears the field edit flag for an editable data field, combo box, multi line text field, table window column, or picture.

ParameterTypeDescription

bSet

Returns: SalBoolean.

Sets the value of a named property.

ParameterTypeDescription

name

value

length

Returns: SalBoolean.

Resizes a window.

ParameterTypeDescription

width

height

Returns: SalBoolean.

Copies a string to a data field or table window column. After copying the string to the field, formats the string.

ParameterTypeDescription

sValue

bFormat

Returns: SalBoolean.

Sets the text of a window.

ParameterTypeDescription

text

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.

ParameterTypeDescription

idEvent

elapseMilliSec

Returns: SalBoolean.

Sets a window's color.

ParameterTypeDescription

colorIndex

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.

ParameterTypeDescription

menuName

flags

x

y

Returns: SalBoolean.

Creates pop-up menus at runtime.

ParameterTypeDescription

menuType

flags

x

y

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.

ParameterTypeDescription

validate

Returns: SalBoolean.

Starts the Windows help system.

ParameterTypeDescription

file

command

numData

strData

Returns: SalBoolean.

Processes messages for this control.

Events

SalMessageHandler Message Actions

WindowActionsEventHandler Window Actions

Inherited By

NameDescription

Data field with tool tip support

Implements

NameDescription

All SAL controls implement this interface.

SAL Editable controls implement this interface

All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.

Last updated