SalFormTableWindow

PPJ.Runtime.Windows.SalFormTableWindow

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.49 (4.9.0.0)

Top level table window implementation.

C#

public class SalFormTableWindow : SalForm, IEnumerable<SalTableRow>, IEnumerable

VB.NET

Constructors

SalFormTableWindow()

Constructs a SalFormWindow object.

Properties

AllowAutoEditing

Boolean: Enables/Disables AutoEditing mode. When this mode is on, the grid automatically enters edit mode when a cell is selected. (Default: False)

AllowRowSizing

Boolean: Allow row sizing. (Default: True)

AllowSorting

Boolean: Enables/Disables automatic sorting on table columns. (Default: False)

Columns

SalTableColumnCollection: Returns the collection of columns.

DisableSplitGrid

Boolean: Prevents the split grid from getting the focus while allowing for he horizontal scroll and column resizing. (Default: False)

Item(id)

SalTableColumn: Returns the table column object with the specified column ID. The ID is 1-based.

Item(name)

SalTableColumn: Returns the table column object with the specified name.

LinesPerRow

Int32: Number of lines per row.

ReadOnly

Boolean: Returns/Sets the ReadOnly flag. When the ReadOnly flag is true the entire TableWindow control cannot be edited. However, the Mouse, scrolling and the Keyboard are still active. (Default: False)

RowSizingStyle

RowsSizingStyle: Keeps all rows of the same height. (Default: FreeSize)

TableWindow

SalTableWindow: Returns the internal table window control.

Methods

AnyRows(nFlagsOn, nFlagsOff)

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

Parameter	Type	Description
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

BeginUpdate()

Prevents the control from updating until the EndUpdate method is called.

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	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

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	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalNumber.

CopyRows(nFlagsOn, nFlagsOff)

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

Parameter	Type	Description
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)

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

Parameter	Type	Description
nColumnPos	SalNumber
nDispWidth	SalNumber
nMaxChars	SalNumber
sTitle	SalString

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	SalNumber
nDispWidth	SalNumber
sTitle	SalString
nMaxChars	SalNumber
nDatatype	SalNumber

Returns: SalNumber.

DefineRowHeader(sTitle, nWidth, nFlags, column)

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

Parameter	Type	Description
sTitle	SalString
nWidth	SalNumber
nFlags	SalNumber
column	Control

Returns: SalBoolean.

DefineSplitWindow(nRowsLowerHalf, bDragAdjust)

Splits a table window horizontally.

Parameter	Type	Description
nRowsLowerHalf	SalNumber
bDragAdjust	SalBoolean

Returns: SalBoolean.

DeleteRow(nRow, nFlag)

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

Parameter	Type	Description
nRow	SalNumber
nFlag	SalNumber

Returns: SalBoolean.

DeleteSelected(hSql)

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

Parameter	Type	Description
hSql	SalSqlHandle

Returns: SalBoolean.

DeleteSelected(hSql, errorHandler)

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

Parameter	Type	Description
hSql	SalSqlHandle
errorHandler	WhenSqlErrorHandler

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.

DoDeletes(hSql, nFlagsOn)

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

Parameter	Type	Description
hSql	SalSqlHandle
nFlagsOn	SalNumber

Returns: SalBoolean.

DoDeletes(hSql, nFlagsOn, errorHandler)

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

Parameter	Type	Description
hSql	SalSqlHandle
nFlagsOn	SalNumber
errorHandler	WhenSqlErrorHandler

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
hSql	SalSqlHandle
bClearFlags	SalBoolean

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
hSql	SalSqlHandle
bClearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

DoUpdates(hSql, bClearFlags)

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

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean

Returns: SalBoolean.

DoUpdates(hSql, bClearFlags, errorHandler)

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

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

EndUpdate()

Resumes updating of the list view control after suspending it by the BeginUpdate method.

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
nRow	SalNumber

Returns: SalNumber.

FindNextRow(nRow, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nRow	SalNumber&
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

FindPrevRow(nRow, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nRow	SalNumber&
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

GetColumnText(nColumnID, sText)

Parameter	Type	Description
nColumnID	SalNumber
sText	SalString&

Returns: SalBoolean.

GetColumnText(nColumnID)

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

Parameter	Type	Description
nColumnID	SalNumber

Returns: SalString.

GetColumnWindow(nCol, nFlags)

Gets the handle of a table window column.

Parameter	Type	Description
nCol	SalNumber
nFlags	SalNumber

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.

GetLinesPerRow(nLines)

Parameter	Type	Description
nLines	SalNumber&

Returns: SalBoolean.

GetLinesPerRow()

Retrieves the height of a row in lines.

Returns: SalNumber.

GetLockedColumns()

Retrieves the number of locked table window columns.

Returns: SalNumber.

GetRowFlags(nRow, nFlags)

Queries a row's flags.

Parameter	Type	Description
nRow	SalNumber
nFlags	SalNumber

Returns: SalBoolean.

GetTableFlags(nFlags)

Tests the state of a table window's flags.

Parameter	Type	Description
nFlags	SalNumber

Returns: SalBoolean.

InsertRow(nRow)

Inserts a new blank row into a table window.

Parameter	Type	Description
nRow	SalNumber

Returns: SalNumber.

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.

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.

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
hSql	SalSqlHandle
sSelect	SalString
nMethod	SalNumber

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
hSql	SalSqlHandle
sSelect	SalString
nMethod	SalNumber
errorHandler	WhenSqlErrorHandler

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
hSql	SalSqlHandle
sSelect	SalString

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
hSql	SalSqlHandle
sSelect	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

QueryFocusCell(nRow, hWndCol)

Parameter	Type	Description
nRow	SalNumber&
hWndCol	SalWindowHandle&

Returns: SalBoolean.

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

Parameter	Type	Description
sTitle	SalString&
nMaxTitle	SalNumber
nWidth	SalNumber&
nFlags	SalNumber&
hWndCol	SalWindowHandle&

Returns: SalBoolean.

QueryScroll(nPosition, nMinRange, nMaxRange)

Parameter	Type	Description
nPosition	SalNumber&
nMinRange	SalNumber&
nMaxRange	SalNumber&

Returns: SalBoolean.

QuerySplitWindow(nRowsLowerHalf, bDragAdjust)

Parameter	Type	Description
nRowsLowerHalf	SalNumber&
bDragAdjust	SalBoolean&

Returns: SalBoolean.

QueryVisibleRange(nMinRange, nMaxRange)

Parameter	Type	Description
nMinRange	SalNumber&
nMaxRange	SalNumber&

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
nRow	SalNumber
column	Control
nFlags	SalNumber

Returns: SalBoolean.

ScrollRow(nRow, column)

Scrolls a table window to the specified row and column.

Parameter	Type	Description
nRow	SalNumber
column	Control

Returns: SalBoolean.

SetColumnText(nColumnID, sText)

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

Parameter	Type	Description
nColumnID	SalNumber
sText	SalString

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
nRow	SalNumber

Returns: SalBoolean.

SetFlagsAnyRows(nFlags, bSet, nFlagsOn, nFlagsOff)

Sets or clears row flags.

Parameter	Type	Description
nFlags	SalNumber
bSet	SalBoolean
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

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
nRow	SalNumber
column	Control

Returns: SalBoolean.

SetFocusRow(nRow)

Sets a table window's focus frame row.

Parameter	Type	Description
nRow	SalNumber

Returns: SalBoolean.

SetLinesPerRow(nLines)

Sets the height of a row in lines.

Parameter	Type	Description
nLines	SalNumber

Returns: SalBoolean.

SetLockedColumns(nLockedColumns)

Sets the number of locked table window columns.

Parameter	Type	Description
nLockedColumns	SalNumber

Returns: SalBoolean.

SetRange(nMin, nMax)

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

Parameter	Type	Description
nMin	SalNumber
nMax	SalNumber

Returns: SalBoolean.

SetRow(nRowPos)

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

Parameter	Type	Description
nRowPos	SalNumber

Returns: SalNumber.

SetRowFlags(nRow, nFlags, bSet)

Sets or clears a table window row's flags.

Parameter	Type	Description
nRow	SalNumber
nFlags	SalNumber
bSet	SalBoolean

Returns: SalBoolean.

SetTableFlags(nFlags, bSet)

Sets or clears a table window's flags.

Parameter	Type	Description
nFlags	SalNumber
bSet	SalBoolean

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	SalNumber
nOrder	SalNumber

Returns: SalBoolean.

Implements

Name	Description
ISalWindow	All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.