The SalWindowHandle type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AddListItem |
Adds a string to a list box or combo box.
|
| AnyRows |
Determines whether any rows in the specified table window match certain flags.
|
| BringWindowToTop |
Brings a window to the top of all overlapping windows.
|
| 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.
|
| Clear |
Clears the value from a data field, multiline field, or table window column.
|
| ClearCursor |
Clears a window's cursor.
|
| ClearImage |
Deletes the contents of a picture.
|
| ClearList |
Deletes all entries from a list box or combo box.
|
| ClearSelection |
Deselects all rows of a table window.
|
| ColumnAverage |
Computes the average of all column values or only specified column values in a table
window.
|
| ColumnSum |
Computes the sum of all column values or only specified column values in a table
window.
|
| CompareTo(Object) | |
| CompareTo(SalWindowHandle) | |
| CopyRows |
Copies the contents of the specified table window rows to the Clipboard in text format.
|
| CreateColumn |
Creates a table window column of string data type at runtime.
|
| CreateColumnEx |
Creates a table window column using a given data type at runtime.
Allowed types are DT_String, DT_Number and DT_DateTime
|
| DefineCheckBoxColumn |
Define a column as a check box.
|
| DefineDropDownListColumn |
Define a column as a drop down list.
|
| DefinePopupEditColumn |
Define a column as a popup edit window.
|
| DefineRowHeader |
Defines the appearance and behavior of a table window's row header.
|
| DefineSplitWindow |
Splits a table window horizontally.
|
| DeleteListItem |
Deletes a list box or combo box entry.
|
| DeleteRow |
Deletes a row from a table window but not from the database.
|
| DeleteSelected(SalSqlHandle) |
Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
|
| DeleteSelected(SalSqlHandle, WhenSqlErrorHandler) |
Applies a SQL DELETE statement to all table window rows with the ROW Selected flag.
|
| DestroyColumns |
Destroys all automatic columns created by SalTblCreateColumn or SalTblPopulate at
runtime. This function only works on table windows that contain only automatic
columns.
|
| DestroyWindow |
Destroys a form window, a top-level table window, or a modeless dialog box created
with SalCreateWindow.
|
| 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.
|
| 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.
|
| DoDeletes(SalSqlHandle, SalNumber) |
Applies a SQL DELETE statement to all table window rows that have nFlagsOn flags.
|
| DoDeletes(SalSqlHandle, SalNumber, WhenSqlErrorHandler) |
Applies a SQL DELETE statement to all table window rows that have nFlagsOn flags.
|
| DoInserts(SalSqlHandle, SalBoolean) |
Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
|
| DoInserts(SalSqlHandle, SalBoolean, WhenSqlErrorHandler) |
Applies a SQL INSERT statement to all the rows in a table window that have the ROW New flag.
|
| DoUpdates(SalSqlHandle, SalBoolean) |
Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
|
| DoUpdates(SalSqlHandle, SalBoolean, WhenSqlErrorHandler) |
Applies a SQL UPDATE statement to all table window rows with the Row Edited flag.
|
| DrawMenuBar |
Redraws the menu bar for a given form window or top-level table window.
|
| EnableWindow |
Enables keyboard and mouse input to a window.
|
| 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.
|
| EndDialog |
Destroys a modal dialog box and returns control to the caller of SalModalDialog.
|
| Equals |
Overrides the Object.Equals() method.
(Overrides ValueType..::..Equals(Object).) |
| FetchRow |
Sends a SAM_FetchRow message to a table window if the row you specify is not currently
in the table window cache.
|
| FindChild |
This function finds a child window of a given name in the specified window.
|
| FindControl |
Finds a member control in the specified control.
Used as a helper functions to resolve unqualified references.
|
| FindMember |
Find a member in the specified control.
Used as a helper functions to resolve unqualified references.
|
| FindNextRow |
Scans forward in a table looking for a row whose flags match those specified.
|
| FindPrevRow |
Scans backward in a table looking for a row whose flags match those specified.
|
| FormUnitsToPixels |
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.
|
| GetCellType()()()() |
Indicates whether a column is a checkbox, drop down list, popup edit, or standard
column.
|
| GetCellType(SalNumber%) |
Indicates whether a column is a checkbox, drop down list, popup edit, or standard
column.
|
| GetClassName |
Return the name of a window's class as a string.
|
| GetColumnFlags |
Tests the state of a table window column's flags.
|
| GetColumnID |
Gets a table window column's identifier.
|
| GetColumnPosition |
Gets a table window column's relative position.
|
| GetColumnText(SalNumber) |
Gets data from a column of a table window's context row.
|
| GetColumnText(SalNumber, SalString%) |
Gets data from a column of a table window's context row.
|
| GetColumnTitle(SalNumber) |
Gets the title of a table window column.
|
| GetColumnTitle(SalString%, SalNumber) |
Gets the title of a table window column.
|
| GetColumnWidth()()()() |
Returns the width (in form units) of a table window column.
|
| GetColumnWidth(SalNumber%) |
Returns the width (in form units) of a table window column.
|
| GetColumnWindow |
Gets the handle of a table window column.
|
| 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.
|
| GetControlType |
Returns an object's type.
|
| GetDataLength |
Returns the maximum length of a data field, multiline text field, or table window
column.
|
| GetDataType |
Returns a data field's or table window column's data type.
|
| 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.
|
| GetFirstChild |
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.
|
| GetFont |
Gets a window's font name, size, and enhancements.
|
| GetFormat()()()() |
Gets the picture format of a data field or table window column.
|
| GetFormat(SalString%) |
Gets the picture format of a data field or table window column.
|
| GetFormatCode |
Returns the current format of a data field or table window column.
|
| GetFormattedText(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.
|
| GetFormattedText(SalString%, 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.
|
| GetHashCode |
Overrides the Object.GetHashCode() method
(Overrides ValueType..::..GetHashCode()()()().) |
| GetImageBytes |
Copies the contents of a picture to a string.
|
| GetImageDescription(SalNumber) |
Retrieves a description of a picture's contents.
|
| GetImageDescription(SalString%, SalNumber) |
Retrieves a description of a picture's contents.
|
| GetImageString(SalNumber) |
Return the contents of a picture into a string.
|
| GetImageString(SalNumber, SalString%) |
Copies the contents of a picture to a string.
|
| GetInputMask()()()() |
Gets the input mask of a data field or table window column.
|
| GetInputMask(SalString%) |
Gets the input mask of a data field or table window column.
|
| 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.
|
| GetLabelText(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.
|
| GetLabelText(SalString%, 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.
|
| GetLinesPerRow()()()() |
Retrieves the height of a row in lines.
|
| GetLinesPerRow(SalNumber%) |
Retrieves the height of a row in lines.
|
| GetListItemsCount |
Returns the number of list box or combo box entries.
|
| GetListItemState |
Determines whether the specified list box or combo box entry is selected.
|
| GetListItemText(SalNumber) |
Returns the text of the specified item.
|
| GetListItemText(SalNumber, SalString%) |
Returns the text of the specified item.
|
| GetListItemTextLength |
Returns the length of a list box or combo box entry.
|
| GetListSelectedFile()()()() |
Fetches the selected directory or file name from a list box or combo box.
|
| GetListSelectedFile(SalString%) |
Fetches the selected directory or file name from a list box or combo box.
|
| GetListSelectedIndex |
Returns the index of the selected entry in a combo box or single-selection list box.
|
| GetListSelectedItems |
Returns an array of index numbers of selected list box entries.
|
| GetListSelectedItemsCount |
Returns the number of selected entries in a multiple-selection list box. Specify
single- or multiple-selection in the list box's customizer.
|
| GetLocation |
Returns a window's current position on the X and Y axes.
|
| GetLockedColumns |
Retrieves the number of locked table window columns.
|
| GetName()()()() |
Gets the name of an object.
|
| GetName(SalString%) |
Gets the name of an object.
|
| GetNextChild |
Returns the handle of the next child window that matches a specified type.
|
| GetObjectData | |
| GetParent |
Returns the handle of an object's parent window.
|
| GetProperty(SalString) |
Gets the value of a named property.
|
| GetProperty(SalString, SalString%) |
Gets the value of a named property.
|
| GetRowFlags |
Queries a row's flags.
|
| GetScrollBarPosition()()()() |
Returns the current scroll bar value.
|
| GetScrollBarPosition(SalNumber%) |
Returns the current scroll bar value.
|
| GetScrollBarRange |
Gets a scroll bar's scroll range, line increment, and page increment.
|
| GetSize |
Returns a window's size.
|
| GetStatusBarText(SalNumber) |
Gets the text displayed in the status bar of a top-level or MDI window.
|
| GetStatusBarText(SalString%, SalNumber) |
Gets the text displayed in the status bar of a top-level or MDI window.
|
| GetTableFlags |
Tests the state of a table window's flags.
|
| GetText(SalNumber) |
Retrieves the text of a window.
|
| GetText(SalString%, SalNumber) |
Retrieves the text of a window.
|
| GetTextUnmasked()()()() |
Unmasks the text from a masked edit control.
|
| GetTextUnmasked(SalString%) |
Unmasks the text from a masked edit control.
|
| GetWindowColor |
Gets a window's color.
|
| GetWindowState |
Returns a window's current state.
|
| HideWindow |
Hides a window.
|
| HideWindowAndLabel |
Hides a window and its associated label.
|
| HitTest |
Returns the part of the table window located at a given coordinate.
|
| InsertListItem |
Inserts an entry into a list box or combo box at a specified position.
|
| InsertRow |
Inserts a new blank row into a table window.
|
| InvalidateWindow |
Causes a window to be repainted.
|
| IsChecked |
Determines whether a radio button is set or a check box is checked.
|
| IsDerivedFromClass |
Determines whether a window is an instance of the specified class.
|
| IsEmpty |
Verifies whether a data field, multiline text field, or table window column is null
or empty.
|
| IsEnabled |
Determines whether a window is enabled for mouse and keyboard input.
|
| 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.
|
| IsValid |
Validates the contents of a data field or table window column using the current profile.
|
| 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.
|
| IsValidDecimal |
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.
|
| 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.
|
| 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.
|
| IsVisible |
Determines whether a window is currently visible.
|
| 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.
|
| KillFocusRow | |
| KillTimer |
Destroys an object's system timer.
|
| MDIArrangeIcons |
Arranges minimized child window icons in an MDI window.
|
| MDICascade |
Cascades all non-iconized child windows of an MDI window.
|
| MDITile |
Tiles all non-iconized child windows of an MDI window. Windows that are not sizable
will not be tiled.
|
| MoveWindow |
Moves a window a given number of form units on the X and Y axes relative to its current
position.
|
| 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.
|
| PixelsToFormUnits |
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.
|
| Populate(SalSqlHandle, SalString) |
Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the
result set and populates a table window with them.
|
| Populate(SalSqlHandle, SalString, SalNumber) |
Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the
result set and populates a table window with them.
|
| Populate(SalSqlHandle, SalString, WhenSqlErrorHandler) |
Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the
result set and populates a table window with them.
|
| Populate(SalSqlHandle, SalString, SalNumber, WhenSqlErrorHandler) |
Compiles, binds, and executes a SQL SELECT statement, then fetches the rows of the
result set and populates a table window with them.
|
| PopulateList(SalSqlHandle, SalString) |
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.
|
| PopulateList(SalSqlHandle, SalString, WhenSqlErrorHandler) |
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.
|
| PopulateListFiles |
Populates a list box or combo box with a directory of files.
|
| PostMessage |
Posts the specified message to a window by adding nMsg to hWndReceiver's message
queue.
|
| QueryCheckBoxColumn |
If the column is defined as a check box, this function retrieves information about
the check box and returns TRUE. If it is not a check box, this function returns
FALSE.
|
| QueryDropDownListColumn |
If the column is defined as a drop down list, this function retrieves information
about the list and returns TRUE. If it is not a drop down list, this function returns
FALSE.
|
| QueryFocusCell |
Identifies the cell in a table window with the focus.
|
| QueryPopupEditColumn |
If the column is defined as a popup edit, this function retrieves information about
the popup edit and returns TRUE. If it is not a popup edit, this function returns
FALSE.
|
| QueryRowHeader |
Gets a table window's row header definition.
|
| QueryScroll |
Returns a table window's current scroll position and range. The scroll position is
the row number of the row that is currently at the top of the window. You set
the table window range with SalTblSetRange and changes it when you insert
or delete rows from the table window.
|
| QuerySplitWindow |
Specifies how a table window is split horizontally.
|
| QueryVisibleRange |
Returns the current range of visible rows in a table window.
|
| ResetTable |
Clears a table window by discarding all rows from the table window cache and setting
the table range to 0, -1.
|
| ScrollRow(SalNumber, Control) |
Scrolls a table window to the specified row and column.
|
| ScrollRow(SalNumber, Control, SalNumber) |
Scrolls a table window to the specified row and column.
|
| SendMessage |
Sends the specified message to a window. SalSendMsg does not return until the processing
for the message is complete.
|
| SendMessageToChildren |
Sends a message to all child items of a form window, dialog box, table window, or
MDI window.
|
| SetCellTextColor(SalNumber) |
Changes a table window cell's text color.
|
| SetCellTextColor(SalNumber, SalBoolean) |
Changes a table window cell's text color.
|
| SetColumnFlags |
Sets or clears a table window column's flags.
|
| SetColumnPos |
Moves a table window column to a new position.
|
| SetColumnPosition |
Moves a table window column to a new position.
|
| SetColumnText |
Assigns data to a column of a table window's context row.
|
| SetColumnTitle |
Sets the title of a table window column.
|
| SetColumnWidth |
Sets a table window column's display width.
|
| SetContextMenu(Type, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
|
| SetContextMenu(SalString, SalNumber) |
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
|
| SetContextRow |
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.
|
| SetCursor(Int32, SalNumber) |
Sets a window's cursor.
|
| SetCursor(SalResourceCursor, SalNumber) |
Sets a window's cursor.
|
| SetCursor(SalString, SalNumber) |
Sets a window's cursor from a string variable.
|
| SetCursorFile |
Sets an application-defined cursor for the specified window. Use this function to
set the cursor from an image stored in a file.
|
| SetDataLength |
Sets a limit on the number of characters that a user can enter into a data field,
multiline text field, or table window column.
|
| SetDefaultButton |
Sets the default push button of a form window or dialog box.
|
| SetFlagsAnyRows |
Sets or clears row flags.
|
| SetFocus |
Sets the focus to a specified window.
|
| SetFocusCell |
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.
|
| SetFocusRow |
Sets a table window's focus frame row.
|
| SetFont |
Sets a window's font, font size, and font enhancements.
|
| SetFormat |
Sets the picture format of a data field or table window column.
|
| SetFormatCode |
Sets a data field's or table window column's format.
|
| SetImageBytes |
Inserts the contents of a picture to an image without the image header.
|
| SetImageFile |
Inserts a file's contents into a picture.
|
| SetImageFit |
Sets the fit for a picture.
|
| SetImageHandle |
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.
|
| SetImageResource |
Inserts a resource into a picture.
|
| SetImageString |
Inserts the contents of a string into a picture.
|
| SetInputMask |
Sets the input mask of a data field or table window column.
|
| SetLabelText |
Sets the text of the associaetd label control.
|
| SetLinesPerRow |
Sets the height of a row in lines.
|
| SetListRedraw |
Redraws entries in a list box or combo box, or prevents them from being redrawn.
|
| SetListSelectedIndex |
Selects or deselects a combo box or single-selection list box entry.
|
| SetListSelectedItems |
Selects or deselects a combo box or multiple-selection list box entry.
|
| SetListSelectedText |
Finds and selects a combo box or single-selection list box entry.
|
| SetListTabStops |
Sets tabs in a list box.
|
| SetLocation |
Moves a window to a new position (x, y) on the X and Y axes.
|
| SetLockedColumns |
Sets the number of locked table window columns.
|
| SetModified |
Sets or clears the field edit flag for an editable data field, combo box, multiline
text field, table window column, or picture.
|
| SetProperty |
Sets the value of a named property.
|
| SetRange |
Defines the minimum and maximum rows (range) of a table.
|
| SetRow |
Sets the focus to the first, last, next, or previous row in a table window.
|
| SetRowFlags |
Sets or clears a table window row's flags.
|
| SetScrollBarPosition |
Sets the scrollbar's value.
|
| SetScrollBarRange |
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.
|
| SetSize |
Resizes a window.
|
| SetStatusBarText |
Displays specified text in the status bar of a top-level or MDI window.
|
| SetTableFlags |
Sets or clears a table window's flags.
|
| SetText(SalString) |
Sets the text of a window.
|
| SetText(SalString, SalBoolean) |
Copies a string to a data field or table window column. After copying the string
to the field, formats the string.
|
| SetTimer |
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.
|
| SetWindowColor |
Sets a window's color.
|
| ShowStatusBar |
Shows or hides the status bar on a top-level or MDI window.
|
| ShowToolBar |
Shows or hides the tool bar on a top-level or MDI window.
|
| ShowWindow |
Makes a window visible.
|
| ShowWindowAndLabel |
Makes a window and its associated label visible. A label is the label control that
immediately precedes the window in the outline.
|
| SortRows |
Sorts the rows of a table window based on the values in one of the
table window's columns.
|
| ToControl |
Returns the Control associated with this handle.
|
| ToInt32 |
Converts a window handle to a number.
|
| ToIntPtr |
Returns the IntPtr value.
|
| ToNumber |
Returns the value converted to SalNumber.
|
| ToString |
Overrides the ToString() method and redirects it to the wrapped member.
(Overrides ValueType..::..ToString()()()().) |
| TrackPopupMenu(Type, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
|
| TrackPopupMenu(SalString, SalNumber, SalNumber, SalNumber) |
Creates pop-up menus at runtime.
|
| UpdateWindow |
Forces the update of a window.
|
| Validate()()()() |
Validates and formats a data field's or table window column's contents.
|
| Validate(SalNumber) |
Validates and formats a data field's or table window column's contents.
|
| WinHelp |
Starts the Windows help system.
|
| Yield |
Processes messages for this control.
|
