PPJ Desktop API
HomeCurrent IssuesDownloads
  • Welcome
  • Concepts
  • PPJ.Runtime.49
    • General
      • Sal
      • Sys
      • SalApplication
      • SalNamedProperties
      • SalWindow
      • WindowActionsEventArgs
      • SalXML
    • COM
      • SalCoClass
      • SalObject
      • SalOleErrorInfo
      • SalSafeArray
      • SalVariant
    • Controls
      • SalActiveX
      • SalBackgroundText
      • SalCheckBox
      • SalComboBox
      • SalContext
      • SalCustomControl
      • SalDataField
        • DataType
      • SalFrame
        • BorderStyle
      • SalGeneralWindow
      • SalGroupBox
      • SalGroupSeparator
      • SalHorizontalScrollBar
      • SalLine
        • LineStyle
        • LineType
      • SalListBox
      • SalMultilineField
      • SalNavigationBar
      • SalOptionButton
        • OptionButtonStyle
      • SalPicture
        • ImageStorage
      • SalPushbutton
      • SalRadioButton
      • SalTableWindow
        • CellType
        • FocusRowStyle
        • RowsSizingStyle
        • SalTableColumn
        • SalTableColumnCollection
        • SalTableRow
        • SalTableRowCollection
        • SalTableWindowBase
      • SalTreeControl
        • SalTreeItem
      • SalUserControl
      • SalVerticalScrollBar
    • Forms
      • AccessoryType
      • SalDialogBox
      • SalForm
      • SalFormClientArea
      • SalFormStatusBar
      • SalFormTableWindow
      • SalFormToolBar
      • SalFormWindow
      • SalMDIWindow
      • SalRibbonBarBase
      • SalRibbonBarForm
      • SalRibbonBarMDI
      • SalRibbonStatusBar
    • Interfaces
      • ISalControl
      • ISalEditControl
      • ISalListControl
      • ISalPictureControl
      • ISalRadioButton
      • ISalReport
      • ISalType
      • ISalAccessory
      • ISalMenu
      • ISalWindow
    • Internet
      • FtpEventArgs
      • FtpEventHandler
      • HttpEventArgs
      • HttpEventHandler
      • SalFtpClient
      • SalHttpClient
      • SalQuickFTP
      • SalQuickHTTP
    • Menus
      • SalContextMenu
      • SalFormMainMenu
      • SalMenuColumn
      • SalMenuItem
      • SalMenuRow
      • SalMenuSeparator
      • SalPopupMenu
      • SalWindowsMenu
    • QO
      • QO
      • SalQuickHTML
      • SalQuickTabs
      • SalQuickTabsDialog
      • SalQuickTabsForm
      • SalQuickTabsParent
      • SalQuickTabsParentDialog
      • SalQuickTabsParentForm
      • SalQuickToolTipCheckBox
      • SalQuickToolTipChildTable
      • SalQuickToolTipComboBox
      • SalQuickToolTipDataField
      • SalQuickToolTipHScrollBar
      • SalQuickToolTipListBox
      • SalQuickToolTipMultilineField
      • SalQuickToolTipOptionButton
      • SalQuickToolTipPicture
      • SalQuickToolTipPushButton
      • SalQuickToolTipRadioButton
      • SalQuickToolTipTableWindow
      • SalQuickToolTipVScrollBar
      • SalToolTipManager
    • Sql
      • SalSqlBindVariables
      • SalSqlError
      • SalSqlHandle
      • SalSqlSessionHandle
      • Sql
      • SqlContext
      • SqlOra
      • WhenSqlError
    • Types
      • SalArray
      • SalArray<T>
      • SalBinary
      • SalBoolean
      • SalDateTime
      • SalFileHandle
      • SalFunctionalClass
      • SalNumber
      • SalResource
      • SalString
      • SalStringContext
      • SalWindowHandle
  • PPJ.Runtime.DDE.49
    • General
      • SalDDE
  • PPJ.Runtime.Vis.49
    • General
      • Vis
      • VisTblEx
    • Controls
      • VisCalendar
      • VisCalendarDropDown
      • VisColorComboBox
      • VisColorListBox
      • VisColorPalette
      • VisColorPaletteBase
      • VisColorPaletteDropDown
      • VisComboBoxBase
      • VisDesktopListBox
      • VisDirListBox
      • VisDirTreeListBox
      • VisDriveListBox
      • VisDropDownBase
      • VisFileListBox
      • VisFontComboBox
      • VisFontListBox
      • VisFontNameComboBox
      • VisFontNameListBox
      • VisListBoxBase
      • VisListBoxExtension
      • VisListView
      • VisListViewDropDown
      • VisMeter
      • VisOutlineComboBox
      • VisOutlineListBox
      • VisPictureComboBox
      • VisPictureListBox
      • VisPoint
      • VisRadioListBox
      • VisRect
      • VisRichEdit
      • VisSize
      • VisSpinField
      • VisSplitter
      • VisSplitterWindow
        • Orientation
  • PPJ.Runtime.XSal.49
    • General
      • XSal
      • XSalScript
    • Controls
      • XSalFlatButton
      • XSalHSplitter
      • XSalSeparator
      • XSalSeparatorDoubleRaised
      • XSalSeparatorEtched
      • XSalSeparatorInvisible
      • XSalSeparatorSingleRaised
      • XSalSplitter
      • XSalToolbar
      • XSalToolbox
      • XSalVSplitter
Powered by GitBook
On this page
  • Properties
  • AutoScaleBaseDpi
  • CultureInfo
  • IconName
  • NamedProperties
  • Methods
  • BeginUpdate()
  • BringWindowToTop()
  • CenterWindow()
  • ClearCursor(type)
  • DestroyWindow()
  • DisableWindow()
  • DrawMenuBar()
  • EnableWindow()
  • EndDialog(nReturn)
  • EndUpdate()
  • FindChild(windowName)
  • FireWindowActions(msg, mywParam, mylParam)
  • FireWindowActionsToChildren(msg, mywParam, mylParam)
  • FormUnitsToPixels(formUnits, vertical)
  • GetClassName()
  • GetControlType()
  • GetDefaultButton()
  • GetFirstChild(typeMask)
  • GetFont(name, size, enhancement)
  • GetFormParameter(paramType)
  • GetLocation(x, y)
  • GetName(text)
  • GetName()
  • GetNextChild(typeMask)
  • GetParent()
  • GetProperty(name, value)
  • GetProperty(name)
  • GetSize(width, height)
  • GetStatusBarText(sText, nMaxLen)
  • GetStatusBarText(nMaxLen)
  • GetText(text, maxLen)
  • GetText(maxLen)
  • GetWindowColor(colorIndex)
  • GetWindowState()
  • HideWindow()
  • InvalidateWindow()
  • IsDerivedFromClass(typeClass)
  • IsEnabled()
  • IsVisible()
  • KillTimer(idEvent)
  • MoveWindow(xOffset, yOffset)
  • PixelsToFormUnits(numPixels, vertical)
  • PostMessage(msg, mywParam, mylParam)
  • SendMessage(msg, mywParam, mylParam)
  • SendMessageToChildren(msg, mywParam, mylParam)
  • SetContextMenu(menuName, flags)
  • SetContextMenu(menuType, flags)
  • SetCursor(resource, type)
  • SetCursor(resourceId, type)
  • SetCursor(blob, type)
  • SetCursorFile(file, type)
  • SetFocus()
  • SetFont(name, size, enhancement)
  • SetLocation(x, y)
  • SetProperty(name, value, length)
  • SetSize(width, height)
  • SetStatusBarText(sText)
  • SetText(text)
  • SetTimer(idEvent, elapseMilliSec)
  • SetWindowColor(colorIndex, color)
  • Show(parent)
  • ShowAsChild(parent, rect, border)
  • ShowAsChild(parent, rect, border)
  • ShowDialog(parent)
  • ShowStatusBar(bShow)
  • ShowToolBar(bShow)
  • ShowWindow()
  • TrackPopupMenu(menuName, flags, x, y)
  • TrackPopupMenu(menuType, flags, x, y)
  • UpdateWindow()
  • WinHelp(file, command, numData, strData)
  • Yield()
  • Events
  • MessageActions
  • PaintBackground
  • WindowActions
  • Inherited By
  • Implements
  1. PPJ.Runtime.49
  2. Forms

SalForm

PPJ.Runtime.Windows.SalForm

PreviousSalDialogBoxNextSalFormClientArea

Last updated 2 years ago

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

Base class for Sal forms.

public class SalForm : Form, ISalForm, ISalWindow
Public Class SalForm
    Inherits Form
    Implements ISalForm, ISalWindow

Properties

AutoScaleBaseDpi

: Returns/Sets the DPI used to design this form. This is the base DPI scale and it will be used to scale the form.

CultureInfo

: Returns/Sets the culture to use for this form.

IconName

: Icon name. The image is loaded from the embedded resources.

NamedProperties

: Returns the collection of named properties.

Methods

Freezes screen updates to the form.

Brings a window to the top of all overlapping windows.

Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.

Clears a window's cursor.

Parameter
Type
Description

type

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.

Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Redraws the menu bar for a given form window or top-level table window.

Enables keyboard and mouse input to a window.

Destroys a modal dialog box and returns control to the caller of SalModalDialog.

Parameter
Type
Description

nReturn

Enables screen updates to the form.

This function finds a child window of a given name in the specified window.

Parameter
Type
Description

windowName

Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.

Parameter
Type
Description

msg

mywParam

mylParam

Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.

Parameter
Type
Description

msg

mywParam

mylParam

Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.

Parameter
Type
Description

formUnits

The number of form units.

vertical

If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.

Return the name of a window's class as a string.

Returns an object's type.

Returns the handle of the default push button on a form window or dialog box. The default push button is the one that has the focus by default.

Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.

Parameter
Type
Description

typeMask

One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Parameter
Type
Description

name

size

enhancement

Returns the value of one of three form window parameters: height, width, or number of pages.

Parameter
Type
Description

paramType

One of Sys.FORM.nFormHeight, Sys.FORM_nFormWidth, Sys.FORM_nFormPages.

Parameter
Type
Description

x

y

Parameter
Type
Description

text

Gets the name of an object.

Returns the handle of the next child window that matches a specified type.

Parameter
Type
Description

typeMask

One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns the handle of an object's parent window.

Parameter
Type
Description

name

value

Gets the value of a named property.

Parameter
Type
Description

name

Parameter
Type
Description

width

height

Parameter
Type
Description

sText

nMaxLen

Gets the text displayed in the status bar of a top-level or MDI window.

Parameter
Type
Description

nMaxLen

Parameter
Type
Description

text

maxLen

Retrieves the text of a window.

Parameter
Type
Description

maxLen

Gets a window's color.

Parameter
Type
Description

colorIndex

Returns a window's current state.

Hides a window.

Causes a window to be repainted.

Determines whether a window is an instance of the specified class.

Parameter
Type
Description

typeClass

Determines whether a window is enabled for mouse and keyboard input.

Determines whether a window is currently visible.

Destroys an object's system timer.

Parameter
Type
Description

idEvent

Moves a window a given number of form units on the X and Y axes relative to its current position.

Parameter
Type
Description

xOffset

yOffset

Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.

Parameter
Type
Description

numPixels

vertical

If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.

Parameter
Type
Description

msg

mywParam

mylParam

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

Parameter
Type
Description

msg

mywParam

mylParam

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

Parameter
Type
Description

msg

mywParam

mylParam

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter
Type
Description

menuName

flags

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter
Type
Description

menuType

flags

Sets a window's cursor.

Parameter
Type
Description

resource

type

Sets a window's cursor.

Parameter
Type
Description

resourceId

type

Sets a window's cursor from a string variable.

Parameter
Type
Description

blob

type

Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.

Parameter
Type
Description

file

type

Sets the focus to a specified window.

Sets a window's font, font size, and font enhancements.

Parameter
Type
Description

name

size

enhancement

Moves a window to a new position (x, y) on the X and Y axes.

Parameter
Type
Description

x

y

Sets the value of a named property.

Parameter
Type
Description

name

value

length

Resizes a window.

Parameter
Type
Description

width

height

Displays specified text in the status bar of a top-level or MDI window.

Parameter
Type
Description

sText

Sets the text of a window.

Parameter
Type
Description

text

Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.

Parameter
Type
Description

idEvent

elapseMilliSec

Sets a window's color.

Parameter
Type
Description

colorIndex

color

Shows the form.

Parameter
Type
Description

parent

Shows the form as child control.

Parameter
Type
Description

parent

rect

border

Shows the form as child control.

Parameter
Type
Description

parent

rect

border

Shows the modal dialog.

Parameter
Type
Description

parent

Shows or hides the status bar on a top-level or MDI window.

Parameter
Type
Description

bShow

Shows or hides the tool bar on a top-level or MDI window.

Parameter
Type
Description

bShow

Makes a window visible.

Creates pop-up menus at runtime.

Parameter
Type
Description

menuName

flags

x

y

Creates pop-up menus at runtime.

Parameter
Type
Description

menuType

flags

x

y

Forces the update of a window.

Starts the Windows help system.

Parameter
Type
Description

file

command

numData

strData

Processes messages for this control.

Events

Inherited By

Name
Description

Summary description for SalDialogBox.

Top level table window implementation.

Top level form window implementation.

Top level MDI window implementation.

Dialog Box window parent of a tab frame. This class allows editing of the properties of child windows identifying their associated tab.

Form window with a tab frame. In addition to containing a built in tab frame. This class also has the smarts to manage other child windows on the form so that they can be associated with specific tabs.

Defines late bound functions in QuickTabs parent Form or Dialog Box that will be called when an event occurs in the tab control.

Specializes the generic SalQuickTabsParent class into a dialog box implementation. This class should be used when the ported code extends cQuickTabsParent directly. Using this class avoids the creation of multiple inheritance constructs.

Specializes the generic SalQuickTabsParent class into a form implementation. This class should be used when the ported code extends cQuickTabsParent directly. Using this class avoids the creation of multiple inheritance constructs.

Pushbutton with tool tip support

Implements

Name
Description

All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.

BeginUpdate()

BringWindowToTop()

Returns: .

CenterWindow()

Returns: .

ClearCursor(type)

Returns: .

DestroyWindow()

Returns: .

DisableWindow()

Returns: .

DrawMenuBar()

Returns: .

EnableWindow()

Returns: .

EndDialog(nReturn)

Returns: .

EndUpdate()

FindChild(windowName)

Returns: .

FireWindowActions(msg, mywParam, mylParam)

Returns: .

FireWindowActionsToChildren(msg, mywParam, mylParam)

Returns: .

FormUnitsToPixels(formUnits, vertical)

Returns: .

GetClassName()

Returns: .

GetControlType()

Returns: .

GetDefaultButton()

Returns: .

GetFirstChild(typeMask)

Returns: .

GetFont(name, size, enhancement)

Returns: .

GetFormParameter(paramType)

Returns: .

GetLocation(x, y)

Returns: .

GetName(text)

Returns: .

GetName()

Returns: .

GetNextChild(typeMask)

Returns: .

GetParent()

Returns: .

GetProperty(name, value)

Returns: .

GetProperty(name)

Returns: .

GetSize(width, height)

Returns: .

GetStatusBarText(sText, nMaxLen)

Returns: .

GetStatusBarText(nMaxLen)

Returns: .

GetText(text, maxLen)

Returns: .

GetText(maxLen)

Returns: .

GetWindowColor(colorIndex)

Returns: .

GetWindowState()

Returns: .

HideWindow()

Returns: .

InvalidateWindow()

Returns: .

IsDerivedFromClass(typeClass)

Returns: .

IsEnabled()

Returns: .

IsVisible()

Returns: .

KillTimer(idEvent)

Returns: .

MoveWindow(xOffset, yOffset)

Returns: .

PixelsToFormUnits(numPixels, vertical)

Returns: .

PostMessage(msg, mywParam, mylParam)

Returns: .

SendMessage(msg, mywParam, mylParam)

Returns: .

SendMessageToChildren(msg, mywParam, mylParam)

Returns: .

SetContextMenu(menuName, flags)

Returns: .

SetContextMenu(menuType, flags)

Returns: .

SetCursor(resource, type)

Returns: .

SetCursor(resourceId, type)

Returns: .

SetCursor(blob, type)

Returns: .

SetCursorFile(file, type)

Returns: .

SetFocus()

Returns: .

SetFont(name, size, enhancement)

Returns: .

SetLocation(x, y)

Returns: .

SetProperty(name, value, length)

Returns: .

SetSize(width, height)

Returns: .

SetStatusBarText(sText)

Returns: .

SetText(text)

Returns: .

SetTimer(idEvent, elapseMilliSec)

Returns: .

SetWindowColor(colorIndex, color)

Returns: .

Show(parent)

ShowAsChild(parent, rect, border)

ShowAsChild(parent, rect, border)

ShowDialog(parent)

Returns: .

ShowStatusBar(bShow)

Returns: .

ShowToolBar(bShow)

Returns: .

ShowWindow()

Returns: .

TrackPopupMenu(menuName, flags, x, y)

Returns: .

TrackPopupMenu(menuType, flags, x, y)

Returns: .

UpdateWindow()

Returns: .

WinHelp(file, command, numData, strData)

Returns: .

Yield()

MessageActions

Message Actions

PaintBackground

fired when the form needs to paint the background, this event is missing from WinForms.

WindowActions

Window Actions

SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalWindowHandle
SalNumber
SalBoolean
SalNumber
SalString
SalNumber
SalWindowHandle
SalWindowHandle
SalBoolean
SalNumber
SalBoolean
SalBoolean
SalString
SalWindowHandle
SalWindowHandle
SalBoolean
SalString
SalBoolean
SalNumber
SalString
SalNumber
SalString
SalNumber
SalNumber
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalNumber
SalBoolean
SalNumber
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalWindowHandle
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
Int32
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalMessageHandler
PaintEventHandler
WindowActionsEventHandler
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalNumber
Int32
SalNumber
SalNumber
SalNumber
SalBoolean
SalNumber
SalString&
SalNumber&
SalNumber&
SalNumber
SalNumber&
SalNumber&
SalString&
SalNumber
SalString
SalString&
SalString
SalNumber&
SalNumber&
SalString&
SalNumber
SalNumber
SalString&
SalNumber
SalNumber
SalNumber
Type
SalNumber
SalNumber
SalNumber
SalNumber
SalBoolean
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalString
SalNumber
Type
SalNumber
SalResourceCursor
SalNumber
Int32
SalNumber
SalString
SalNumber
SalString
SalNumber
SalString
SalNumber
SalNumber
SalNumber
SalNumber
SalString
SalString
SalNumber
SalNumber
SalNumber
SalString
SalString
SalNumber
SalNumber
SalNumber
SalNumber
Control
Control
RectangleF
Boolean
Control
Rectangle
Boolean
Control
SalBoolean
SalBoolean
SalString
SalNumber
SalNumber
SalNumber
Type
SalNumber
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalString
SalDialogBox
SalFormTableWindow
SalFormWindow
SalMDIWindow
SalQuickTabsDialog
SalQuickTabsForm
SalQuickTabsParent
SalQuickTabsParentDialog
SalQuickTabsParentForm
SalQuickToolTipTableWindow
VisSplitterWindow
XSalToolbox
ISalWindow
Size
CultureInfo
String
SalNamedProperties