XSal

PPJ.Runtime.XSal.XSal

Namespace: PPJ.Runtime.XSal

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

XSal functions.

public class XSal

Fields

Name
Type
Description

SAM_HotSpotClick

The form, dialog or MDI receive this message when the user clicks the left mouse button on the hotspot. wParam = HotSpot ID lParam = Mouse position

SAM_HotSpotMouseMove

The form, dialog or MDI receive this message when the user moves the mouse on the hotspot. wParam = HotSpot ID if the mouse is entering the hotspot or NULL if the mouse is leaving the hotspot. lParam = Mouse position

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 toolbars. 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 tooltip when the tooltip is destroyed.

SAM_TooltipSetText

Sent to the control under the mouse to show the tooltip.

Methods

GetClientWindow(form)

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

Parameter
Type
Description

Returns: SalWindowHandle.

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

Parameter
Type
Description

Returns: SalBoolean.

GZipClose(Param1)

Parameter
Type
Description

Returns: SalBoolean.

GZipEof(Param1)

BOOL XSalGZipEof( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalBoolean.

GZipFlush(Param1)

BOOL XSalGZipFlush( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalBoolean.

GZipGetChar(Param1)

CHAR XSalGZipGetStr( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalNumber.

GZipGetError(Param1, Param2)

Parameter
Type
Description

Returns: SalString.

GZipGetStr(Param1, Param2, Param3)

Parameter
Type
Description

Returns: SalNumber.

GZipOpen(Param1, Param2, Param3)

Parameter
Type
Description

Returns: SalBoolean.

GZipPutChar(Param1, Param2)

BOOL XSalGZipPutChar( gzFile p_File, CHAR p_cChar )

Parameter
Type
Description

Returns: SalBoolean.

GZipPutStr(Param1, Param2)

INT XSalGZipPutStr( gzFile p_File, LPSTR p_lpBufferOut )

Parameter
Type
Description

Param1

Param2

Returns: SalNumber.

GZipRead(Param1, Param2, Param3)

Parameter
Type
Description

Returns: SalNumber.

GZipRewind(Param1)

BOOL XSalGZipRewind( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalBoolean.

GZipSeek(Param1, Param2, Param3)

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

Parameter
Type
Description

Param1

Param2

Param3

Returns: SalNumber.

GZipTell(Param1)

LONG XSalGZipTell( gzFile p_File )

Parameter
Type
Description

Param1

Returns: SalNumber.

GZipWrite(Param1, Param2, Param3)

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

Parameter
Type
Description

Param1

Param2

Param3

Returns: SalNumber.

ScriptAddLine(handle, line)

Adds a line to the script and recompiles.

Parameter
Type
Description

Returns: SalBoolean.

ScriptCreate(source)

Creates and compiles the script.

Parameter
Type
Description

source

Returns: SalNumber.

ScriptFree(handle)

Frees the script.

Parameter
Type
Description

handle

Returns: SalBoolean.

ScriptGetErrors(handle, errorsList)

Parameter
Type
Description

handle

errorsList

Returns: SalNumber.

ScriptGetLocalName(handle, localName, varName)

Deprecated: Not supported.

Parameter
Type
Description

handle

localName

varName

Returns: SalBoolean.

ScriptRun(handle, result)

Parameter
Type
Description

Returns: SalBoolean.

ScriptSetContext(handle, context)

Changes the execution context for the script object.

Parameter
Type
Description

handle

context

Returns: SalBoolean.

ScriptSetDebugMode(handle, debugOn)

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

Parameter
Type
Description

handle

debugOn

Returns: SalBoolean.

ScriptSetTimeout(handle, timeout)

Deprecated: Not supported. Not supported.

Parameter
Type
Description

handle

timeout

Returns: SalBoolean.

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

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

Parameter
Type
Description

ctrl

Target control on which to execute the call.

height

Returns: SalBoolean.

SetWindowImageFile(ctrl, fileName, flags)

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

Parameter
Type
Description

ctrl

Target control on which to execute the call.

fileName

Returns: SalBoolean.

SplitGetBarPosition(split)

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

Parameter
Type
Description

Returns: SalNumber.

SplitGetFrameChild(split, frame)

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

Parameter
Type
Description

Returns: SalWindowHandle.

SplitGetStyle(split)

Returns the styles of the splitter.

Parameter
Type
Description

Returns: SplitterStyles.

SplitSetBarPosition(split, pos)

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

Parameter
Type
Description

Returns: SalBoolean.

SplitSetBarSize(split, size)

Sets the size of the splitter.

Parameter
Type
Description

Returns: SalBoolean.

SplitSetFrameChild(split, child, frame)

Associates the child control to the splitter's frames.

Parameter
Type
Description

Returns: SalBoolean.

SplitSetMinMax(split, min, max)

Sets the minimum and maximum positions for the splitter.

Parameter
Type
Description

Returns: SalBoolean.

SplitSetStyle(split, Style, on)

Sets the style of the splitter.

Parameter
Type
Description

Returns: SalBoolean.

StrAny(text, chars)

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

Parameter
Type
Description

Returns: SalNumber.

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

Compares a substring in a string.

Parameter
Type
Description

source

compare

caseSensitive

Returns: SalBoolean.

StrCompress(sIn, nLevel, sOut)

Parameter
Type
Description

Returns: SalBoolean.

StrCount(sText, sSearch, nStart, nLength, bLeft)

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

Parameter
Type
Description

Returns: SalNumber.

StrFormat(text, mask)

Formats a string using a string mask.

Parameter
Type
Description

Returns: SalString.

StrFormatDateTime(date, format, language)

Parameter
Type
Description

Returns: SalString.

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

Parameter
Type
Description

format

shortDays

months

shortMonths

Returns: SalString.

StrFromHex(hex)

Converts an hexadecimal text into a string.

Parameter
Type
Description

Returns: SalString.

StrGetCharAt(text, index)

Returns the character at the indicated position.

Parameter
Type
Description

Returns: SalNumber.

StrGetFirstToken(list, separators)

Parameter
Type
Description

separators

Returns: SalString.

StrGetNextToken()

Returns the next token string in a list.

Returns: SalString.

StrMetaphone(text)

Parameter
Type
Description

Returns: SalString.

StrNAny(text, chars)

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

Parameter
Type
Description

Returns: SalNumber.

StrScan(sText, search, nIndex)

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

Parameter
Type
Description

Returns: SalNumber.

StrScanR(sText, search, nIndex)

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

Parameter
Type
Description

Returns: SalNumber.

StrSetCharAt(text, index, character)

Parameter
Type
Description

Returns: SalNumber.

StrToHex(text)

Converts a string to an hexadecimal text.

Parameter
Type
Description

Returns: SalString.

StrToNumber(text)

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

Parameter
Type
Description

Returns: SalNumber.

StrUncompress(sIn, sOut)

Parameter
Type
Description

Returns: SalBoolean.

TblCopyRows(table, flagsOn, flagsOff, copyFlags)

Copies the matching rows to the clipboard.

Parameter
Type
Description

Returns: SalBoolean.

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

Parameter
Type
Description

Returns: SalBoolean.

TblGetCellBackColor(column, color)

Parameter
Type
Description

Returns: SalBoolean.

TblGetCellBackColor(column)

Returns the background color set for a single cell.

Parameter
Type
Description

column

Returns: Color.

TblGetCellFont(column)

Returns the font associated with the specified table cell.

Parameter
Type
Description

column

Returns: Font.

TblGetCellImage(column, position)

Parameter
Type
Description

Returns: Image.

TblGetColHeaderFont(column)

Returns the font associated to the column header.

Parameter
Type
Description

column

Returns: Font.

TblGetColHeaderImage(column, image, position)

Parameter
Type
Description

Returns: SalBoolean.

TblGetColumnBackColor(column, color)

Parameter
Type
Description

Returns: SalBoolean.

TblGetColumnBackColor(column)

Returns the background color set for a table column.

Parameter
Type
Description

column

Returns: Color.

TblGetColumnFont(column)

Returns the font associated with the specified table column.

Parameter
Type
Description

column

Returns: Font.

TblGetRowBackColor(table, row, color)

Parameter
Type
Description

Returns: SalBoolean.

TblGetRowBackColor(table, row)

Returns the background color of the specified row.

Parameter
Type
Description

Returns: Color.

TblGetRowFont(table, nRow)

Returns the font used for the specified row.

Parameter
Type
Description

Returns: Font.

TblGetRowHeaderBackColor(table, row, color)

Parameter
Type
Description

Returns: SalBoolean.

TblGetRowHeaderBackColor(table, row)

Returns the background color of the specified row.

Parameter
Type
Description

Returns: Color.

TblPasteRows(table, copyFlags)

Pastes the CSV text from the clipboard.

Parameter
Type
Description

Returns: SalBoolean.

TblPasteRowsFromString(table, flags, csvText)

Pastes the specified CSV string into the table window control.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellBackColor(column, color)

Sets the background color of an individual cell.

Parameter
Type
Description

column

Target control on which to execute the call.

Returns: SalBoolean.

TblSetCellBackColor(column, color)

Sets the background color of an individual cell.

Parameter
Type
Description

column

Target control on which to execute the call.

color

Returns: SalBoolean.

TblSetCellFont(column, font)

Sets the font for a single cell.

Parameter
Type
Description

column

font

Returns: SalBoolean.

TblSetCellImage(column, image, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellImageFile(column, fileName, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellImageResource(column, name, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetCellImageString(column, imageBlob, flags)

Assigns an image to a table cell.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderFont(column, font)

Assigns the specified font to the column header.

Parameter
Type
Description

column

font

Returns: SalBoolean.

TblSetColHeaderFontName(column, fontName, fontSize, fontStyle)

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

Parameter
Type
Description

column

fontName

fontSize

fontStyle

Returns: SalBoolean.

TblSetColHeaderImage(column, image, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImage(column, hImage, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImageFile(column, fileName, flags)

Assigns the image file to the specified column header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImageResource(column, resName, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

TblSetColHeaderImageString(column, imageBlob, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnBackColor(column, color)

Sets the background color for a table column.

Parameter
Type
Description

column

Returns: SalBoolean.

TblSetColumnBackColor(column, color)

Sets the background color for a table column.

Parameter
Type
Description

column

color

Returns: SalBoolean.

TblSetColumnFont(column, font)

Sets the font for a table column.

Parameter
Type
Description

column

font

Returns: SalBoolean.

TblSetColumnFontName(column, fontName, fontSize, fontStyle)

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

Parameter
Type
Description

column

fontName

fontSize

fontStyle

Returns: SalBoolean.

TblSetColumnImage(column, image, flags)

Assigns an image to a table column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnImageFile(column, fileName, flags)

Assigns an image to the column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnImageResource(column, name, flags)

Assigns an image to the column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetColumnImageString(column, sImage, flags)

Assigns an image to the column.

Parameter
Type
Description

Returns: SalBoolean.

TblSetDelimiters(colDelimiter, rowDelimiter)

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

Parameter
Type
Description

colDelimiter

rowDelimiter

Returns: SalBoolean.

TblSetRowBackColor(table, row, color)

Sets the background color of a row.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowBackColor(table, row, color)

Sets the background color of a row.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowFont(table, row, font)

Sets the font for the entire row.

Parameter
Type
Description

Returns: SalBoolean.

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

Sets the font for the entire row.

Parameter
Type
Description

table

fontName

fontSize

fontStyle

Returns: SalBoolean.

TblSetRowHeaderBackColor(table, row, color)

Sets the background color of the row header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowHeaderBackColor(table, row, color)

Sets the background color of the row header.

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImage(table, row, image, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImageFile(table, row, fileName, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImageResource(table, row, resName, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

TblSetRowImageString(table, row, imageBlob, flags)

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

Parameter
Type
Description

Returns: SalBoolean.

ToolboxCreate(parent, name, position, flags)

Creates the specified toolbox dialog.

Parameter
Type
Description

Returns: SalWindowHandle.

ToolboxDestroy(parent, name)

Closes the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxGetPosition(parent, name)

Returns the position of the specified toolbox.

Parameter
Type
Description

Returns: ToolboxPositions.

ToolboxHide(parent, name)

Hides the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxHideAll(parent)

Hides all the toolboxes.

Parameter
Type
Description

parent

Returns: SalBoolean.

ToolboxIsVisible(parent, name)

Tests the visibility of the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxSetMetrics(value, type)

Sets metric values for the toolbars.

Parameter
Type
Description

value

Value to set.

Returns: SalBoolean.

ToolboxSetMetrics(type)

Returns metric values for the toolbars.

Parameter
Type
Description

Returns: SalNumber.

ToolboxSetPosition(parent, name, position)

Changes the position of the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxShow(parent, name)

Shows the specified toolbox.

Parameter
Type
Description

Returns: SalBoolean.

ToolboxShowAll(parent)

Shows all the toolboxes.

Parameter
Type
Description

parent

Returns: SalBoolean.

UdvArrayDelete(Array, index)

Removes an element from the array.

Parameter
Type
Description

Returns: SalBoolean.

UdvArrayInsert(Array, index)

Inserts a new element in the array.

Parameter
Type
Description

Returns: SalBoolean.

UdvArrayMove(Array, sourceIndex, targetIndex)

Moves the element to the target index in the array.

Parameter
Type
Description

sourceIndex

targetIndex

Returns: SalBoolean.

UdvArraySort(Array, fieldName, dataType, sortOrder)

Sorts the objects in the array using the value in the variable specified in sFieldName.

Parameter
Type
Description

fieldName

dataType

sortOrder

Returns: SalBoolean.

UdvArraySwap(Array, index1, index2)

Swaps two object items in an array.

Parameter
Type
Description

Returns: SalBoolean.

UdvClone(source, target)

Parameter
Type
Description

Returns: SalBoolean.

UdvFromString(obj, source)

Parameter
Type
Description

Returns: SalBoolean.

UdvToString(obj, target)

Parameter
Type
Description

Returns: SalBoolean.

ZipCloseArchive(zipFile)

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipCloseFile(zipFile)

Closes the currently open zip entry. It doesn't close the Zip archive, to close the archive you have to use XSalZipCloseArchive.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

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

Creates a file in the Zip archive and sets the newly created file as the currently open file.

Parameter
Type
Description

zipFile

fileName

comment

compressionLevel

Returns: SalBoolean.

ZipFindFile(zipFile, fileName)

Returms the zip entry that matches the specified name.

Parameter
Type
Description

zipFile

fileName

Returns: SalBoolean.

ZipFindFirstFile(zipFile)

Positions the current zip entry to the first file in the archive.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipFindNextFile(zipFile)

Positions the current zip entry to the next file in the archive.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

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

Parameter
Type
Description

zipFile

fileName

comment

compressedSize

uncompressedSize

Returns: SalBoolean.

ZipOpenArchive(zipFile, fileName, mode)

Parameter
Type
Description

zipFile

fileName

Returns: SalBoolean.

ZipOpenFile(zipFile)

Opens the current zip entry for reading in the Zip archive. It must be used after XSalZipFindFile or XSalZipFindFirstFile, or XSalZipFindNextFile.

Parameter
Type
Description

zipFile

Returns: SalBoolean.

ZipRead(zipFile, content, count)

Parameter
Type
Description

zipFile

content

Returns: SalNumber.

ZipWrite(zipFile, buffer, length)

Writes the buffer to the currently open zip entry in the zip file.

Parameter
Type
Description

zipFile

buffer

length

Returns: SalBoolean.

ZipWrite(zipFile, buffer, length)

Writes the buffer to the currently open zip entry in the zip file.

Parameter
Type
Description

zipFile

buffer

length

Returns: SalBoolean.

Last updated