SalTableColumn

PPJ.Runtime.Windows.SalTableColumn

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

Summary description for SalTableColumn.

public class SalTableColumn : Control, ISalWindow, ISalEditControl, ISalControl, ISalListControl, IConvertible, IComparer

Constructors

SalTableColumn()

Constructs a new SalTableColumn. The SalTableColumn control is made invisible by moving it outside of the bounds of the parent SalTableWindow control.

Properties

AllowDrop

Boolean: Allow Drop (Default: False)

AllowFiltering

Boolean: Enables/Disables filtering on this column. (Default: False)

Anchor

AnchorStyles: Anchor (Default: Top, Left)

BackColor

Color: Returns/Sets the column's background color.

BackgroundImage

Image: Background Image (Default: null)

BackgroundImageLayout

ImageLayout: Background Image Layout (Default: Tile)

CausesValidation

Boolean: Causes Validation

CellTextColor

Color: Returns/Sets th current cell text color

CellType

CellType: Indicates the type of control used to edit the cell. (Default: Standard)

CharacterCasing

CharacterCasing: Indicates if all characters should be left alone or converted to uppercase or lowercase. (Default: Normal)

CheckBox

CellCheckBox: Defines the behavior of the check box column.

ComboBox

CellComboBox: Defines the behavior of the combo box column.

CultureInfo

CultureInfo: Returns/Sets the culture to use for this control. (Default: null)

Cursor

Cursor: Cursor

CustomEditor

Control: Returns/Sets the custom editor control used to edit cells. (Default: null)

DataType

DataType: Value type of the text box control. (Default: String)

DateTime

SalDateTime: DateTime value property.

Dock

DockStyle: Dock (Default: None)

EditMask

String: Indicates the edit mask to apply to the text. (Default: "")

EnableSpellChecker

Boolean: Enables/Disables the built-in spell checker. (Default: False)

Flags

Int32: Returns/Sets the column flags on this column.

Format

String: Format string. (Default: "")

GridCol

Column: Returns/Sets the underlying flexgrid column.

Id

Int32: Unique column id.

ImeMode

ImeMode: ImeMode

IsAutomatic

Boolean: Returns true if the column has been automatically created.

IsDynamic

Boolean: Returns true if the column has been dynamically created.

Label

Control: Returns/Sets the label associated with this control.

Location

Point: Location

MaxLength

Int32: Maximum number of characters. (Default: 100)

Modified

Boolean: Returns/Sets the modified flag on the current cell.

NamedProperties

SalNamedProperties: Returns the collection of named properties.

Number

SalNumber: Number value property.

ParentTable

SalTableWindow: Returns the parent SalTableWindow control.

PasswordChar

Char: Indicates the character to display for password input. (Default: "\0")

PasswordText

String: Returns the text to use when displaying password-protected columns.

CellPopupBox: Defines the behavior of the popup edit column.

Position

Int32: Column position.

ReadOnly

Boolean: Controls whether the text in the cell can be changed. (Default: False)

RightToLeft

Boolean: RightToLeft

Selected

Boolean: Selects/Deselcts the column.

Size

Size: Size

SplitGridCol

Column: Returns/Sets the underlying flexgrid column for the split grid.

TabIndex

Int32: TabIndex

TabStop

Boolean: TabStop

Text

String: Overrides the default text property to keep it in sync with the grid cell and to convert boolean values.

TextAlign

HorizontalAlignment: Indicates how the text should be aligned. (Default: Left)

Title

String: Column's title. (Default: "")

TitleAlign

HorizontalAlignment: Indicates how the column header should be aligned. (Default: Center)

Width

Int32: Column Width. (Default: 80)

WordWrap

Boolean: Indicates if lines are automatically word-wrapped for multi line cells. (Default: False)

Methods

AddListItem(sName)

Adds a string to a list box or combo box.

Parameter
Type
Description

Returns: SalNumber.

Average(flagsOn, flagsOff)

Computes the average of all column values or only specified column values in a table window. Use row flags constants to specify the rows to use in the computation. For example, you can choose to average only the values of modified rows.

Parameter
Type
Description

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: Decimal. Average

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

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.

Returns: SalBoolean.

Clear()

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

Returns: SalBoolean.

ClearCursor(type)

Clears a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

ClearList()

Deletes all entries from a list box or combo box.

Returns: SalBoolean.

DefineCheckBoxColumn(flags, checkedValue, uncheckedValue)

Define a column as a check box.

Parameter
Type
Description

checkedValue

uncheckedValue

Returns: SalBoolean.

DefineDropDownListColumn(flags, lines)

Define a column as a drop down list.

Parameter
Type
Description

Returns: SalBoolean.

DefinePopupEditColumn(flags, lines)

Define a column as a popup edit window.

Parameter
Type
Description

Returns: SalBoolean.

DeleteListItem(nIndex)

Deletes a list box or combo box entry.

Parameter
Type
Description

nIndex

Returns: SalNumber.

DestroyWindow()

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

Returns: SalBoolean.

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.

Returns: SalBoolean.

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.

Returns: SalBoolean.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

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.

Returns: SalBoolean.

FindChild(windowName)

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

Parameter
Type
Description

windowName

Returns: SalWindowHandle.

FireWindowActions(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalNumber.

FormUnitsToPixels(formUnits, vertical)

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.

Parameter
Type
Description

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.

FromControl(ctrl)

Returns the SalTableColumn instance from the specified control.

Parameter
Type
Description

ctrl

Target control on which to execute the call.

Returns: SalTableColumn.

GetCellType(type)

Parameter
Type
Description

Returns: SalBoolean.

GetCellType()

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

Returns: SalNumber.

GetClassName()

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

Returns: SalString.

GetColumnFlags(flags)

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

Parameter
Type
Description

Returns: SalBoolean.

GetColumnID()

Gets a table window column's identifier.

Returns: SalNumber.

GetColumnPosition()

Gets a table window column's relative position.

Returns: SalNumber.

GetColumnTitle(text, maxLen)

Parameter
Type
Description

Returns: SalNumber.

GetColumnTitle(maxLen)

Gets the title of a table window column.

Parameter
Type
Description

maxLen

Returns: SalString.

GetColumnWidth(width)

Parameter
Type
Description

Returns: SalBoolean.

GetColumnWidth()

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

Returns: SalNumber.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetDataLength()

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

Returns: SalNumber.

GetDataType()

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

Returns: SalNumber.

GetFirstChild(typeMask)

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.

Parameter
Type
Description

typeMask

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

Returns: SalWindowHandle.

GetFont(name, size, enhancement)

Parameter
Type
Description

Returns: SalBoolean.

GetFormat(sPicture)

Parameter
Type
Description

sPicture

Returns: SalBoolean.

GetFormat()

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

Returns: SalString.

GetFormatCode()

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

Returns: SalNumber.

GetFormattedText(sText, bFormat)

Parameter
Type
Description

Returns: SalBoolean.

GetFormattedText(bFormat)

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.

Parameter
Type
Description

bFormat

Returns: SalString.

GetInputMask(sMask)

Parameter
Type
Description

Returns: SalBoolean.

GetInputMask()

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

Returns: SalString.

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.

Returns: SalWindowHandle.

GetLabelText(sText, nMaxLength)

Parameter
Type
Description

nMaxLength

Returns: SalNumber.

GetLabelText(nMaxLength)

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.

Parameter
Type
Description

nMaxLength

Returns: SalString.

GetListItemsCount()

Returns the number of list box or combo box entries.

Returns: SalNumber.

GetListItemState(index)

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

Parameter
Type
Description

Returns: SalBoolean.

GetListItemText(index, text)

Parameter
Type
Description

Returns: SalNumber.

GetListItemText(index)

Returns the text of the specified item.

Parameter
Type
Description

Returns: SalString.

GetListItemTextLength(index)

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

Parameter
Type
Description

Returns: SalNumber.

GetListSelectedFile(fileName)

Parameter
Type
Description

fileName

Returns: SalBoolean.

GetListSelectedFile()

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.

GetListSelectedIndex()

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

Returns: SalNumber.

GetListSelectedItems(nSelectedArray)

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

Parameter
Type
Description

nSelectedArray

Returns: SalBoolean.

GetListSelectedItemsCount()

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.

GetLocation(x, y)

Parameter
Type
Description

Returns: SalBoolean.

GetName(text)

Parameter
Type
Description

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(typeMask)

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

Parameter
Type
Description

typeMask

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

Returns: SalWindowHandle.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(name, value)

Parameter
Type
Description

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter
Type
Description

Returns: SalString.

GetSize(width, height)

Parameter
Type
Description

Returns: SalBoolean.

GetText(text, maxLen)

Parameter
Type
Description

Returns: SalNumber.

GetText(maxLen)

Retrieves the text of a window.

Parameter
Type
Description

maxLen

Returns: SalString.

GetTextUnmasked(sText)

Parameter
Type
Description

Returns: SalBoolean.

GetTextUnmasked()

Unmasks the text from a masked edit control.

Returns: SalString.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter
Type
Description

colorIndex

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

HideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBoolean.

InsertListItem(nIndex, sAdd)

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

Parameter
Type
Description

Returns: SalNumber.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

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

Parameter
Type
Description

typeClass

Returns: SalBoolean.

IsEmpty()

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

Returns: SalBoolean.

IsEnabled()

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

Returns: SalBoolean.

IsModified()

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.

IsValid()

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

Returns: SalBoolean.

IsValidDateTime()

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.

IsValidDecimal(nPrecision, nScale)

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.

Parameter
Type
Description

nPrecision

nScale

Returns: SalBoolean.

IsValidInteger()

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.

IsValidNumber()

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.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter
Type
Description

idEvent

Returns: SalBoolean.

MoveWindow(xOffset, yOffset)

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

Parameter
Type
Description

xOffset

yOffset

Returns: SalBoolean.

PixelsToFormUnits(numPixels, vertical)

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.

Parameter
Type
Description

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.

PopulateList(hSql, sSelect)

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.

Parameter
Type
Description

Returns: SalBoolean.

PopulateList(hSql, sSelect, errorHandler)

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.

Parameter
Type
Description

Returns: SalBoolean.

PopulateListFiles(ctrlPath, pathName, attributes)

Parameter
Type
Description

ctrlPath

pathName

attributes

Returns: SalBoolean.

PostMessage(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalBoolean.

QueryCheckBoxColumn(flags, checkedValue, uncheckedValue)

Parameter
Type
Description

checkedValue

uncheckedValue

Returns: SalBoolean.

QueryDropDownListColumn(flags, lines)

Parameter
Type
Description

Returns: SalBoolean.

QueryPopupEditColumn(flags, lines)

Parameter
Type
Description

Returns: SalBoolean.

SendMessage(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

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

Parameter
Type
Description

nMywParam

nMylParam

Returns: SalBoolean.

SetCellTextColor(color, discardable)

Changes a table window cell's text color.

Parameter
Type
Description

discardable

Returns: SalBoolean.

SetCellTextColor(color)

Changes a table window cell's text color.

Parameter
Type
Description

Returns: SalBoolean.

SetColumnFlags(flags, set)

Sets or clears a table window column's flags.

Parameter
Type
Description

Returns: SalBoolean.

SetColumnPosition(position)

Moves a table window column to a new position.

Parameter
Type
Description

position

Returns: SalBoolean.

SetColumnTitle(title)

Sets the title of a table window column.

Parameter
Type
Description

Returns: SalBoolean.

SetColumnWidth(width)

Sets a table window column's display width.

Parameter
Type
Description

Returns: SalBoolean.

SetContextMenu(sMenuName, nFlags)

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

Parameter
Type
Description

sMenuName

nFlags

Returns: SalBoolean.

SetContextMenu(menuType, flags)

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

Parameter
Type
Description

menuType

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter
Type
Description

resourceId

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter
Type
Description

Returns: SalBoolean.

SetCursorFile(file, type)

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

Parameter
Type
Description

Returns: SalBoolean.

SetDataLength(length)

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.

Parameter
Type
Description

length

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(name, size, enhancement)

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

Parameter
Type
Description

enhancement

Returns: SalBoolean.

SetFormat(sPicture)

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

Parameter
Type
Description

sPicture

Returns: SalBoolean.

SetFormatCode(nFormat)

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

Parameter
Type
Description

nFormat

Returns: SalBoolean.

SetInputMask(sMask)

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

Parameter
Type
Description

Returns: SalBoolean.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter
Type
Description

Returns: SalBoolean.

SetListRedraw(redraw)

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

Parameter
Type
Description

redraw

Returns: SalBoolean.

SetListSelectedIndex(index)

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

Parameter
Type
Description

Returns: SalBoolean.

SetListSelectedItems(index, select)

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

Parameter
Type
Description

Returns: SalBoolean.

SetListSelectedText(indexStart, text)

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

Parameter
Type
Description

indexStart

Returns: SalNumber.

SetListTabStops(tabStops)

Sets tabs in a list box.

Parameter
Type
Description

Returns: SalBoolean.

SetLocation(x, y)

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

Parameter
Type
Description

Returns: SalBoolean.

SetModified(bSet)

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

Parameter
Type
Description

Returns: SalBoolean.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter
Type
Description

Returns: SalBoolean.

SetSize(width, height)

Resizes a window.

Parameter
Type
Description

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter
Type
Description

Returns: SalBoolean.

SetText(sValue, bFormat)

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

Parameter
Type
Description

sValue

bFormat

Returns: SalBoolean.

SetTimer(idEvent, elapseMilliSec)

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.

Parameter
Type
Description

idEvent

elapseMilliSec

Returns: SalBoolean.

SetWindowColor(colorIndex, color)

Sets a window's color.

Parameter
Type
Description

colorIndex

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

ShowWindowAndLabel()

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

Returns: SalBoolean.

Sort(flags)

Sorts the column and shows the sort glyph.

Parameter
Type
Description

Sum(flagsOn, flagsOff)

Adds the values of the cells in the rows that match the specified flags.

Parameter
Type
Description

flagsOn

flagsOff

Returns: Decimal. Sum

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

TrackPopupMenu(menuType, flags, x, y)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Validate()

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

Returns: SalBoolean.

Validate(validate)

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

Parameter
Type
Description

validate

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter
Type
Description

command

numData

strData

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

WindowActions

WindowActionsEventHandler Window Actions

Implements

Name
Description

All SAL controls implement this interface.

SAL Editable controls implement this interface

SAL List controls implement this interface.

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

Last updated