SalFormTableWindow

PPJ.Runtime.Windows.SalFormTableWindow

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

Top level table window implementation.

C#

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

VB.NET

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

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)

AllowFiltering

Boolean: Enables/Disables the excel-style filtering feature. (Default: False)

Set the property UseNativeTypes to true to be able to use the type-specific filters, otherwise the filters operate on the displayed value. When using native types in conjunction with a non-standard format or an edit mask that cannot be parsed to a native value, it is possible to lose the edited value when it cannot be parsed.

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.

ExtendLastColumn

Boolean: Enables/Disables the extension of the last column to fill the grid. (Default: False)

FocusRowStyle

FocusRowStyle: Enables/Disables the focus frame around the current row. (Default: Thick)

Icon

Icon: Overrides the default Image property.

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)

ShowCellLabels

Boolean: Gets or sets whether the grid should display labels over cells whose contents are partially hidden. (Default: False)

ShowCursor

Boolean: Enables/Disables the arrow icon on the current row. (Default: False)

ShowFocusRow

Boolean: Enables/Disables the focus frame around the current row. (Default: True)

TableWindow

SalTableWindow: Returns the internal table window control.

Trimming

StringTrimming: Defines how to trim the content that doesn't fit the width of the cell. (Default: None)

UseNativeTypes

Boolean: Returns or sets whether the grid tries to parse the edited value into the native type of the column. (Default: False)

When using native types in conjunction with a non-standard format or an edit mask that cannot be parsed to a native value, it is possible to lose the edited value when it cannot be parsed.

UseVisualStyles

Boolean: Enables/Disabled drawing of columns and rows headers using the current visual style theme renderer. (Default: False)

VirtualMode

Boolean: Enables or disables virtual mode. When virtual mode is on, the rows are fetched from the data source as they are scrolled into view. (Default: False)

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.

ClearSelection()

Deselects all rows of a table window.

Returns: SalBoolean.

ColumnAverage(columnID, flagsOn, flagsOff)

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

Parameter	Type	Description
columnID	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalNumber.

ColumnSum(columnID, flagsOn, flagsOff)

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

Parameter	Type	Description
columnID	SalNumber
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalNumber.

CopyRows(flagsOn, flagsOff)

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

Parameter	Type	Description
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

CreateColumn(columnPos, dispWidth, maxChars, title)

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

Parameter	Type	Description
columnPos	SalNumber
dispWidth	SalNumber
maxChars	SalNumber
title	SalString

Returns: SalNumber.

CreateColumnEx(columnPos, dispWidth, title, maxChars, datatype)

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
columnPos	SalNumber
dispWidth	SalNumber
title	SalString
maxChars	SalNumber
datatype	SalNumber

Returns: SalNumber.

DefineRowHeader(title, width, flags, column)

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

Parameter	Type	Description
title	SalString
width	SalNumber
flags	SalNumber
column	Control

Returns: SalBoolean.

DefineSplitWindow(rowsLowerHalf, dragAdjust)

Splits a table window horizontally.

Parameter	Type	Description
rowsLowerHalf	SalNumber
dragAdjust	SalBoolean

Returns: SalBoolean.

DeleteRow(row, flag)

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

Parameter	Type	Description
row	SalNumber
flag	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, flagsOn)

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

Parameter	Type	Description
hSql	SalSqlHandle
flagsOn	SalNumber

Returns: SalBoolean.

DoDeletes(hSql, flagsOn, errorHandler)

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

Parameter	Type	Description
hSql	SalSqlHandle
flagsOn	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

DoInserts(hSql, clearFlags)

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

Parameter	Type	Description
hSql	SalSqlHandle
clearFlags	SalBoolean

Returns: SalBoolean.

DoInserts(hSql, clearFlags, 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
clearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

DoUpdates(hSql, clearFlags)

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

Parameter	Type	Description
hSql	SalSqlHandle
clearFlags	SalBoolean

Returns: SalBoolean.

DoUpdates(hSql, clearFlags, errorHandler)

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

Parameter	Type	Description
hSql	SalSqlHandle
clearFlags	SalBoolean
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

FetchRow(row)

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

Returns: SalNumber.

FindNextRow(row, flagsOn, flagsOff)

Parameter	Type	Description
row	SalNumber&
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

FindPrevRow(row, flagsOn, flagsOff)

Parameter	Type	Description
row	SalNumber&
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

GetColumnText(columnID, text)

Parameter	Type	Description
columnID	SalNumber
text	SalString&

Returns: SalBoolean.

GetColumnText(columnID)

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

Parameter	Type	Description
columnID	SalNumber

Returns: SalString.

GetColumnWindow(col, flags)

Gets the handle of a table window column.

Parameter	Type	Description
col	SalNumber
flags	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(lines)

Parameter	Type	Description
lines	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.

GetMergedRange(row, col, clip)

Overrides GetMergedRange to allow the SalTableWindow class to override the method.

Parameter	Type	Description
row	Int32
col	Int32
clip	Boolean

Returns: CellRange.

GetRowFlags(row, flags)

Queries a row's flags.

Parameter	Type	Description
row	SalNumber
flags	SalNumber

Returns: SalBoolean.

GetTableFlags(flags)

Tests the state of a table window's flags.

Parameter	Type	Description
flags	SalNumber

Returns: SalBoolean.

HitTest(x, y, row, col, flags)

Parameter	Type	Description
x	SalNumber
y	SalNumber
row	SalNumber&
col	SalWindowHandle&
flags	SalNumber&

Returns: SalBoolean.

InsertRow(row)

Inserts a new blank row into a table window.

Parameter	Type	Description
row	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, select, method)

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
select	SalString
method	SalNumber

Returns: SalBoolean.

Populate(hSql, select, method, 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
select	SalString
method	SalNumber
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

Populate(hSql, select)

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
select	SalString

Returns: SalBoolean.

Populate(hSql, select, 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
select	SalString
errorHandler	WhenSqlErrorHandler

Returns: SalBoolean.

QueryFocusCell(row, col)

Parameter	Type	Description
row	SalNumber&
col	SalWindowHandle&

Returns: SalBoolean.

QueryRowHeader(title, maxTitle, width, flags, col)

Parameter	Type	Description
title	SalString&
maxTitle	SalNumber
width	SalNumber&
flags	SalNumber&
col	SalWindowHandle&

Returns: SalBoolean.

QueryScroll(position, minRange, maxRange)

Parameter	Type	Description
position	SalNumber&
minRange	SalNumber&
maxRange	SalNumber&

Returns: SalBoolean.

QuerySplitWindow(rowsLowerHalf, dragAdjust)

Parameter	Type	Description
rowsLowerHalf	SalNumber&
dragAdjust	SalBoolean&

Returns: SalBoolean.

QueryVisibleRange(minRange, maxRange)

Parameter	Type	Description
minRange	SalNumber&
maxRange	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(row, column, flags)

Scrolls a table window to the specified row and column.

Parameter	Type	Description
row	SalNumber
column	Control
flags	SalNumber

Returns: SalBoolean.

ScrollRow(row, column)

Scrolls a table window to the specified row and column.

Parameter	Type	Description
row	SalNumber
column	Control

Returns: SalBoolean.

SetColumnText(columnID, text)

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

Parameter	Type	Description
columnID	SalNumber
text	SalString

Returns: SalBoolean.

SetContextRow(row)

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

Returns: SalBoolean.

SetFlagsAnyRows(flags, set, flagsOn, flagsOff)

Sets or clears row flags.

Parameter	Type	Description
flags	SalNumber
set	SalBoolean
flagsOn	SalNumber
flagsOff	SalNumber

Returns: SalBoolean.

SetFocusCell(row, column, editMin, editMax)

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
row	SalNumber
column	Control
editMin	SalNumber
editMax	SalNumber

Returns: SalBoolean.

SetFocusRow(row)

Sets a table window's focus frame row.

Parameter	Type	Description
row	SalNumber

Returns: SalBoolean.

SetLinesPerRow(lines)

Sets the height of a row in lines.

Parameter	Type	Description
lines	SalNumber

Returns: SalBoolean.

SetLockedColumns(lockedColumns)

Sets the number of locked table window columns.

Parameter	Type	Description
lockedColumns	SalNumber

Returns: SalBoolean.

SetRange(min, max)

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

Parameter	Type	Description
min	SalNumber
max	SalNumber

Returns: SalBoolean.

SetRow(rowPos)

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

Parameter	Type	Description
rowPos	SalNumber

Returns: SalNumber.

SetRowFlags(row, flags, set)

Sets or clears a table window row's flags.

Parameter	Type	Description
row	SalNumber
flags	SalNumber
set	SalBoolean

Returns: SalBoolean.

SetTableFlags(flags, set)

Sets or clears a table window's flags.

Parameter	Type	Description
flags	SalNumber
set	SalBoolean

Returns: SalBoolean.

SortRows(columnID, order)

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

Parameter	Type	Description
columnID	SalNumber
order	SalNumber

Returns: SalBoolean.

Inherited By

Name	Description
SalQuickToolTipTableWindow	Pushbutton with tool tip support

Implements

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