XSal

Namespace: PPJ.Runtime.XSal

Assembly: PPJ.Runtime.XSal.50 (5.0.0.0)

Provides XSal compatibility operations for tables, splitters, toolboxes, strings, scripts, and archive data.

C#

public class XSal

VB.NET

Public Class XSal

Example:

SalString token = XSal.StrGetFirstToken("red,green,blue", ",");
            while (!token.IsNull)
            {
                System.Console.WriteLine(token);
                token = XSal.StrGetNextToken();
            }

Fields

Name	Type	Description	Value
SAM_DrawCell	Int32	Identifies the custom-cell drawing message; wParam indicates selection and lParam carries drawing information for TblGetCustomInfo.
SAM_HotSpotClick	Int32	Identifies a hot-spot click; wParam contains the hot-spot identifier and lParam the packed mouse position.
SAM_HotSpotMouseMove	Int32	Identifies a hot-spot pointer transition; wParam carries the entering identifier or zero on leaving, and lParam the packed mouse position.
SAM_SwapRows	Int32	Identifies a row swap during XSal sorting; wParam and lParam identify the swapped rows.
SAM_ToolboxSetPosition	Int32	Requests toolbox and child layout for the orientation in wParam: horizontal, vertical, or floating.
SAM_ToolboxUpdateMenu	Int32	Compatibility message identifier for updating a toolbox menu.
SAM_TooltipClose	Int32	Identifies the XSal tooltip-close notification.
SAM_TooltipSetText	Int32	Requests tooltip text from the control currently under the pointer.

Properties

ToolTip

ToolTip: Gets the shared native tooltip component used by XSal.

Methods

BitmapClose(hBitmap)

Deletes a native bitmap or other GDI object handle.

Parameter	Type	Description
hBitmap	SalNumber	The native GDI handle to release.

Returns: SalBoolean. False for a zero handle; otherwise the DeleteObject result.

BitmapCreateDisabled(Param1, Param2)

Provides an unsupported compatibility entry point for creating a disabled bitmap.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is not implemented.

BitmapDraw(ctrl, hImage, x, y, width, height)

Draws a bitmap directly onto a control without color-key transparency.

Parameter	Type	Description
ctrl	Control	The target control.
hImage	SalNumber	The native bitmap handle.
x	SalNumber	The left drawing coordinate in pixels.
y	SalNumber	The top drawing coordinate in pixels.
width	SalNumber	The target width in pixels.
height	SalNumber	The target height in pixels.

Returns: SalBoolean. False for a zero bitmap handle or a disposing/disposed control; otherwise true after drawing.

When both dimensions are zero, the bitmap's natural size is used.

BitmapDraw(ctrl, hImage, x, y, width, height, transparent)

Draws a bitmap directly onto a control with optional color-key transparency.

Parameter	Type	Description
ctrl	Control	The target control.
hImage	SalNumber	The native bitmap handle.
x	SalNumber	The left drawing coordinate in pixels.
y	SalNumber	The top drawing coordinate in pixels.
width	SalNumber	The target width in pixels.
height	SalNumber	The target height in pixels.
transparent	SalBoolean	True to use the top-left pixel color as transparent.

Returns: SalBoolean. False for a zero bitmap handle or a disposing/disposed control; otherwise true after drawing.

When both dimensions are zero, the bitmap's natural size is used. The drawing is immediate rather than retained for future repaints.

BitmapDrawDC(Param1, Param2, Param3, Param4, Param5, Param6)

Provides an unsupported compatibility entry point for drawing a bitmap into a device context.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalNumber	Reserved for compatibility; ignored.
Param3	SalNumber	Reserved for compatibility; ignored.
Param4	SalNumber	Reserved for compatibility; ignored.
Param5	SalNumber	Reserved for compatibility; ignored.
Param6	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

BitmapFromFile(fileName)

Creates a native bitmap handle from an image file.

Parameter	Type	Description
fileName	SalString	The image-file path.

Returns: SalNumber. The native bitmap handle, or zero when loading fails.

Release a successful handle with BitmapClose.

BitmapFromIcon(Param1, Param2)

Provides an unsupported compatibility entry point for creating a bitmap from an icon.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is not implemented.

BitmapFromResource(resName)

Creates a native bitmap handle from an embedded bitmap resource.

Parameter	Type	Description
resName	SalString	The embedded resource name.

Returns: SalNumber. The native bitmap handle, or zero when loading fails.

Release a successful handle with BitmapClose.

BitmapFromString(bitmapBytes)

Creates a native bitmap handle from bitmap bytes in a SAL binary string.

Parameter	Type	Description
bitmapBytes	SalString	The binary bitmap data.

Returns: SalNumber. The native bitmap handle, or zero when loading fails.

Release a successful handle with BitmapClose.

BitmapFromWindow(Param1, Param2)

Provides an unsupported compatibility entry point for capturing a window bitmap.

Parameter	Type	Description
Param1	SalWindowHandle	Reserved for compatibility; ignored.
Param2	SalBoolean	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is not implemented.

BitmapToString(Param1, Param2)

Provides an unsupported compatibility entry point for serializing a bitmap.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalString	Reserved for compatibility; left unchanged.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

GetClientWindow(form)

Gets the SAL client-area control associated with a form.

Parameter	Type	Description
form	Control	The form or control to inspect.

Returns: SalWindowHandle. The client-area handle returned by SalWindow.GetClientArea.

GetWindowHotSpot(ctrl, id, x, y, width, height)

Provides an unsupported compatibility entry point for querying a window hot spot.

Parameter	Type	Description
ctrl	Control	Reserved for compatibility; ignored.
id	SalNumber	Reserved for compatibility; ignored.
x	SalNumber	Reserved for compatibility; left unchanged.
y	SalNumber	Reserved for compatibility; left unchanged.
width	SalNumber	Reserved for compatibility; left unchanged.
height	SalNumber	Reserved for compatibility; left unchanged.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

GetWindowImage(ctrl, hImage)

Provides an unsupported compatibility entry point for retrieving a window-image handle.

Parameter	Type	Description
ctrl	Control	Reserved for compatibility; ignored.
hImage	SalNumber	Reserved for compatibility; left unchanged.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

GZipClose(Param1)

Provides an unsupported compatibility entry point for closing a gzip stream.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; not modified.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

GZipEof(Param1)

Provides an unsupported compatibility entry point for testing gzip end-of-file.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

GZipFlush(Param1)

Provides an unsupported compatibility entry point for flushing a gzip stream.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

GZipGetChar(Param1)

Provides an unsupported compatibility entry point for reading a gzip character.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is unavailable and performs no operation.

GZipGetError(Param1, Param2)

Provides an unsupported compatibility entry point for querying a gzip error.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalNumber	Reserved for compatibility; not modified.

Returns: SalString. Always SalString.Null.

Logs that the operation is unavailable and performs no operation.

GZipGetStr(Param1, Param2, Param3)

Provides an unsupported compatibility entry point for reading a gzip string.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalString	Reserved for compatibility; not modified.
Param3	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is unavailable and performs no operation.

GZipOpen(Param1, Param2, Param3)

Provides an unsupported compatibility entry point for opening a gzip stream.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; not modified.
Param2	SalString	Reserved for compatibility; ignored.
Param3	SalString	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

GZipPutChar(Param1, Param2)

Provides an unsupported compatibility entry point for writing a gzip character.

Parameter	Type	Description
Param1	SalFileHandle	Reserved for compatibility; ignored.
Param2	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

GZipPutStr(Param1, Param2)

Provides an unsupported compatibility entry point for writing a gzip string.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalString	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is unavailable and performs no operation.

GZipRead(Param1, Param2, Param3)

Provides an unsupported compatibility entry point for reading gzip data.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalString	Reserved for compatibility; not modified.
Param3	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is unavailable and performs no operation.

GZipRewind(Param1)

Provides an unsupported compatibility entry point for rewinding a gzip stream.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

GZipSeek(Param1, Param2, Param3)

Provides an unsupported compatibility entry point for seeking within a gzip stream.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalNumber	Reserved for compatibility; ignored.
Param3	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is unavailable and performs no operation.

GZipTell(Param1)

Provides an unsupported compatibility entry point for querying a gzip position.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is unavailable and performs no operation.

GZipWrite(Param1, Param2, Param3)

Provides an unsupported compatibility entry point for writing gzip data.

Parameter	Type	Description
Param1	SalNumber	Reserved for compatibility; ignored.
Param2	SalString	Reserved for compatibility; ignored.
Param3	SalNumber	Reserved for compatibility; ignored.

Returns: SalNumber. Always zero.

Logs that the operation is unavailable and performs no operation.

ScriptAddLine(handle, line)

Appends a script line and recompiles the program.

Parameter	Type	Description
handle	SalNumber	A live script handle, or zero.
line	SalString	The line to append.

Returns: SalBoolean. The compilation result, or false for a null handle.

ScriptCreate(source)

Creates and compiles a script and allocates its handle.

Parameter	Type	Description
source	SalString	The script source; a complete brace-delimited block enables C# syntax.

Returns: SalNumber. The allocated script handle. Compilation errors are recorded and can be queried separately.

ScriptFree(handle)

Releases the script’s context and allocated handle.

Parameter	Type	Description
handle	SalNumber	A live script handle, or zero.

Returns: SalBoolean. True if a script was released; false for a null handle.

ScriptGetErrors(handle, errorsList)

Retrieves a script’s recorded error text.

Parameter	Type	Description
handle	SalNumber	A live script handle, or zero.
errorsList	SalString	Receives error text when an error exists; otherwise unchanged.

Returns: SalNumber. The error-text length, or zero when no script or error exists.

ScriptGetLocalName(handle, localName, varName)

Deprecated: Not supported. Provides an unsupported compatibility entry point for resolving a script-local variable name.

Parameter	Type	Description
handle	SalNumber	Reserved for compatibility; ignored.
localName	SalString	Reserved for compatibility; ignored.
varName	SalString	Reserved for compatibility; not modified.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

ScriptRun(handle, result)

Executes a compiled script and retrieves its textual result.

Parameter	Type	Description
handle	SalNumber	A live script handle, or zero.
result	SalString	Receives the result text when a script exists.

Returns: SalBoolean. True if the script has no recorded errors after execution; false for a null handle or recorded error.

ScriptSetContext(handle, context)

Assigns the object used for script member lookup during execution.

Parameter	Type	Description
handle	SalNumber	A live script handle, or zero.
context	Object	The execution context object.

Returns: SalBoolean. True if the context was assigned; false for a null handle.

ScriptSetDebugMode(handle, debugOn)

Controls whether parser and interpreter exceptions propagate from a script.

Parameter	Type	Description
handle	SalNumber	A live script handle, or zero.
debugOn	SalBoolean	True to rethrow errors instead of recording them.

Returns: SalBoolean. True if the setting was applied; false for a null handle.

ScriptSetTimeout(handle, timeout)

Deprecated: Not supported. Provides an unsupported compatibility entry point for setting a script execution timeout.

Parameter	Type	Description
handle	SalNumber	Reserved for compatibility; ignored.
timeout	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is unavailable and performs no operation.

SetWindowHotSpot(ctrl, id, x, y, width, height)

Registers a clickable rectangular hot spot, or removes one when either dimension is zero.

Parameter	Type	Description
ctrl	Control	The owning control.
id	SalNumber	The nonzero hot-spot identifier reported in SAL messages.
x	SalNumber	The horizontal position in pixels.
y	SalNumber	The vertical position in pixels.
width	SalNumber	The width in pixels; zero requests removal.
height	SalNumber	The height in pixels; zero requests removal.

Returns: SalBoolean. False for a null control or zero identifier; otherwise true.

Registering an existing identifier leaves its original rectangle unchanged.

SetWindowImage(ctrl, hImage, flags)

Provides an unsupported compatibility entry point for assigning a window image by native handle.

Parameter	Type	Description
ctrl	Control	Reserved for compatibility; ignored.
hImage	SalNumber	Reserved for compatibility; ignored.
flags	BackgroundImageFlags	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

SetWindowImageFile(ctrl, sFileName, flags)

Loads a file image and assigns it as the control's background.

Parameter	Type	Description
ctrl	Control	The target control; its SAL client area is used when present.
sFileName	SalString	The image-file path.
flags	BackgroundImageFlags	The background layout and optional transparency. Transparency uses the top-left pixel color.

Returns: SalBoolean. True after assignment; false when loading or applying the image throws an exception.

SplitGetBarPosition(split)

Gets an XSal splitter’s current or deferred position.

Parameter	Type	Description
split	SalWindowHandle	The splitter handle.

Returns: SalNumber. The position in pixels or thousandths according to its style, or zero for an invalid splitter.

SplitGetFrameChild(split, frame)

Gets a control hosted in an XSal splitter panel.

Parameter	Type	Description
split	SalWindowHandle	The XSal splitter handle.
frame	SalNumber	Zero for the first panel, one for the second.

Returns: SalWindowHandle. The child handle, or a null handle for an invalid splitter, frame, or empty panel.

SplitGetStyle(split)

Gets the splitter’s orientation, absolute-position, and resizing flags.

Parameter	Type	Description
split	SalWindowHandle	The splitter handle.

Returns: SplitterStyles. The supported style mask, excluding Invisible, or zero for an invalid splitter.

SplitSetBarPosition(split, pos)

Sets an XSal splitter’s position.

Parameter	Type	Description
split	SalWindowHandle	The splitter handle.
pos	SalNumber	The position in pixels for absolute mode or thousandths for proportional mode.

Returns: SalBoolean. True if assigned or deferred; false for an invalid splitter.

SplitSetBarSize(split, size)

Sets an XSal splitter bar’s width.

Parameter	Type	Description
split	SalWindowHandle	The splitter handle.
size	SalNumber	The width in pixels.

Returns: SalBoolean. True on assignment; false if the handle is not an XSal splitter.

SplitSetFrameChild(split, child, frame)

Assigns a control to one of an XSal splitter’s panels.

Parameter	Type	Description
split	SalWindowHandle	The XSal splitter handle.
child	SalWindowHandle	The child-control handle, or a null handle to clear the panel.
frame	SalNumber	Zero for the first panel, one for the second.

Returns: SalBoolean. True if assigned; false for an invalid splitter or frame number.

SplitSetMinMax(split, min, max)

Sets minimum sizes for the first and second splitter panels.

Parameter	Type	Description
split	SalWindowHandle	The splitter handle.
min	SalNumber	The first panel’s minimum size in pixels.
max	SalNumber	The second panel’s minimum size in pixels.

Returns: SalBoolean. True on assignment; false for an invalid splitter.

SplitSetStyle(split, style, on)

Applies supported XSal splitter style flags.

Parameter	Type	Description
split	SalWindowHandle	The splitter handle.
style	SplitterStyles	The flags to change.
on	SalBoolean	True to enable the selected flags; false to disable them.

Returns: SalBoolean. True on assignment; false for an invalid splitter.

StrAny(text, chars)

Finds the first character belonging to a specified character set.

Parameter	Type	Description
text	SalString	The text to scan.
chars	SalString	The characters to match.

Returns: SalNumber. The zero-based index, or -1 if no character matches.

StrCompare(source, compare, start, size, caseSensitive)

Compares a source segment with the beginning of another string using the current culture.

Parameter	Type	Description
source	SalString	The source text.
compare	SalString	The comparison text.
start	SalNumber	The starting source index.
size	SalNumber	The maximum number of characters to compare.
caseSensitive	SalBoolean	True to distinguish case; false to ignore case.

Returns: SalBoolean. True if the compared segments are equal; false on mismatch or an out-of-range argument.

StrCompress(inString, level, outString)

Compresses binary string data with an XZ prefix.

Parameter	Type	Description
inString	SalString	The input binary string.
level	SalNumber	The compression level passed unchanged to the compression implementation.
outString	SalString	Receives the prefixed compressed buffer, or SalString.Null when no bytes are returned.

Returns: SalBoolean. False for null input or a caught compression error; otherwise true.

The implementation calculates a clamped local level but passes the original argument to the compressor.

StrCount(text, search, start, length, left)

Counts nonoverlapping, case-insensitive substring matches within a selected text segment.

Parameter	Type	Description
text	SalString	The text to search.
search	SalString	The nonempty substring to count.
start	SalNumber	The segment’s starting index for a forward search or ending index for a leftward search.
length	SalNumber	The segment length.
left	SalBoolean	True to select a segment ending at start; false to select one starting there.

Returns: SalNumber. The number of matches, or zero for empty input or an unusable segment.

StrFit(ctrl, text, append)

Removes trailing characters until text and a suffix fit the control width.

Parameter	Type	Description
ctrl	Control	The control supplying width, font, and graphics context.
text	SalString	The text to shorten.
append	SalString	The suffix always appended to a measured nonempty result.

Returns: SalString. The shortened text plus suffix, or the original text for a null control or empty input.

The suffix is appended even when the original text already fits. An oversized suffix can cause shortening past the empty string and throw.

StrFormat(text, mask)

Builds text using underscore placeholders and percent remainder markers.

Parameter	Type	Description
text	SalString	The source characters.
mask	SalString	An underscore consumes one source character; percent appends all remaining source text; other characters are copied literally.

Returns: SalString. The constructed text followed by the unused mask suffix.

The percent marker itself remains in the appended mask suffix in this implementation.

StrFormatDateTime(date, format, language)

Provides an unsupported compatibility entry point for formatting a date with a language.

Parameter	Type	Description
date	SalDateTime	Reserved for compatibility; ignored.
format	SalString	Reserved for compatibility; ignored.
language	SalString	Reserved for compatibility; ignored.

Returns: SalString. Always SalString.Null.

Logs that the operation is unavailable and performs no operation.

StrFormatDateTimeX(date, format, days, shortDays, months, shortMonths)

Provides an unsupported compatibility entry point for formatting a date with custom names.

Parameter	Type	Description
date	SalDateTime	Reserved for compatibility; ignored.
format	SalString	Reserved for compatibility; ignored.
days	SalString	Reserved for compatibility; ignored.
shortDays	SalString	Reserved for compatibility; ignored.
months	SalString	Reserved for compatibility; ignored.
shortMonths	SalString	Reserved for compatibility; ignored.

Returns: SalString. Always SalString.Null.

Logs that the operation is unavailable and performs no operation.

StrFromHex(hex)

Decodes pairs of uppercase hexadecimal digits into a SAL binary string.

Parameter	Type	Description
hex	SalString	The hexadecimal text, optionally prefixed with lowercase 0x.

Returns: SalString. The decoded bytes, or SalString.Null for input shorter than two characters.

An unmatched final digit is ignored. Digits are not validated, and lowercase hexadecimal letters are not normalized.

StrGetCharAt(text, index)

Gets the numeric value of a character at a zero-based index.

Parameter	Type	Description
text	SalString	The source text.
index	SalNumber	The character index.

Returns: SalNumber. The character value, or zero for empty text or an invalid index.

StrGetFirstToken(list, separators)

Replaces the shared token sequence and returns its first nonempty token.

Parameter	Type	Description
list	SalString	The text to split.
separators	SalString	The delimiter characters.

Returns: SalString. The first token, or SalString.Null if none exists.

StrGetNextToken()

Advances the shared token sequence created by StrGetFirstToken.

Returns: SalString. The next token, or SalString.Null when no sequence or tokens remain.

StrMetaphone(text)

Provides an unsupported compatibility entry point for computing a Metaphone code.

Parameter	Type	Description
text	SalString	Reserved for compatibility; ignored.

Returns: SalString. Always SalString.Null.

Logs that the operation is unavailable and performs no operation.

StrNAny(text, chars)

Finds the first character outside a specified character set.

Parameter	Type	Description
text	SalString	The text to scan.
chars	SalString	The allowed characters.

Returns: SalNumber. The zero-based index, or -1 when every character belongs to the set.

StrScan(text, search, index)

Searches forward using ordinal case-insensitive comparison.

Parameter	Type	Description
text	SalString	The text to search.
search	SalString	The nonempty substring to find.
index	SalNumber	The starting index, clamped to the text length; negative values fail.

Returns: SalNumber. The matching zero-based index, or -1 for no match or invalid input.

StrScanR(text, search, index)

Searches backward using ordinal case-insensitive comparison.

Parameter	Type	Description
text	SalString	The text to search.
search	SalString	The nonempty substring to find.
index	SalNumber	The starting index; a negative value searches from the end, and larger values are clamped to the text length.

Returns: SalNumber. The matching zero-based index, or -1 for no match or invalid input.

StrSetCharAt(text, index, charSet)

Replaces a character at a zero-based index.

Parameter	Type	Description
text	SalString	The text to modify.
index	SalNumber	The character index.
charSet	SalNumber	The numeric character value to insert.

Returns: SalNumber. The previous character value, or zero for empty text or an invalid index.

StrToHex(str)

Encodes the string’s binary buffer as uppercase hexadecimal prefixed with 0x.

Parameter	Type	Description
str	SalString	The string whose bytes are encoded.

Returns: SalString. The hexadecimal text, or SalString.Null for empty input.

StrToNumber(text)

Parses a number after adapting the first period or comma to the current decimal separator when needed.

Parameter	Type	Description
text	SalString	The numeric text.

Returns: SalNumber. The parsed SAL number, or SalNumber.Null for empty or unparseable input.

StrUncompress(inString, outString)

Decompresses bytes after the three-byte XSal compression prefix.

Parameter	Type	Description
inString	SalString	The binary string beginning with XZ.
outString	SalString	Receives decompressed data, or SalString.Null for an empty output.

Returns: SalBoolean. False for invalid input or a caught decompression error; otherwise, true.

A trailing zero terminator from compatible CTD strings may be removed when the result is converted to ordinary text.

TblCopyRows(table, flagsOn, flagsOff, copyFlags)

Copies matching rows as delimited text to the clipboard.

Parameter	Type	Description
table	Control	The table control or table form.
flagsOn	SalNumber	Row flags for which at least one must be set, or zero to omit this test.
flagsOff	SalNumber	Row flags that must all be clear.
copyFlags	TableWindowClipboardFlags	Options to skip hidden columns or include column titles.

Returns: SalBoolean. True when nonempty text was generated and the copy call was issued; false otherwise.

The original context row is restored. Cell delimiters are not escaped.

TblCopyRowsToString(table, flagsOn, flagsOff, copyFlags, csvText)

Copies matching rows into delimited text.

Parameter	Type	Description
table	Control	The table control or table form.
flagsOn	SalNumber	Row flags for which at least one must be set, or zero to omit this test.
flagsOff	SalNumber	Row flags that must all be clear.
copyFlags	TableWindowClipboardFlags	Options to skip hidden columns or include column titles.
csvText	SalString	Receives nonempty generated text; unchanged when no text is produced.

Returns: SalBoolean. True when text was generated; otherwise false.

The original context row is restored. Values are not quoted or escaped, and rows end with the configured row delimiter.

TblGetCellBackColor(column, backColor)

Retrieves the background-color override for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
backColor	SalNumber	Receives the explicitly assigned Win32 color.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetCellCustom(column, userValue)

Retrieves the custom-drawing value for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
userValue	SalNumber	Receives the stored custom-drawing value when a compatible entry exists.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblGetCellFont(column, hFont)

Retrieves the font override for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hFont	SalNumber	Receives a newly allocated native font handle; release it with DeleteObject when finished.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetCellFont(column)

Retrieves the font override for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.

Returns: Font. The explicitly assigned font, or null when the target or override is absent.

TblGetCellImage(column, hImage, position)

Retrieves the image and alignment for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hImage	SalNumber	Receives a newly allocated bitmap handle when the stored image is a bitmap; otherwise remains unchanged.
position	TableWindowImageFlags	Receives the stored alignment; the Transparent flag is not reconstructed.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetCellImage(column, position)

Retrieves the image and alignment for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
position	TableWindowImageFlags	Receives the stored alignment; the Transparent flag is not reconstructed.

Returns: Image. The stored cell image, or null when the target or image mapping is absent.

TblGetColHeaderCustom(column, userValue)

Retrieves the custom-drawing value for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
userValue	SalNumber	Receives the stored custom-drawing value when a compatible entry exists.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblGetColHeaderFont(column, hFont)

Retrieves the font override for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hFont	SalNumber	Receives a newly allocated native font handle; release it with DeleteObject when finished.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetColHeaderFont(column)

Retrieves the font override for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.

Returns: Font. The explicitly assigned font, or null when the target or override is absent.

TblGetColHeaderImage(column, hImage, position)

Provides an unsupported compatibility entry point for retrieving a column-header image.

Parameter	Type	Description
column	Control	Reserved for compatibility; ignored.
hImage	SalNumber	Reserved for compatibility; left unchanged.
position	TableWindowImageFlags	Reserved for compatibility; left unchanged.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

TblGetColumnBackColor(column, backColor)

Retrieves the background-color override for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
backColor	SalNumber	Receives the explicitly assigned Win32 color.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetColumnCustom(column, userValue)

Retrieves the custom-drawing value for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
userValue	SalNumber	Receives the stored custom-drawing value when a compatible entry exists.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblGetColumnFont(column, hFont)

Retrieves the font override for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hFont	SalNumber	Receives a newly allocated native font handle; release it with DeleteObject when finished.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetColumnFont(column)

Retrieves the font override for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.

Returns: Font. The explicitly assigned font, or null when the target or override is absent.

TblGetColumnImage(column, hImage, flags)

Provides an unsupported compatibility entry point for retrieving a column-image handle.

Parameter	Type	Description
column	Control	Reserved for compatibility; ignored.
hImage	SalNumber	Reserved for compatibility; left unchanged.
flags	TableWindowImageFlags	Reserved for compatibility; left unchanged.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

TblGetCustomInfo(lParam, HDC, col, row, tag, left, top, right, bottom)

Extracts drawing data from a live SAM_DrawCell callback handle.

Parameter	Type	Description
lParam	SalNumber	The callback drawing-information handle.
HDC	SalNumber	Receives the drawing device context.
col	SalNumber	Receives the column identifier.
row	SalNumber	Receives the SAL row index.
tag	SalNumber	Receives the custom user value.
left	SalNumber	Receives the left drawing boundary.
top	SalNumber	Receives the top drawing boundary.
right	SalNumber	Receives the right drawing boundary.
bottom	SalNumber	Receives the bottom drawing boundary.

Returns: SalBoolean. True when drawing information is available; otherwise false.

Use the handle only during the callback that supplied it.

TblGetRowBackColor(table, row, color)

Retrieves the background-color override for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
color	SalNumber	Receives the explicitly assigned Win32 color.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetRowCustom(table, row, userValue)

Retrieves the custom-drawing value for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
userValue	SalNumber	Receives the stored custom-drawing value when a compatible entry exists.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblGetRowFont(table, row, hFont)

Retrieves the font override for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
hFont	SalNumber	Receives a newly allocated native font handle; release it with DeleteObject when finished.

Returns: SalBoolean. True when the target contains the requested explicit setting; otherwise false with output values unchanged.

TblGetRowFont(table, row)

Retrieves the font override for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.

Returns: Font. The explicitly assigned font, or null when the target or override is absent.

TblGetRowImage(table, row, hImage, flags)

Provides an unsupported compatibility entry point for retrieving a row-image handle.

Parameter	Type	Description
table	Control	Reserved for compatibility; ignored.
row	SalNumber	Reserved for compatibility; ignored.
hImage	SalNumber	Reserved for compatibility; left unchanged.
flags	TableWindowImageFlags	Reserved for compatibility; left unchanged.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

TblPasteRows(table, copyFlags)

Appends rows parsed from clipboard text using the shared delimiters.

Parameter	Type	Description
table	Control	The table control or table form.
copyFlags	TableWindowClipboardFlags	Options to skip hidden columns or treat the first input row as titles.

Returns: SalBoolean. False when clipboard text or the table is unavailable; otherwise true, including after caught row-import errors.

Rows added before an error remain. Empty trailing records are processed, and the original context row is restored.

TblPasteRowsFromString(table, flags, csvText)

Appends rows parsed from delimited text.

Parameter	Type	Description
table	Control	The table control or table form.
flags	TableWindowClipboardFlags	Options to skip hidden columns or treat the first input row as titles.
csvText	SalString	The delimited row data.

Returns: SalBoolean. False for an invalid table; otherwise true, including after caught import errors.

The current implementation indexes input fields by grid-column position plus the fixed-column count. It can therefore skip leading input fields. The context row is restored, but partial imports are retained.

TblSetCellBackColor(column, backColor)

Assigns the background-color override for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
backColor	SalNumber	The SAL color, or COLOR_Default or SalNumber.Null to clear the override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetCellCustom(column, userValue)

Assigns the custom-drawing value for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
userValue	SalNumber	The custom-drawing tag. SalNumber.Null requests removal of an existing CUSTOMINFO entry.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblSetCellFont(column, font)

Assigns the font override for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
font	Font	The font to assign; null removes or resets the font override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetCellFont(column, hFont)

Assigns the font override for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hFont	SalNumber	The native font handle, or zero to assign a null font.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetCellFontName(column, fontName, fontSize, fontEnh)

Assigns the font override for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
fontName	SalString	The font family name.
fontSize	SalNumber	The font size in points.
fontEnh	SalNumber	The SAL font-enhancement flags.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetCellImage(column, image, flags)

Assigns the image and alignment for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
image	Image	A Bitmap to display, or null to clear the image. Other Image types are not applied.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetCellImage(column, hImage, flags)

Assigns the image and alignment for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hImage	SalNumber	The native bitmap handle, or zero to clear the image.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetCellImageFile(column, file, flags)

Assigns the image and alignment for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
file	SalString	The image-file path.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved. Image-loading errors are traced and return false.

TblSetCellImageResource(column, name, flags)

Assigns the image and alignment for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
name	SalString	The embedded image resource name.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetCellImageString(column, sImage, flags)

Assigns the image and alignment for the cell in the table context row.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
sImage	SalString	The bitmap binary data stored in a SAL string.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetClipRect(lParam, left, top, right, bottom)

Provides an unsupported compatibility entry point for changing a custom-drawing clip rectangle.

Parameter	Type	Description
lParam	SalNumber	Reserved for compatibility; ignored.
left	SalNumber	Reserved for compatibility; ignored.
top	SalNumber	Reserved for compatibility; ignored.
right	SalNumber	Reserved for compatibility; ignored.
bottom	SalNumber	Reserved for compatibility; ignored.

Returns: SalBoolean. Always false.

Logs that the operation is not implemented.

TblSetColHeaderCustom(column, userValue)

Assigns the custom-drawing value for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
userValue	SalNumber	The custom-drawing tag. SalNumber.Null requests removal of an existing CUSTOMINFO entry.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblSetColHeaderFont(column, font)

Assigns the font override for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
font	Font	The font to assign; null removes or resets the font override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColHeaderFont(column, hFont)

Assigns the font override for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hFont	SalNumber	The native font handle, or zero to assign a null font.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColHeaderFontName(column, fontName, fontSize, fontEnh)

Assigns the font override for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
fontName	SalString	The font family name.
fontSize	SalNumber	The font size in points.
fontEnh	SalNumber	The SAL font-enhancement flags.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColHeaderImage(column, image, flags)

Assigns the image and alignment for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
image	Image	A Bitmap to display, or null to clear the image. Other Image types are not applied.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColHeaderImage(column, hImage, flags)

Assigns the image and alignment for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hImage	SalNumber	The native bitmap handle, or zero to clear the image.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColHeaderImageFile(column, imageFile, flags)

Assigns the image and alignment for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
imageFile	SalString	The image-file path.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved. Image-loading errors are traced and return false.

TblSetColHeaderImageResource(column, resName, flags)

Assigns the image and alignment for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
resName	SalString	The embedded image resource name.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved. A missing or non-bitmap resource returns false.

TblSetColHeaderImageString(column, imageBlob, flags)

Assigns the image and alignment for the column header.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
imageBlob	SalString	The bitmap binary data stored in a SAL string.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColumnBackColor(column, backColor)

Assigns the background-color override for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
backColor	SalNumber	The SAL color, or COLOR_Default or SalNumber.Null to clear the override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColumnCustom(column, userValue)

Assigns the custom-drawing value for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
userValue	SalNumber	The custom-drawing tag. SalNumber.Null requests removal of an existing CUSTOMINFO entry.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblSetColumnFont(column, font)

Assigns the font override for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
font	Font	The font to assign; null removes or resets the font override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColumnFont(column, hFont)

Assigns the font override for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hFont	SalNumber	The native font handle, or zero to assign a null font.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColumnFontName(column, fontName, fontSize, fontEnh)

Assigns the font override for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
fontName	SalString	The font family name.
fontSize	SalNumber	The font size in points.
fontEnh	SalNumber	The SAL font-enhancement flags.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColumnImage(column, image, flags)

Assigns the image and alignment for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
image	Image	A Bitmap to display, or null to clear the image. Other Image types are not applied.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColumnImage(column, hImage, flags)

Assigns the image and alignment for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
hImage	SalNumber	The native bitmap handle, or zero to clear the image.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetColumnImageFile(column, file, flags)

Assigns the image and alignment for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
file	SalString	The image-file path.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved. Image-loading errors are traced and return false.

TblSetColumnImageResource(column, name, flags)

Assigns the image and alignment for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
name	SalString	The embedded image resource name.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved. A missing or non-bitmap resource returns false.

TblSetColumnImageString(column, sImage, flags)

Assigns the image and alignment for the column.

Parameter	Type	Description
column	Control	An attached SalTableColumn.
sImage	SalString	The bitmap binary data stored in a SAL string.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetDelimiters(colDelimiter, rowDelimiter)

Changes the shared delimiters used by table text copy and paste operations.

Parameter	Type	Description
colDelimiter	SalString	The separator between cell values.
rowDelimiter	SalString	The separator between table rows.

Returns: SalBoolean. True after assigning the delimiters.

TblSetRowBackColor(table, row, color)

Assigns the background-color override for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
color	SalNumber	The SAL color, or COLOR_Default or SalNumber.Null to clear the override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetRowCustom(table, row, userValue)

Assigns the custom-drawing value for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
userValue	SalNumber	The custom-drawing tag. SalNumber.Null requests removal of an existing CUSTOMINFO entry.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

The setter stores a USERVALUE entry, whereas the getter and removal path test for CUSTOMINFO. Consequently, a value installed by this setter is not returned or removed by those paths.

TblSetRowFont(table, row, font)

Assigns the font override for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
font	Font	The font to assign; null removes or resets the font override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetRowFont(table, row, hFont)

Assigns the font override for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
hFont	SalNumber	The native font handle, or zero to assign a null font.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetRowFontName(table, row, fontName, fontSize, fontEnh)

Assigns the font override for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
fontName	SalString	The font family name.
fontSize	SalNumber	The font size in points.
fontEnh	SalNumber	The SAL font-enhancement flags.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetRowHeaderBackColor(table, row, color)

Assigns the background-color override for the specified row header.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
color	SalNumber	The SAL color, or COLOR_Default or SalNumber.Null to clear the override.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetRowImage(table, row, image, flags)

Assigns the image and alignment for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
image	Image	A Bitmap to display, or null to clear the image. Other Image types are not applied.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetRowImage(table, row, hImage, flags)

Assigns the image and alignment for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
hImage	SalNumber	The native bitmap handle, or zero to clear the image.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSetRowImageFile(table, row, imageFile, flags)

Assigns the image and alignment for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
imageFile	SalString	The image-file path.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved. Image-loading errors are traced and return false.

TblSetRowImageResource(table, row, resName, flags)

Assigns the image and alignment for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
resName	SalString	The embedded image resource name.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved. A missing or non-bitmap resource returns false.

TblSetRowImageString(table, row, imageBlob, flags)

Assigns the image and alignment for the specified row.

Parameter	Type	Description
table	Control	The table control or table form.
row	SalNumber	The SAL row index, including split-row indices when applicable.
imageBlob	SalString	The bitmap binary data stored in a SAL string.
flags	TableWindowImageFlags	The image alignment and optional Transparent flag. FillAll stretches; transparency uses the bitmap's top-left pixel and modifies the bitmap.

Returns: SalBoolean. True when the target style or row is available; false when the target cannot be resolved.

TblSortRows(table, colID, flags)

Sorts the table's scrollable rows by a column, sending SAM_SwapRows for row exchanges.

Parameter	Type	Description
table	Control	The table control or table form.
colID	SalNumber	The column identifier.
flags	TableWindowSort	The sort direction, data interpretation, and case-comparison flags.

Returns: SalBoolean. False for an invalid table or column; otherwise true.

The active editor is canceled. Numeric and date columns automatically enable the corresponding comparison mode.

ToolboxCreate(parent, name, position, flags)

Creates a registered toolbox template and configures its owner, docking, behavior, and child layout.

Parameter	Type	Description
parent	Control	The owning form.
name	SalString	The registered SAL toolbox template name.
position	ToolboxPositions	The initial docked or floating position.
flags	ToolboxFlags	The initial behavior and visibility flags.

Returns: SalWindowHandle. The toolbox handle, or a null handle when parent is not a form or the template cannot be created.

Throws:

• ArgumentException The created template does not derive from XSalToolbox.

ToolboxDestroy(parent, name)

Disposes a named toolbox associated with a form.

Parameter	Type	Description
parent	Control	The containing form.
name	SalString	The case-sensitive toolbox name.

Returns: SalBoolean. True if the toolbox was found and processed; otherwise, false.

ToolboxGetButtonHandle()

Provides the compatibility accessor for a toolbox button handle.

Returns: SalWindowHandle. Always the null window handle.

ToolboxGetFlags(parent, name)

Gets the configuration flags of a named toolbox.

Parameter	Type	Description
parent	Control	The parent form.
name	SalString	The toolbox name.

Returns: ToolboxFlags. The toolbox flags, or ToolboxFlags.None if not found.

ToolboxGetPosition(parent, name)

Gets a named toolbox's docked or floating position.

Parameter	Type	Description
parent	Control	The containing form.
name	SalString	The case-sensitive toolbox name.

Returns: ToolboxPositions. The stored position, or None when the toolbox is absent.

ToolboxHide(parent, name)

Clears the visibility flag of a named toolbox.

Parameter	Type	Description
parent	Control	The parent form.
name	SalString	The toolbox name.

Returns: SalBoolean. True when the toolbox exists; otherwise false.

ToolboxHideAll(parent)

Clears the visibility flag of every toolbox registered for a form.

Parameter	Type	Description
parent	Control	The parent form.

Returns: SalBoolean. True when a toolbox collection is available; otherwise false.

ToolboxIsVisible(parent, name)

Tests the visibility flag of a named toolbox.

Parameter	Type	Description
parent	Control	The parent form.
name	SalString	The toolbox name.

Returns: SalBoolean. True when the toolbox exists and its Visible flag is set.

ToolboxSetButtonStyle(button, style)

Applies XSal toolbar appearance flags to a native button control.

Parameter	Type	Description
button	SalWindowHandle	The handle of a ButtonBase control.
style	ToolbuttonStyles	The button appearance flags.

Returns: SalBoolean. True when the handle resolves to a button; otherwise false.

ToolboxSetMetrics(value, type)

Sets a shared toolbar dimension or toolbox layout offset.

Parameter	Type	Description
value	SalNumber	The value in pixels.
type	ToolbarMetrics	The metric to change; unknown values are ignored.

Returns: SalBoolean. True.

ToolboxSetPosition(parent, name, position)

Changes a named toolbox's docked or floating position and rearranges its children.

Parameter	Type	Description
parent	Control	The containing form.
name	SalString	The case-sensitive toolbox name.
position	ToolboxPositions	The desired docking edge or Floating position.

Returns: SalBoolean. True when the toolbox exists and the position assignment completes; otherwise false.

ToolboxShow(parent, name)

Sets the visibility flag of a named toolbox.

Parameter	Type	Description
parent	Control	The parent form.
name	SalString	The toolbox name.

Returns: SalBoolean. True when the toolbox exists; otherwise false.

ToolboxShowAll(parent)

Sets the visibility flag of every toolbox registered for a form.

Parameter	Type	Description
parent	Control	The parent form.

Returns: SalBoolean. True when a toolbox collection is available; otherwise false.

ToolboxUpdate(parent, name)

Recalculates the layout of a named toolbox.

Parameter	Type	Description
parent	Control	The parent form.
name	SalString	The toolbox name.

Returns: SalBoolean. True when the toolbox exists; otherwise false.

TooltipInit()

Ensures the shared tooltip manager, timers, and mouse-message filter are initialized.

Returns: SalNumber. Always zero.

Repeated calls do not reset configured tooltip values.

TooltipSetColors(textColor, backColor)

Sets the shared tooltip text and background colors.

Parameter	Type	Description
textColor	SalNumber	The SAL foreground color.
backColor	SalNumber	The SAL background color.

Returns: SalNumber. Always zero.

TooltipSetDelay(showDelay, popDelay)

Changes the shared tooltip initial-show and automatic-hide delays.

Parameter	Type	Description
showDelay	SalNumber	The initial delay in milliseconds.
popDelay	SalNumber	The automatic-hide delay in milliseconds.

Returns: SalNumber. Always zero.

TooltipSetText(tooltip)

Updates or shows tooltip text for the current tooltip target.

Parameter	Type	Description
tooltip	SalString	The text to display, or empty text to hide the tip.

Returns: SalBoolean. Always true.

TooltipShow(ctrl, tooltip)

Shows or schedules tooltip text for a control, or hides the current tip for empty text or an invalid control.

Parameter	Type	Description
ctrl	Control	The tooltip target.
tooltip	SalString	The tooltip text.

Returns: SalWindowHandle. Always SalWindowHandle.Null.

UdvArrayDelete(array, index)

Removes the element at the specified array index.

Parameter	Type	Description
array	SalArray	The SAL array to modify.
index	SalNumber	The element index.

Returns: SalBoolean. True if the operation completes; false for an IndexOutOfRangeException.

UdvArrayInsert(array, index)

Inserts an empty element at the specified array index.

Parameter	Type	Description
array	SalArray	The SAL array to modify.
index	SalNumber	The element index.

Returns: SalBoolean. True if the operation completes; false for an IndexOutOfRangeException.

UdvArrayMove(array, sourceIndex, targetIndex)

Inserts a copy of an array element at the target position and removes the original.

Parameter	Type	Description
array	SalArray	The array to modify.
sourceIndex	SalNumber	The source element index.
targetIndex	SalNumber	The insertion index before the original element is removed.

Returns: SalBoolean. True on success or when the indices are equal; false for an IndexOutOfRangeException.

UdvArraySort(array, fieldName, dataType, sortOrder)

Sorts a one-dimensional object array by a public field or property.

Parameter	Type	Description
array	SalArray	The array to sort.
fieldName	SalString	The public field or property name on the element type.
dataType	SalNumber	Reserved for compatibility; ignored.
sortOrder	SalNumber	The sort order consumed by the member comparer.

Returns: SalBoolean. True when sorting completes or the array has fewer than two elements; false for a multidimensional array, empty member name, or missing member.

UdvArraySwap(array, index1, index2)

Exchanges two array elements.

Parameter	Type	Description
array	SalArray	The SAL array to modify.
index1	SalNumber	The first element index.
index2	SalNumber	The second element index.

Returns: SalBoolean. True if the exchange completes; false for an IndexOutOfRangeException.

UdvClone(source, target)

Clones a functional-class object by binary serialization and deserialization.

Parameter	Type	Description
source	SalFunctionalClass	The serializable object to copy.
target	SalFunctionalClass	Receives the deserialized copy.

Returns: SalBoolean. True if both operations succeed; false for a null source.

UdvFromString(obj, source)

Deserializes a functional-class object from a BinaryFormatter binary string.

Parameter	Type	Description
obj	SalFunctionalClass	Receives the deserialized object.
source	SalString	The serialized binary data.

Returns: SalBoolean. False for null or empty binary data; true after deserialization.

The input must be trusted serialized application data. Deserialization and cast errors propagate.

UdvToString(obj, target)

Serializes a functional-class object into a SAL binary string using BinaryFormatter.

Parameter	Type	Description
obj	SalFunctionalClass	The serializable object.
target	SalString	Receives the serialized stream buffer.

Returns: SalBoolean. False for a null object; true after serialization.

Serialization exceptions propagate to the caller.

ZipCloseArchive(zipFile)

Closes a ZIP archive and frees its allocated handle.

Parameter	Type	Description
zipFile	SalNumber	The live archive handle; its numeric value is not reset after release.

Returns: SalBoolean. False for a nonpositive handle or a caught archive error; otherwise true.

A positive handle is freed in the finally block even when archive closure fails. Do not reuse it afterward.

ZipCloseFile(zipFile)

Closes the current archive entry.

Parameter	Type	Description
zipFile	SalNumber	The archive handle whose entry is open.

Returns: SalBoolean. True if closure succeeds; false for a caught archive error.

ZipCreateFile(zipFile, fileName, date, comment, compressionLevel)

Creates a writable entry in an output ZIP archive.

Parameter	Type	Description
zipFile	SalNumber	The open output-archive handle.
fileName	SalString	The entry path within the archive.
date	SalDateTime	The entry timestamp.
comment	SalString	The entry comment.
compressionLevel	SalNumber	The compression level passed to the ZIP implementation.

Returns: SalBoolean. True if an entry is created; false for a zero handle or a caught error.

ZipFindFile(zipFile, fileName)

Selects an archive entry by name.

Parameter	Type	Description
zipFile	SalNumber	The open input-archive handle.
fileName	SalString	The archive entry name to find.

Returns: SalBoolean. True if the entry is found; false for a zero handle, no match, or a caught archive error.

ZipFindFirstFile(zipFile)

Selects the first entry and resets archive enumeration.

Parameter	Type	Description
zipFile	SalNumber	The open input-archive handle.

Returns: SalBoolean. True if an entry exists; false for a zero handle, no matching entry, or a caught archive error.

ZipFindNextFile(zipFile)

Advances to the next archive entry.

Parameter	Type	Description
zipFile	SalNumber	The open input-archive handle.

Returns: SalBoolean. True if an entry exists; false for a zero handle, no matching entry, or a caught archive error.

ZipGetFileInfo(zipFile, fileName, comment, date, compressedSize, uncompressedSize)

Retrieves metadata for the currently selected ZIP entry.

Parameter	Type	Description
zipFile	SalNumber	The input-archive handle.
fileName	SalString	Receives the entry name.
comment	SalString	Receives the entry comment.
date	SalDateTime	Receives the entry timestamp.
compressedSize	SalNumber	Receives the compressed size in bytes.
uncompressedSize	SalNumber	Receives the uncompressed size in bytes.

Returns: SalBoolean. True if metadata is retrieved; false for a zero handle, no selected entry, or a caught error.

ZipOpenArchive(zipFile, fileName, mode)

Opens an existing ZIP archive for reading or creates a new archive for writing.

Parameter	Type	Description
zipFile	SalNumber	Receives an allocated archive handle on success.
fileName	SalString	The archive path.
mode	SalNumber	OF_Read to open or OF_Write to create and overwrite the file.

Returns: SalBoolean. True if the archive handle is allocated; false for another mode or a caught archive error.

Requires the dynamically loaded SharpZipLib archive support. Close the archive handle when finished.

ZipOpenFile(zipFile)

Opens the currently selected archive entry for reading.

Parameter	Type	Description
zipFile	SalNumber	The input-archive handle with an entry selected.

Returns: SalBoolean. True if an entry stream is opened; otherwise, false.

ZipRead(zipFile, buffer, count)

Reads bytes from the current ZIP entry into a newly allocated buffer.

Parameter	Type	Description
zipFile	SalNumber	The input archive handle.
buffer	SalString	Receives a binary string of the requested count when bytes are read, including zero padding after a short read; receives empty text at end of input. A nonpositive count leaves it unchanged.
count	SalNumber	The maximum byte count to read.

Returns: SalNumber. The actual byte count, or zero for a nonpositive count or a caught error.

ZipWrite(zipFile, buffer, length)

Writes bytes to the current output ZIP entry.

Parameter	Type	Description
zipFile	SalNumber	The open output-archive handle.
buffer	SalString	The SAL string whose binary buffer is written.
length	SalNumber	The number of bytes to write from the beginning of the buffer.

Returns: SalBoolean. True if writing succeeds; false for a zero archive handle or a caught write error.

ZipWrite(zipFile, buffer, length)

Writes bytes to the current output ZIP entry.

Parameter	Type	Description
zipFile	SalNumber	The open output-archive handle.
buffer	Byte[]	The source byte array.
length	SalNumber	The number of bytes to write from the beginning of the buffer.

Returns: SalBoolean. True if writing succeeds; false for a zero archive handle or a caught write error.