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, IXmlSerializable

Constructors

Creates a new SalWindowHandle.

NameTypeDescription

handle

Creates a new SalWindowHandle.

NameTypeDescription

ctrl

Properties

Control: Returns the referenced control instance.

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

IntPtr: Returns the Handle value.

Methods

Adds a string to a list box or combo box.

ParameterTypeDescription

sName

Returns: SalNumber.

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

ParameterTypeDescription

flagsOn

flagsOff

Returns: SalBoolean.

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.

Returns: SalBoolean.

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

Returns: SalBoolean.

Clears a window's cursor.

ParameterTypeDescription

type

Returns: SalBoolean.

Deletes the contents of a picture.

Returns: SalBoolean.

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

Deselects all rows of a table window.

Returns: SalBoolean.

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

ParameterTypeDescription

nColumnID

flagsOn

flagsOff

Returns: SalNumber.

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

ParameterTypeDescription

columnId

The Column Identifier.

flagsOn

The flags that the row should have. You can combine ROW* flags using the OR (|) operator.

flagsOff

The flags that the row should not have. You can combine ROW* flags using the OR (|) operator.

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.

compare to an object

ParameterTypeDescription

obj

Returns: Int32.

compare to a SalWindowHandle

ParameterTypeDescription

handle

Returns: Int32.

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

ParameterTypeDescription

flagsOn

flagsOff

Returns: SalBoolean.

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

ParameterTypeDescription

nColumnPos

nDispWidth

nMaxChars

sTitle

Returns: SalNumber.

Creates a table window column using a given data type at runtime. Allowed types are DT_String, DT_Number and DT_DateTime

ParameterTypeDescription

nColumnPos

nDispWidth

sTitle

nMaxChars

nDatatype

Returns: SalNumber.

Define a column as a check box.

ParameterTypeDescription

flags

checkedValue

uncheckedValue

Returns: SalBoolean.

Define a column as a drop down list.

ParameterTypeDescription

flags

lines

Returns: SalBoolean.

Define a column as a popup edit window.

ParameterTypeDescription

flags

lines

Returns: SalBoolean.

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

ParameterTypeDescription

title

The title of the row header column.

width

The width of the row header in pixels.

flags

The row header attributes. You can combine these flags using the OR (|) operator.

column

The column that the row header mirrors.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

Splits a table window horizontally.

ParameterTypeDescription

nRowsLowerHalf

bDragAdjust

Returns: SalBoolean.

Deletes a list box or combo box entry.

ParameterTypeDescription

nIndex

Returns: SalNumber.

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

ParameterTypeDescription

nRow

nFlag

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

errorHandler

Returns: SalBoolean.

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.

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

Returns: SalBoolean.

Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Returns: SalBoolean.

Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window in the outline. The label control must have a mnemonic. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

flagsOn

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

flagsOn

errorHandler

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

bClearFlags

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

bClearFlags

errorHandler

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

bClearFlags

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

bClearFlags

errorHandler

Returns: SalBoolean.

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

Returns: SalBoolean.

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

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

ParameterTypeDescription

nReturn

Returns: SalBoolean.

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

ParameterTypeDescription

nRow

Returns: SalNumber.

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

ParameterTypeDescription

windowName

Returns: SalWindowHandle.

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

ParameterTypeDescription

name

Returns: Control.

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

ParameterTypeDescription

name

Returns: ReferenceInfo.

ParameterTypeDescription

Row

flagsOn

flagsOff

Returns: SalBoolean.

ParameterTypeDescription

Row

flagsOn

flagsOff

Returns: SalBoolean.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalNumber.

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

ParameterTypeDescription

nMsg

nMywParam

nMylParam

Returns: SalBoolean.

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

ParameterTypeDescription

formUnits

The number of form units.

vertical

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

Returns: SalNumber.

ParameterTypeDescription

type

Returns: SalBoolean.

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

Returns: SalNumber.

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

Returns: SalString.

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

ParameterTypeDescription

flags

Returns: SalBoolean.

Gets a table window column's identifier.

Returns: SalNumber.

Gets a table window column's relative position.

Returns: SalNumber.

ParameterTypeDescription

columnID

text

Returns: SalBoolean.

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

ParameterTypeDescription

columnID

Returns: SalString.

ParameterTypeDescription

text

maxLen

Returns: SalNumber.

Gets the title of a table window column.

ParameterTypeDescription

maxLen

Returns: SalString.

ParameterTypeDescription

formUnits

Returns: SalBoolean.

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

Returns: SalNumber.

Gets the handle of a table window column.

ParameterTypeDescription

col

flags

Returns: SalWindowHandle.

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.

Returns an object's type.

Returns: SalNumber.

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

Returns: SalNumber.

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

Returns: SalNumber.

Returns the handle of the 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.

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

ParameterTypeDescription

typeMask

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

Returns: SalWindowHandle.

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

ParameterTypeDescription

sPicture

Returns: SalBoolean.

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

Returns: SalString.

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

Returns: SalNumber.

ParameterTypeDescription

sText

bFormat

Returns: SalBoolean.

Copies the contents of a data field or table window column to a string. This function also lets you copy the format of the data.

ParameterTypeDescription

bFormat

Returns: SalString.

ParameterTypeDescription

buffer

type

Returns: SalNumber.

ParameterTypeDescription

buffer

type

Returns: SalNumber.

ParameterTypeDescription

desc

maxLen

Returns: SalNumber.

Retrieves a description of a picture's contents.

ParameterTypeDescription

maxLen

Returns: SalString.

ParameterTypeDescription

format

pict

Returns: SalNumber.

Return the contents of a picture into a string.

ParameterTypeDescription

format

Returns: SalString.

ParameterTypeDescription

format

buffer

Returns: SalNumber.

ParameterTypeDescription

sMask

Returns: SalBoolean.

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

Returns: SalString.

Retrieves the window handle of the label (label control) that is associated with the hWndTarget parameter. There must be a mnemonic in that label, and it must immediately precede hWndTarget in the outline, or this function will fail.

Returns: SalWindowHandle.

ParameterTypeDescription

sText

nMaxLength

Returns: SalNumber.

Retrieves the text of the label associated to a control. Important: The label control does not require a mnemonic for the functions listed above to operate.

ParameterTypeDescription

nMaxLength

Returns: SalString.

ParameterTypeDescription

lines

Returns: SalBoolean.

Retrieves the height of a row in lines.

Returns: SalNumber.

Returns the number of list box or combo box entries.

Returns: SalNumber.

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

ParameterTypeDescription

nIndex

Returns: SalBoolean.

ParameterTypeDescription

nIndex

sText

Returns: SalNumber.

Returns the text of the specified item.

ParameterTypeDescription

nIndex

Returns: SalString.

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

ParameterTypeDescription

nIndex

Returns: SalNumber.

ParameterTypeDescription

sFileName

Returns: SalBoolean.

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.

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

Returns: SalNumber.

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

ParameterTypeDescription

nSelectedArray

Returns: SalBoolean.

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.

ParameterTypeDescription

x

y

Returns: SalBoolean.

Retrieves the number of locked table window columns.

Returns: SalNumber.

ParameterTypeDescription

text

Returns: SalBoolean.

Gets the name of an object.

Returns: SalString.

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

ParameterTypeDescription

typeMask

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

Returns: SalWindowHandle.

get object data

ParameterTypeDescription

info

context

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

ParameterTypeDescription

name

value

Returns: SalBoolean.

Gets the value of a named property.

ParameterTypeDescription

name

Returns: SalString.

Queries a row's flags.

ParameterTypeDescription

row

flags

Returns: SalBoolean.

ParameterTypeDescription

pos

Returns: SalBoolean.

Returns the current scroll bar value.

Returns: SalNumber.

ParameterTypeDescription

min

max

line

page

Returns: SalBoolean.

ParameterTypeDescription

width

height

Returns: SalBoolean.

ParameterTypeDescription

sText

nMaxLen

Returns: SalNumber.

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

ParameterTypeDescription

nMaxLen

Returns: SalString.

Tests the state of a table window's flags.

ParameterTypeDescription

flags

Returns: SalBoolean.

ParameterTypeDescription

text

maxLen

Returns: SalNumber.

Retrieves the text of a window.

ParameterTypeDescription

maxLen

Returns: SalString.

ParameterTypeDescription

sText

Returns: SalBoolean.

Unmasks the text from a masked edit control.

Returns: SalString.

Gets a window's color.

ParameterTypeDescription

colorIndex

Returns: SalNumber.

Returns a window's current state.

Returns: SalNumber.

Hides a window.

Returns: SalBoolean.

Hides a window and its associated label.

Returns: SalBoolean.

ParameterTypeDescription

x

y

row

col

flags

Returns: SalBoolean.

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

ParameterTypeDescription

nIndex

sAdd

Returns: SalNumber.

Inserts a new blank row into a table window.

ParameterTypeDescription

row

Returns: SalNumber.

Causes a window to be repainted.

Returns: SalBoolean.

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

Returns: SalBoolean.

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

ParameterTypeDescription

typeClass

Returns: SalBoolean.

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

Returns: SalBoolean.

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

Returns: SalBoolean.

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

Returns: SalBoolean.

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

Returns: SalBoolean.

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

Returns: SalBoolean.

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

ParameterTypeDescription

nPrecision

nScale

Returns: SalBoolean.

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

Returns: SalBoolean.

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

Returns: SalBoolean.

Determines whether a window is currently visible.

Returns: SalBoolean.

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.

Turns off the table window's focus frame.

Returns: SalBoolean.

Destroys an object's system timer.

ParameterTypeDescription

idEvent

Returns: SalBoolean.

Arranges minimized child window icons in an MDI window.

Returns: SalBoolean.

Cascades all non-iconized child windows of an MDI window.

Returns: SalBoolean.

Tiles all non-iconized child windows of an MDI window. Windows that are not sizable will not be tiled.

ParameterTypeDescription

bPosition

Returns: SalBoolean.

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

ParameterTypeDescription

xOffset

yOffset

Returns: SalBoolean.

Adds a new group to the specified pane of a navigation bar.

ParameterTypeDescription

paneIndex

Zero-based index of the pane to which you want to add a group.

groupIndex

Zero-based index that the new group will occupy.

groupTitle

The title of the new group.

height

The height of the new group in form units.

Returns: SalBoolean.

Inserts a pane into the navigation bar control.

ParameterTypeDescription

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.

name

Name of the new pane (object title)

expandedImage

File name of the image to display for the new pane when it is expanded.

collapsedImage

File name of the image to display for the new pane when it is collapsed.

Returns: SalBoolean.

Associates a control to a pane.

ParameterTypeDescription

paneIndex

Zero-based index of the pane.

groupIndex

Zero-based index of the group. If the pane has no groups, use zero.

child

the control you're associating to the pane.

Returns: SalBoolean.

Disassociates a control from a pane.

ParameterTypeDescription

paneIndex

Zero-based index of the pane

child

The control you're disassociating

Returns: SalBoolean.

Enables or disables a pane on the navigation bar.

ParameterTypeDescription

paneIndex

Index for the pane to enable (start at 0).

enable

Set TRUE to enable pane, FALSE to disable.

Returns: SalBoolean.

Expands or collapses a group.

ParameterTypeDescription

paneIndex

Zero-based index of the pane

groupIndex

Zero-based index of the group

expand

Set to TRUE to expand, FALSE to collapse

Returns: SalBoolean.

Returns the index of the currently selected pane.

Returns: SalNumber. The zero-based index of the currently selected pane.

ParameterTypeDescription

paneIndex

binary

format

expanded

Returns: SalBoolean.

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.

ParameterTypeDescription

name

The name of the pane (object title)

Returns: SalNumber. the zero-based index of the pane. If the pane is not found, nIndex is -1.

ParameterTypeDescription

paneIndex

title

Returns: SalBoolean.

Returns the title of a pane.

ParameterTypeDescription

paneIndex

Index for the pane whose title you want to get (start at 0)

Returns: SalString.

Retrieves the group status. The function returns true if the group is expanded; false if collapsed.

ParameterTypeDescription

paneIndex

Zero-based index of the pane

groupIndex

Zero-based index of the group

Returns: SalBoolean.

Restore the settings of a navigation bar from an XML string.

ParameterTypeDescription

xml

Returns: SalBoolean.

Returns true if the pane is enabled (visible in the pane navigator); false if disabled (not visible).

ParameterTypeDescription

paneIndex

Index of pane (start at 0).

Returns: SalBoolean.

Removes a group from the navigation bar control.

ParameterTypeDescription

paneIndex

Zero-based index of the pane to be removed.

groupIndex

Zero-based index of the group to remove.

Returns: SalBoolean.

Removes a pane from the navigation bar control.

ParameterTypeDescription

paneIndex

Zero-based index of the pane to be removed.

Returns: SalBoolean.

ParameterTypeDescription

xml

Returns: SalBoolean.

Activates the indicated pane.

ParameterTypeDescription

paneIndex

The zero-based index of the pane to activate.

Returns: SalBoolean.

Sets the title of a pane.

ParameterTypeDescription

paneIndex

Index for the pane.

binary

Buffer that stores the image (bmp or icon).

format

Indicates the image format. Use PIC_FormatIcon or PIC_FormatBitmap.

expanded

TRUE for "expanded" image, FALSE for "collapsed" image

Returns: SalBoolean.

Sets the title of a pane.

ParameterTypeDescription

paneIndex

Index for the pane whose title you want to get (start at 0).

title

The new title for the pane.

Returns: SalBoolean.

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.

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

ParameterTypeDescription

numPixels

vertical

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

Returns: SalNumber.

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

ParameterTypeDescription

hSql

select

method

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

select

method

errorHandler

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

select

Returns: SalBoolean.

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

ParameterTypeDescription

hSql

select

errorHandler

Returns: SalBoolean.

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.

ParameterTypeDescription

hSql

sSelect

Returns: SalBoolean.

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.

ParameterTypeDescription

hSql

sSelect

errorHandler

Returns: SalBoolean.

ParameterTypeDescription

ctrlPath

sPathName

nAttributes

Returns: SalBoolean.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

ParameterTypeDescription

flags

checkedValue

uncheckedValue

Returns: SalBoolean.

ParameterTypeDescription

flags

lines

Returns: SalBoolean.

ParameterTypeDescription

nRow

hWndCol

Returns: SalBoolean.

ParameterTypeDescription

flags

lines

Returns: SalBoolean.

ParameterTypeDescription

title

maxTitle

width

flags

col

Returns: SalBoolean.

ParameterTypeDescription

position

minRange

maxRange

Returns: SalBoolean.

ParameterTypeDescription

nRowsLowerHalf

bDragAdjust

Returns: SalBoolean.

ParameterTypeDescription

minRange

maxRange

Returns: SalBoolean.

Clears a table window by discarding all rows from the table window cache and setting the table range to 0, -1.

Returns: SalBoolean.

Scrolls a table window to the specified row and column.

ParameterTypeDescription

row

column

flags

Returns: SalBoolean.

Scrolls a table window to the specified row and column.

ParameterTypeDescription

row

column

Returns: SalBoolean.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalNumber.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

Changes a table window cell's text color.

ParameterTypeDescription

color

discardable

Returns: SalBoolean.

Changes a table window cell's text color.

ParameterTypeDescription

color

Returns: SalBoolean.

Sets or clears a table window column's flags.

ParameterTypeDescription

flags

set

Returns: SalBoolean.

Moves a table window column to a new position.

ParameterTypeDescription

pos

Returns: SalBoolean.

Moves a table window column to a new position.

ParameterTypeDescription

pos

Returns: SalBoolean.

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

ParameterTypeDescription

columnID

text

Returns: SalBoolean.

Sets the title of a table window column.

ParameterTypeDescription

title

Returns: SalBoolean.

Sets a table window column's display width.

ParameterTypeDescription

formUnits

The number of form units.

Returns: SalBoolean.

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

ParameterTypeDescription

sMenuName

nFlags

Returns: SalBoolean.

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

ParameterTypeDescription

menuType

flags

Returns: SalBoolean.

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

ParameterTypeDescription

row

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resource

type

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resourceId

type

Returns: SalBoolean.

Sets a window's cursor from a string variable.

ParameterTypeDescription

blob

type

Returns: SalBoolean.

Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.

ParameterTypeDescription

file

type

Returns: SalBoolean.

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

ParameterTypeDescription

length

Returns: SalBoolean.

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

Returns: SalBoolean.

Sets or clears row flags.

ParameterTypeDescription

flags

set

flagsOn

flagsOff

Returns: SalBoolean.

Sets the focus to a specified window.

Returns: SalWindowHandle.

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.

ParameterTypeDescription

row

column

editMin

editMax

Returns: SalBoolean.

Sets a table window's focus frame row.

ParameterTypeDescription

row

Returns: SalBoolean.

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

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

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

ParameterTypeDescription

sPicture

Returns: SalBoolean.

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

ParameterTypeDescription

nFormat

Returns: SalBoolean.

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

ParameterTypeDescription

imageBytes

type

Returns: SalBoolean.

Inserts a file's contents into a picture.

ParameterTypeDescription

fileName

Returns: SalBoolean.

Sets the fit for a picture.

ParameterTypeDescription

fit

scaleWidth

scaleHeight

Returns: SalBoolean.

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.

ParameterTypeDescription

type

handle

Returns: SalBoolean.

Inserts a resource into a picture.

ParameterTypeDescription

resource

format

Returns: SalBoolean.

Inserts the contents of a string into a picture.

ParameterTypeDescription

format

picture

Returns: SalBoolean.

Inserts the contents of a binary buffer into a picture.

ParameterTypeDescription

format

buffer

Returns: SalBoolean.

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

ParameterTypeDescription

sMask

Returns: SalBoolean.

Sets the text of the associated label control.

ParameterTypeDescription

sText

Returns: SalBoolean.

Sets the height of a row in lines.

ParameterTypeDescription

lines

Returns: SalBoolean.

Redraws entries in a list box or combo box, or prevents them from being redrawn.

ParameterTypeDescription

bRedraw

Returns: SalBoolean.

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

ParameterTypeDescription

nIndex

Returns: SalBoolean.

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

ParameterTypeDescription

nIndex

bSelect

Returns: SalBoolean.

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

ParameterTypeDescription

nIndexStart

sText

Returns: SalNumber.

Sets tabs in a list box.

ParameterTypeDescription

nTabStops

Returns: SalBoolean.

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

ParameterTypeDescription

x

y

Returns: SalBoolean.

Sets the number of locked table window columns.

ParameterTypeDescription

lockedColumns

Returns: SalBoolean.

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

ParameterTypeDescription

bSet

Returns: SalBoolean.

Sets the value of a named property.

ParameterTypeDescription

name

value

length

Returns: SalBoolean.

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

ParameterTypeDescription

min

max

Returns: SalBoolean.

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

ParameterTypeDescription

rowPos

Returns: SalNumber.

Sets or clears a table window row's flags.

ParameterTypeDescription

row

flags

set

Returns: SalBoolean.

Sets the scrollbar's value.

ParameterTypeDescription

pos

Returns: SalBoolean.

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.

ParameterTypeDescription

min

max

line

page

Returns: SalBoolean.

Resizes a window.

ParameterTypeDescription

width

height

Returns: SalBoolean.

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

ParameterTypeDescription

sText

Returns: SalBoolean.

Sets or clears a table window's flags.

ParameterTypeDescription

flags

set

Returns: SalBoolean.

Sets the text of a window.

ParameterTypeDescription

text

Returns: SalBoolean.

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

ParameterTypeDescription

sValue

bFormat

Returns: SalBoolean.

Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.

ParameterTypeDescription

idEvent

elapseMilliSec

Returns: SalBoolean.

Sets a window's color.

ParameterTypeDescription

colorIndex

color

Returns: SalBoolean.

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

ParameterTypeDescription

bShow

Returns: SalBoolean.

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

ParameterTypeDescription

bShow

Returns: SalBoolean.

Makes a window visible.

Returns: SalBoolean.

Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

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

ParameterTypeDescription

columnID

order

Returns: SalBoolean.

Returns the Control associated with this handle.

Returns: Control.

Converts a window handle to a number.

Returns: Int32. nWnd

Returns the IntPtr value.

Returns: IntPtr.

Returns the value converted to SalNumber.

Returns: SalNumber.

Creates pop-up menus at runtime.

ParameterTypeDescription

menuName

flags

x

y

Returns: SalBoolean.

Creates pop-up menus at runtime.

ParameterTypeDescription

menuType

flags

x

y

Returns: SalBoolean.

Forces the update of a window.

Returns: SalBoolean.

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

Returns: SalBoolean.

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

ParameterTypeDescription

validate

Returns: SalBoolean.

Starts the Windows help system.

ParameterTypeDescription

file

command

numData

strData

Returns: SalBoolean.

Processes messages for this control.

Used By

NameDescription

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