XSal

PPJ.Runtime.XSal.XSal

Namespace: PPJ.Runtime.XSal

Assembly: PPJ.Runtime.XSal.49 (4.9.0.0)

XSal functions.

C#

public class XSal

VB.NET

Public Class XSal

Fields

Name	Type	Description
SAM_DrawCell	Int32	Callback message for cell drawing The table window receives this message each time a custom drawn cell needs to be repainted. wParam = cell selected flag (TRUE or FALSE) lParam = pointer to a structure with drawing information. Use it with XSalTblGetCustomInfo().
SAM_HotSpotClick	Int32	The form, dialog or MDI receive this message when the user clicks the left mouse button on the hot spot. wParam = HotSpot ID lParam = Mouse position
SAM_HotSpotMouseMove	Int32	The form, dialog or MDI receive this message when the user moves the mouse on the hot spot. wParam = HotSpot ID if the mouse is entering the hot spot or NULL if the mouse is leaving the hot spot. lParam = Mouse position
SAM_SwapRows	Int32	Notification message from XSalTblSortRows. The table window receives this message each time the quick-sort routine swaps two rows. wParam = first row lParam = second row
SAM_ToolboxSetPosition	Int32	The toolbox receives this message when it's orientation and position are being changed. This allows the program to change some visual aspect of the toolbox. wParam = The new orientation flag lParam = not used
SAM_ToolboxUpdateMenu	Int32	Send to the form that owns the tool bars. The app can modify the popup menu before it's displayed by processing this event. The menu object can be accessed using the form's ContextMenu property or VT menu functions using wParam for the menu handle. wParam = Handle for the menu lParam = not used.
SAM_TooltipClose	Int32	Sent to the control with the tool tip when the tool tip is destroyed.
SAM_TooltipSetText	Int32	Sent to the control under the mouse to show the tool tip.

Properties

ToolTip: Returns the single tool tips instance used by XSalTooltips.

Methods

Frees the bitmap handle.

Parameter	Type	Description
hBitmap	SalNumber

Returns: SalBoolean.

HBITMAP XSalBitmapCreateDisabled( HBITMAP p_hBitmap, COLORREF p_cColor );

Parameter	Type	Description
Param1	SalNumber
Param2	SalNumber

Returns: SalNumber.

Draws the image inside the control.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
hImage	SalNumber
x	SalNumber
y	SalNumber
width	SalNumber
height	SalNumber

Returns: SalBoolean.

Draws the image inside the control.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
hImage	SalNumber
x	SalNumber
y	SalNumber
width	SalNumber
height	SalNumber
transparent	SalBoolean

Returns: SalBoolean.

Draws the image inside the device context.

Parameter	Type	Description
Param1	SalNumber
Param2	SalNumber
Param3	SalNumber
Param4	SalNumber
Param5	SalNumber
Param6	SalNumber

Returns: SalBoolean.

Returns the bitmap handle from the image file.

Parameter	Type	Description
fileName	SalString

Returns: SalNumber.

HBITMAP XSalBitmapFromIcon( HICON p_hIcon, COLORREF p_cBackColor );

Parameter	Type	Description
Param1	SalNumber
Param2	SalNumber

Returns: SalNumber.

Returns the bitmap handle from the resource object,

Parameter	Type	Description
resName	SalString

Returns: SalNumber.

Returns the bitmap handle from the bytes string.

Parameter	Type	Description
bitmapBytes	SalString

Returns: SalNumber.

HBITMAP XSalBitmapFromWindow( HWND p_hWnd, BOOL p_bClientOnly )

Parameter	Type	Description
Param1	SalWindowHandle
Param2	SalBoolean

Returns: SalNumber.

Parameter	Type	Description
Param1	SalNumber
Param2	SalString&

Returns: SalBoolean.

Returns the client area of a form with the accessories enabled.

Parameter	Type	Description
form	Control

Returns: SalWindowHandle.

Parameter	Type	Description
ctrl	Control
id	SalNumber
x	SalNumber&
y	SalNumber&
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
ctrl	Control
hImage	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
Param1	SalNumber&

Returns: SalBoolean.

BOOL XSalGZipEof( gzFile p_File )

Parameter	Type	Description
Param1	SalNumber

Returns: SalBoolean.

BOOL XSalGZipFlush( gzFile p_File )

Parameter	Type	Description
Param1	SalNumber

Returns: SalBoolean.

CHAR XSalGZipGetStr( gzFile p_File )

Parameter	Type	Description
Param1	SalNumber

Returns: SalNumber.

Parameter	Type	Description
Param1	SalNumber
Param2	SalNumber&

Returns: SalString.

Parameter	Type	Description
Param1	SalNumber
Param2	SalString&
Param3	SalNumber

Returns: SalNumber.

Parameter	Type	Description
Param1	SalNumber&
Param2	SalString
Param3	SalString

Returns: SalBoolean.

BOOL XSalGZipPutChar( gzFile p_File, CHAR p_cChar )

Parameter	Type	Description
Param1	SalFileHandle
Param2	SalNumber

Returns: SalBoolean.

INT XSalGZipPutStr( gzFile p_File, LPSTR p_lpBufferOut )

Parameter	Type	Description
Param1	SalNumber
Param2	SalString

Returns: SalNumber.

Parameter	Type	Description
Param1	SalNumber
Param2	SalString&
Param3	SalNumber

Returns: SalNumber.

BOOL XSalGZipRewind( gzFile p_File )

Parameter	Type	Description
Param1	SalNumber

Returns: SalBoolean.

LONG XSalGZipSeek( gzFile p_File, LONG p_lOffset, INT p_iWhence )

Parameter	Type	Description
Param1	SalNumber
Param2	SalNumber
Param3	SalNumber

Returns: SalNumber.

LONG XSalGZipTell( gzFile p_File )

Parameter	Type	Description
Param1	SalNumber

Returns: SalNumber.

LONG XSalGZipWrite( gzFile p_File, LPVOID p_lpBufferOut, LONG p_lSize )

Parameter	Type	Description
Param1	SalNumber
Param2	SalString
Param3	SalNumber

Returns: SalNumber.

Adds a line to the script and recompiles.

Parameter	Type	Description
handle	SalNumber
line	SalString

Returns: SalBoolean.

Creates and compiles the script.

Parameter	Type	Description
source	SalString

Returns: SalNumber.

Frees the script.

Parameter	Type	Description
handle	SalNumber

Returns: SalBoolean.

Parameter	Type	Description
handle	SalNumber
errorsList	SalString&

Returns: SalNumber.

Parameter	Type	Description
handle	SalNumber
localName	SalString
varName	SalString&

Returns: SalBoolean.

Parameter	Type	Description
handle	SalNumber
result	SalString&

Returns: SalBoolean.

Changes the execution context for the script object.

Parameter	Type	Description
handle	SalNumber
context	Object

Returns: SalBoolean.

Enables/Disables debug mode. When the debug mode is on, the exceptions generated by the interpreter are unhandled.

Parameter	Type	Description
handle	SalNumber
debugOn	SalBoolean

Returns: SalBoolean.

Parameter	Type	Description
handle	SalNumber
timeout	SalNumber

Returns: SalBoolean.

Creates a new hot spot are on the windows background. If the hot spot dimensions are 0,0,0,0 the specified hot spot ID is removed.

Parameter	Type	Description
ctrl	Control	The control to add the hot spot to.
id	SalNumber	A unique id returned in the SAM_HotSpotClick event.
x	SalNumber	The X coordinate of the hot spot in pixels.
y	SalNumber	The X coordinate of the hot spot in pixels.
width	SalNumber	The width of the hot spot in pixels.
height	SalNumber	The height of the hot spot in pixels.

Returns: SalBoolean.

Sets the image to show as the background of the specified window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
hImage	SalNumber
flags	BackgroundImageFlags

Returns: SalBoolean.

Sets the image to show as the background of the specified window.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
sFileName	SalString
flags	BackgroundImageFlags

Returns: SalBoolean.

Returns the position of the splitter. If the splitter is proportional, the position is expressed as a percentage integer: 500 = 50%.

Parameter	Type	Description
split	SalWindowHandle

Returns: SalNumber.

Returns the child control associated to the splitter's frames.

Parameter	Type	Description
split	SalWindowHandle
frame	SalNumber

Returns: SalWindowHandle.

Returns the styles of the splitter.

Parameter	Type	Description
split	SalWindowHandle

Returns: SplitterStyles.

Sets the position of the splitter. If the splitter is proportional, the position is expressed as a percentage integer: 500 = 50%.

Parameter	Type	Description
split	SalWindowHandle
pos	SalNumber

Returns: SalBoolean.

Sets the size of the splitter.

Parameter	Type	Description
split	SalWindowHandle
size	SalNumber

Returns: SalBoolean.

Associates the child control to the splitter's frames.

Parameter	Type	Description
split	SalWindowHandle
child	SalWindowHandle
frame	SalNumber

Returns: SalBoolean.

Sets the minimum and maximum positions for the splitter.

Parameter	Type	Description
split	SalWindowHandle
min	SalNumber
max	SalNumber

Returns: SalBoolean.

Sets the style of the splitter.

Parameter	Type	Description
split	SalWindowHandle
style	SplitterStyles
on	SalBoolean

Returns: SalBoolean.

Finds the first character in the string that appears in a given character set.

Parameter	Type	Description
text	SalString
chars	SalString

Returns: SalNumber.

Compares a substring in a string.

Parameter	Type	Description
source	SalString
compare	SalString
start	SalNumber
size	SalNumber
caseSensitive	SalBoolean

Returns: SalBoolean.

Parameter	Type	Description
inString	SalString
level	SalNumber
outString	SalString&

Returns: SalBoolean.

Counts the number of times a substring appears in a string.

Parameter	Type	Description
text	SalString
search	SalString
start	SalNumber
length	SalNumber
left	SalBoolean

Returns: SalNumber.

Truncates the string to fit the control's width and adds the ellipses characters at the end of the resulting string.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
text	SalString
append	SalString

Returns: SalString.

Formats a string using a string mask.

Parameter	Type	Description
text	SalString
mask	SalString

Returns: SalString.

Parameter	Type	Description
date	SalDateTime
format	SalString
language	SalString

Returns: SalString.

Parameter	Type	Description
date	SalDateTime
format	SalString
days	SalString
shortDays	SalString
months	SalString
shortMonths	SalString

Returns: SalString.

Converts a hexadecimal text into a string.

Parameter	Type	Description
hex	SalString

Returns: SalString.

Returns the character at the indicated position.

Parameter	Type	Description
text	SalString
index	SalNumber

Returns: SalNumber.

Parameter	Type	Description
list	SalString
separators	SalString

Returns: SalString.

Returns the next token string in a list.

Returns: SalString.

Parameter	Type	Description
text	SalString

Returns: SalString.

Finds the first character in the string that does not appear in a given character set.

Parameter	Type	Description
text	SalString
chars	SalString

Returns: SalNumber.

Searches for a substring in the source string starting from the specified index.

Parameter	Type	Description
text	SalString
search	SalString
index	SalNumber

Returns: SalNumber.

Searches for a substring in the source string starting from the specified index.

Parameter	Type	Description
text	SalString
search	SalString
index	SalNumber

Returns: SalNumber.

Parameter	Type	Description
text	SalString&
index	SalNumber
charSet	SalNumber

Returns: SalNumber.

Converts a string to a hexadecimal text.

Parameter	Type	Description
str	SalString

Returns: SalString.

Converts a string to a number, regardless of the decimal point.

Parameter	Type	Description
text	SalString

Returns: SalNumber.

Parameter	Type	Description
inString	SalString
outString	SalString&

Returns: SalBoolean.

Copies the matching rows to the clipboard.

Parameter	Type	Description
table	Control
flagsOn	SalNumber
flagsOff	SalNumber
copyFlags	TableWindowClipboardFlags

Returns: SalBoolean.

Parameter	Type	Description
table	Control
flagsOn	SalNumber
flagsOff	SalNumber
copyFlags	TableWindowClipboardFlags
csvText	SalString&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
backColor	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
userValue	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
hFont	SalNumber&

Returns: SalBoolean.

Returns the font associated with the specified table cell.

Parameter	Type	Description
column	Control

Returns: Font.

Parameter	Type	Description
column	Control
hImage	SalNumber&
position	TableWindowImageFlags&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
position	TableWindowImageFlags&

Returns: Image.

Parameter	Type	Description
column	Control
userValue	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
hFont	SalNumber&

Returns: SalBoolean.

Returns the font associated to the column header.

Parameter	Type	Description
column	Control

Returns: Font.

Parameter	Type	Description
column	Control
hImage	SalNumber&
position	TableWindowImageFlags&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
backColor	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
userValue	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
column	Control
hFont	SalNumber&

Returns: SalBoolean.

Returns the font associated with the specified table column.

Parameter	Type	Description
column	Control

Returns: Font.

Parameter	Type	Description
column	Control
hImage	SalNumber&
flags	TableWindowImageFlags&

Returns: SalBoolean.

Parameter	Type	Description
lParam	SalNumber
HDC	SalNumber&
col	SalNumber&
row	SalNumber&
tag	SalNumber&
left	SalNumber&
top	SalNumber&
right	SalNumber&
bottom	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
table	Control
row	SalNumber
color	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
table	Control
row	SalNumber
userValue	SalNumber&

Returns: SalBoolean.

Parameter	Type	Description
table	Control
row	SalNumber
hFont	SalNumber&

Returns: SalBoolean.

Returns the font used for the specified row.

Parameter	Type	Description
table	Control
row	SalNumber

Returns: Font.

Parameter	Type	Description
table	Control
row	SalNumber
hImage	SalNumber&
flags	TableWindowImageFlags&

Returns: SalBoolean.

Pastes the CSV text from the clipboard.

Parameter	Type	Description
table	Control
copyFlags	TableWindowClipboardFlags

Returns: SalBoolean.

Pastes the specified CSV string into the table window control.

Parameter	Type	Description
table	Control
flags	TableWindowClipboardFlags
csvText	SalString

Returns: SalBoolean.

Sets the background color of an individual cell.

Parameter	Type	Description
column	Control
backColor	SalNumber

Returns: SalBoolean.

Makes the specified cell custom-drawn and assigns the user value to it.

Parameter	Type	Description
column	Control
userValue	SalNumber

Returns: SalBoolean.

Sets the font for a single cell.

Parameter	Type	Description
column	Control
font	Font

Returns: SalBoolean.

Sets the font for a single cell.

Parameter	Type	Description
column	Control
hFont	SalNumber

Returns: SalBoolean.

Sets the font for a single cell.

Parameter	Type	Description
column	Control
fontName	SalString
fontSize	SalNumber
fontEnh	SalNumber

Returns: SalBoolean.

Assigns an image to a table cell.

Parameter	Type	Description
column	Control
image	Image
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to a table cell.

Parameter	Type	Description
column	Control
hImage	SalNumber
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to a table cell.

Parameter	Type	Description
column	Control
file	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to a table cell.

Parameter	Type	Description
column	Control
name	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to a table cell.

Parameter	Type	Description
column	Control
sImage	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Changes the clipping rectangle when custom drawing a cell. It must be used when processing SAM_DrawCell to make sure that lParam contains the correct value.

Parameter	Type	Description
lParam	SalNumber
left	SalNumber
top	SalNumber
right	SalNumber
bottom	SalNumber

Returns: SalBoolean.

Defines the column header as custom drawn.

Parameter	Type	Description
column	Control
userValue	SalNumber

Returns: SalBoolean.

Assigns the specified font to the column header.

Parameter	Type	Description
column	Control
font	Font

Returns: SalBoolean.

Assigns the specified font to the column header.

Parameter	Type	Description
column	Control
hFont	SalNumber

Returns: SalBoolean.

Creates the specified font and assigns it to the column header.

Parameter	Type	Description
column	Control
fontName	SalString
fontSize	SalNumber
fontEnh	SalNumber

Returns: SalBoolean.

Assigns the image from the handle to the specified column header.

Parameter	Type	Description
column	Control
image	Image
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns the image from the handle to the specified column header.

Parameter	Type	Description
column	Control
hImage	SalNumber
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns the image file to the specified column header.

Parameter	Type	Description
column	Control
imageFile	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns the image from the specified resource object to the column header.

Parameter	Type	Description
column	Control
resName	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns the image from the blob string to the specified column header.

Parameter	Type	Description
column	Control
imageBlob	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Sets the background color for a table column.

Parameter	Type	Description
column	Control
backColor	SalNumber

Returns: SalBoolean.

Enables custom drawing (SAM_DrawCell) for the specified column.

Parameter	Type	Description
column	Control
userValue	SalNumber

Returns: SalBoolean.

Sets the font for a table column.

Parameter	Type	Description
column	Control
font	Font

Returns: SalBoolean.

Sets the font for a table column.

Parameter	Type	Description
column	Control
hFont	SalNumber

Returns: SalBoolean.

Sets the font for the table column. The font is created using the specified arguments.

Parameter	Type	Description
column	Control
fontName	SalString
fontSize	SalNumber
fontEnh	SalNumber

Returns: SalBoolean.

Assigns an image to a table column.

Parameter	Type	Description
column	Control
image	Image
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to the column.

Parameter	Type	Description
column	Control
hImage	SalNumber
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to the column.

Parameter	Type	Description
column	Control
file	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to the column.

Parameter	Type	Description
column	Control
name	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to the column.

Parameter	Type	Description
column	Control
sImage	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Changes the standard column and row delimiters for the copy/paste operations.

Parameter	Type	Description
colDelimiter	SalString
rowDelimiter	SalString

Returns: SalBoolean.

Sets the background color of a row.

Parameter	Type	Description
table	Control
row	SalNumber
color	SalNumber

Returns: SalBoolean.

Defines the specified row as custom drawn and assigns the user value.

Parameter	Type	Description
table	Control
row	SalNumber
userValue	SalNumber

Returns: SalBoolean.

Sets the font for the entire row.

Parameter	Type	Description
table	Control
row	SalNumber
font	Font

Returns: SalBoolean.

Sets the font for the entire row.

Parameter	Type	Description
table	Control
row	SalNumber
hFont	SalNumber

Returns: SalBoolean.

Sets the font for the entire row.

Parameter	Type	Description
table	Control
row	SalNumber
fontName	SalString
fontSize	SalNumber
fontEnh	SalNumber

Returns: SalBoolean.

Sets the background color of the row header.

Parameter	Type	Description
table	Control
row	SalNumber
color	SalNumber

Returns: SalBoolean.

Assigns an image to all the cells in the specified row,

Parameter	Type	Description
table	Control
row	SalNumber
image	Image
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to all the cells in the specified row,

Parameter	Type	Description
table	Control
row	SalNumber
hImage	SalNumber
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to all the cells in the specified row.

Parameter	Type	Description
table	Control
row	SalNumber
imageFile	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns the image from the resource object to all the cells in the table row.

Parameter	Type	Description
table	Control
row	SalNumber
resName	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Assigns an image to all the cells in the specified row.

Parameter	Type	Description
table	Control
row	SalNumber
imageBlob	SalString
flags	TableWindowImageFlags

Returns: SalBoolean.

Sort the table rows using the values in the specified column.

Parameter	Type	Description
table	Control
colID	SalNumber
flags	TableWindowSort

Returns: SalBoolean.

Creates the specified toolbox dialog.