SalWindowHandle

PPJ.Runtime.SalWindowHandle

Namespace: PPJ.Runtime

Assembly: PPJ.Web.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, IXmlSerializable, IWisejSerializable

Constructors

SalWindowHandle(handle)

Creates a new SalWindowHandle.

Name
Type
Description

handle

SalWindowHandle(ctrl)

Creates a new SalWindowHandle.

Name
Type
Description

Properties

Control

Control: Returns the referenced control instance.

IsNull

Boolean: Checks if this SalWindowHandle object contain a null value.

Value

IntPtr: Returns the Handle value.

Methods

AddListItem(sName)

Adds a string to a list box or combo box.

Parameter
Type
Description

Returns: SalNumber.

AnyRows(nFlagsOn, nFlagsOff)

Determines whether any rows in the specified table window match certain flags.

Parameter
Type
Description

nFlagsOn

nFlagsOff

Returns: SalBoolean.

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

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()

Clears the value from a data field, multiline field, or table window column.

Returns: SalBoolean.

ClearCursor(nType)

Clears a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

ClearImage()

Deletes the contents of a picture.

Returns: SalBoolean.

ClearList()

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

ClearSelection()

Deselects all rows of a table window.

Returns: SalBoolean.

ColumnAverage(nColumnID, nFlagsOn, nFlagsOff)

Computes the average of all column values or only specified column values in a table window.

Parameter
Type
Description

nColumnID

nFlagsOn

nFlagsOff

Returns: SalNumber.

ColumnSum(nColumnID, nFlagsOn, nFlagsOff)

Computes the sum of all column values or only specified column values in a table window.

Parameter
Type
Description

nColumnID

nFlagsOn

nFlagsOff

Returns: SalNumber.

CompareTo(obj)

compare to an object

Parameter
Type
Description

Returns: Int32.

CompareTo(handle)

compare to a SalWindowHandle

Parameter
Type
Description

Returns: Int32.

CopyRows(nFlagsOn, nFlagsOff)

Copies the contents of the specified table window rows to the Clipboard in text format.

Parameter
Type
Description

nFlagsOn

nFlagsOff

Returns: SalBoolean.

CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)

Creates a table window column of string data type at runtime.

Parameter
Type
Description

nColumnPos

nDispWidth

nMaxChars

sTitle

Returns: SalNumber.

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

Parameter
Type
Description

nColumnPos

nDispWidth

sTitle

nMaxChars

nDatatype

Returns: SalNumber.

DefineCheckBoxColumn(nFlags, sCheckedValue, sUncheckedValue)

Define a column as a check box.

Parameter
Type
Description

nFlags

sCheckedValue

sUncheckedValue

Returns: SalBoolean.

DefineDropDownListColumn(nFlags, nLines)

Define a column as a drop down list.

Parameter
Type
Description

nFlags

nLines

Returns: SalBoolean.

DefinePopupEditColumn(nFlags, nLines)

Define a column as a popup edit window.

Parameter
Type
Description

nFlags

nLines

Returns: SalBoolean.

DefineRowHeader(sTitle, nWidth, nFlags, column)

Defines the appearance and behavior of a table window's row header.

Parameter
Type
Description

sTitle

nWidth

nFlags

column

Returns: SalBoolean.

DefineSplitWindow(nRowsLowerHalf, bDragAdjust)

Splits a table window horizontally.

Parameter
Type
Description

nRowsLowerHalf

bDragAdjust

Returns: SalBoolean.

DeleteListItem(nIndex)

Deletes a list box or combo box entry.

Parameter
Type
Description

nIndex

Returns: SalNumber.

DeleteRow(nRow, nFlag)

Deletes a row from a table window but not from the database.

Parameter
Type
Description

Returns: SalBoolean.

DeleteSelected(hSql)

Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.

Parameter
Type
Description

Returns: SalBoolean.

DeleteSelected(hSql, errorHandler)

Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.

Parameter
Type
Description

Returns: SalBoolean.

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()

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.

Returns: SalBoolean.

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()

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, nFlagsOn)

Applies a SQL DELETE statement to all table window rows that have nFlagsOn flags.

Parameter
Type
Description

Returns: SalBoolean.

DoDeletes(hSql, nFlagsOn, errorHandler)

Applies a SQL DELETE statement to all table window rows that have nFlagsOn flags.

Parameter
Type
Description

Returns: SalBoolean.

DoInserts(hSql, bClearFlags)

Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.

Parameter
Type
Description

bClearFlags

Returns: SalBoolean.

DoInserts(hSql, bClearFlags, errorHandler)

Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.

Parameter
Type
Description

Returns: SalBoolean.

DoUpdates(hSql, bClearFlags)

Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.

Parameter
Type
Description

bClearFlags

Returns: SalBoolean.

DoUpdates(hSql, bClearFlags, errorHandler)

Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.

Parameter
Type
Description

Returns: SalBoolean.

DrawMenuBar()

Redraws the menu bar for a given form window or top-level table window.

Returns: SalBoolean.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

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)

Destroys a modal dialog box and returns control to the caller of SalModalDialog.

Parameter
Type
Description

nReturn

Returns: SalBoolean.

FetchRow(nRow)

Sends a SAM_FetchRow message to a table window if the row you specify is not currently in the table window cache.

Parameter
Type
Description

Returns: SalNumber.

FindChild(sWindowName)

This function finds a child window of a given name in the specified window.

Parameter
Type
Description

sWindowName

Returns: SalWindowHandle.

FindControl(name)

Finds a member control in the specified control. Used as a helper functions to resolve unqualified references.

Parameter
Type
Description

name

Returns: Control.

FindMember(name)

Find a member in the specified control. Used as a helper functions to resolve unqualified references.

Parameter
Type
Description

name

Returns: ReferenceInfo.

FindNextRow(nRow, nFlagsOn, nFlagsOff)

Parameter
Type
Description

nFlagsOn

nFlagsOff

Returns: SalBoolean.

FindPrevRow(nRow, nFlagsOn, nFlagsOff)

Parameter
Type
Description

nFlagsOn

nFlagsOff

Returns: SalBoolean.

FireWindowActions(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalNumber.

FireWindowActionsToChildren(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMsg

nMywParam

nMylParam

Returns: SalBoolean.

FormUnitsToPixels(nFormUnits, bVertical)

Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.

Parameter
Type
Description

nFormUnits

bVertical

Returns: SalNumber.

GetCellType(nType)

Parameter
Type
Description

Returns: SalBoolean.

GetCellType()

Indicates whether a column is a checkbox, drop down list, popup edit, or standard column.

Returns: SalNumber.

GetClassName()

Return the name of a window's class as a string.

Returns: SalString.

GetColumnFlags(nFlags)

Tests the state of a table window column's flags.

Parameter
Type
Description

nFlags

Returns: SalBoolean.

GetColumnID()

Gets a table window column's identifier.

Returns: SalNumber.

GetColumnPosition()

Gets a table window column's relative position.

Returns: SalNumber.

GetColumnText(nColumnID, sText)

Parameter
Type
Description

nColumnID

Returns: SalBoolean.

GetColumnText(nColumnID)

Gets data from a column of a table window's context row.

Parameter
Type
Description

nColumnID

Returns: SalString.

GetColumnTitle(sText, nMaxLen)

Parameter
Type
Description

Returns: SalNumber.

GetColumnTitle(nMaxLen)

Gets the title of a table window column.

Parameter
Type
Description

nMaxLen

Returns: SalString.

GetColumnWidth(nFormUnits)

Parameter
Type
Description

nFormUnits

Returns: SalBoolean.

GetColumnWidth()

Returns the width (in form units) of a table window column.

Returns: SalNumber.

GetColumnWindow(nCol, nFlags)

Gets the handle of a table window column.

Parameter
Type
Description

Returns: SalWindowHandle.

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()

Returns an object's type.

Returns: SalNumber.

GetDataLength()

Returns the maximum length of a data field, multiline text field, or table window column.

Returns: SalNumber.

GetDataType()

Returns a data field's or table window column's data type.

Returns: SalNumber.

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(nTypeMask)

Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.

Parameter
Type
Description

nTypeMask

Returns: SalWindowHandle.

GetFont(sName, nSize, nEnhancement)

Parameter
Type
Description

nEnhancement

Returns: SalBoolean.

GetFormat(sPicture)

Parameter
Type
Description

sPicture

Returns: SalBoolean.

GetFormat()

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

Returns: SalString.

GetFormatCode()

Returns the current format of a data field or table window column.

Returns: SalNumber.

GetFormattedText(sText, bFormat)

Parameter
Type
Description

Returns: SalBoolean.

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.

Parameter
Type
Description

bFormat

Returns: SalString.

GetImageBytes(sImageBytes, nType)

Parameter
Type
Description

sImageBytes

Returns: SalNumber.

GetImageDescription(sDesc, nMaxLen)

Parameter
Type
Description

Returns: SalNumber.

GetImageDescription(nMaxLen)

Retrieves a description of a picture's contents.

Parameter
Type
Description

nMaxLen

Returns: SalString.

GetImageString(nFormat, sPict)

Parameter
Type
Description

Returns: SalNumber.

GetImageString(nFormat)

Return the contents of a picture into a string.

Parameter
Type
Description

nFormat

Returns: SalString.

GetInputMask(sMask)

Parameter
Type
Description

Returns: SalBoolean.

GetInputMask()

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

Returns: SalString.

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)

Parameter
Type
Description

nMaxLength

Returns: SalNumber.

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.

Parameter
Type
Description

nMaxLength

Returns: SalString.

GetLinesPerRow(nLines)

Parameter
Type
Description

Returns: SalBoolean.

GetLinesPerRow()

Retrieves the height of a row in lines.

Returns: SalNumber.

GetListItemsCount()

Returns the number of list box or combo box entries.

Returns: SalNumber.

GetListItemState(nIndex)

Determines whether the specified list box or combo box entry is selected.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

GetListItemText(nIndex, sText)

Parameter
Type
Description

Returns: SalNumber.

GetListItemText(nIndex)

Returns the text of the specified item.

Parameter
Type
Description

nIndex

Returns: SalString.

GetListItemTextLength(nIndex)

Returns the length of a list box or combo box entry.

Parameter
Type
Description

nIndex

Returns: SalNumber.

GetListSelectedFile(sFileName)

Parameter
Type
Description

sFileName

Returns: SalBoolean.

GetListSelectedFile()

Fetches the selected directory or file name from a list box or combo box.

Returns: SalString.

GetListSelectedIndex()

Returns the index of the selected entry in a combo box or single-selection list box.

Returns: SalNumber.

GetListSelectedItems(nSelectedArray)

Returns an array of index numbers of selected list box entries.

Parameter
Type
Description

nSelectedArray

Returns: SalBoolean.

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(nX, nY)

Parameter
Type
Description

Returns: SalBoolean.

GetLockedColumns()

Retrieves the number of locked table window columns.

Returns: SalNumber.

GetName(sText)

Parameter
Type
Description

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(nTypeMask)

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

Parameter
Type
Description

nTypeMask

Returns: SalWindowHandle.

GetObjectData(info, context)

get object data

Parameter
Type
Description

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(sName, sValue)

Parameter
Type
Description

Returns: SalBoolean.

GetProperty(sName)

Gets the value of a named property.

Parameter
Type
Description

Returns: SalString.

GetRowFlags(nRow, nFlags)

Queries a row's flags.

Parameter
Type
Description

Returns: SalBoolean.

GetScrollBarPosition(nPos)

Parameter
Type
Description

Returns: SalBoolean.

GetScrollBarPosition()

Returns the current scroll bar value.

Returns: SalNumber.

GetScrollBarRange(nMin, nMax, nLine, nPage)

Parameter
Type
Description

Returns: SalBoolean.

GetSize(nWidth, nHeight)

Parameter
Type
Description

Returns: SalBoolean.

GetStatusBarText(sText, nMaxLen)

Parameter
Type
Description

Returns: SalNumber.

GetStatusBarText(nMaxLen)

Gets the text displayed in the status bar of a top-level or MDI window.

Parameter
Type
Description

nMaxLen

Returns: SalString.

GetTableFlags(nFlags)

Tests the state of a table window's flags.

Parameter
Type
Description

nFlags

Returns: SalBoolean.

GetText(sText, nMaxLen)

Parameter
Type
Description

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter
Type
Description

nMaxLen

Returns: SalString.

GetTextUnmasked(sText)

Parameter
Type
Description

Returns: SalBoolean.

GetTextUnmasked()

Unmasks the text from a masked edit control.

Returns: SalString.

GetWindowColor(nColorIndex)

Gets a window's color.

Parameter
Type
Description

nColorIndex

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

HideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBoolean.

HitTest(nX, nY, nRow, hWndCol, nFlags)

Parameter
Type
Description

Returns: SalBoolean.

InsertListItem(nIndex, sAdd)

Inserts an entry into a list box or combo box at a specified position.

Parameter
Type
Description

Returns: SalNumber.

InsertRow(nRow)

Inserts a new blank row into a table window.

Parameter
Type
Description

Returns: SalNumber.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsChecked()

Determines whether a radio button is set or a check box is checked.

Returns: SalBoolean.

IsDerivedFromClass(tClass)

Determines whether a window is an instance of the specified class.

Parameter
Type
Description

tClass

Returns: SalBoolean.

IsEmpty()

Verifies whether a data field, multiline text field, or table window column is null or empty.

Returns: SalBoolean.

IsEnabled()

Determines whether a window is enabled for mouse and keyboard input.

Returns: SalBoolean.

IsModified()

Returns the setting of the Field Edit Flag for a data field, multiline field, combo box, table window's context row cell, or picture.

Returns: SalBoolean.

IsValid()

Validates the contents of a data field or table window column using the current profile.

Returns: SalBoolean.

IsValidDateTime()

Verifies whether a data field, multiline text field, or table window column contains a valid date/time value. For multiline text fields, the date/time value must be the only item in the field.

Returns: SalBoolean.

IsValidDecimal(nPrecision, nScale)

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

Parameter
Type
Description

nPrecision

nScale

Returns: SalBoolean.

IsValidInteger()

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

Returns: SalBoolean.

IsValidNumber()

Verifies whether a data field, multiline text field, or table window column contains a valid numeric value. Valid numbers are integers or floating point numbers, negative and positive. For multiline text fields, the numeric value must be the only item in the field.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

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()

Turns off the table window's focus frame.

Returns: SalBoolean.

KillTimer(nIDEvent)

Destroys an object's system timer.

Parameter
Type
Description

nIDEvent

Returns: SalBoolean.

MoveWindow(nXOffset, nYOffset)

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

Parameter
Type
Description

nXOffset

nYOffset

Returns: SalBoolean.

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(nNumPixels, bVertical)

Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.

Parameter
Type
Description

nNumPixels

bVertical

Returns: SalNumber.

Populate(hSql, sSelect, nMethod)

Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.

Parameter
Type
Description

Returns: SalBoolean.

Populate(hSql, sSelect, nMethod, errorHandler)

Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.

Parameter
Type
Description

Returns: SalBoolean.

Populate(hSql, sSelect)

Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.

Parameter
Type
Description

Returns: SalBoolean.

Populate(hSql, sSelect, errorHandler)

Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the result set and populates a table window with them.

Parameter
Type
Description

Returns: SalBoolean.

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.

Parameter
Type
Description

Returns: SalBoolean.

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.

Parameter
Type
Description

Returns: SalBoolean.

PopulateListFiles(ctrlPath, sPathName, nAttributes)

Parameter
Type
Description

ctrlPath

sPathName

nAttributes

Returns: SalBoolean.

PostMessage(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalBoolean.

QueryCheckBoxColumn(nFlags, sCheckedValue, sUncheckedValue)

Parameter
Type
Description

sCheckedValue

sUncheckedValue

Returns: SalBoolean.

QueryDropDownListColumn(nFlags, nLines)

Parameter
Type
Description

Returns: SalBoolean.

QueryFocusCell(nRow, hWndCol)

Parameter
Type
Description

Returns: SalBoolean.

QueryPopupEditColumn(nFlags, nLines)

Parameter
Type
Description

Returns: SalBoolean.

QueryRowHeader(sTitle, nMaxTitle, nWidth, nFlags, hWndCol)

Parameter
Type
Description

Returns: SalBoolean.

QueryScroll(nPosition, nMinRange, nMaxRange)

Parameter
Type
Description

nPosition

nMinRange

nMaxRange

Returns: SalBoolean.

QuerySplitWindow(nRowsLowerHalf, bDragAdjust)

Parameter
Type
Description

nRowsLowerHalf

bDragAdjust

Returns: SalBoolean.

QueryVisibleRange(nMinRange, nMaxRange)

Parameter
Type
Description

nMinRange

nMaxRange

Returns: SalBoolean.

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(nRow, column, nFlags)

Scrolls a table window to the specified row and column.

Parameter
Type
Description

Returns: SalBoolean.

ScrollRow(nRow, column)

Scrolls a table window to the specified row and column.

Parameter
Type
Description

Returns: SalBoolean.

SendMessage(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalBoolean.

SetCellTextColor(nColor, bDiscardable)

Changes a table window cell's text color.

Parameter
Type
Description

nColor

bDiscardable

Returns: SalBoolean.

SetCellTextColor(nColor)

Changes a table window cell's text color.

Parameter
Type
Description

nColor

Returns: SalBoolean.

SetColumnFlags(nFlags, bSet)

Sets or clears a table window column's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetColumnPos(nPos)

Moves a table window column to a new position.

Parameter
Type
Description

Returns: SalBoolean.

SetColumnPosition(nPos)

Moves a table window column to a new position.

Parameter
Type
Description

Returns: SalBoolean.

SetColumnText(nColumnID, sText)

Assigns data to a column of a table window's context row.

Parameter
Type
Description

nColumnID

Returns: SalBoolean.

SetColumnTitle(sTitle)

Sets the title of a table window column.

Parameter
Type
Description

sTitle

Returns: SalBoolean.

SetColumnWidth(nFormUnits)

Sets a table window column's display width.

Parameter
Type
Description

nFormUnits

Returns: SalBoolean.

SetContextMenu(menuName, flags)

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

Parameter
Type
Description

menuName

Returns: SalBoolean.

SetContextMenu(menuType, flags)

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

Parameter
Type
Description

menuType

Returns: SalBoolean.

SetContextRow(nRow)

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.

Parameter
Type
Description

Returns: SalBoolean.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Parameter
Type
Description

nResourceId

Returns: SalBoolean.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

Parameter
Type
Description

Returns: SalBoolean.

SetCursorFile(sFile, nType)

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

Returns: SalBoolean.

SetDataLength(length)

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

Parameter
Type
Description

length

Returns: SalBoolean.

SetDefaultButton()

Sets the default push button of a form window or dialog box.

Returns: SalBoolean.

SetFlagsAnyRows(nFlags, bSet, nFlagsOn, nFlagsOff)

Sets or clears row flags.

Parameter
Type
Description

nFlags

nFlagsOn

nFlagsOff

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFocusCell(nRow, column)

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.

Parameter
Type
Description

Returns: SalBoolean.

SetFocusRow(nRow)

Sets a table window's focus frame row.

Parameter
Type
Description

Returns: SalBoolean.

SetFont(sName, nSize, nEnhancement)

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

Parameter
Type
Description

nEnhancement

Returns: SalBoolean.

SetFormat(sPicture)

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

Parameter
Type
Description

sPicture

Returns: SalBoolean.

SetFormatCode(nFormat)

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

Parameter
Type
Description

nFormat

Returns: SalBoolean.

SetImageBytes(sImageBytes, nType)

Inserts the contents of a picture to an image without the image header.

Parameter
Type
Description

sImageBytes

Returns: SalBoolean.

SetImageFile(sFileName)

Inserts a file's contents into a picture.

Parameter
Type
Description

sFileName

Returns: SalBoolean.

SetImageFit(nFit, nScaleWidth, nScaleHeight)

Deprecated: SetImageFit(nFit, nScaleWidth, nScaleHeight) is deprecated, use SetImageFit(nFit) Sets the fit for a picture.

Parameter
Type
Description

nScaleWidth

Not supported.

nScaleHeight

Not supported.

Returns: SalBoolean.

SetImageFit(nFit)

Sets the fit for a picture.

Parameter
Type
Description

Returns: SalBoolean.

SetImageHandle(nType, nHandle)

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.

Parameter
Type
Description

nHandle

HICON or HBITMAp handle of the image.

Returns: SalBoolean.

SetImageResource(tResource, nFormat)

Inserts a resource into a picture.

Parameter
Type
Description

tResource

nFormat

Returns: SalBoolean.

SetImageString(nFormat, sPicture)

Inserts the contents of a string into a picture.

Parameter
Type
Description

nFormat

sPicture

Returns: SalBoolean.

SetInputMask(sMask)

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

Parameter
Type
Description

Returns: SalBoolean.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter
Type
Description

Returns: SalBoolean.

SetLinesPerRow(nLines)

Sets the height of a row in lines.

Parameter
Type
Description

nLines

Returns: SalBoolean.

SetListSelectedIndex(nIndex)

Selects or deselects a combo box or single-selection list box entry.

Parameter
Type
Description

nIndex

Returns: SalBoolean.

SetListSelectedItems(nIndex, bSelect)

Selects or deselects a combo box or multiple-selection list box entry.

Parameter
Type
Description

nIndex

bSelect

Returns: SalBoolean.

SetListSelectedText(nIndexStart, sText)

Finds and selects a combo box or single-selection list box entry.

Parameter
Type
Description

nIndexStart

Returns: SalNumber.

SetLocation(nX, nY)

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

Parameter
Type
Description

Returns: SalBoolean.

SetLockedColumns(nLockedColumns)

Sets the number of locked table window columns.

Parameter
Type
Description

nLockedColumns

Returns: SalBoolean.

SetModified(bSet)

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

Parameter
Type
Description

Returns: SalBoolean.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Parameter
Type
Description

sValue

nLength

Returns: SalBoolean.

SetRange(nMin, nMax)

Defines the minimum and maximum rows (range) of a table.

Parameter
Type
Description

Returns: SalBoolean.

SetRow(nRowPos)

Sets the focus to the first, last, next, or previous row in a table window.

Parameter
Type
Description

nRowPos

Returns: SalNumber.

SetRowFlags(nRow, nFlags, bSet)

Sets or clears a table window row's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetScrollBarPosition(nPos)

Sets the scrollbar's value.

Parameter
Type
Description

Returns: SalBoolean.

SetScrollBarRange(nMin, nMax, nLine, nPage)

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.

Parameter
Type
Description

Returns: SalBoolean.

SetSize(nWidth, nHeight)

Resizes a window.

Parameter
Type
Description

nWidth

nHeight

Returns: SalBoolean.

SetStatusBarText(sText)

Displays specified text in the status bar of a top-level or MDI window.

Parameter
Type
Description

Returns: SalBoolean.

SetTableFlags(nFlags, bSet)

Sets or clears a table window's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetText(sText)

Sets the text of a window.

Parameter
Type
Description

Returns: SalBoolean.

SetText(sValue, bFormat)

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

Parameter
Type
Description

sValue

bFormat

Returns: SalBoolean.

SetTimer(nIDEvent, nElapseMilliSec)

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.

Parameter
Type
Description

nIDEvent

nElapseMilliSec

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter
Type
Description

nColorIndex

nColor

Returns: SalBoolean.

ShowStatusBar(bShow)

Shows or hides the status bar on a top-level or MDI window.

Parameter
Type
Description

Returns: SalBoolean.

ShowToolBar(bShow)

Shows or hides the tool bar on a top-level or MDI window.

Parameter
Type
Description

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

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(nColumnID, nOrder)

Sorts the rows of a table window based on the values in one of the table window's columns.

Parameter
Type
Description

nColumnID

nOrder

Returns: SalBoolean.

ToControl()

Returns the Control associated with this handle.

Returns: Control.

ToInt32()

Converts a window handle to a number.

Returns: Int32. nWnd

ToIntPtr()

Returns the IntPtr value.

Returns: IntPtr.

ToNumber()

Returns the value converted to SalNumber.

Returns: SalNumber.

TrackPopupMenu(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Validate()

Validates and formats a data field's or table window column's contents.

Returns: SalBoolean.

Validate(nValidate)

Validates and formats a data field's or table window column's contents.

Parameter
Type
Description

nValidate

Returns: SalBoolean.

Used By

Name
Description

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.

This function finds a child window of a given name in the specified window.

Sets the focus to a 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.

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 next child window that matches a specified type.

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 next child window that matches a specified type.

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 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.

Sets the focus to a specified window.

This function finds a child window of a given name in the specified window.

Gets the handle of a table window column.

Returns the control with the focus.

Returns the handle of an object's parent window.

This function finds a child window of a given name in the specified window.

Returns the target window 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 overridden in the tab form or tab dialog box

Returns the control associated with the handle.

Sets the context to the specified form.

Last updated