XSal

PPJ.Runtime.XSal.XSal

Namespace: PPJ.Runtime.XSal

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

XSal functions.

public class XSal

Fields

NameTypeDescription

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

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

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 hotspot are on the windows background. If the hotspot dimensions are 0,0,0,0 the specified hotspot ID is removed.

ParameterTypeDescription

ctrl

Target control on which to execute the call.

id

x

y

width

height

Returns: SalBoolean.

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

ParameterTypeDescription

ctrl

Target control on which to execute the call.

fileName

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

sIn

nLevel

sOut

Returns: SalBoolean.

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

ParameterTypeDescription

sText

sSearch

nStart

nLength

bLeft

Returns: SalNumber.

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 an 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

sText

search

nIndex

Returns: SalNumber.

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

ParameterTypeDescription

sText

search

nIndex

Returns: SalNumber.

ParameterTypeDescription

text

index

character

Returns: SalNumber.

Converts a string to an hexadecimal text.

ParameterTypeDescription

text

Returns: SalString.

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

ParameterTypeDescription

text

Returns: SalNumber.

ParameterTypeDescription

sIn

sOut

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

color

Returns: SalBoolean.

Returns the background color set for a single cell.

ParameterTypeDescription

column

Returns: Color.

Returns the font associated with the specified table cell.

ParameterTypeDescription

column

Returns: Font.

ParameterTypeDescription

column

position

Returns: Image.

Returns the font associated to the column header.

ParameterTypeDescription

column

Returns: Font.

ParameterTypeDescription

column

image

position

Returns: SalBoolean.

ParameterTypeDescription

column

color

Returns: SalBoolean.

Returns the background color set for a table column.

ParameterTypeDescription

column

Returns: Color.

Returns the font associated with the specified table column.

ParameterTypeDescription

column

Returns: Font.

ParameterTypeDescription

table

row

color

Returns: SalBoolean.

Returns the background color of the specified row.

ParameterTypeDescription

table

row

Returns: Color.

Returns the font used for the specified row.

ParameterTypeDescription

table

nRow

Returns: Font.

ParameterTypeDescription

table

row

color

Returns: SalBoolean.

Returns the background color of the specified row.

ParameterTypeDescription

table

row

Returns: Color.

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

Target control on which to execute the call.

color

Returns: SalBoolean.

Sets the background color of an individual cell.

ParameterTypeDescription

column

Target control on which to execute the call.

color

Returns: SalBoolean.

Sets the font for a single cell.

ParameterTypeDescription

column

font

Returns: SalBoolean.

Assigns an image to a table cell.

ParameterTypeDescription

column

image

flags

Returns: SalBoolean.

Assigns an image to a table cell.

ParameterTypeDescription

column

fileName

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

imageBlob

flags

Returns: SalBoolean.

Assigns the specified font to the column header.

ParameterTypeDescription

column

font

Returns: SalBoolean.

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

ParameterTypeDescription

column

fontName

fontSize

fontStyle

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

fileName

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

color

Returns: SalBoolean.

Sets the background color for a table column.

ParameterTypeDescription

column

color

Returns: SalBoolean.

Sets the font for a table column.

ParameterTypeDescription

column

font

Returns: SalBoolean.

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

ParameterTypeDescription

column

fontName

fontSize

fontStyle

Returns: SalBoolean.

Assigns an image to a table column.

ParameterTypeDescription

column

image

flags

Returns: SalBoolean.

Assigns an image to the column.

ParameterTypeDescription

column

fileName

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.

Sets the background color of a row.

ParameterTypeDescription

table

row

color

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

fontName

fontSize

fontStyle

Returns: SalBoolean.

Sets the background color of the row header.

ParameterTypeDescription

table

row

color

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

fileName

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.

Creates the specified toolbox dialog.

ParameterTypeDescription

parent

name

position

flags

Returns: SalWindowHandle.

Closes the specified toolbox.

ParameterTypeDescription

parent

name

Returns: SalBoolean.

Returns the position of the specified toolbox.

ParameterTypeDescription

parent

name

Returns: ToolboxPositions.

Hides the specified toolbox.

ParameterTypeDescription

parent

name

Returns: SalBoolean.

Hides all the toolboxes.

ParameterTypeDescription

parent

Returns: SalBoolean.

Tests the visibility of the specified toolbox.

ParameterTypeDescription

parent

name

Returns: SalBoolean.

Sets metric values for the toolbars.

ParameterTypeDescription

value

Value to set.

type

ToolbarMetrics to change.

Returns: SalBoolean.

Returns metric values for the toolbars.

ParameterTypeDescription

type

ToolbarMetrics to return.

Returns: SalNumber.

Changes the position of the specified toolbox.

ParameterTypeDescription

parent

name

position

Returns: SalBoolean.

Shows the specified toolbox.

ParameterTypeDescription

parent

name

Returns: SalBoolean.

Shows all the toolboxes.

ParameterTypeDescription

parent

Returns: SalBoolean.

Removes an element from the array.

ParameterTypeDescription

Array

index

Returns: SalBoolean.

Inserts a new element in the array.

ParameterTypeDescription

Array

index

Returns: SalBoolean.

Moves the element to the target index in the array.

ParameterTypeDescription

Array

sourceIndex

targetIndex

Returns: SalBoolean.

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

ParameterTypeDescription

Array

fieldName

dataType

sortOrder

Returns: SalBoolean.

Swaps two object items in an array.

ParameterTypeDescription

Array

index1

index2

Returns: SalBoolean.

ParameterTypeDescription

source

target

Returns: SalBoolean.

ParameterTypeDescription

obj

source

Returns: SalBoolean.

ParameterTypeDescription

obj

target

Returns: SalBoolean.

ParameterTypeDescription

zipFile

Returns: SalBoolean.

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

ParameterTypeDescription

zipFile

Returns: SalBoolean.

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

ParameterTypeDescription

zipFile

fileName

date

comment

compressionLevel

Returns: SalBoolean.

Returms the zip entry that matches the specified name.

ParameterTypeDescription

zipFile

fileName

Returns: SalBoolean.

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

ParameterTypeDescription

zipFile

Returns: SalBoolean.

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

ParameterTypeDescription

zipFile

Returns: SalBoolean.

ParameterTypeDescription

zipFile

fileName

comment

date

compressedSize

uncompressedSize

Returns: SalBoolean.

ParameterTypeDescription

zipFile

fileName

mode

Returns: SalBoolean.

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

ParameterTypeDescription

zipFile

Returns: SalBoolean.

ParameterTypeDescription

zipFile

content

count

Returns: SalNumber.

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

ParameterTypeDescription

zipFile

buffer

length

Returns: SalBoolean.

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

ParameterTypeDescription

zipFile

buffer

length

Returns: SalBoolean.

Last updated