XSal

PPJ.Runtime.XSal.XSal

Namespace: PPJ.Runtime.XSal

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

XSal functions.

public class XSal

Fields

NameTypeDescription

SAM_DrawCell

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

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

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

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

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

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

Sent to the control with the tool tip when the tool tip is destroyed.

SAM_TooltipSetText

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.

ParameterTypeDescription

hBitmap

Returns: SalBoolean.

HBITMAP XSalBitmapCreateDisabled( HBITMAP p_hBitmap, COLORREF p_cColor );

ParameterTypeDescription

Param1

Param2

Returns: SalNumber.

Draws the image inside the control.

ParameterTypeDescription

ctrl

Target control on which to execute the call.

hImage

x

y

width

height

Returns: SalBoolean.

Draws the image inside the control.

ParameterTypeDescription

ctrl

Target control on which to execute the call.

hImage

x

y

width

height

transparent

Returns: SalBoolean.

Draws the image inside the device context.

ParameterTypeDescription

Param1

Param2

Param3

Param4

Param5

Param6

Returns: SalBoolean.

Returns the bitmap handle from the image file.

ParameterTypeDescription

fileName

Returns: SalNumber.

HBITMAP XSalBitmapFromIcon( HICON p_hIcon, COLORREF p_cBackColor );

ParameterTypeDescription

Param1

Param2

Returns: SalNumber.

Returns the bitmap handle from the resource object,

ParameterTypeDescription

resName

Returns: SalNumber.

Returns the bitmap handle from the bytes string.

ParameterTypeDescription

bitmapBytes

Returns: SalNumber.

HBITMAP XSalBitmapFromWindow( HWND p_hWnd, BOOL p_bClientOnly )

ParameterTypeDescription

Param1

Param2

Returns: SalNumber.

ParameterTypeDescription

Param1

Param2

Returns: SalBoolean.

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

ParameterTypeDescription

form

Returns: SalWindowHandle.

ParameterTypeDescription

ctrl

id

x

y

width

height

Returns: SalBoolean.

ParameterTypeDescription

ctrl

hImage

Returns: SalBoolean.

ParameterTypeDescription

Param1

Returns: SalBoolean.

BOOL XSalGZipEof( gzFile p_File )

ParameterTypeDescription

Param1

Returns: SalBoolean.

BOOL XSalGZipFlush( gzFile p_File )

ParameterTypeDescription

Param1

Returns: SalBoolean.

CHAR XSalGZipGetStr( gzFile p_File )

ParameterTypeDescription

Param1

Returns: SalNumber.

ParameterTypeDescription

Param1

Param2

Returns: SalString.

ParameterTypeDescription

Param1

Param2

Param3

Returns: SalNumber.

ParameterTypeDescription

Param1

Param2

Param3

Returns: SalBoolean.

BOOL XSalGZipPutChar( gzFile p_File, CHAR p_cChar )

ParameterTypeDescription

Param1

Param2

Returns: SalBoolean.

INT XSalGZipPutStr( gzFile p_File, LPSTR p_lpBufferOut )

ParameterTypeDescription

Param1

Param2

Returns: SalNumber.

ParameterTypeDescription

Param1

Param2

Param3

Returns: SalNumber.

BOOL XSalGZipRewind( gzFile p_File )

ParameterTypeDescription

Param1

Returns: SalBoolean.

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

ParameterTypeDescription

Param1

Param2

Param3

Returns: SalNumber.

LONG XSalGZipTell( gzFile p_File )

ParameterTypeDescription

Param1

Returns: SalNumber.

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

ParameterTypeDescription

Param1

Param2

Param3

Returns: SalNumber.

Adds a line to the script and recompiles.

ParameterTypeDescription

handle

line

Returns: SalBoolean.

Creates and compiles the script.

ParameterTypeDescription

source

Returns: SalNumber.

Frees the script.

ParameterTypeDescription

handle

Returns: SalBoolean.

ParameterTypeDescription

handle

errorsList

Returns: SalNumber.

ParameterTypeDescription

handle

localName

varName

Returns: SalBoolean.

ParameterTypeDescription

handle

result

Returns: SalBoolean.

Changes the execution context for the script object.

ParameterTypeDescription

handle

context

Returns: SalBoolean.

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

ParameterTypeDescription

handle

debugOn

Returns: SalBoolean.

ParameterTypeDescription

handle

timeout

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.

ParameterTypeDescription

ctrl

The control to add the hot spot to.

id

A unique id returned in the SAM_HotSpotClick event.

x

The X coordinate of the hot spot in pixels.

y

The X coordinate of the hot spot in pixels.

width

The width of the hot spot in pixels.

height

The height of the hot spot in pixels.

Returns: SalBoolean.

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

ParameterTypeDescription

ctrl

Target control on which to execute the call.

hImage

flags

Returns: SalBoolean.

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

ParameterTypeDescription

ctrl

Target control on which to execute the call.

sFileName

flags

Returns: SalBoolean.

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

ParameterTypeDescription

split

Returns: SalNumber.

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

ParameterTypeDescription

split

frame

Returns: SalWindowHandle.

Returns the styles of the splitter.

ParameterTypeDescription

split

Returns: SplitterStyles.

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

ParameterTypeDescription

split

pos

Returns: SalBoolean.

Sets the size of the splitter.

ParameterTypeDescription

split

size

Returns: SalBoolean.

Associates the child control to the splitter's frames.

ParameterTypeDescription

split

child

frame

Returns: SalBoolean.

Sets the minimum and maximum positions for the splitter.

ParameterTypeDescription

split

min

max

Returns: SalBoolean.

Sets the style of the splitter.

ParameterTypeDescription

split

style

on

Returns: SalBoolean.

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

ParameterTypeDescription

text

chars

Returns: SalNumber.

Compares a substring in a string.

ParameterTypeDescription

source

compare

start

size

caseSensitive

Returns: SalBoolean.

ParameterTypeDescription

inString

level

outString

Returns: SalBoolean.

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

ParameterTypeDescription

text

search

start

length

left

Returns: SalNumber.

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

ParameterTypeDescription

ctrl

Target control on which to execute the call.

text

append

Returns: SalString.

Formats a string using a string mask.

ParameterTypeDescription

text

mask

Returns: SalString.

ParameterTypeDescription

date

format

language

Returns: SalString.

ParameterTypeDescription

date

format

days

shortDays

months

shortMonths

Returns: SalString.

Converts a hexadecimal text into a string.

ParameterTypeDescription

hex

Returns: SalString.

Returns the character at the indicated position.

ParameterTypeDescription

text

index

Returns: SalNumber.

ParameterTypeDescription

list

separators

Returns: SalString.

Returns the next token string in a list.

Returns: SalString.

ParameterTypeDescription

text

Returns: SalString.

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

ParameterTypeDescription

text

chars

Returns: SalNumber.

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

ParameterTypeDescription

text

search

index

Returns: SalNumber.

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

ParameterTypeDescription

text

search

index

Returns: SalNumber.

ParameterTypeDescription

text

index

charSet

Returns: SalNumber.

Converts a string to a hexadecimal text.

ParameterTypeDescription

str

Returns: SalString.

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

ParameterTypeDescription

text

Returns: SalNumber.

ParameterTypeDescription

inString

outString

Returns: SalBoolean.

Copies the matching rows to the clipboard.

ParameterTypeDescription

table

flagsOn

flagsOff

copyFlags

Returns: SalBoolean.

ParameterTypeDescription

table

flagsOn

flagsOff

copyFlags

csvText

Returns: SalBoolean.

ParameterTypeDescription

column

backColor

Returns: SalBoolean.

ParameterTypeDescription

column

userValue

Returns: SalBoolean.

ParameterTypeDescription

column

hFont

Returns: SalBoolean.

Returns the font associated with the specified table cell.

ParameterTypeDescription

column

Returns: Font.

ParameterTypeDescription

column

hImage

position

Returns: SalBoolean.

ParameterTypeDescription

column

position

Returns: Image.

ParameterTypeDescription

column

userValue

Returns: SalBoolean.

ParameterTypeDescription

column

hFont

Returns: SalBoolean.

Returns the font associated to the column header.

ParameterTypeDescription

column

Returns: Font.

ParameterTypeDescription

column

hImage

position

Returns: SalBoolean.

ParameterTypeDescription

column

backColor

Returns: SalBoolean.

ParameterTypeDescription

column

userValue

Returns: SalBoolean.

ParameterTypeDescription

column

hFont

Returns: SalBoolean.

Returns the font associated with the specified table column.

ParameterTypeDescription

column

Returns: Font.

ParameterTypeDescription

column

hImage

flags

Returns: SalBoolean.

ParameterTypeDescription

lParam

HDC

col

row

tag

left

top

right

bottom

Returns: SalBoolean.

ParameterTypeDescription

table

row

color

Returns: SalBoolean.

ParameterTypeDescription

table

row

userValue

Returns: SalBoolean.

ParameterTypeDescription

table

row

hFont

Returns: SalBoolean.

Returns the font used for the specified row.

ParameterTypeDescription

table

row

Returns: Font.

ParameterTypeDescription

table

row

hImage

flags

Returns: SalBoolean.

Pastes the CSV text from the clipboard.

ParameterTypeDescription

table

copyFlags

Returns: SalBoolean.

Pastes the specified CSV string into the table window control.

ParameterTypeDescription

table

flags

csvText

Returns: SalBoolean.

Sets the background color of an individual cell.

ParameterTypeDescription

column

backColor

Returns: SalBoolean.

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

ParameterTypeDescription

column

userValue

Returns: SalBoolean.

Sets the font for a single cell.

ParameterTypeDescription

column

font

Returns: SalBoolean.

Sets the font for a single cell.

ParameterTypeDescription

column

hFont

Returns: SalBoolean.

Sets the font for a single cell.

ParameterTypeDescription

column

fontName

fontSize

fontEnh

Returns: SalBoolean.

Assigns an image to a table cell.

ParameterTypeDescription

column

image

flags

Returns: SalBoolean.

Assigns an image to a table cell.

ParameterTypeDescription

column

hImage

flags

Returns: SalBoolean.

Assigns an image to a table cell.

ParameterTypeDescription

column

file

flags

Returns: SalBoolean.

Assigns an image to a table cell.

ParameterTypeDescription

column

name

flags

Returns: SalBoolean.

Assigns an image to a table cell.

ParameterTypeDescription

column

sImage

flags

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.

ParameterTypeDescription

lParam

left

top

right

bottom

Returns: SalBoolean.

Defines the column header as custom drawn.

ParameterTypeDescription

column

userValue

Returns: SalBoolean.

Assigns the specified font to the column header.

ParameterTypeDescription

column

font

Returns: SalBoolean.

Assigns the specified font to the column header.

ParameterTypeDescription

column

hFont

Returns: SalBoolean.

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

ParameterTypeDescription

column

fontName

fontSize

fontEnh

Returns: SalBoolean.

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

ParameterTypeDescription

column

image

flags

Returns: SalBoolean.

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

ParameterTypeDescription

column

hImage

flags

Returns: SalBoolean.

Assigns the image file to the specified column header.

ParameterTypeDescription

column

imageFile

flags

Returns: SalBoolean.

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

ParameterTypeDescription

column

resName

flags

Returns: SalBoolean.

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

ParameterTypeDescription

column

imageBlob

flags

Returns: SalBoolean.

Sets the background color for a table column.

ParameterTypeDescription

column

backColor

Returns: SalBoolean.

Enables custom drawing (SAM_DrawCell) for the specified column.

ParameterTypeDescription

column

userValue

Returns: SalBoolean.

Sets the font for a table column.

ParameterTypeDescription

column

font

Returns: SalBoolean.

Sets the font for a table column.

ParameterTypeDescription

column

hFont

Returns: SalBoolean.

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

ParameterTypeDescription

column

fontName

fontSize

fontEnh

Returns: SalBoolean.

Assigns an image to a table column.

ParameterTypeDescription

column

image

flags

Returns: SalBoolean.

Assigns an image to the column.

ParameterTypeDescription

column

hImage

flags

Returns: SalBoolean.

Assigns an image to the column.

ParameterTypeDescription

column

file

flags

Returns: SalBoolean.

Assigns an image to the column.

ParameterTypeDescription

column

name

flags

Returns: SalBoolean.

Assigns an image to the column.

ParameterTypeDescription

column

sImage

flags

Returns: SalBoolean.

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

ParameterTypeDescription

colDelimiter

rowDelimiter

Returns: SalBoolean.

Sets the background color of a row.

ParameterTypeDescription

table

row

color

Returns: SalBoolean.

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

ParameterTypeDescription

table

row

userValue

Returns: SalBoolean.

Sets the font for the entire row.

ParameterTypeDescription

table

row

font

Returns: SalBoolean.

Sets the font for the entire row.

ParameterTypeDescription

table

row

hFont

Returns: SalBoolean.

Sets the font for the entire row.

ParameterTypeDescription

table

row

fontName

fontSize

fontEnh

Returns: SalBoolean.

Sets the background color of the row header.

ParameterTypeDescription

table

row

color

Returns: SalBoolean.

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

ParameterTypeDescription

table

row

image

flags

Returns: SalBoolean.

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

ParameterTypeDescription

table

row

hImage

flags

Returns: SalBoolean.

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

ParameterTypeDescription

table

row

imageFile

flags

Returns: SalBoolean.

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

ParameterTypeDescription

table

row

resName

flags

Returns: SalBoolean.

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

ParameterTypeDescription

table

row

imageBlob

flags

Returns: SalBoolean.

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

ParameterTypeDescription

table

colID

flags

Returns: SalBoolean.

Creates the specified toolbox dialog.

ParameterTypeDescription

parent

name

position