SalFormTableWindow

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.50 (5.0.0.0)

Hosts an embedded SAL table as a form and exposes its row, column, and population operations.

C#

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

VB.NET

Public Class SalFormTableWindow
    Inherits SalForm
    Implements IEnumerable(Of SalTableRow), IEnumerable

Example:

SalFormTableWindow form = new SalFormTableWindow();
            form.CreateColumn(0, 20, 80, "Name");
            form.InsertRow(Sys.TBL_MaxRow);
            form.Show();

Constructors

SalFormTableWindow()

Creates a borderless embedded table that fills the form’s client area.

Properties

AllowAutoEditing

Boolean: (Default: False)

Accesses the embedded table’s setting.

AllowRowSizing

Boolean: (Default: True)

Accesses the embedded table’s setting.

AllowSorting

Boolean: (Default: False)

Accesses the embedded table’s setting.

Columns

SalTableColumnCollection:

Accesses the embedded table’s setting.

DisableSplitGrid

Boolean: (Default: False)

Accesses the embedded table’s setting.

Item(id)

SalTableColumn: Gets an embedded-table column by its SAL identifier.

Item(name)

SalTableColumn: Gets an embedded-table column by its control name.

LinesPerRow

Int32:

Accesses the embedded table’s setting.

ReadOnly

Boolean: (Default: False)

Accesses the embedded table’s setting.

RowSizingStyle

RowsSizingStyle: (Default: FreeSize)

Accesses the embedded table’s setting.

TableWindow

SalTableWindow: Gets the embedded table control that implements this form’s table operations.

Methods

AnyRows(nFlagsOn, nFlagsOff)

Parameter	Type	Description
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

BeginUpdate()

Delegates to the embedded table.

ClearSelection()

Returns: SalBoolean.

Delegates to the embedded table.

ColumnAverage(nColumnID, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nColumnID	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalNumber.

Delegates to the embedded table.

ColumnSum(nColumnID, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nColumnID	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalNumber.

Delegates to the embedded table.

CopyRows(nFlagsOn, nFlagsOff)

Parameter	Type	Description
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

CreateColumn(nColumnPos, nDispWidth, nMaxChars, sTitle)

Parameter	Type	Description
nColumnPos	SalNumber
nDispWidth	SalNumber
nMaxChars	SalNumber
sTitle	SalString

Returns: SalNumber.

Delegates to the embedded table.

CreateColumnEx(nColumnPos, nDispWidth, sTitle, nMaxChars, nDatatype)

Parameter	Type	Description
nColumnPos	SalNumber
nDispWidth	SalNumber
sTitle	SalString
nMaxChars	SalNumber
nDatatype	SalNumber

Returns: SalNumber.

Delegates to the embedded table.

DefineRowHeader(sTitle, nWidth, nFlags, column)

Parameter	Type	Description
sTitle	SalString
nWidth	SalNumber
nFlags	SalNumber
column	Control

Returns: SalBoolean.

Delegates to the embedded table.

DefineSplitWindow(nRowsLowerHalf, bDragAdjust)

Parameter	Type	Description
nRowsLowerHalf	SalNumber
bDragAdjust	SalBoolean

Returns: SalBoolean.

Delegates to the embedded table.

DeleteRow(nRow, nFlag)

Parameter	Type	Description
nRow	SalNumber
nFlag	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

DeleteSelected(hSql)

Parameter	Type	Description
hSql	SalSqlHandle

Returns: SalBoolean.

Delegates to the embedded table.

DeleteSelected(hSql, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Delegates to the embedded table.

DestroyColumns()

Returns: SalBoolean.

Delegates to the embedded table.

DoDeletes(hSql, nFlagsOn)

Parameter	Type	Description
hSql	SalSqlHandle
nFlagsOn	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

DoDeletes(hSql, nFlagsOn, errorHandler)

Executes the prepared delete statement for matching rows in the embedded table under a temporary SQL error handler.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL handle containing the prepared statement and row-context bindings.
nFlagsOn	SalNumber	The flags required on rows to process; converted to an integer mask.
errorHandler	WhenSqlErrorHandler	The SQL error handler installed for the operation.

Returns: SalBoolean. True if all required executions succeed; false at the first execution failure.

New rows are marked deleted without executing SQL. The previous row context is restored.

DoInserts(hSql, bClearFlags)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean

Returns: SalBoolean.

Delegates to the embedded table.

DoInserts(hSql, bClearFlags, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Delegates to the embedded table.

DoUpdates(hSql, bClearFlags)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean

Returns: SalBoolean.

Delegates to the embedded table.

DoUpdates(hSql, bClearFlags, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
bClearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Delegates to the embedded table.

EndUpdate()

Delegates to the embedded table.

FetchRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalNumber.

Delegates to the embedded table.

FindNextRow(nRow, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nRow	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

FindPrevRow(nRow, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nRow	SalNumber
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

GetColumnText(nColumnID, sText)

Parameter	Type	Description
nColumnID	SalNumber
sText	SalString

Returns: SalBoolean.

Delegates to the embedded table.

GetColumnText(nColumnID)

Parameter	Type	Description
nColumnID	SalNumber

Returns: SalString.

Delegates to the embedded table.

GetColumnWindow(nCol, nFlags)

Parameter	Type	Description
nCol	SalNumber
nFlags	SalNumber

Returns: SalWindowHandle.

Delegates to the embedded table.

GetContextRow()

Returns: SalNumber.

Delegates to the embedded table.

GetLinesPerRow(nLines)

Parameter	Type	Description
nLines	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

GetLinesPerRow()

Returns: SalNumber.

Delegates to the embedded table.

GetLockedColumns()

Returns: SalNumber.

Delegates to the embedded table.

GetRowFlags(nRow, nFlags)

Parameter	Type	Description
nRow	SalNumber
nFlags	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

GetTableFlags(nFlags)

Parameter	Type	Description
nFlags	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

InsertRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalNumber.

Delegates to the embedded table.

KillCellEdit()

Returns: SalBoolean.

Delegates to the embedded table.

KillFocusRow()

Returns: SalBoolean.

Delegates to the embedded table.

OnControlAdded(e)

Registers an added SAL column with the embedded table.

Parameter	Type	Description
e	ControlEventArgs	The event data identifying the added control.

OnControlRemoved(e)

Removes a detached SAL column from the embedded table.

Parameter	Type	Description
e	ControlEventArgs	The event data identifying the removed control.

OnLoad(e)

Brings the fill-docked embedded table forward so docked accessories remain correctly arranged.

Parameter	Type	Description
e	EventArgs	The form-load event data.

PasteRows()

Returns: SalBoolean.

Delegates to the embedded table.

Populate(hSql, sSelect, nMethod)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString
nMethod	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

Populate(hSql, sSelect, nMethod, errorHandler)

Parameter	Type	Description
hSql	SalSqlHandle
sSelect	SalString
nMethod	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Delegates to the embedded table.

Populate(hSql, sSelect)

Executes a query and fills the embedded table using TBL_FillAll.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL handle used to prepare, execute, and fetch the query.
sSelect	SalString	The SQL statement, or empty text to execute the previously prepared statement.

Returns: SalBoolean. True when population completes; false if preparation or execution fails.

Populate(hSql, sSelect, errorHandler)

Executes a query and fills the embedded table using TBL_FillAll.

Parameter	Type	Description
hSql	SalSqlHandle	The SQL handle used to prepare, execute, and fetch the query.
sSelect	SalString	The SQL statement, or empty text to execute the previously prepared statement.
errorHandler	WhenSqlErrorHandler	The SQL error handler installed for this call.

Returns: SalBoolean. True when population completes; false if preparation or execution fails.

QueryFocusCell(nRow, hWndCol)

Parameter	Type	Description
nRow	SalNumber
hWndCol	SalWindowHandle

Returns: SalBoolean.

Delegates to the embedded table.

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

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

Returns: SalBoolean.

Delegates to the embedded table.

QueryScroll(nPosition, nMinRange, nMaxRange)

Parameter	Type	Description
nPosition	SalNumber
nMinRange	SalNumber
nMaxRange	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

QuerySplitWindow(nRowsLowerHalf, bDragAdjust)

Parameter	Type	Description
nRowsLowerHalf	SalNumber
bDragAdjust	SalBoolean

Returns: SalBoolean.

Delegates to the embedded table.

QueryVisibleRange(nMinRange, nMaxRange)

Parameter	Type	Description
nMinRange	SalNumber
nMaxRange	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

ResetTable()

Returns: SalBoolean.

Delegates to the embedded table.

ScrollRow(nRow, column, nFlags)

Parameter	Type	Description
nRow	SalNumber
column	Control
nFlags	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

ScrollRow(nRow, column)

Parameter	Type	Description
nRow	SalNumber
column	Control

Returns: SalBoolean.

Delegates to the embedded table.

SetColumnText(nColumnID, sText)

Parameter	Type	Description
nColumnID	SalNumber
sText	SalString

Returns: SalBoolean.

Delegates to the embedded table.

SetContextRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

SetFlagsAnyRows(nFlags, bSet, nFlagsOn, nFlagsOff)

Parameter	Type	Description
nFlags	SalNumber
bSet	SalBoolean
nFlagsOn	SalNumber
nFlagsOff	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

SetFocusCell(nRow, column)

Parameter	Type	Description
nRow	SalNumber
column	Control

Returns: SalBoolean.

Delegates to the embedded table.

SetFocusRow(nRow)

Parameter	Type	Description
nRow	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

SetLinesPerRow(nLines)

Parameter	Type	Description
nLines	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

SetLockedColumns(nLockedColumns)

Parameter	Type	Description
nLockedColumns	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

SetRange(nMin, nMax)

Parameter	Type	Description
nMin	SalNumber
nMax	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

SetRow(nRowPos)

Parameter	Type	Description
nRowPos	SalNumber

Returns: SalNumber.

Delegates to the embedded table.

SetRowFlags(nRow, nFlags, bSet)

Parameter	Type	Description
nRow	SalNumber
nFlags	SalNumber
bSet	SalBoolean

Returns: SalBoolean.

Delegates to the embedded table.

SetTableFlags(nFlags, bSet)

Parameter	Type	Description
nFlags	SalNumber
bSet	SalBoolean

Returns: SalBoolean.

Delegates to the embedded table.

SortRows(nColumnID, nOrder)

Parameter	Type	Description
nColumnID	SalNumber
nOrder	SalNumber

Returns: SalBoolean.

Delegates to the embedded table.

Implements

Name	Description
ISalWindow	Provides SAL window actions, named properties, and access to a window's runtime implementation.