SalWindow
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Runtime.49 (4.9.0.0)
Delegate class for Sal windows functionality. Since we cannot inherit from .NET controls and from our class we need to implement all common functionality here and then delegate calls using method wrappers.
- C#
- VB.NET
public class SalWindow
Public Class SalWindow
Constructors
SalWindow(salWnd)
Creates a new instance of SalWindow and saves the control that is bound to this instance.
| Name | Type | Description |
|---|---|---|
| salWnd | ISalWindow |
Properties
DesignMode
Boolean: Returns/Sets the DesignMode flag.
DisableMessages
Boolean: Enables/Disables the dispatching of Windows messages to the SAL MessageActions handler. This is used to suppress message dispatching when there is a potential recursive loop that will cause a stack overflow. For example, when setting the cursor .NET causes the WM_SETCURSOR message to be sent which might cause stack overflow if the function was originally called in response to WM_SETCURSOR.
DragLocation
Point: Returns the location of the mouse, in client's coordinates, when the drag-drop mode was initiated.
DragSource
Control: Returns the source control for the drag-drop operations.
DropDisabled
Boolean: Enables/Disables drag-drop operations.
DropLocation
Point: Returns the location of the mouse (in client's coordinates), when the mouse was released the drag-drop operation terminated.
DropTarget
Control: Returns the drop target control.
KeepMask
Boolean: Enables/Disables keeping the mask when reading the text from a masked edit control.
MapEnterToTab
Boolean: Enables/Disables the mapping of the enter key to the tab key.
NamedProperties
SalNamedProperties: Returns the collection of named properties.
ProfessionalColors
ProfessionalColorTable: Returns the shared instance of the ProfessionalColors table. This is used by components that want to use colors similar to WinForms tool strip controls. Currently we use it for SalFormToolBar, XSalToolbar, XSalSeparator, XSalToolbox.
Methods
AddListItem(ctrl, text)
Adds a string to the list control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| text | String | Text to add to the list. |
Returns: Int32. The index of the added item or Sys.LB_Err (-1) if there is an error.
AddMessageActions(handler)
Deprecated: Deprecated. Use AddWindowActions()
Adds the specified handler to the list of delegates registered to received the MessageActions event.
| Parameter | Type | Description |
|---|---|---|
| handler | Delegate |
AddMessageActions(target)
Deprecated: Deprecated. Use AddWindowActions().
Adds the handlers from the target window to the list of delegates registered to received the MessageActions event.
| Parameter | Type | Description |
|---|---|---|
| target | ISalWindow |
AddWindowActions(handler)
Adds the specified handler to the list of delegates registered to handle the WindowActions event.
| Parameter | Type | Description |
|---|---|---|
| handler | Delegate |
AddWindowActions(target)
Adds the handlers from the target window to the list of delegates registered to received the WindowActions event.
| Parameter | Type | Description |
|---|---|---|
| target | ISalWindow |
BringToTop(ctrl)
Brings a window to the top of all overlapping windows.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
CanCopy()
Returns true of the selection in the control with the focus can be copied.
Returns: Boolean.
CanCut()
Returns true of the selection in the control with the focus can be cut.
Returns: Boolean.
CanPaste()
Returns true if there is the control with the focus can paste the text in the clipboard.
Returns: Boolean.
CanUndo()
Returns true if the control with the focus can undo the last edit operation.
Returns: Boolean.
Center(ctrl)
Centers a window relative to the parent, or the owner, or the screen.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
Clear()
Deletes the selection in the control with the focus.
Returns: Boolean.
Clear(ctrl)
Clears the value from a data field, multi line field, or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
ClearCursor(ctrl, type)
Clears a window's cursor.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| type | Int32 |
Returns: Boolean.
ClearList(ctrl)
Deletes all entries from the list control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
Copy()
Copies the selection from the control with the focus to the clipboard.
Returns: Boolean.
CopyProfile(ctrl, profile)
Clones the specified profile into the custom profile associated to the specified field.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| profile | Int32 |
Returns: Boolean.
CopyString(text)
Copies the text to the clipboard.
| Parameter | Type | Description |
|---|---|---|
| text | String |
CreateFont(name, size, enhancement)
Creates a Font object from the specified parameters.
| Parameter | Type | Description |
|---|---|---|
| name | String | |
| size | Single | |
| enhancement | Int32 |
Returns: Font.
CreateWindow(type, owner, args)
Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows at runtime.
| Parameter | Type | Description |
|---|---|---|
| type | Type | |
| owner | Control | |
| args | Object[] |
Returns: Control.
CreateWindow(typeName, parent, args)
Creates modeless dialog boxes, MDI windows, form windows, and top-level table windows at runtime.
| Parameter | Type | Description |
|---|---|---|
| typeName | String | |
| parent | Control | |
| args | Object[] |
Returns: Control.
CreateWindow(type, parent, left, top, width, height, flags, args)
Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.
| Parameter | Type | Description |
|---|---|---|
| type | Type | |
| parent | Control | |
| left | Single | |
| top | Single | |
| width | Single | |
| height | Single | |
| flags | Int32 | |
| args | Object[] |
Returns: Control.
CreateWindow(typeName, parent, left, top, width, height, flags)
Creates a form window, dialog box, or table window as a child of another form window, dialog box, or toolbar at runtime.
| Parameter | Type | Description |
|---|---|---|
| typeName | String | |
| parent | Control | |
| left | Single | |
| top | Single | |
| width | Single | |
| height | Single | |
| flags | Int32 |
Returns: Control.
Cut()
Deletes the selected from the control with the focus and places it in the clipboard.
Returns: Boolean.
DeleteListItem(ctrl, index)
Deletes a list box or combo box entry.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| index | Int32 | Index of the item to remove from the list. |
Returns: Int32.
Destroy(ctrl)
Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control |
Returns: Boolean.
DisableWindow(ctrl)
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.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
DisableWindowAndLabel(ctrl)
Disables keyboard and mouse input to a window and grays out its associated label.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
DragAcceptFiles(ctrl, accept)
Indicates whether a window can accept a file from Windows' File Manager.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| accept | Boolean |
Returns: Boolean.
DragDropStart()
Initiates drag-drop mode.
Returns: Boolean.
DragDropStart(pt, data)
Initiates drag-drop mode.
| Parameter | Type | Description |
|---|---|---|
| pt | Point | |
| data | Object |
Returns: Boolean.
DragDropStop()
Aborts drag mode.
Returns: Boolean.
EnableWindow(ctrl)
Enables keyboard and mouse input to a window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
EnableWindowAndLabel(ctrl)
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 tab order.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
EndDialog(ctrl, value)
Destroys a modal dialog box and returns control to the caller of SalModalDialog.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| value | Int32 |
Returns: Boolean.
FillDoubleGradient(g, start, middle, end, bounds, firstGradientSize, secondGradientSize, vertical)
Draws a double gradient background.
| Parameter | Type | Description |
|---|---|---|
| g | Graphics | |
| start | Color | |
| middle | Color | |
| end | Color | |
| bounds | Rectangle | |
| firstGradientSize | Int32 | |
| secondGradientSize | Int32 | |
| vertical | Boolean | 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. |
FillGradient(g, start, end, bounds, vertical)
Draws a gradient background.
| Parameter | Type | Description |
|---|---|---|
| g | Graphics | |
| start | Color | |
| end | Color | |
| bounds | Rectangle | |
| vertical | Boolean | 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. |
FindChild(ctrl, name)
Finds a child window of a given name in the specified window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| name | String |
Returns: Control.
FindChild(ctrl, type)
Finds a child window of a given type in the specified window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| type | Type |
Returns: Control.
FindControl(ctrl, name, throwIfNotFound)
Finds a member control in the specified control. Used as a helper functions to resolve unqualified references.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control that owns the member to find. |
| name | String | Name of the member control to find. |
| throwIfNotFound | Boolean | When true, throws a MissingMemberException if the member is not found. The default is true. |
Returns: Control.
FindMember(ctrl, name, throwIfNotFound)
Find a member in the specified control. Used as a helper functions to resolve unqualified references.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | The control that owns the member to find. |
| name | String | The name of the member to find. |
| throwIfNotFound | Boolean | When true, throws a MissingMemberException if the member is not found. The default is true. |
Returns: ReferenceInfo.
FireWindowActions(ctrl, msgCode, wParam, lParam)
Dispatches a Sal messages directly to the control's WindowActions handlers.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| msgCode | Int32 | |
| wParam | SalNumber | |
| lParam | SalNumber |
Returns: WindowActionsEventArgs.
FireWindowActionsToChildren(ctrl, msg, wParam, lParam)
Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| msg | Int32 | |
| wParam | SalNumber | |
| lParam | SalNumber |
Returns: Boolean.
FormUnitsToPixels(ctrl, units, vertical)
Computes the number of pixels in the number form units.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| units | Single | |
| vertical | Boolean | 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: Int32.
FromHandle(handle, type)
Retrieves the control associated with the handle and casts it to the target type. If the target type is a second-base class in multiple inheritance tree, uses reflection to cast the control to the second-base instance.
| Parameter | Type | Description |
|---|---|---|
| handle | SalWindowHandle | |
| type | Type |
Returns: Object.
GetClassName(ctrl)
Return the name of a window's class as a string.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String.
GetClientArea(ctrl)
Returns the SalClientArea panel.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: SalFormClientArea.
GetControlName(ctrl)
Gets the name of a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String.
GetControlName(ctrl, sName)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| sName | SalString& |
Returns: Boolean.
GetControlType(ctrl)
Returns the type of control (TYPE_*).
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32.
GetDataLength(ctrl)
Returns the maximum length of a data field, multi line text field, or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32.
GetDataType(ctrl)
Returns a data field's or table window column's data type (DT_*).
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control |
Returns: Int32. DT_*
GetDefaultButton(ctrl)
Returns the default push button on a form window or dialog box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Control.
GetFirstChild(parent, typeMask)
Returns the first child window of the specified type.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| typeMask | Int32 | One or more window types combined (using the OR (|) operator) to create a mask of child window types. |
Returns: Control.
GetFocus()
Returns the handle of the control with the focus.
Returns: SalWindowHandle.
GetFont(ctrl, sName, nSize, nEnhancement)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| sName | SalString& | |
| nSize | SalNumber& | |
| nEnhancement | SalNumber& |
Returns: Boolean.
GetFont(font, name, size, enhancement)
| Parameter | Type | Description |
|---|---|---|
| font | Font | |
| name | String& | |
| size | Single& | |
| enhancement | Int32& |
Returns: Boolean.
GetFontNames()
Gets the names of the screen or printer fonts.
Returns: String[].
GetFormat(ctrl)
Gets the format of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String.
GetFormatCode(ctrl)
Returns the current format of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32.
GetFormattedText(ctrl, format)
Returns the contents of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| format | Boolean |
Returns: String.
GetFormParameter(ctrl, paramType, value)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| paramType | SalNumber | |
| value | SalNumber& |
Returns: SalBoolean.
GetInputMask(ctrl)
Gets the input mask of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String.
GetLabel(ctrl)
Finds the Label assigned the specified control. Labels are assigned at startup using the TabIndex preceding the control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Control.
GetLabelText(ctrl)
Retrieves the label text of a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String.
GetLabelText(ctrl, maxLen)
Returns the text of the label associated to the specified control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| maxLen | Int32 |
Returns: String.
GetLabelText(ctrl, sText, maxLen)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| sText | SalString& | |
| maxLen | Int32 |
Returns: SalNumber.
GetListItemsCount(ctrl)
Returns the number of list box or combo box entries.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32. Number of items in the list.
GetListItemState(ctrl, index)
Determines whether the specified list box or combo box entry is selected.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| index | Int32 | Index of the item to check the state for. |
Returns: Boolean. True if the item at the index position is selected, otherwise false.
GetListItemText(ctrl, index)
Returns an entry in the list box or combo box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| index | Int32 | Index of the item to retrieve the text from. |
Returns: String. Text of the specified item.
GetListItemText(ctrl, index, text)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| index | Int32 | |
| text | SalString& |
Returns: Int32.
GetListItemTextLength(ctrl, index)
Returns the length of a list box or combo box entry.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| index | Int32 | Index of the item to return the length for. |
Returns: Int32. Length of the text of the specified item.
GetListSelectedFile(ctrl, fileName)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| fileName | SalString& |
Returns: Boolean.
GetListSelectedFile(ctrl)
Fetches the selected directory or file name from a list box or combo box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String. Name of the selected file in t he control.
GetListSelectedIndex(ctrl)
Returns the index of the selected entry in a combo box or single-selection list box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32. Index of the first selected item.
GetListSelectedItems(ctrl, selectedArray)
Fills the target array with the indexes of the selected entries in the list box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| selectedArray | SalArray<SalNumber> | Array to receive the list of selected indices. |
Returns: Boolean. Number of selected items, which is the number of elements in selectedArray .
GetListSelectedItemsCount(ctrl)
Returns the number of selected entries in a multiple-selection list box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32. Number of selected items in the list.
GetLocation(ctrl)
Returns a window's current position on the X and Y axes.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: PointF.
GetMdiClient(ctrl)
Returns the MDI client area of the MDI container.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: MdiClient.
GetMessageName(msg)
| Parameter | Type | Description |
|---|---|---|
| msg | Int32 |
Returns: String.
GetMousePositionFromLParam(lParam)
Converts Windows' LParam value to the corresponding signed X,Y mouse coordinates.
| Parameter | Type | Description |
|---|---|---|
| lParam | IntPtr |
Returns: Point.
GetNextChild(ctrl, typeMask)
Returns the next child control in the tab order that matches a specified type.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| typeMask | Int32 | One or more window types combined (using the OR (|) operator) to create a mask of child window types. |
Returns: Control.
GetParent(ctrl)
Returns the handle of an object's parent window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Control.
GetProfile(ctrl)
Returns the code of the custom profile associated with the specified field.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32.
GetProfileParameter(ctrl, paramCode, paramValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| paramCode | Int32 | |
| paramValue | SalNumber& |
Returns: Boolean.
GetProfileParameter(ctrl, paramCode, paramValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| paramCode | Int32 | |
| paramValue | SalString& |
Returns: Boolean.
GetProperty(ctrl, name)
Gets the value of a named property for a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| name | String |
Returns: String.
GetProperty(ctrl, name, sValue)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| name | String | |
| sValue | SalString& |
Returns: Boolean.
GetSalMessageName(msg)
Returns the name of a SAM message.
| Parameter | Type | Description |
|---|---|---|
| msg | Int32 |
Returns: String.
GetScrollBarPosition(ctrl)
Returns the current scroll bar value.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32.
GetScrollBarRange(ctrl, nMin, nMax, nLine, nPage)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| nMin | SalNumber& | |
| nMax | SalNumber& | |
| nLine | SalNumber& | |
| nPage | SalNumber& |
Returns: Boolean.
GetSize(ctrl)
Returns a window's size.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: SizeF.
GetSortedControls(parent)
Returns the collection of controls sorted by the TabIndex.
| Parameter | Type | Description |
|---|---|---|
| parent | Control |
Returns: Control[].
GetState(ctrl)
Returns a window's current state.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Int32.
GetStatusBar(ctrl)
Returns the SalStatusBar control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: SalFormStatusBar.
GetStatusBarText(ctrl)
Gets the text displayed in the status bar of a top-level or MDI window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String.
GetSysColor(colorValue)
Gets a system color.
| Parameter | Type | Description |
|---|---|---|
| colorValue | Int32 |
Returns: Int32. Color
GetText(ctrl)
Retrieves the text of a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: String.
GetText(ctrl, text, maxLen)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| text | SalString& | |
| maxLen | Int32 |
Returns: Int32.
GetText(ctrl, maxLen)
Returns the string value of the specified control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| maxLen | Int32 |
Returns: SalString.
GetTextUnmasked(ctrl)
Returns the unmasked content of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: SalString.
GetToolBar(ctrl)
Returns the SalToolbar control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: SalFormToolBar.
GetWindowColor(ctrl, colorIndex)
Gets a window's color.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| colorIndex | Int32 |
Returns: Int32.
HasAccessories(ctrl)
Returns true if the form has the accessories panels.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
HideWindow(ctrl)
Hides a control. Returns false if the control is already hidden.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean. True if the control was previously visible.
HideWindowAndLabel(ctrl)
Hides a control and its associated label.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
InsertListItem(ctrl, index, text)
Inserts an entry into a list box or combo box at a specified position.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| index | Int32 | Position in the list where to insert the text . |
| text | String | Text of the item to insert in the list. |
Returns: Int32. The index of the added item or Sys.LB_Err (-1) if there is an error.
Invalidate(ctrl)
Causes a window to be repainted.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsChecked(ctrl)
Determines whether a radio button is set or a check box is checked.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsDerivedFrom(ctrl, type)
Returns true if a control is an instance of the class.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| type | Type |
Returns: Boolean.
IsEmpty(ctrl)
Verifies whether a data field, multi line text field, or table window column is null or empty.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsEnabled(ctrl)
Determines whether a window is enabled for mouse and keyboard input.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control |
Returns: Boolean.
IsKeyboardMessage(msg)
Returns true if the message code is a mouse or a keyboard message.
| Parameter | Type | Description |
|---|---|---|
| msg | Int32 |
Returns: Boolean.
IsModified(ctrl)
Returns the setting of the modified flag for a data field, multi line field, combo box, table window's context row cell.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsMouseMessage(msg)
Returns true if the message code is a mouse or a keyboard message.
| Parameter | Type | Description |
|---|---|---|
| msg | Int32 |
Returns: Boolean.
IsSalMessage(msg)
Returns true if the message is a known SAM message.
| Parameter | Type | Description |
|---|---|---|
| msg | Int32 |
Returns: Boolean.
IsScrollBarVisible(control, bars)
Returns true if the requested scrollbar is visible on the control.
| Parameter | Type | Description |
|---|---|---|
| control | Control | |
| bars | ScrollBars |
Returns: Boolean.
IsValid(ctrl)
Validates the contents of a data field or table window column using the current profile.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsValidDateTime(ctrl)
Verifies whether a data field, multi line text field, or table window column contains a valid date/time value.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsValidDecimal(ctrl, precision, scale)
Verifies whether a data field, multi line text field, or table window column contains a valid decimal value.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| precision | Int32 | |
| scale | Int32 |
Returns: Boolean.
IsValidEditMask(mask)
Validates the input mask of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| mask | String |
Returns: Boolean.
IsValidFormat(format, code)
Validates a numeric or date/time picture format.
| Parameter | Type | Description |
|---|---|---|
| format | String | |
| code | Int32 |
Returns: Boolean.
IsValidInteger(ctrl)
Verifies whether a data field, multi line text field, or table window column contains a valid integer value.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsValidNumber(ctrl)
Verifies whether a data field, multi line text field, or table window column contains a valid numeric value..
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
IsVisible(ctrl)
Determines whether a window is currently visible.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
KillTimer(ctrl, id)
Destroys an control's system timer.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| id | Int32 |
Returns: Boolean.
ListGetMultiSelect(ctrl)
Returns an array of index numbers of selected list box entries.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: IList. List of selected indices.
MDIArrangeIcons(ctrl)
Arranges minimized child window icons in an MDI window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
MDICascade(ctrl)
Cascades all non-iconized child windows of an MDI window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
MDITile(ctrl, vertical)
Tiles all non-iconized child windows of an MDI window. Windows that are not sizable will not be tiled.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| vertical | Boolean | 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: Boolean.
MessageBeep(alert)
Plays a waveform sound that corresponds to a given system alert level.
| Parameter | Type | Description |
|---|---|---|
| alert | Int32 |
Returns: Boolean.
MessageBox(owner, text, title, flags)
Displays a message box and returns a number that indicates the user's response.
| Parameter | Type | Description |
|---|---|---|
| owner | Control | |
| text | String | |
| title | String | |
| flags | Int32 |
Returns: Int32.
ModalDialog(type, owner, args)
Creates a modal dialog box. See also: EndDialog
| Parameter | Type | Description |
|---|---|---|
| type | Type | |
| owner | Control | |
| args | Object[] |
Returns: Int32.
ModalDialog(typeName, owner, args)
Creates a modal dialog box. See also: EndDialog
| Parameter | Type | Description |
|---|---|---|
| typeName | String | |
| owner | Control | |
| args | Object[] |
Returns: Int32.
Move(ctrl, offset)
Moves a window a given number of form units on the X and Y axes relative to its current position.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| offset | PointF |
Returns: Boolean.
Paste()
Pastes the text in the clipboard to the control with the focus.
Returns: Boolean.
PasteString(text)
| Parameter | Type | Description |
|---|---|---|
| text | String& |
Returns: Boolean.
PixelsToFormUnits(ctrl, pixels, vertical)
Computes the number of form units based on the number of pixels.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| pixels | Int32 | |
| vertical | Boolean | 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: Single.
PopulateList(ctrl, hSql, sql)
Populates a list box or combo box with a result set.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| hSql | SalSqlHandle | SalSqlHandle to use to execute the sql command. |
| sql | String | SQL command to execute to populate the list. |
Returns: Boolean.
PopulateList(ctrl, hSql, sql, errorHandler)
Populates a list box or combo box with a result set.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| hSql | SalSqlHandle | SalSqlHandle to use to execute the sql command. |
| sql | String | SQL command to execute to populate the list. |
| errorHandler | WhenSqlErrorHandler | Error handle callback. |
Returns: Boolean.
PopulateListFiles(ctrl, ctrlPath, pathName, attributes)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| ctrlPath | Control | |
| pathName | SalString& | |
| attributes | Int32 |
Returns: Boolean.
PostMessage(ctrl, msg, wParam, lParam)
Posts the specified message to a window by adding nMsg to handleReceiver's message queue.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| msg | Int32 | |
| wParam | IntPtr | |
| lParam | IntPtr |
Returns: Boolean.
PreviewForm(ctrl)
Prints a form window, table window, or dialog box, including its contents and row header flags.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
PrintForm(ctrl)
Prints a form window, table window, or dialog box, including its contents and row header flags.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
ProcessWndProc(m)
| Parameter | Type | Description |
|---|---|---|
| m | Message& |
RemoveMessageActions(handler)
Deprecated: Deprecated. Use RemoveWindowActions()
Removes the specified handler from the list.
| Parameter | Type | Description |
|---|---|---|
| handler | Delegate |
RemoveWindowActions(handler)
Removes the specified handler from the list.
| Parameter | Type | Description |
|---|---|---|
| handler | Delegate |
Scale(size, oldScale, newScale)
Scales the specified pixels by converting to form units first and then back to pixels using the new scaling factor.
| Parameter | Type | Description |
|---|---|---|
| size | Size | |
| oldScale | Size | |
| newScale | Size |
Returns: Size.
Scale(point, oldScale, newScale)
Scales the specified pixels by converting to form units first and then back to pixels using the new scaling factor.
| Parameter | Type | Description |
|---|---|---|
| point | Point | |
| oldScale | Size | |
| newScale | Size |
Returns: Point.
SendMessage(ctrl, msg, wParam, lParam)
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| msg | Int32 | |
| wParam | SalNumber | |
| lParam | SalNumber |
Returns: SalNumber.
SendMessageToChildren(ctrl, msg, wParam, lParam)
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| msg | Int32 | |
| wParam | SalNumber | |
| lParam | SalNumber |
Returns: Boolean.
SendSalMessage(ctrl, msgCode, wParam, lParam)
Deprecated: Deprecated. Use SalWindow.FireWindowActions().
Dispatches a Sal messages directly to the control's WindowActions handlers.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| msgCode | Int32 | |
| wParam | SalNumber | |
| lParam | SalNumber |
Returns: SalMessage.
SendValidateMessage()
Sends a SAM_Validate message to the object with the focus.
Returns: Int32.
SetContextMenu(ctrl, menuName, flags)
Defines the context menu for a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| menuName | String | |
| flags | Int32 |
Returns: Boolean.
SetContextMenu(ctrl, menuType, flags)
Defines the context menu for a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| menuType | Type | |
| flags | Int32 |
Returns: Boolean.
SetCursor(ctrl, cursor, type)
Sets a window's cursor.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| cursor | Cursor | |
| type | Int32 |
Returns: Boolean.
SetCursor(ctrl, cursorId, type)
Sets a window's cursor.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| cursorId | Int32 | Specify one of these system-supplied cursors: CURSOR_Arrow CURSOR_Cross CURSOR_IBeam CURSOR_Icon CURSOR_Size CURSOR_SizeNESW CURSOR_SizeNS CURSOR_SizeNWSE CURSOR_SizeWE CURSOR_UpArrow CURSOR_Wait |
| type | Int32 |
Returns: Boolean.
SetCursor(ctrl, fileName, type)
Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| fileName | String | The name of a cursor or an icon file. |
| type | Int32 |
Returns: Boolean.
SetCursor(ctrl, blob, type)
Sets a window's cursor from a string variable.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| blob | Byte[] | |
| type | Int32 |
Returns: Boolean.
SetDataLength(ctrl, maxLength)
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.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| maxLength | Int32 |
Returns: Boolean.
SetDefaultButton(ctrl)
Sets the default push button of a form window or dialog box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
SetFocus(ctrl)
Sets the focus to a specified window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Control.
SetFont(ctrl, name, size, enhancement)
Sets a window's font, font size, and font enhancements.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| name | String | |
| size | Int32 | |
| enhancement | Int32 |
Returns: Boolean.
SetFormat(ctrl, format)
Sets the picture format of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| format | String |
Returns: Boolean.
SetFormatCode(ctrl, format)
Sets a data field's or table window column's format.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| format | Int32 |
Returns: Boolean.
SetFormattedText(ctrl, text, applyFormat)
Copies a formatted string to a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| text | String | |
| applyFormat | Boolean |
Returns: Boolean.
SetInputMask(ctrl, mask)
Sets the input mask of a data field or table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| mask | String |
Returns: Boolean.
SetLabel(ctrl, label)
Changes the Label assigned to the specified control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| label | Control |
SetLabelText(ctrl, text)
Sets the label text of a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| text | String |
Returns: Boolean.
SetListRedraw(ctrl, redraw)
Turns off or on redrawing on the list box or combo box.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| redraw | Boolean | True to redraw the control. |
Returns: Boolean.
SetListSelectedIndex(ctrl, index)
Selects or deselects a combo box or single-selection list box entry. If the list box is multi select using -1 as the index value selects all items, while using any other invalid index value deselects all items. For normal list box, using -1 always deselects all items.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| index | Int32 | Index of the item to select. Use -1 to select all items and -2 to deselect all items. |
Returns: Boolean.
SetListSelectedItems(ctrl, index, select)
Selects or deselects a combo box or multiple-selection list box entry.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| index | Int32 | Index of the item to select or deselect. Use -1 to select or deselect all the items in the list. |
| select | Boolean | True to select the specified item(s), false to deselect the item(s). |
Returns: Boolean.
SetListSelectedText(ctrl, startIndex, text)
Finds and selects a combo box or single-selection list box entry.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| startIndex | Int32 | Position where to start the search for text . |
| text | String | Text to search for in the list. |
Returns: Int32. Index of the first item that matches the text or -1 if not found.
SetListTabStops(ctrl, tabStops)
Sets tabs in a list box. List boxes use tabs to align columns of data.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| tabStops | SalArray<SalNumber> | Array of tab stop position. |
Returns: Boolean.
SetLocation(ctrl, pos)
Moves a window to a new position (x, y) on the X and Y axes.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| pos | PointF |
Returns: Boolean.
SetModified(ctrl, modified)
Sets or clears the field modified flag for an editable data field, combo box, multi line text field, table window column.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| modified | Boolean |
Returns: Boolean.
SetProfile(ctrl, profile)
Changes the custom profile of the specified field.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| profile | Int32 |
Returns: Boolean.
SetProfileParameter(ctrl, paramCode, paramValue)
Alters the specified parameter for the custom profile associated to the specified field.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| paramCode | Int32 | |
| paramValue | SalNumber |
Returns: Boolean.
SetProfileParameter(ctrl, paramCode, paramValue)
Alters the specified parameter for the custom profile associated to the specified field.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| paramCode | Int32 | |
| paramValue | SalString |
Returns: Boolean.
SetProperty(ctrl, name, value)
Sets the value of a named property for a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| name | String | |
| value | String |
Returns: Boolean.
SetScrollBarPosition(ctrl, pos)
Sets a scroll bar's position.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| pos | Int32 |
Returns: Boolean.
SetScrollBarRange(ctrl, min, max, line, page)
Sets a scroll bar's range, line increment, and page increment.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| min | Int32 | |
| max | Int32 | |
| line | Int32 | |
| page | Int32 |
Returns: Boolean.
SetSize(ctrl, size)
Resizes a window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| size | SizeF |
Returns: Boolean.
SetStatusBarText(ctrl, text)
Updates the status bar of the top level form that owns the specified control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| text | String |
Returns: Boolean.
SetStatusBarText(menu, text)
Updates the status bar of the form that owns the menu item.
| Parameter | Type | Description |
|---|---|---|
| menu | Menu | |
| text | String |
Returns: Boolean.
SetText(ctrl, text)
Sets the text of a control to a specified string.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| text | String |
Returns: Boolean.
SetTimer(ctrl, id, millisec)
Creates a system timer for a given control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| id | Int32 | |
| millisec | Int32 |
Returns: Boolean.
SetWindowColor(ctrl, colorIndex, nColor)
Sets a window's color.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| colorIndex | Int32 | |
| nColor | Int32 |
Returns: Boolean.
ShowStatusBar(ctrl, visible)
Shows or hides the status bar on a top-level or MDI window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| visible | Boolean |
Returns: Boolean.
ShowToolBar(ctrl, visible)
Shows or hides the tool bar on a top-level or MDI window.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| visible | Boolean |
Returns: Boolean.
ShowWindow(ctrl)
Makes a control visible.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean. True if the control was previously visible.
ShowWindowAndLabel(ctrl)
Makes a control and its associated label visible.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
TrackPopupMenu(ctrl, menuName, flags, pos)
Shows context popup menu at runtime.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| menuName | String | |
| flags | Int32 | |
| pos | Point |
Returns: Boolean.
TrackPopupMenu(ctrl, menuType, flags, pos)
Shows context popup menu at runtime.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| menuType | Type | |
| flags | Int32 | |
| pos | Point |
Returns: Boolean.
TranslateColor(color)
Converts .NET colors to the corresponding SAL color constant.
| Parameter | Type | Description |
|---|---|---|
| color | Color |
Returns: Int32.
TranslateControl(ctrl)
Translate the parent control into a valid control instance: - if the ClientArea is passed returns the form - if a second base visual class is passed, returns the instance - if a embedded TableWindow control is passed, returns the parent TableWindowForm
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Control.
TranslateProfile(profile)
Translates CTD profile codes to the equivalent .NET CultureInfo.
| Parameter | Type | Description |
|---|---|---|
| profile | Int32 |
Returns: CultureInfo.
TranslateSalColor(colorValue)
Converts SAL colors to a .NET Color.
| Parameter | Type | Description |
|---|---|---|
| colorValue | Int32 |
Returns: Color. Color
Undo()
Undoes the last edit in the control with the focus.
Returns: Boolean.
Update(ctrl)
Forces the repaint of a control.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
Returns: Boolean.
UpdateMainMenu(form)
Updates the form's main menu.
| Parameter | Type | Description |
|---|---|---|
| form | Form |
Returns: Boolean.
Validate(ctrl, showErrorMessage)
Validates and formats a data field's or table window column's contents.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| showErrorMessage | Boolean |
Returns: Boolean.
WaitCursor(wait)
Displays or removes the hourglass cursor.
| Parameter | Type | Description |
|---|---|---|
| wait | Boolean |
Returns: Boolean.
WinHelp(ctrl, file, command, index, key)
Starts the Windows help system.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |
| file | String | |
| command | Int32 | |
| index | Int32 | |
| key | String |
Returns: Boolean.
Yield(ctrl)
Processes messages in the message loop. This function replaces all SalYield* functions. It must be placed in the loop that block execution.
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | Target control on which to execute the call. |