XSal
Namespace: PPJ.Runtime.XSal
Assembly: PPJ.Web.XSal.49 (4.9.0.0)
XSal functions.
- C#
- VB.NET
public class XSal
Public Class XSal
Fields
| Name | Type | Description |
|---|---|---|
| SAM_HotSpotClick | Int32 | 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 | Int32 | 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 | 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 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 | Int32 | Sent to the control with the tooltip when the tooltip is destroyed. |
| SAM_TooltipSetText | Int32 | 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 |
|---|---|---|
| form | Control |
Returns: SalWindowHandle.
GetWindowHotSpot(ctrl, id, x, y, width, height)
| Parameter | Type | Description |
|---|---|---|
| ctrl | Control | |
| id | SalNumber | |
| x | SalNumber& | |
| y | SalNumber& | |
| width | SalNumber& | |
| height | SalNumber& |
Returns: SalBoolean.
GZipClose(Param1)
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber& |
Returns: SalBoolean.
GZipEof(Param1)
BOOL XSalGZipEof( gzFile p_File )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber |
Returns: SalBoolean.
GZipFlush(Param1)
BOOL XSalGZipFlush( gzFile p_File )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber |
Returns: SalBoolean.
GZipGetChar(Param1)
CHAR XSalGZipGetStr( gzFile p_File )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber |
Returns: SalNumber.
GZipGetError(Param1, Param2)
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber | |
| Param2 | SalNumber& |
Returns: SalString.
GZipGetStr(Param1, Param2, Param3)
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber | |
| Param2 | SalString& | |
| Param3 | SalNumber |
Returns: SalNumber.
GZipOpen(Param1, Param2, Param3)
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber& | |
| Param2 | SalString | |
| Param3 | SalString |
Returns: SalBoolean.
GZipPutChar(Param1, Param2)
BOOL XSalGZipPutChar( gzFile p_File, CHAR p_cChar )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalFileHandle | |
| Param2 | SalNumber |
Returns: SalBoolean.
GZipPutStr(Param1, Param2)
INT XSalGZipPutStr( gzFile p_File, LPSTR p_lpBufferOut )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber | |
| Param2 | SalString |
Returns: SalNumber.
GZipRead(Param1, Param2, Param3)
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber | |
| Param2 | SalString& | |
| Param3 | SalNumber |
Returns: SalNumber.
GZipRewind(Param1)
BOOL XSalGZipRewind( gzFile p_File )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber |
Returns: SalBoolean.
GZipSeek(Param1, Param2, Param3)
LONG XSalGZipSeek( gzFile p_File, LONG p_lOffset, INT p_iWhence )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber | |
| Param2 | SalNumber | |
| Param3 | SalNumber |
Returns: SalNumber.
GZipTell(Param1)
LONG XSalGZipTell( gzFile p_File )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber |
Returns: SalNumber.
GZipWrite(Param1, Param2, Param3)
LONG XSalGZipWrite( gzFile p_File, LPVOID p_lpBufferOut, LONG p_lSize )
| Parameter | Type | Description |
|---|---|---|
| Param1 | SalNumber | |
| Param2 | SalString | |
| Param3 | SalNumber |
Returns: SalNumber.
ScriptAddLine(handle, line)
Adds a line to the script and recompiles.
| Parameter | Type | Description |
|---|---|---|
| handle | SalNumber | |
| line | SalString |
Returns: SalBoolean.
ScriptCreate(source)
Creates and compiles the script.
| Parameter | Type | Description |
|---|---|---|
| source | SalString |
Returns: SalNumber.
ScriptFree(handle)
Frees the script.
| Parameter | Type | Description |
|---|---|---|
| handle | SalNumber |
Returns: SalBoolean.
ScriptGetErrors(handle, errorsList)
| Parameter | Type | Description |
|---|---|---|
| handle | SalNumber | |
| errorsList | SalString& |
Returns: SalNumber.
ScriptGetLocalName(handle, localName, varName)
Deprecated: Not supported.
| Parameter | Type | Description |
|---|---|---|
| handle | SalNumber | |
| localName | SalString | |
| varName | SalString& |
Returns: SalBoolean.
ScriptRun(handle, result)
| Parameter | Type | Description |
|---|---|---|
| handle | SalNumber | |
| result | SalString& |
Returns: SalBoolean.
ScriptSetContext(handle, context)
Changes the execution context for the script object.
| Parameter | Type | Description |
|---|---|---|
| handle | SalNumber | |
| context | Object |
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 | SalNumber | |
| debugOn | SalBoolean |
Returns: SalBoolean.
ScriptSetTimeout(handle, timeout)
Deprecated: Not supported.
Not supported.
| Parameter | Type | Description |
|---|---|---|
| handle | SalNumber | |
| timeout | SalNumber |
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 | Control | Target control on which to execute the call. |
| id | SalNumber | |
| x | SalNumber | |
| y | SalNumber | |
| width | SalNumber | |
| height | SalNumber |
Returns: SalBoolean.
SetWindowImageFile(ctrl, fileName, flags)
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. |
| fileName | SalString | |
| flags | BackgroundImageFlags |
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 |
|---|---|---|
| split | SalWindowHandle |
Returns: SalNumber.
SplitGetFrameChild(split, frame)
Returns the child control associated to the splitter's frames.
| Parameter | Type | Description |
|---|---|---|
| split | SalWindowHandle | |
| frame | SalNumber |
Returns: SalWindowHandle.
SplitGetStyle(split)
Returns the styles of the splitter.
| Parameter | Type | Description |
|---|---|---|
| split | SalWindowHandle |
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 |
|---|---|---|
| split | SalWindowHandle | |
| pos | SalNumber |
Returns: SalBoolean.
SplitSetBarSize(split, size)
Sets the size of the splitter.
| Parameter | Type | Description |
|---|---|---|
| split | SalWindowHandle | |
| size | SalNumber |
Returns: SalBoolean.
SplitSetFrameChild(split, child, frame)
Associates the child control to the splitter's frames.
| Parameter | Type | Description |
|---|---|---|
| split | SalWindowHandle | |
| child | SalWindowHandle | |
| frame | SalNumber |
Returns: SalBoolean.
SplitSetMinMax(split, min, max)
Sets the minimum and maximum positions for the splitter.
| Parameter | Type | Description |
|---|---|---|
| split | SalWindowHandle | |
| min | SalNumber | |
| max | SalNumber |
Returns: SalBoolean.
SplitSetStyle(split, Style, on)
Sets the style of the splitter.
| Parameter | Type | Description |
|---|---|---|
| split | SalWindowHandle | |
| Style | SplitterStyles | |
| on | SalBoolean |
Returns: SalBoolean.
StrAny(text, chars)
Finds the first character in the string that appears in a given character set.
| Parameter | Type | Description |
|---|---|---|
| text | SalString | |
| chars | SalString |
Returns: SalNumber.
StrCompare(source, compare, start, size, caseSensitive)
Compares a substring in a string.
| Parameter | Type | Description |
|---|---|---|
| source | SalString | |
| compare | SalString | |
| start | SalNumber | |
| size | SalNumber | |
| caseSensitive | SalBoolean |
Returns: SalBoolean.
StrCompress(sIn, nLevel, sOut)
| Parameter | Type | Description |
|---|---|---|
| sIn | SalString | |
| nLevel | SalNumber | |
| sOut | SalString& |
Returns: SalBoolean.
StrCount(sText, sSearch, nStart, nLength, bLeft)
Counts the number of times a substring appears in a string.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | |
| sSearch | SalString | |
| nStart | SalNumber | |
| nLength | SalNumber | |
| bLeft | SalBoolean |
Returns: SalNumber.
StrFormat(text, mask)
Formats a string using a string mask.
| Parameter | Type | Description |
|---|---|---|
| text | SalString | |
| mask | SalString |
Returns: SalString.
StrFormatDateTime(date, format, language)
| Parameter | Type | Description |
|---|---|---|
| date | SalDateTime | |
| format | SalString | |
| language | SalString |
Returns: SalString.
StrFormatDateTimeX(date, format, days, shortDays, months, shortMonths)
| Parameter | Type | Description |
|---|---|---|
| date | SalDateTime | |
| format | SalString | |
| days | SalString | |
| shortDays | SalString | |
| months | SalString | |
| shortMonths | SalString |
Returns: SalString.
StrFromHex(hex)
Converts an hexadecimal text into a string.
| Parameter | Type | Description |
|---|---|---|
| hex | SalString |
Returns: SalString.
StrGetCharAt(text, index)
Returns the character at the indicated position.
| Parameter | Type | Description |
|---|---|---|
| text | SalString | |
| index | SalNumber |
Returns: SalNumber.
StrGetFirstToken(list, separators)
| Parameter | Type | Description |
|---|---|---|
| list | SalString | |
| separators | SalString |
Returns: SalString.
StrGetNextToken()
Returns the next token string in a list.
Returns: SalString.
StrMetaphone(text)
| Parameter | Type | Description |
|---|---|---|
| text | SalString |
Returns: SalString.
StrNAny(text, chars)
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.
StrScan(sText, search, nIndex)
Searches for a substring in the source string starting from the specified index.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | |
| search | SalString | |
| nIndex | SalNumber |
Returns: SalNumber.
StrScanR(sText, search, nIndex)
Searches for a substring in the source string starting from the specified index.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | |
| search | SalString | |
| nIndex | SalNumber |
Returns: SalNumber.
StrSetCharAt(text, index, character)
| Parameter | Type | Description |
|---|---|---|
| text | SalString& | |
| index | SalNumber | |
| character | SalNumber |
Returns: SalNumber.
StrToHex(text)
Converts a string to an hexadecimal text.
| Parameter | Type | Description |
|---|---|---|
| text | SalString |
Returns: SalString.
StrToNumber(text)
Converts a string to a number, regardless of the decimal point.
| Parameter | Type | Description |
|---|---|---|
| text | SalString |
Returns: SalNumber.
StrUncompress(sIn, sOut)
| Parameter | Type | Description |
|---|---|---|
| sIn | SalString | |
| sOut | SalString& |
Returns: SalBoolean.
TblCopyRows(table, flagsOn, flagsOff, copyFlags)
Copies the matching rows to the clipboard.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| flagsOn | SalNumber | |
| flagsOff | SalNumber | |
| copyFlags | TableWindowClipboardFlags |
Returns: SalBoolean.
TblCopyRowsToString(table, flagsOn, flagsOff, copyFlags, csvText)
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| flagsOn | SalNumber | |
| flagsOff | SalNumber | |
| copyFlags | TableWindowClipboardFlags | |
| csvText | SalString& |
Returns: SalBoolean.
TblGetCellBackColor(column, color)
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| color | SalNumber& |
Returns: SalBoolean.
TblGetCellBackColor(column)
Returns the background color set for a single cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control |
Returns: Color.
TblGetCellFont(column)
Returns the font associated with the specified table cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control |
Returns: Font.
TblGetCellImage(column, position)
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| position | TableWindowImageFlags& |
Returns: Image.
TblGetColHeaderFont(column)
Returns the font associated to the column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control |
Returns: Font.
TblGetColHeaderImage(column, image, position)
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| image | SalNumber& | |
| position | TableWindowImageFlags& |
Returns: SalBoolean.
TblGetColumnBackColor(column, color)
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| color | SalNumber& |
Returns: SalBoolean.
TblGetColumnBackColor(column)
Returns the background color set for a table column.
| Parameter | Type | Description |
|---|---|---|
| column | Control |
Returns: Color.
TblGetColumnFont(column)
Returns the font associated with the specified table column.
| Parameter | Type | Description |
|---|---|---|
| column | Control |
Returns: Font.
TblGetRowBackColor(table, row, color)
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| color | SalNumber& |
Returns: SalBoolean.
TblGetRowBackColor(table, row)
Returns the background color of the specified row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber |
Returns: Color.
TblGetRowFont(table, nRow)
Returns the font used for the specified row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| nRow | SalNumber |
Returns: Font.
TblGetRowHeaderBackColor(table, row, color)
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| color | SalNumber& |
Returns: SalBoolean.
TblGetRowHeaderBackColor(table, row)
Returns the background color of the specified row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber |
Returns: Color.
TblPasteRows(table, copyFlags)
Pastes the CSV text from the clipboard.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| copyFlags | TableWindowClipboardFlags |
Returns: SalBoolean.
TblPasteRowsFromString(table, flags, csvText)
Pastes the specified CSV string into the table window control.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| flags | TableWindowClipboardFlags | |
| csvText | SalString |
Returns: SalBoolean.
TblSetCellBackColor(column, color)
Sets the background color of an individual cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control | Target control on which to execute the call. |
| color | SalNumber |
Returns: SalBoolean.
TblSetCellBackColor(column, color)
Sets the background color of an individual cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control | Target control on which to execute the call. |
| color | Color |
Returns: SalBoolean.
TblSetCellFont(column, font)
Sets the font for a single cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| font | Font |
Returns: SalBoolean.
TblSetCellImage(column, image, flags)
Assigns an image to a table cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| image | Image | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetCellImageFile(column, fileName, flags)
Assigns an image to a table cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| fileName | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetCellImageResource(column, name, flags)
Assigns an image to a table cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| name | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetCellImageString(column, imageBlob, flags)
Assigns an image to a table cell.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| imageBlob | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColHeaderFont(column, font)
Assigns the specified font to the column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| font | Font |
Returns: SalBoolean.
TblSetColHeaderFontName(column, fontName, fontSize, fontStyle)
Creates the specified font and assigns it to the column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| fontName | SalString | |
| fontSize | SalNumber | |
| fontStyle | SalNumber |
Returns: SalBoolean.
TblSetColHeaderImage(column, image, flags)
Assigns the image from the handle to the specified column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| image | Image | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColHeaderImage(column, hImage, flags)
Assigns the image from the handle to the specified column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| hImage | SalNumber | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColHeaderImageFile(column, fileName, flags)
Assigns the image file to the specified column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| fileName | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColHeaderImageResource(column, resName, flags)
Assigns the image from the specified resource object to the column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| resName | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColHeaderImageString(column, imageBlob, flags)
Assigns the image from the blob string to the specified column header.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| imageBlob | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColumnBackColor(column, color)
Sets the background color for a table column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| color | SalNumber |
Returns: SalBoolean.
TblSetColumnBackColor(column, color)
Sets the background color for a table column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| color | Color |
Returns: SalBoolean.
TblSetColumnFont(column, font)
Sets the font for a table column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| font | 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 | Control | |
| fontName | SalString | |
| fontSize | SalNumber | |
| fontStyle | SalNumber |
Returns: SalBoolean.
TblSetColumnImage(column, image, flags)
Assigns an image to a table column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| image | Image | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColumnImageFile(column, fileName, flags)
Assigns an image to the column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| fileName | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColumnImageResource(column, name, flags)
Assigns an image to the column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| name | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetColumnImageString(column, sImage, flags)
Assigns an image to the column.
| Parameter | Type | Description |
|---|---|---|
| column | Control | |
| sImage | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetDelimiters(colDelimiter, rowDelimiter)
Changes the standard column and row delimiters for the copy/paste operations.
| Parameter | Type | Description |
|---|---|---|
| colDelimiter | SalString | |
| rowDelimiter | SalString |
Returns: SalBoolean.
TblSetRowBackColor(table, row, color)
Sets the background color of a row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| color | SalNumber |
Returns: SalBoolean.
TblSetRowBackColor(table, row, color)
Sets the background color of a row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| color | Color |
Returns: SalBoolean.
TblSetRowFont(table, row, font)
Sets the font for the entire row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| font | Font |
Returns: SalBoolean.
TblSetRowFontName(table, row, fontName, fontSize, fontStyle)
Sets the font for the entire row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| fontName | SalString | |
| fontSize | SalNumber | |
| fontStyle | SalNumber |
Returns: SalBoolean.
TblSetRowHeaderBackColor(table, row, color)
Sets the background color of the row header.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| color | SalNumber |
Returns: SalBoolean.
TblSetRowHeaderBackColor(table, row, color)
Sets the background color of the row header.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| color | Color |
Returns: SalBoolean.
TblSetRowImage(table, row, image, flags)
Assigns an image to all the cells in the specified row,
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| image | Image | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetRowImageFile(table, row, fileName, flags)
Assigns an image to all the cells in the specified row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| fileName | SalString | |
| flags | TableWindowImageFlags |
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 |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| resName | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
TblSetRowImageString(table, row, imageBlob, flags)
Assigns an image to all the cells in the specified row.
| Parameter | Type | Description |
|---|---|---|
| table | Control | |
| row | SalNumber | |
| imageBlob | SalString | |
| flags | TableWindowImageFlags |
Returns: SalBoolean.
ToolboxCreate(parent, name, position, flags)
Creates the specified toolbox dialog.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| name | SalString | |
| position | ToolboxPositions | |
| flags | ToolboxFlags |
Returns: SalWindowHandle.
ToolboxDestroy(parent, name)
Closes the specified toolbox.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| name | SalString |
Returns: SalBoolean.
ToolboxGetPosition(parent, name)
Returns the position of the specified toolbox.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| name | SalString |
Returns: ToolboxPositions.
ToolboxHide(parent, name)
Hides the specified toolbox.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| name | SalString |
Returns: SalBoolean.
ToolboxHideAll(parent)
Hides all the toolboxes.
| Parameter | Type | Description |
|---|---|---|
| parent | Control |
Returns: SalBoolean.
ToolboxIsVisible(parent, name)
Tests the visibility of the specified toolbox.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| name | SalString |
Returns: SalBoolean.
ToolboxSetMetrics(value, type)
Sets metric values for the toolbars.
| Parameter | Type | Description |
|---|---|---|
| value | SalNumber | Value to set. |
| type | ToolbarMetrics | ToolbarMetrics to change. |
Returns: SalBoolean.
ToolboxSetMetrics(type)
Returns metric values for the toolbars.
| Parameter | Type | Description |
|---|---|---|
| type | ToolbarMetrics | ToolbarMetrics to return. |
Returns: SalNumber.
ToolboxSetPosition(parent, name, position)
Changes the position of the specified toolbox.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| name | SalString | |
| position | ToolboxPositions |
Returns: SalBoolean.
ToolboxShow(parent, name)
Shows the specified toolbox.
| Parameter | Type | Description |
|---|---|---|
| parent | Control | |
| name | SalString |
Returns: SalBoolean.
ToolboxShowAll(parent)
Shows all the toolboxes.
| Parameter | Type | Description |
|---|---|---|
| parent | Control |
Returns: SalBoolean.
UdvArrayDelete(Array, index)
Removes an element from the array.
| Parameter | Type | Description |
|---|---|---|
| Array | SalArray | |
| index | SalNumber |
Returns: SalBoolean.
UdvArrayInsert(Array, index)
Inserts a new element in the array.
| Parameter | Type | Description |
|---|---|---|
| Array | SalArray | |
| index | SalNumber |
Returns: SalBoolean.
UdvArrayMove(Array, sourceIndex, targetIndex)
Moves the element to the target index in the array.
| Parameter | Type | Description |
|---|---|---|
| Array | SalArray | |
| sourceIndex | SalNumber | |
| targetIndex | SalNumber |
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 |
|---|---|---|
| Array | SalArray | |
| fieldName | SalString | |
| dataType | SalNumber | |
| sortOrder | SalNumber |
Returns: SalBoolean.
UdvArraySwap(Array, index1, index2)
Swaps two object items in an array.
| Parameter | Type | Description |
|---|---|---|
| Array | SalArray | |
| index1 | SalNumber | |
| index2 | SalNumber |
Returns: SalBoolean.
UdvClone(source, target)
| Parameter | Type | Description |
|---|---|---|
| source | SalFunctionalClass | |
| target | SalFunctionalClass& |
Returns: SalBoolean.
UdvFromString(obj, source)
| Parameter | Type | Description |
|---|---|---|
| obj | SalFunctionalClass& | |
| source | SalString |
Returns: SalBoolean.
UdvToString(obj, target)
| Parameter | Type | Description |
|---|---|---|
| obj | SalFunctionalClass | |
| target | SalString& |
Returns: SalBoolean.
ZipCloseArchive(zipFile)
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber& |
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 | SalNumber |
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 | SalNumber | |
| fileName | SalString | |
| date | SalDateTime | |
| comment | SalString | |
| compressionLevel | SalNumber |
Returns: SalBoolean.
ZipFindFile(zipFile, fileName)
Returms the zip entry that matches the specified name.
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber | |
| fileName | SalString |
Returns: SalBoolean.
ZipFindFirstFile(zipFile)
Positions the current zip entry to the first file in the archive.
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber |
Returns: SalBoolean.
ZipFindNextFile(zipFile)
Positions the current zip entry to the next file in the archive.
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber |
Returns: SalBoolean.
ZipGetFileInfo(zipFile, fileName, comment, date, compressedSize, uncompressedSize)
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber | |
| fileName | SalString& | |
| comment | SalString& | |
| date | SalDateTime& | |
| compressedSize | SalNumber& | |
| uncompressedSize | SalNumber& |
Returns: SalBoolean.
ZipOpenArchive(zipFile, fileName, mode)
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber& | |
| fileName | SalString | |
| mode | SalNumber |
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 | SalNumber |
Returns: SalBoolean.
ZipRead(zipFile, content, count)
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber | |
| content | SalString& | |
| count | SalNumber |
Returns: SalNumber.
ZipWrite(zipFile, buffer, length)
Writes the buffer to the currently open zip entry in the zip file.
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber | |
| buffer | SalString | |
| length | SalNumber |
Returns: SalBoolean.
ZipWrite(zipFile, buffer, length)
Writes the buffer to the currently open zip entry in the zip file.
| Parameter | Type | Description |
|---|---|---|
| zipFile | SalNumber | |
| buffer | Byte[] | |
| length | SalNumber |
Returns: SalBoolean.