SalWindowHandle
PPJ.Runtime.SalWindowHandle
Namespace: PPJ.Runtime
Assembly: PPJ.Runtime.49 (4.9.0.0)
SAL WindowHandle basic type. This class holds either a raw handle (a handle to SalSqlHandle, SalSqlSessionHandle, SalFileHandle, or a native control handle) or a weak reference to a .NET control.
public struct SalWindowHandle : ValueType, IConvertible, IComparable, ISalType, ISerializable, IXmlSerializableConstructors
SalWindowHandle(handle)
SalWindowHandle(handle)Creates a new SalWindowHandle.
SalWindowHandle(ctrl)
SalWindowHandle(ctrl)Creates a new SalWindowHandle.
Properties
Control
ControlControl: Returns the referenced control instance.
IsNull
IsNullBoolean: Checks if this SalWindowHandle object contain a null value.
Value
ValueIntPtr: Returns the Handle value.
Methods
AddListItem(sName)
AddListItem(sName)Adds a string to a list box or combo box.
Returns: SalNumber.
AnyRows(flagsOn, flagsOff)
AnyRows(flagsOn, flagsOff)Determines whether any rows in the specified table window match certain flags.
Returns: SalBoolean.
BringWindowToTop()
BringWindowToTop()Brings a window to the top of all overlapping windows.
Returns: SalBoolean.
CenterWindow()
CenterWindow()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.
Clear()
Clear()Clears the value from a data field, multi line field, or table window column.
Returns: SalBoolean.
ClearCursor(type)
ClearCursor(type)Clears a window's cursor.
Returns: SalBoolean.
ClearImage()
ClearImage()Deletes the contents of a picture.
Returns: SalBoolean.
ClearList()
ClearList()Deletes all entries from a list box or combo box.
Returns: SalBoolean.
ClearSelection()
ClearSelection()Deselects all rows of a table window.
Returns: SalBoolean.
ColumnAverage(nColumnID, flagsOn, flagsOff)
ColumnAverage(nColumnID, flagsOn, flagsOff)Computes the average of all column values or only specified column values in a table window.
Returns: SalNumber.
ColumnSum(columnId, flagsOn, flagsOff)
ColumnSum(columnId, flagsOn, flagsOff)Computes the sum of all column values or only specified column values in a table window.
Returns: SalNumber. The sum of all column values or only specified column values in a table window or grid. Returns zero (0) if an error occurs.
Use row flag constants to specify the rows to use to compute the sum. For example, you can choose to sum only the values of modified rows.
CompareTo(obj)
CompareTo(obj)compare to an object
Returns: Int32.
CompareTo(handle)
CompareTo(handle)compare to a SalWindowHandle
Returns: Int32.
CopyRows(flagsOn, flagsOff)
CopyRows(flagsOn, flagsOff)Copies the contents of the specified table window rows to the Clipboard in text format.
Returns: SalBoolean.
CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)
CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)Creates a table window column of string data type at runtime.
Returns: SalNumber.
CreateColumnEx(nColumnPos, nDispWidth, sTitle, nMaxChars, nDatatype)
CreateColumnEx(nColumnPos, nDispWidth, sTitle, nMaxChars, nDatatype)Creates a table window column using a given data type at runtime. Allowed types are DT_String, DT_Number and DT_DateTime
Returns: SalNumber.
DefineCheckBoxColumn(flags, checkedValue, uncheckedValue)
DefineCheckBoxColumn(flags, checkedValue, uncheckedValue)Define a column as a check box.
Returns: SalBoolean.
DefineDropDownListColumn(flags, lines)
DefineDropDownListColumn(flags, lines)Define a column as a drop down list.
Returns: SalBoolean.
DefinePopupEditColumn(flags, lines)
DefinePopupEditColumn(flags, lines)Define a column as a popup edit window.
Returns: SalBoolean.
DefineRowHeader(title, width, flags, column)
DefineRowHeader(title, width, flags, column)Defines the appearance and behavior of a table window's row header.
Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.
DefineSplitWindow(nRowsLowerHalf, bDragAdjust)
DefineSplitWindow(nRowsLowerHalf, bDragAdjust)Splits a table window horizontally.
Returns: SalBoolean.
DeleteListItem(nIndex)
DeleteListItem(nIndex)Deletes a list box or combo box entry.
Returns: SalNumber.
DeleteRow(nRow, nFlag)
DeleteRow(nRow, nFlag)Deletes a row from a table window but not from the database.
Returns: SalBoolean.
DeleteSelected(hSql)
DeleteSelected(hSql)Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
Returns: SalBoolean.
DeleteSelected(hSql, errorHandler)
DeleteSelected(hSql, errorHandler)Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
Returns: SalBoolean.
DestroyColumns()
DestroyColumns()Destroys all automatic columns created by SalTblCreateColumn or SalTblPopulate at runtime. This function only works on table windows that contain only automatic columns.
Returns: SalBoolean.
DestroyWindow()
DestroyWindow()Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
Returns: SalBoolean.
DisableWindow()
DisableWindow()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.
DisableWindowAndLabel()
DisableWindowAndLabel()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.
DoDeletes(hSql, flagsOn)
DoDeletes(hSql, flagsOn)Applies a SQL DELETE statement to all table window rows that have flagsOn flags.
Returns: SalBoolean.
DoDeletes(hSql, flagsOn, errorHandler)
DoDeletes(hSql, flagsOn, errorHandler)Applies a SQL DELETE statement to all table window rows that have flagsOn flags.
Returns: SalBoolean.
DoInserts(hSql, bClearFlags)
DoInserts(hSql, bClearFlags)Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
Returns: SalBoolean.
DoInserts(hSql, bClearFlags, errorHandler)
DoInserts(hSql, bClearFlags, errorHandler)Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
Returns: SalBoolean.
DoUpdates(hSql, bClearFlags)
DoUpdates(hSql, bClearFlags)Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
Returns: SalBoolean.
DoUpdates(hSql, bClearFlags, errorHandler)
DoUpdates(hSql, bClearFlags, errorHandler)Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
Returns: SalBoolean.
DrawMenuBar()
DrawMenuBar()Redraws the menu bar for a given form window or top-level table window.
Returns: SalBoolean.
EnableWindow()
EnableWindow()Enables keyboard and mouse input to a window.
Returns: SalBoolean.
EnableWindowAndLabel()
EnableWindowAndLabel()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.
EndDialog(nReturn)
EndDialog(nReturn)Destroys a modal dialog box and returns control to the caller of SalModalDialog.
Returns: SalBoolean.
FetchRow(nRow)
FetchRow(nRow)Sends a SAM_FetchRow message to a table window if the row you specify is not currently in the table window cache.
Returns: SalNumber.
FindChild(windowName)
FindChild(windowName)This function finds a child window of a given name in the specified window.
Returns: SalWindowHandle.
FindControl(name)
FindControl(name)Finds a member control in the specified control. Used as a helper functions to resolve unqualified references.
Returns: Control.
FindMember(name)
FindMember(name)Find a member in the specified control. Used as a helper functions to resolve unqualified references.
Returns: ReferenceInfo.
FindNextRow(Row, flagsOn, flagsOff)
FindNextRow(Row, flagsOn, flagsOff)Returns: SalBoolean.
FindPrevRow(Row, flagsOn, flagsOff)
FindPrevRow(Row, flagsOn, flagsOff)Returns: SalBoolean.
FireWindowActions(msg, mywParam, mylParam)
FireWindowActions(msg, mywParam, mylParam)Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
Returns: SalNumber.
FireWindowActionsToChildren(nMsg, nMywParam, nMylParam)
FireWindowActionsToChildren(nMsg, nMywParam, nMylParam)Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.
Returns: SalBoolean.
FormUnitsToPixels(formUnits, vertical)
FormUnitsToPixels(formUnits, vertical)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.
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.
GetCellType(type)
GetCellType(type)Returns: SalBoolean.
GetCellType()
GetCellType()Indicates whether a column is a check box, drop down list, popup edit, or standard column.
Returns: SalNumber.
GetClassName()
GetClassName()Return the name of a window's class as a string.
Returns: SalString.
GetColumnFlags(flags)
GetColumnFlags(flags)Tests the state of a table window column's flags.
Returns: SalBoolean.
GetColumnID()
GetColumnID()Gets a table window column's identifier.
Returns: SalNumber.
GetColumnPosition()
GetColumnPosition()Gets a table window column's relative position.
Returns: SalNumber.
GetColumnText(columnID, text)
GetColumnText(columnID, text)Returns: SalBoolean.
GetColumnText(columnID)
GetColumnText(columnID)Gets data from a column of a table window's context row.
Returns: SalString.
GetColumnTitle(text, maxLen)
GetColumnTitle(text, maxLen)Returns: SalNumber.
GetColumnTitle(maxLen)
GetColumnTitle(maxLen)Gets the title of a table window column.
Returns: SalString.
GetColumnWidth(formUnits)
GetColumnWidth(formUnits)Returns: SalBoolean.
GetColumnWidth()
GetColumnWidth()Returns the width (in form units) of a table window column.
Returns: SalNumber.
GetColumnWindow(col, flags)
GetColumnWindow(col, flags)Gets the handle of a table window column.
Returns: SalWindowHandle.
GetContextRow()
GetContextRow()Returns a table window's current context row. Before sending a SAM_FetchRow message, automatically sets the context row so that assignments made while processing the message reference the correct row.
Returns: SalNumber.
GetControlType()
GetControlType()Returns an object's type.
Returns: SalNumber.
GetDataLength()
GetDataLength()Returns the maximum length of a data field, multi line text field, or table window column.
Returns: SalNumber.
GetDataType()
GetDataType()Returns a data field's or table window column's data type.
Returns: SalNumber.
GetDefaultButton()
GetDefaultButton()Returns the handle of the default push button on a form window or dialog box. The default push button is the one that has the focus by default.
Returns: SalWindowHandle.
GetFirstChild(typeMask)
GetFirstChild(typeMask)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.
typeMask
One or more window types combined (using the OR (|) operator) to create a mask of child window types.
Returns: SalWindowHandle.
GetFont(name, size, enhancement)
GetFont(name, size, enhancement)Returns: SalBoolean.
GetFormat(sPicture)
GetFormat(sPicture)Returns: SalBoolean.
GetFormat()
GetFormat()Gets the picture format of a data field or table window column.
Returns: SalString.
GetFormatCode()
GetFormatCode()Returns the current format of a data field or table window column.
Returns: SalNumber.
GetFormattedText(sText, bFormat)
GetFormattedText(sText, bFormat)Returns: SalBoolean.
GetFormattedText(bFormat)
GetFormattedText(bFormat)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.
Returns: SalString.
GetImageBytes(buffer, type)
GetImageBytes(buffer, type)Returns: SalNumber.
GetImageBytes(buffer, type)
GetImageBytes(buffer, type)Returns: SalNumber.
GetImageDescription(desc, maxLen)
GetImageDescription(desc, maxLen)Returns: SalNumber.
GetImageDescription(maxLen)
GetImageDescription(maxLen)Retrieves a description of a picture's contents.
Returns: SalString.
GetImageString(format, pict)
GetImageString(format, pict)Returns: SalNumber.
GetImageString(format)
GetImageString(format)Return the contents of a picture into a string.
Returns: SalString.
GetImageString(format, buffer)
GetImageString(format, buffer)Returns: SalNumber.
GetInputMask(sMask)
GetInputMask(sMask)Returns: SalBoolean.
GetInputMask()
GetInputMask()Gets the input mask of a data field or table window column.
Returns: SalString.
GetLabel()
GetLabel()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.
GetLabelText(sText, nMaxLength)
GetLabelText(sText, nMaxLength)Returns: SalNumber.
GetLabelText(nMaxLength)
GetLabelText(nMaxLength)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.
Returns: SalString.
GetLinesPerRow(lines)
GetLinesPerRow(lines)Returns: SalBoolean.
GetLinesPerRow()
GetLinesPerRow()Retrieves the height of a row in lines.
Returns: SalNumber.
GetListItemsCount()
GetListItemsCount()Returns the number of list box or combo box entries.
Returns: SalNumber.
GetListItemState(nIndex)
GetListItemState(nIndex)Determines whether the specified list box or combo box entry is selected.
Returns: SalBoolean.
GetListItemText(nIndex, sText)
GetListItemText(nIndex, sText)Returns: SalNumber.
GetListItemText(nIndex)
GetListItemText(nIndex)Returns the text of the specified item.
Returns: SalString.
GetListItemTextLength(nIndex)
GetListItemTextLength(nIndex)Returns the length of a list box or combo box entry.
Returns: SalNumber.
GetListSelectedFile(sFileName)
GetListSelectedFile(sFileName)Returns: SalBoolean.
GetListSelectedFile()
GetListSelectedFile()Fetches the selected directory or file name from a list box or combo box.
Returns: SalString. Name of the selected file in t he control.
GetListSelectedIndex()
GetListSelectedIndex()Returns the index of the selected entry in a combo box or single-selection list box.
Returns: SalNumber.
GetListSelectedItems(nSelectedArray)
GetListSelectedItems(nSelectedArray)Returns an array of index numbers of selected list box entries.
Returns: SalBoolean.
GetListSelectedItemsCount()
GetListSelectedItemsCount()Returns the number of selected entries in a multiple-selection list box. Specify single- or multiple-selection in the list box's customizer.
Returns: SalNumber.
GetLocation(x, y)
GetLocation(x, y)Returns: SalBoolean.
GetLockedColumns()
GetLockedColumns()Retrieves the number of locked table window columns.
Returns: SalNumber.
GetName(text)
GetName(text)Returns: SalBoolean.
GetName()
GetName()Gets the name of an object.
Returns: SalString.
GetNextChild(typeMask)
GetNextChild(typeMask)Returns the handle of the next child window that matches a specified type.
typeMask
One or more window types combined (using the OR (|) operator) to create a mask of child window types.
Returns: SalWindowHandle.
GetObjectData(info, context)
GetObjectData(info, context)get object data
GetParent()
GetParent()Returns the handle of an object's parent window.
Returns: SalWindowHandle.
GetProperty(name, value)
GetProperty(name, value)Returns: SalBoolean.
GetProperty(name)
GetProperty(name)Gets the value of a named property.
Returns: SalString.
GetRowFlags(row, flags)
GetRowFlags(row, flags)Queries a row's flags.
Returns: SalBoolean.
GetScrollBarPosition(pos)
GetScrollBarPosition(pos)Returns: SalBoolean.
GetScrollBarPosition()
GetScrollBarPosition()Returns the current scroll bar value.
Returns: SalNumber.
GetScrollBarRange(min, max, line, page)
GetScrollBarRange(min, max, line, page)Returns: SalBoolean.
GetSize(width, height)
GetSize(width, height)Returns: SalBoolean.
GetStatusBarText(sText, nMaxLen)
GetStatusBarText(sText, nMaxLen)Returns: SalNumber.
GetStatusBarText(nMaxLen)
GetStatusBarText(nMaxLen)Gets the text displayed in the status bar of a top-level or MDI window.
Returns: SalString.
GetTableFlags(flags)
GetTableFlags(flags)Tests the state of a table window's flags.
Returns: SalBoolean.
GetText(text, maxLen)
GetText(text, maxLen)Returns: SalNumber.
GetText(maxLen)
GetText(maxLen)Retrieves the text of a window.
Returns: SalString.
GetTextUnmasked(sText)
GetTextUnmasked(sText)Returns: SalBoolean.
GetTextUnmasked()
GetTextUnmasked()Unmasks the text from a masked edit control.
Returns: SalString.
GetWindowColor(colorIndex)
GetWindowColor(colorIndex)Gets a window's color.
Returns: SalNumber.
GetWindowState()
GetWindowState()Returns a window's current state.
Returns: SalNumber.
HideWindow()
HideWindow()Hides a window.
Returns: SalBoolean.
HideWindowAndLabel()
HideWindowAndLabel()Hides a window and its associated label.
Returns: SalBoolean.
HitTest(x, y, row, col, flags)
HitTest(x, y, row, col, flags)Returns: SalBoolean.
InsertListItem(nIndex, sAdd)
InsertListItem(nIndex, sAdd)Inserts an entry into a list box or combo box at a specified position.
Returns: SalNumber.
InsertRow(row)
InsertRow(row)Inserts a new blank row into a table window.
Returns: SalNumber.
InvalidateWindow()
InvalidateWindow()Causes a window to be repainted.
Returns: SalBoolean.
IsChecked()
IsChecked()Determines whether a radio button is set or a check box is checked.
Returns: SalBoolean.
IsDerivedFromClass(typeClass)
IsDerivedFromClass(typeClass)Determines whether a window is an instance of the specified class.
Returns: SalBoolean.
IsEmpty()
IsEmpty()Verifies whether a data field, multi line text field, or table window column is null or empty.
Returns: SalBoolean.
IsEnabled()
IsEnabled()Determines whether a window is enabled for mouse and keyboard input.
Returns: SalBoolean.
IsModified()
IsModified()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.
IsValid()
IsValid()Validates the contents of a data field or table window column using the current profile.
Returns: SalBoolean.
IsValidDateTime()
IsValidDateTime()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.
IsValidDecimal(nPrecision, nScale)
IsValidDecimal(nPrecision, nScale)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.
Returns: SalBoolean.
IsValidInteger()
IsValidInteger()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.
IsValidNumber()
IsValidNumber()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.
IsVisible()
IsVisible()Determines whether a window is currently visible.
Returns: SalBoolean.
KillCellEdit()
KillCellEdit()Takes a row out of edit mode and selects the row. This causes the row to receive both SAM_Validate and SAM_KillFocus messages.
Returns: SalBoolean.
KillFocusRow()
KillFocusRow()Turns off the table window's focus frame.
Returns: SalBoolean.
KillTimer(idEvent)
KillTimer(idEvent)Destroys an object's system timer.
Returns: SalBoolean.
MDIArrangeIcons()
MDIArrangeIcons()Arranges minimized child window icons in an MDI window.
Returns: SalBoolean.
MDICascade()
MDICascade()Cascades all non-iconized child windows of an MDI window.
Returns: SalBoolean.
MDITile(bPosition)
MDITile(bPosition)Tiles all non-iconized child windows of an MDI window. Windows that are not sizable will not be tiled.
Returns: SalBoolean.
MoveWindow(xOffset, yOffset)
MoveWindow(xOffset, yOffset)Moves a window a given number of form units on the X and Y axes relative to its current position.
Returns: SalBoolean.
NavAddGroup(paneIndex, groupIndex, groupTitle, height)
NavAddGroup(paneIndex, groupIndex, groupTitle, height)Adds a new group to the specified pane of a navigation bar.
Returns: SalBoolean.
NavAddPane(paneIndex, name, expandedImage, collapsedImage)
NavAddPane(paneIndex, name, expandedImage, collapsedImage)Inserts a pane into the navigation bar control.
paneIndex
Indicates a zero-based pane index. The new pane will be inserted after the pane indicated by nPaneIndex. Use -1 to append as the last pane.
Returns: SalBoolean.
NavAssociateChild(paneIndex, groupIndex, child)
NavAssociateChild(paneIndex, groupIndex, child)Associates a control to a pane.
Returns: SalBoolean.
NavDisassociateChild(paneIndex, child)
NavDisassociateChild(paneIndex, child)Disassociates a control from a pane.
Returns: SalBoolean.
NavEnablePane(paneIndex, enable)
NavEnablePane(paneIndex, enable)Enables or disables a pane on the navigation bar.
Returns: SalBoolean.
NavExpandGroup(paneIndex, groupIndex, expand)
NavExpandGroup(paneIndex, groupIndex, expand)Expands or collapses a group.
Returns: SalBoolean.
NavGetActivePane()
NavGetActivePane()Returns the index of the currently selected pane.
Returns: SalNumber. The zero-based index of the currently selected pane.
NavGetPaneIcon(paneIndex, binary, format, expanded)
NavGetPaneIcon(paneIndex, binary, format, expanded)Returns: SalBoolean.
NavGetPaneIndex(name)
NavGetPaneIndex(name)Finds the pane by its name and returns a zero-based index of the pane if successful or -1 if the pane is not found.
Returns: SalNumber. the zero-based index of the pane. If the pane is not found, nIndex is -1.
NavGetPaneTitle(paneIndex, title)
NavGetPaneTitle(paneIndex, title)Returns: SalBoolean.
NavGetPaneTitle(paneIndex)
NavGetPaneTitle(paneIndex)Returns the title of a pane.
Returns: SalString.
NavGroupIsExpanded(paneIndex, groupIndex)
NavGroupIsExpanded(paneIndex, groupIndex)Retrieves the group status. The function returns true if the group is expanded; false if collapsed.
Returns: SalBoolean.
NavLoadState(xml)
NavLoadState(xml)Restore the settings of a navigation bar from an XML string.
Returns: SalBoolean.
NavPaneIsEnabled(paneIndex)
NavPaneIsEnabled(paneIndex)Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).
Returns: SalBoolean.
NavRemoveGroup(paneIndex, groupIndex)
NavRemoveGroup(paneIndex, groupIndex)Removes a group from the navigation bar control.
Returns: SalBoolean.
NavRemovePane(paneIndex)
NavRemovePane(paneIndex)Removes a pane from the navigation bar control.
Returns: SalBoolean.
NavSaveState(xml)
NavSaveState(xml)Returns: SalBoolean.
NavSetActivePane(paneIndex)
NavSetActivePane(paneIndex)Activates the indicated pane.
Returns: SalBoolean.
NavSetPaneIcon(paneIndex, binary, format, expanded)
NavSetPaneIcon(paneIndex, binary, format, expanded)Sets the title of a pane.
Returns: SalBoolean.
NavSetPaneTitle(paneIndex, title)
NavSetPaneTitle(paneIndex, title)Sets the title of a pane.
Returns: SalBoolean.
PasteRows()
PasteRows()Pastes the contents of the Clipboard to the specified table window. Assumes the Clipboard data is in text format with cells delimited by tab characters and rows delimited by end-of-line characters. Inserts the new rows into the table window without overwriting existing rows, and converts the data to the data types of the corresponding table window columns.
Returns: SalBoolean.
PixelsToFormUnits(numPixels, vertical)
PixelsToFormUnits(numPixels, vertical)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.
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.
Populate(hSql, select, method)
Populate(hSql, select, method)Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.
Returns: SalBoolean.
Populate(hSql, select, method, errorHandler)
Populate(hSql, select, method, errorHandler)Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.
Returns: SalBoolean.
Populate(hSql, select)
Populate(hSql, select)Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.
Returns: SalBoolean.
Populate(hSql, select, errorHandler)
Populate(hSql, select, errorHandler)Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.
Returns: SalBoolean.
PopulateList(hSql, sSelect)
PopulateList(hSql, sSelect)Populates a list box or combo box with a result set. SalListPopulate overrides any settings made with SalListSetTabs. If the SELECT statement returns data from multiple columns, each column's data displayed in a list box is separated by tabs. However, due to a Microsoft Windows limitation, each column's data displayed in a combo box is separated by a single '|' character. There is no space between one column's data, the separator character, and another column's data.
Returns: SalBoolean.
PopulateList(hSql, sSelect, errorHandler)
PopulateList(hSql, sSelect, errorHandler)Populates a list box or combo box with a result set. SalListPopulate overrides any settings made with SalListSetTabs. If the SELECT statement returns data from multiple columns, each column's data displayed in a list box is separated by tabs. However, due to a Microsoft Windows limitation, each column's data displayed in a combo box is separated by a single '|' character. There is no space between one column's data, the separator character, and another column's data.
Returns: SalBoolean.
PopulateListFiles(ctrlPath, sPathName, nAttributes)
PopulateListFiles(ctrlPath, sPathName, nAttributes)Returns: SalBoolean.
PostMessage(msg, mywParam, mylParam)
PostMessage(msg, mywParam, mylParam)Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
Returns: SalBoolean.
QueryCheckBoxColumn(flags, checkedValue, uncheckedValue)
QueryCheckBoxColumn(flags, checkedValue, uncheckedValue)Returns: SalBoolean.
QueryDropDownListColumn(flags, lines)
QueryDropDownListColumn(flags, lines)Returns: SalBoolean.
QueryFocusCell(nRow, hWndCol)
QueryFocusCell(nRow, hWndCol)Returns: SalBoolean.
QueryPopupEditColumn(flags, lines)
QueryPopupEditColumn(flags, lines)Returns: SalBoolean.
QueryRowHeader(title, maxTitle, width, flags, col)
QueryRowHeader(title, maxTitle, width, flags, col)Returns: SalBoolean.
QueryScroll(position, minRange, maxRange)
QueryScroll(position, minRange, maxRange)Returns: SalBoolean.
QuerySplitWindow(nRowsLowerHalf, bDragAdjust)
QuerySplitWindow(nRowsLowerHalf, bDragAdjust)Returns: SalBoolean.
QueryVisibleRange(minRange, maxRange)
QueryVisibleRange(minRange, maxRange)Returns: SalBoolean.
ResetTable()
ResetTable()Clears a table window by discarding all rows from the table window cache and setting the table range to 0, -1.
Returns: SalBoolean.
ScrollRow(row, column, flags)
ScrollRow(row, column, flags)Scrolls a table window to the specified row and column.
Returns: SalBoolean.
ScrollRow(row, column)
ScrollRow(row, column)Scrolls a table window to the specified row and column.
Returns: SalBoolean.
SendMessage(msg, mywParam, mylParam)
SendMessage(msg, mywParam, mylParam)Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
Returns: SalNumber.
SendMessageToChildren(msg, mywParam, mylParam)
SendMessageToChildren(msg, mywParam, mylParam)Sends a message to all child items of a form window, dialog box, table window, or MDI window.
Returns: SalBoolean.
SetCellTextColor(color, discardable)
SetCellTextColor(color, discardable)Changes a table window cell's text color.
Returns: SalBoolean.
SetCellTextColor(color)
SetCellTextColor(color)Changes a table window cell's text color.
Returns: SalBoolean.
SetColumnFlags(flags, set)
SetColumnFlags(flags, set)Sets or clears a table window column's flags.
Returns: SalBoolean.
SetColumnPos(pos)
SetColumnPos(pos)Moves a table window column to a new position.
Returns: SalBoolean.
SetColumnPosition(pos)
SetColumnPosition(pos)Moves a table window column to a new position.
Returns: SalBoolean.
SetColumnText(columnID, text)
SetColumnText(columnID, text)Assigns data to a column of a table window's context row.
Returns: SalBoolean.
SetColumnTitle(title)
SetColumnTitle(title)Sets the title of a table window column.
Returns: SalBoolean.
SetColumnWidth(formUnits)
SetColumnWidth(formUnits)Sets a table window column's display width.
Returns: SalBoolean.
SetContextMenu(sMenuName, nFlags)
SetContextMenu(sMenuName, nFlags)Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
SetContextMenu(menuType, flags)
SetContextMenu(menuType, flags)Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
SetContextRow(row)
SetContextRow(row)Sets a table window's context row. Setting the context row does not send a SAM_FetchRow message. If the row is not currently in memory, creates a new row in memory and sets its cell values to null.
Returns: SalBoolean.
SetCursor(resource, type)
SetCursor(resource, type)Sets a window's cursor.
Returns: SalBoolean.
SetCursor(resourceId, type)
SetCursor(resourceId, type)Sets a window's cursor.
Returns: SalBoolean.
SetCursor(blob, type)
SetCursor(blob, type)Sets a window's cursor from a string variable.
Returns: SalBoolean.
SetCursorFile(file, type)
SetCursorFile(file, type)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.
SetDataLength(length)
SetDataLength(length)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.
Returns: SalBoolean.
SetDefaultButton()
SetDefaultButton()Sets the default push button of a form window or dialog box.
Returns: SalBoolean.
SetFlagsAnyRows(flags, set, flagsOn, flagsOff)
SetFlagsAnyRows(flags, set, flagsOn, flagsOff)Sets or clears row flags.
Returns: SalBoolean.
SetFocus()
SetFocus()Sets the focus to a specified window.
Returns: SalWindowHandle.
SetFocusCell(row, column, editMin, editMax)
SetFocusCell(row, column, editMin, editMax)Sets the focus to the specified table window cell (row and column). Puts the table window into edit mode and lets the user select a portion of the data in the cell.
Returns: SalBoolean.
SetFocusRow(row)
SetFocusRow(row)Sets a table window's focus frame row.
Returns: SalBoolean.
SetFont(name, size, enhancement)
SetFont(name, size, enhancement)Sets a window's font, font size, and font enhancements.
Returns: SalBoolean.
SetFormat(sPicture)
SetFormat(sPicture)Sets the picture format of a data field or table window column.
Returns: SalBoolean.
SetFormatCode(nFormat)
SetFormatCode(nFormat)Sets a data field's or table window column's format.
Returns: SalBoolean.
SetImageBytes(imageBytes, type)
SetImageBytes(imageBytes, type)Inserts the contents of a picture to an image without the image header.
Returns: SalBoolean.
SetImageFile(fileName)
SetImageFile(fileName)Inserts a file's contents into a picture.
Returns: SalBoolean.
SetImageFit(fit, scaleWidth, scaleHeight)
SetImageFit(fit, scaleWidth, scaleHeight)Sets the fit for a picture.
Returns: SalBoolean.
SetImageHandle(type, handle)
SetImageHandle(type, handle)Sets the picture image of a picture window with the handle of a bitmap (HBITMAP) or icon (HICON). Usually, HBITMAPs and HICONs are loaded from DLLs.
Returns: SalBoolean.
SetImageResource(resource, format)
SetImageResource(resource, format)Inserts a resource into a picture.
Returns: SalBoolean.
SetImageString(format, picture)
SetImageString(format, picture)Inserts the contents of a string into a picture.
Returns: SalBoolean.
SetImageString(format, buffer)
SetImageString(format, buffer)Inserts the contents of a binary buffer into a picture.
Returns: SalBoolean.
SetInputMask(sMask)
SetInputMask(sMask)Sets the input mask of a data field or table window column.
Returns: SalBoolean.
SetLabelText(sText)
SetLabelText(sText)Sets the text of the associated label control.
Returns: SalBoolean.
SetLinesPerRow(lines)
SetLinesPerRow(lines)Sets the height of a row in lines.
Returns: SalBoolean.
SetListRedraw(bRedraw)
SetListRedraw(bRedraw)Redraws entries in a list box or combo box, or prevents them from being redrawn.
Returns: SalBoolean.
SetListSelectedIndex(nIndex)
SetListSelectedIndex(nIndex)Selects or deselects a combo box or single-selection list box entry.
Returns: SalBoolean.
SetListSelectedItems(nIndex, bSelect)
SetListSelectedItems(nIndex, bSelect)Selects or deselects a combo box or multiple-selection list box entry.
Returns: SalBoolean.
SetListSelectedText(nIndexStart, sText)
SetListSelectedText(nIndexStart, sText)Finds and selects a combo box or single-selection list box entry.
Returns: SalNumber.
SetListTabStops(nTabStops)
SetListTabStops(nTabStops)Sets tabs in a list box.
Returns: SalBoolean.
SetLocation(x, y)
SetLocation(x, y)Moves a window to a new position (x, y) on the X and Y axes.
Returns: SalBoolean.
SetLockedColumns(lockedColumns)
SetLockedColumns(lockedColumns)Sets the number of locked table window columns.
Returns: SalBoolean.
SetModified(bSet)
SetModified(bSet)Sets or clears the field edit flag for an editable data field, combo box, multi line text field, table window column, or picture.
Returns: SalBoolean.
SetProperty(name, value, length)
SetProperty(name, value, length)Sets the value of a named property.
Returns: SalBoolean.
SetRange(min, max)
SetRange(min, max)Defines the minimum and maximum rows (range) of a table.
Returns: SalBoolean.
SetRow(rowPos)
SetRow(rowPos)Sets the focus to the first, last, next, or previous row in a table window.
Returns: SalNumber.
SetRowFlags(row, flags, set)
SetRowFlags(row, flags, set)Sets or clears a table window row's flags.
Returns: SalBoolean.
SetScrollBarPosition(pos)
SetScrollBarPosition(pos)Sets the scrollbar's value.
Returns: SalBoolean.
SetScrollBarRange(min, max, line, page)
SetScrollBarRange(min, max, line, page)Sets a scroll bar's range, line increment, and page increment. When the scroll bar is created, assigns it these values: Minimum scroll position0 Maximum scroll position100 Line Increment1 Page Increment10 If the scroll bar's current position is outside the new range, its position changes to one within the new range. The range of a scroll bar is -32,767 to 32,767.
Returns: SalBoolean.
SetSize(width, height)
SetSize(width, height)Resizes a window.
Returns: SalBoolean.
SetStatusBarText(sText)
SetStatusBarText(sText)Displays specified text in the status bar of a top-level or MDI window.
Returns: SalBoolean.
SetTableFlags(flags, set)
SetTableFlags(flags, set)Sets or clears a table window's flags.
Returns: SalBoolean.
SetText(text)
SetText(text)Sets the text of a window.
Returns: SalBoolean.
SetText(sValue, bFormat)
SetText(sValue, bFormat)Copies a string to a data field or table window column. After copying the string to the field, formats the string.
Returns: SalBoolean.
SetTimer(idEvent, elapseMilliSec)
SetTimer(idEvent, elapseMilliSec)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.
SetWindowColor(colorIndex, color)
SetWindowColor(colorIndex, color)Sets a window's color.
Returns: SalBoolean.
ShowStatusBar(bShow)
ShowStatusBar(bShow)Shows or hides the status bar on a top-level or MDI window.
Returns: SalBoolean.
ShowToolBar(bShow)
ShowToolBar(bShow)Shows or hides the tool bar on a top-level or MDI window.
Returns: SalBoolean.
ShowWindow()
ShowWindow()Makes a window visible.
Returns: SalBoolean.
ShowWindowAndLabel()
ShowWindowAndLabel()Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.
Returns: SalBoolean.
SortRows(columnID, order)
SortRows(columnID, order)Sorts the rows of a table window based on the values in one of the table window's columns.
Returns: SalBoolean.
ToControl()
ToControl()Returns the Control associated with this handle.
Returns: Control.
ToInt32()
ToInt32()Converts a window handle to a number.
Returns: Int32. nWnd
ToIntPtr()
ToIntPtr()Returns the IntPtr value.
Returns: IntPtr.
ToNumber()
ToNumber()Returns the value converted to SalNumber.
Returns: SalNumber.
TrackPopupMenu(menuName, flags, x, y)
TrackPopupMenu(menuName, flags, x, y)Creates pop-up menus at runtime.
Returns: SalBoolean.
TrackPopupMenu(menuType, flags, x, y)
TrackPopupMenu(menuType, flags, x, y)Creates pop-up menus at runtime.
Returns: SalBoolean.
UpdateWindow()
UpdateWindow()Forces the update of a window.
Returns: SalBoolean.
Validate()
Validate()Validates and formats a data field's or table window column's contents.
Returns: SalBoolean.
Validate(validate)
Validate(validate)Validates and formats a data field's or table window column's contents.
Returns: SalBoolean.
WinHelp(file, command, numData, strData)
WinHelp(file, command, numData, strData)Starts the Windows help system.
Returns: SalBoolean.
Yield()
Yield()Processes messages for this control.
Used By
Not supported.
Not Supported.
Gets the handle of a table window column.
Converts a number to a window handle.
Gets the handle of a table window column.
Sets the context to the specified form.
This function finds a child window of a given name in the specified window.
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.
This function finds a child window of a given name in the specified window.
This function finds a child window of a given name in the specified window.
Returns the handle of an object's parent window.
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.
This function finds a child window of a given name in the specified window.
This function finds a child window of a given name in the specified window.
This function finds a child window of a given name in the specified window.
This function finds a child window of a given name in the specified window.
Sets the focus to a specified window.
This function finds a child window of a given name in the specified window.
This function finds a child window of a given name in the specified window.
Returns the handle of the default push button on a form window or dialog box. The default push button is the one that has the focus by default.
Returns the target window handle.
This function finds a child window of a given name in the specified window.
This function finds a child window of a given name in the specified window.
Returns the handle of an object's parent window.
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 the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.
This function finds a child window of a given name in the specified window.
Sets the focus to a specified window.
Returns the handle of the default push button on a form window or dialog box. The default push button is the one that has the focus by default.
Gets the handle of a table window column.
Returns the handle of the control with the focus.
Sets the focus to a specified window.
Sets the focus to a specified window.
Returns the control associated with the handle.
Use this function instead of SalShowWindow because it works properly with the class function HideWindow
Use this function instead of SalShowWindowAndLabel because it works properly with the class function HideWindowAndLabel.
Use this function instead of SalHideWindow. This function will keep the window hidden as tabs are selected. Use the class function ShowWindow to undo the affect of this function.
Returns if the specified control is considered to be visible by the tab control and will be shown when the associated tab is selected.
Use this function instead of SalHideWindowAndLabel. This function will keep the window hidden as tabs are selected. Use the class function ShowWindowWindowAndLabel to undo the affect of this function.
Finds the tab frame window on a form or dialog box
Returns the control associated with the handle.
Returns the control associated with the handle.
Indicates that a tab has been created. This function is called when the tab control receives SAM_Create.
Indicates that a tab has been activated. This function is called before the child windows have been shown
Indicates that a tab has been activated. This function is called after the child windows have been shown
Indicates that user is attempting to change the current tab by clicking, tabbing or some other user action. NOTE: Call CancelMode() to deny the user's request
Indicates that the size of the tab frame may have changed
Define the page size for child forms created on the tab frame. This function can be overriden in the tab form or tab dialog box
Returns the control associated with the handle.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Multiple Inheritance: Wrapper function.
Last updated