SalPicture
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Web.50 (5.0.0.0)
Displays an image with SAL resource loading, image conversion, and window actions.
- C#
- VB.NET
public class SalPicture : PictureBox, ISalWindow, ISalPictureControl, ISalControl
Public Class SalPicture
Inherits PictureBox
Implements ISalWindow, ISalPictureControl, ISalControl
Example:
using PPJ.Runtime.Windows;
var picture = new SalPicture();
picture.ImageSource = "images/logo.png";
Constructors
SalPicture()
Initializes a picture with centered image placement and tab navigation disabled.
Properties
Image
Image: Gets or sets the image displayed by the control.
Assigning a different non-null image clears ImageName and the browser ImageSource. Assigning null also clears ImageSource.
ImageName
String: Gets or sets the resource name or external path of the displayed image. (Default: "")
Null is normalized to an empty string. A nonempty changed value reloads the image according to ImageStorage; an empty value clears the image.
ImageSource
String: Gets or sets a theme image name or image URL. (Default: null)
Assigning a different, nonempty source clears the assigned image and embedded-resource name.
ImageStorage
ImageStorage: Gets or sets the image-name resolution mode.
Changing the mode reloads the current ImageName using the calling assembly for resource lookup.
Label
Control: Gets or sets the label associated with this control through its containing SAL form.
NamedProperties
SalNamedProperties: Gets this window's SAL named-property collection.
Methods
BringWindowToTop()
Brings this control to the front, or activates it when it is a top-level or MDI form.
Returns: SalBoolean. True if the translated control exists and is not disposed; otherwise, false.
CenterWindow()
Centers this window within its parent, owner, or available screen area.
Returns: SalBoolean. True if the centering operation is accepted; false for an unavailable control, design mode, or unavailable screen bounds.
Clear()
Clears editable text or selection according to the control type.
Returns: SalBoolean. False for an unavailable control or a form; otherwise, true.
Text fields and labels are emptied; check boxes are unchecked; list selections are cleared. Other control types are left unchanged.
ClearCursor(nType)
Restores the default cursor for the requested role.
| Parameter | Type | Description |
|---|---|---|
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.
ClearImage()
Removes the image assigned to this picture-capable control.
Returns: SalBoolean. True if the translated control supports images; otherwise, false.
DestroyWindow()
Closes this window when it is a form, or disposes the control.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
A true result reports that the close or disposal request was made; a form can apply its own closing behavior.
DisableWindow()
Disables input to this control, or clears editability for a table column.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
DisableWindowAndLabel()
Disables input to this control and disables its associated label.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Dispose(disposing)
Marks this SAL window disposed before releasing the base control resources.
| Parameter | Type | Description |
|---|---|---|
| disposing | Boolean | True to release managed resources; false for finalization cleanup. |
EnableWindow()
Enables input to this control, or enables editing for a table column.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
For text-box controls, this operation also clears the read-only setting.
EnableWindowAndLabel()
Enables input to this control and enables its associated label.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
FindChild(sWindowName)
Searches this window for a child control by name.
| Parameter | Type | Description |
|---|---|---|
| sWindowName | SalString | The child control name to locate. |
Returns: SalWindowHandle. The matching child handle, or a null SAL handle if no child is found.
FireWindowActions(nMsg, nMywParam, nMylParam)
Invokes the SAL action dispatch pipeline for this control.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | The SAL or application-defined message code. |
| nMywParam | SalNumber | The first message parameter. |
| nMylParam | SalNumber | The second message parameter. |
Returns: SalNumber. The return value in the dispatched action's event data.
FormUnitsToPixels(nFormUnits, bVertical)
Converts a length in form units to pixels using this control's form metrics.
| Parameter | Type | Description |
|---|---|---|
| nFormUnits | SalNumber | The length in form units. |
| bVertical | SalBoolean | True for a vertical measurement; false for a horizontal measurement. |
Returns: SalNumber. The converted pixel length.
GetClassName()
Gets the application class name associated with this control.
Returns: SalString. The application class name, an empty string for runtime-defined classes, or a SAL null string when the control cannot be resolved.
Forms are represented by their base type; nested table-window types are resolved to their non-nested base.
GetControlType()
Gets the SAL window type of this control.
Returns: SalNumber. The SAL Sys.TYPE_* code for the translated control.
GetDataType()
Gets the SAL data type represented by this control.
Returns: SalNumber. The SAL data-type code, or zero if the translated control does not implement the SAL value contract.
GetFirstChild(nTypeMask)
Finds the first child matching a SAL window-type mask.
| Parameter | Type | Description |
|---|---|---|
| nTypeMask | SalNumber | The SAL window types to include; zero matches no controls. |
Returns: SalWindowHandle. The first matching child handle, or a null SAL handle when none matches.
Ordinary controls use tab order; table columns use their creation order, and MDI forms use their child-form collection.
GetFont(sName, nSize, nEnhancement)
Reads the control font's family, point size, and style flags.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | Receives the font family name. |
| nSize | SalNumber | Receives the size in points. |
| nEnhancement | SalNumber | Receives the combined Sys.FONT_Enh* style flags. |
Returns: SalBoolean. True if a font was available; otherwise, false.
GetImageBytes(sImageBytes, nType)
Encodes the current image as binary data and reports its image type.
| Parameter | Type | Description |
|---|---|---|
| sImageBytes | SalString | Receives a binary SAL string, or a SAL null blob if no image is available. |
| nType | SalNumber | Receives the image-type code. |
Returns: SalNumber. The byte count of the encoded data, or zero when no image is available.
GetImageDescription(sDesc, nMaxLen)
Copies a Gupta image-format description to the supplied variable.
| Parameter | Type | Description |
|---|---|---|
| sDesc | SalString | Receives the description, or an empty string if no image is available. |
| nMaxLen | SalNumber | The maximum number of characters to copy. |
Returns: SalNumber. The number of characters copied.
GetImageDescription(nMaxLen)
Gets the Gupta image-format description for the current image.
| Parameter | Type | Description |
|---|---|---|
| nMaxLen | SalNumber | The maximum number of characters to return. |
Returns: SalString. The truncated description, or an empty string if no image is available.
GetImageFromBlob(blob, imageType)
Decodes an image blob with optional legacy OLE and Gupta/Centura framing.
| Parameter | Type | Description |
|---|---|---|
| blob | Byte[] | The image bytes, or null/empty for no image. |
| imageType | Int32 | PIC_FormatIcon for icon decoding, PIC_FormatObject for legacy framing, or another format for normal image decoding. |
Returns: Image. The decoded image, or null for missing bytes.
Invalid image content can cause decoder exceptions. Object-format decoding consumes the initial description probe before reading the remaining bytes.
GetImageString(nFormat, sPict)
Serializes the current image into a binary SAL string.
| Parameter | Type | Description |
|---|---|---|
| nFormat | SalNumber | The requested Sys.PIC_Format* representation. Icon and bitmap values select those encodings; object format adds a Gupta description header. |
| sPict | SalString | Receives the encoded image and any requested object header. |
Returns: SalNumber. The number of bytes written.
Object format requires an available image; other formats return an empty blob when no image is available.
GetImageString(nFormat)
Serializes the current image into a binary SAL string.
| Parameter | Type | Description |
|---|---|---|
| nFormat | SalNumber | The requested Sys.PIC_Format* representation. Icon and bitmap values select those encodings; object format adds a Gupta description header. |
Returns: SalString. The encoded image and any requested object header.
Object format requires an available image; other formats return an empty blob when no image is available.
GetLabel()
Gets the label associated with this control.
Returns: SalWindowHandle. The associated label handle, or a null SAL handle if no label can be found.
GetLabelText(sText, nMaxLength)
Copies the associated label text to a supplied variable.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | Receives the label text when it can be read. |
| nMaxLength | SalNumber | The maximum number of leading characters to copy. |
Returns: SalNumber. The number of characters copied, or zero if no label text is available.
GetLabelText(nMaxLength)
Gets this control's associated label text.
| Parameter | Type | Description |
|---|---|---|
| nMaxLength | SalNumber | The maximum number of leading characters to return. |
Returns: SalString. The label text limited to the requested length, or an empty string if no label exists.
GetLocation(nX, nY)
Reads this control's location in form units.
| Parameter | Type | Description |
|---|---|---|
| nX | SalNumber | Receives the horizontal location. |
| nY | SalNumber | Receives the vertical location. |
Returns: SalBoolean. Always true; an unresolved control produces zero coordinates.
GetName(sText)
Copies this control's name to the supplied variable.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | Receives the control name when the operation succeeds. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
GetName()
Gets this control's name.
Returns: SalString. The control name, or an empty string if the control cannot be resolved.
GetNextChild(nTypeMask)
Finds the next sibling matching a SAL window-type mask.
| Parameter | Type | Description |
|---|---|---|
| nTypeMask | SalNumber | The SAL window types to include; zero matches no controls. |
Returns: SalWindowHandle. The next matching control handle, or a null SAL handle when none matches.
GetParent()
Gets the SAL parent form, owner, or table container for this control.
Returns: SalWindowHandle. The parent window handle, or a null SAL handle if no parent can be resolved.
GetProperty(sName, sValue)
Reads a SAL named property into a supplied variable.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The property name. |
| sValue | SalString | Receives the value only when the property is found. |
Returns: SalBoolean. True if a non-null property value was found; otherwise, false.
GetProperty(sName)
Gets the value of a SAL named property.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The property name. |
Returns: SalString. The property value, or a SAL null string if the value is unavailable.
GetSize(nWidth, nHeight)
Reads this control's size in form units.
| Parameter | Type | Description |
|---|---|---|
| nWidth | SalNumber | Receives the width. |
| nHeight | SalNumber | Receives the height. |
Returns: SalBoolean. Always true; an unresolved control produces a zero size.
GetText(sText, nMaxLen)
Copies this control's displayed text or long-string value to a SAL string.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | Receives the retrieved text. |
| nMaxLen | SalNumber | The maximum character count for ordinary text; ignored for a Sys.DT_LongString value. |
Returns: SalNumber. The number of characters copied, or zero when no text is available.
GetText(nMaxLen)
Gets this control's displayed text or long-string value.
| Parameter | Type | Description |
|---|---|---|
| nMaxLen | SalNumber | The maximum character count for ordinary text; ignored for a Sys.DT_LongString value. |
Returns: SalString. The retrieved text, or an empty string if the control cannot be resolved.
GetWindowColor(nColorIndex)
Reads a window or cell color as a Win32 color value.
| Parameter | Type | Description |
|---|---|---|
| nColorIndex | SalNumber | The Sys.COLOR_Index* color component to read. |
Returns: SalNumber. The color encoded as a Win32 color value, or zero if the control is unavailable.
GetWindowState()
Gets the visibility and form-state classification of this window.
Returns: SalNumber. A Sys.Window_* state code; visible non-form controls report Sys.Window_Normal.
HideWindow()
Hides this control or table column.
Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.
HideWindowAndLabel()
Hides this control and its associated label.
Returns: SalBoolean. The control's visibility before the operation, or false if it cannot be resolved.
InvalidateWindow()
Invalidates this control and its child controls for repainting.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
IsDerivedFromClass(tClass)
Tests this control's runtime type against an application base type.
| Parameter | Type | Description |
|---|---|---|
| tClass | Type | The type to test, including the framework's emulated inheritance relationships. |
Returns: SalBoolean. True if the runtime type derives from the requested type; otherwise, false.
IsEnabled()
Determines whether this control accepts input.
Returns: SalBoolean. The enabled state, or the editable flag for a table column; false if the control cannot be resolved.
IsModified()
Reads this control's SAL modification flag.
Returns: SalBoolean. True if the control reports a modified value; otherwise, false.
IsVisible()
Determines whether this control is visible.
Returns: SalBoolean. The visible state, or the visibility flag for a table column; false if the control cannot be resolved.
KillTimer(nIDEvent)
Stops an existing timer owned by this control.
| Parameter | Type | Description |
|---|---|---|
| nIDEvent | SalNumber | The identifier used when the timer was started. |
Returns: SalBoolean. True if the timer was found and stopped; otherwise, false.
The timer remains registered and can be restarted by SetTimer.
MoveWindow(nXOffset, nYOffset)
Moves this control by an offset expressed in form units.
| Parameter | Type | Description |
|---|---|---|
| nXOffset | SalNumber | The horizontal offset to add to the current position. |
| nYOffset | SalNumber | The vertical offset to add to the current position. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
OnDragDrop(e)
Processes the SAL drop notification before raising the inherited event.
| Parameter | Type | Description |
|---|---|---|
| e | DragEventArgs | The event data passed to both handlers. |
OnDragEnd(e)
Ends SAL drag handling before raising the inherited drag-end event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data passed to both handlers. |
OnDragEnter(e)
Processes the SAL drag-enter notification before raising the inherited event.
| Parameter | Type | Description |
|---|---|---|
| e | DragEventArgs | The event data passed to both handlers. |
OnDragLeave(e)
Processes the SAL drag-leave notification before raising the inherited event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data passed to both handlers. |
OnDragOver(e)
Processes SAL drag feedback before raising the inherited drag-over event.
| Parameter | Type | Description |
|---|---|---|
| e | DragEventArgs | The event data passed to both handlers. |
OnDragStart(e)
Starts SAL drag handling before raising the inherited drag-start event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data passed to both handlers. |
OnGotFocus(e)
Dispatches SAL focus-gained processing before raising the inherited focus event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The focus event data. |
OnLostFocus(e)
Dispatches SAL focus-lost processing before raising the inherited focus event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The focus event data. |
OnMouseClick(e)
Raises the inherited mouse event, then sends SAM_Click with the pointer coordinates.
| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | The click event containing the control-relative pixel coordinates. |
OnMouseDoubleClick(e)
Raises the inherited mouse event, then sends SAM_DoubleClick with the pointer coordinates.
| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | The double-click event containing the control-relative pixel coordinates. |
OnWebEvent(e)
Processes the browser event in a root SAL context, then dispatches its simulated WinSDK event.
| Parameter | Type | Description |
|---|---|---|
| e | WisejEventArgs | The browser event to process. |
OnWebRender(config)
Adds the SAL client component class to the configuration rendered by the base control.
| Parameter | Type | Description |
|---|---|---|
| config | Object | The mutable configuration sent to the browser. |
PixelsToFormUnits(nNumPixels, bVertical)
Converts a pixel length to form units using this control's form metrics.
| Parameter | Type | Description |
|---|---|---|
| nNumPixels | SalNumber | The pixel length to convert. |
| bVertical | SalBoolean | True for a vertical measurement; false for a horizontal measurement. |
Returns: SalNumber. The converted length in form units.
PostMessage(nMsg, nMywParam, nMylParam)
Queues a SAL window action for later dispatch on the application context.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | The SAL or application-defined message code. |
| nMywParam | SalNumber | The first message parameter. |
| nMylParam | SalNumber | The second message parameter. |
Returns: SalBoolean. True if the action was queued; false if the control is unavailable or disposed.
SendMessage(nMsg, nMywParam, nMylParam)
Dispatches a SAL window action synchronously and returns its result.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | The SAL or application-defined message code. |
| nMywParam | SalNumber | The first message parameter. |
| nMylParam | SalNumber | The second message parameter. |
Returns: SalNumber. The action's return value, or zero if the target is unavailable or disposed.
SendMessageToChildren(nMsg, nMywParam, nMylParam)
Dispatches a SAL message to this control's children.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | The SAL or application-defined message code. |
| nMywParam | SalNumber | The first message parameter. |
| nMylParam | SalNumber | The second message parameter. |
Returns: SalBoolean. The result of child-message dispatch; false if the parent is unavailable or disposed.
SetContextMenu(sMenuName, nFlags)
Creates and assigns a context menu for this control.
| Parameter | Type | Description |
|---|---|---|
| sMenuName | SalString | The name used to resolve the menu type. |
| nFlags | SalNumber | Use Sys.CM_TableCell to target the associated table column; other values target the control. |
Returns: SalBoolean. True if the menu was created; false if the control or menu type is unavailable or menu creation fails.
SetContextMenu(menuType, nFlags)
Creates and assigns a context menu for this control.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | The type of the menu to create. |
| nFlags | SalNumber | Use Sys.CM_TableCell to target the associated table column; other values target the control. |
Returns: SalBoolean. True if the menu was created; false if the control or menu type is unavailable or menu creation fails.
SetCursor(nResourceId, nType)
Assigns a predefined cursor to the requested role.
| Parameter | Type | Description |
|---|---|---|
| nResourceId | Int32 | A supported Sys.CURSOR_* cursor identifier. |
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.
SetCursor(sBlob, nType)
Requests a cursor from binary data; this web implementation does not support binary cursor loading.
| Parameter | Type | Description |
|---|---|---|
| sBlob | SalString | The binary cursor data. |
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. Always false.
SetCursorFile(sFile, nType)
Loads a cursor from a file and assigns it to the requested role.
| Parameter | Type | Description |
|---|---|---|
| sFile | SalString | The cursor file path. |
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if loading and assignment succeed; otherwise, false.
Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.
SetFocus()
Requests keyboard focus for this control.
Returns: SalWindowHandle. The previously focused control's handle, or a null SAL handle when no previous control exists or this target is ineligible.
Hidden or disabled controls and table columns are ineligible.
SetFont(sName, nSize, nEnhancement)
Creates and assigns a font to this control.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The font family name. |
| nSize | SalNumber | The font size in points. |
| nEnhancement | SalNumber | The combined Sys.FONT_Enh* style flags. |
Returns: SalBoolean. True if the font was created and assigned; otherwise, false.
SetImageBytes(sImageBytes, nType)
Decodes binary image data and assigns the resulting image.
| Parameter | Type | Description |
|---|---|---|
| sImageBytes | SalString | The encoded image buffer. |
| nType | SalNumber | The SAL image-format code supplied to the decoder. |
Returns: SalBoolean. True if the translated control supports images; otherwise, false.
SetImageFile(sFileName)
Loads and assigns an image from a file.
| Parameter | Type | Description |
|---|---|---|
| sFileName | SalString | The file path, or an empty value to clear the image. |
Returns: SalBoolean. True if assignment succeeds; false if the target does not support images or a file I/O error occurs.
Files ending in .ico are decoded as icons; other files use the bitmap image-loading path.
SetImageFit(nFit, nScaleWidth, nScaleHeight)
Deprecated: SetImageFit(nFit, nScaleWidth, nScaleHeight) is deprecated, use SetImageFit(nFit)
Applies the SAL image-fitting mode through the obsolete compatibility overload.
| Parameter | Type | Description |
|---|---|---|
| nFit | SalNumber | The requested PIC_Fit* mode. |
| nScaleWidth | SalNumber | Retained for compatibility; ignored. |
| nScaleHeight | SalNumber | Retained for compatibility; ignored. |
Returns: SalBoolean. The result of the shared image-fit operation.
SetImageFit(nFit)
Applies the SAL image-fitting mode to this picture control.
| Parameter | Type | Description |
|---|---|---|
| nFit | SalNumber | The requested PIC_Fit* mode. |
Returns: SalBoolean. The result of the shared image-fit operation.
SetImageHandle(nType, nHandle)
Assigns an image loaded from a native icon or bitmap handle.
| Parameter | Type | Description |
|---|---|---|
| nType | SalNumber | Use Sys.PIC_FormatIcon for an icon handle; other values use the bitmap-handle path. |
| nHandle | SalNumber | The native handle, or zero to clear the image. |
Returns: SalBoolean. True if the translated control supports images; otherwise, false.
SetImageResource(tResource, nFormat)
Loads and assigns an image from a SAL resource.
| Parameter | Type | Description |
|---|---|---|
| tResource | SalResource | The resource whose image is assigned. |
| nFormat | SalNumber | Retained for SAL compatibility; the resource determines the image representation. |
Returns: SalBoolean. True if the translated control supports images; otherwise, false.
SetImageString(nFormat, sPicture)
Decodes a binary SAL string and assigns the resulting image.
| Parameter | Type | Description |
|---|---|---|
| nFormat | SalNumber | The SAL image-format code supplied to the decoder. |
| sPicture | SalString | The encoded image buffer. |
Returns: SalBoolean. True if the translated control supports images; otherwise, false.
SetLabelText(sText)
Assigns the text of this control's associated label.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | The label text to display. |
Returns: SalBoolean. True if an associated label was found and updated; otherwise, false.
SetLocation(nX, nY)
Sets this control's location in form units.
| Parameter | Type | Description |
|---|---|---|
| nX | SalNumber | The new horizontal coordinate. |
| nY | SalNumber | The new vertical coordinate. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
For forms, this also selects manual startup positioning.
SetModified(bSet)
Sets this control's SAL modification flag.
| Parameter | Type | Description |
|---|---|---|
| bSet | SalBoolean | True to mark the value modified; false to clear the flag. |
Returns: SalBoolean. True if the translated control supports SAL values; otherwise, false.
For editable SAL controls, this also clears the validation flag.
SetProperty(sName, sValue, nLength)
Assigns a SAL named property after limiting the value's length.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The property name. |
| sValue | SalString | The value to assign. |
| nLength | SalNumber | The number of leading characters to retain. |
Returns: SalBoolean. True if the translated control implements the SAL window contract; otherwise, false.
SetSize(nWidth, nHeight)
Sets this control's dimensions in form units.
| Parameter | Type | Description |
|---|---|---|
| nWidth | SalNumber | The new width. |
| nHeight | SalNumber | The new height. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
SetText(sText)
Assigns the control's text.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | The text to display. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
SetTimer(nIDEvent, nElapseMilliSec)
Starts or restarts a timer that sends SAL timer actions to this control.
| Parameter | Type | Description |
|---|---|---|
| nIDEvent | SalNumber | The timer identifier sent in the first parameter of each Sys.SAM_Timer action. |
| nElapseMilliSec | SalNumber | The interval between ticks, in milliseconds. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
SetWindowColor(nColorIndex, nColor)
Assigns a window or table-cell color.
| Parameter | Type | Description |
|---|---|---|
| nColorIndex | SalNumber | The Sys.COLOR_Index* component to change. |
| nColor | SalNumber | The SAL color value to translate and assign. |
Returns: SalBoolean. True for a supported color index and resolved control; otherwise, false.
Cell colors apply only to table columns. Window colors on table windows also update their grid styles.
ShowWindow()
Shows this control or table column.
Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.
ShowWindowAndLabel()
Shows this control and its associated label.
Returns: SalBoolean. The control's visibility before the operation, or false if it cannot be resolved.
TrackPopupMenu(sMenuName, nFlags, nX, nY, callback)
Creates and displays a popup menu, disposing it after it closes.
| Parameter | Type | Description |
|---|---|---|
| sMenuName | SalString | The name used to resolve the menu type. |
| nFlags | SalNumber | Popup flags controlling right alignment and use of the current cursor coordinates. Center alignment and context-menu flags are not supported. |
| nX | SalNumber | The horizontal screen coordinate in pixels, unless the cursor-X flag is set. |
| nY | SalNumber | The vertical screen coordinate in pixels, unless the cursor-Y flag is set. |
| callback | Action<ContextMenu> | An optional callback invoked when the menu closes, before it is disposed. |
Returns: SalBoolean. True if the menu was created and shown; otherwise, false.
TrackPopupMenu(menuType, nFlags, nX, nY, callback)
Creates and displays a popup menu, disposing it after it closes.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | The menu type to instantiate. |
| nFlags | SalNumber | Popup flags controlling right alignment and use of the current cursor coordinates. Center alignment and context-menu flags are not supported. |
| nX | SalNumber | The horizontal screen coordinate in pixels, unless the cursor-X flag is set. |
| nY | SalNumber | The vertical screen coordinate in pixels, unless the cursor-Y flag is set. |
| callback | Action<ContextMenu> | An optional callback invoked when the menu closes, before it is disposed. |
Returns: SalBoolean. True if the menu was created and shown; otherwise, false.
UpdateWindow()
Requests an update of this control.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Events
WindowActions
WindowActionsEventHandler Occurs when the control receives a SAL or application-defined window action.
Implements
| Name | Description |
|---|---|
| ISalControl | Exposes a SAL control's data type, value, and modification state. |
| ISalPictureControl | Exposes the image displayed by a SAL picture-capable control. |
| ISalWindow | Provides SAL window actions, named properties, and access to a window's runtime implementation. |