SalForm

PPJ.Runtime.Windows.SalForm

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

Base class for Sal forms.

public class SalForm : Form, ISalForm, ISalWindow

Properties

AutoScaleBaseDpi

Size: 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

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

IconName

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

NamedProperties

SalNamedProperties: Returns the collection of named properties.

Methods

BeginUpdate()

Freezes screen updates to the form.

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

CenterWindow()

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.

Returns: SalBoolean.

ClearCursor(type)

Clears a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

DestroyWindow()

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

Returns: SalBoolean.

DisableWindow()

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.

Returns: SalBoolean.

DrawMenuBar()

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

Returns: SalBoolean.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

EndDialog(nReturn)

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

Parameter
Type
Description

nReturn

Returns: SalBoolean.

EndUpdate()

Enables screen updates to the form.

FindChild(windowName)

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

Parameter
Type
Description

windowName

Returns: SalWindowHandle.

FireWindowActions(msg, mywParam, mylParam)

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

Parameter
Type
Description

mywParam

mylParam

Returns: SalNumber.

FireWindowActionsToChildren(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

mywParam

mylParam

Returns: SalBoolean.

FormUnitsToPixels(formUnits, vertical)

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.

Returns: SalNumber.

GetClassName()

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

Returns: SalString.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetDefaultButton()

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: SalWindowHandle.

GetFirstChild(typeMask)

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.

Returns: SalWindowHandle.

GetFont(name, size, enhancement)

Parameter
Type
Description

Returns: SalBoolean.

GetFormParameter(paramType)

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.

Returns: SalNumber.

GetLocation(x, y)

Parameter
Type
Description

Returns: SalBoolean.

GetName(text)

Parameter
Type
Description

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(typeMask)

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: SalWindowHandle.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(name, value)

Parameter
Type
Description

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter
Type
Description

Returns: SalString.

GetSize(width, height)

Parameter
Type
Description

Returns: SalBoolean.

GetStatusBarText(sText, nMaxLen)

Parameter
Type
Description

Returns: SalNumber.

GetStatusBarText(nMaxLen)

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

Parameter
Type
Description

nMaxLen

Returns: SalString.

GetText(text, maxLen)

Parameter
Type
Description

Returns: SalNumber.

GetText(maxLen)

Retrieves the text of a window.

Parameter
Type
Description

maxLen

Returns: SalString.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter
Type
Description

colorIndex

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

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

Parameter
Type
Description

typeClass

Returns: SalBoolean.

IsEnabled()

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

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter
Type
Description

idEvent

Returns: SalBoolean.

MoveWindow(xOffset, yOffset)

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

Returns: SalBoolean.

PixelsToFormUnits(numPixels, vertical)

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.

Returns: SalNumber.

PostMessage(msg, mywParam, mylParam)

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

Parameter
Type
Description

mywParam

mylParam

Returns: SalBoolean.

SendMessage(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

mywParam

mylParam

Returns: SalNumber.

SendMessageToChildren(msg, mywParam, mylParam)

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

Parameter
Type
Description

mywParam

mylParam

Returns: SalBoolean.

SetContextMenu(menuName, flags)

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

Parameter
Type
Description

menuName

Returns: SalBoolean.

SetContextMenu(menuType, flags)

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

Parameter
Type
Description

menuType

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter
Type
Description

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter
Type
Description

resourceId

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter
Type
Description

Returns: SalBoolean.

SetCursorFile(file, 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

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(name, size, enhancement)

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

Parameter
Type
Description

enhancement

Returns: SalBoolean.

SetLocation(x, y)

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

Parameter
Type
Description

Returns: SalBoolean.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter
Type
Description

Returns: SalBoolean.

SetSize(width, height)

Resizes a window.

Parameter
Type
Description

Returns: SalBoolean.

SetStatusBarText(sText)

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

Parameter
Type
Description

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter
Type
Description

Returns: SalBoolean.

SetTimer(idEvent, elapseMilliSec)

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

Returns: SalBoolean.

SetWindowColor(colorIndex, color)

Sets a window's color.

Parameter
Type
Description

colorIndex

Returns: SalBoolean.

Show(parent)

Shows the form.

Parameter
Type
Description

parent

ShowAsChild(parent, rect, border)

Shows the form as child control.

Parameter
Type
Description

parent

border

ShowAsChild(parent, rect, border)

Shows the form as child control.

Parameter
Type
Description

parent

border

ShowDialog(parent)

Shows the modal dialog.

Parameter
Type
Description

parent

Returns: Int32.

ShowStatusBar(bShow)

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

Parameter
Type
Description

Returns: SalBoolean.

ShowToolBar(bShow)

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

Parameter
Type
Description

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

TrackPopupMenu(menuType, flags, x, y)

Creates pop-up menus at runtime.

Parameter
Type
Description

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter
Type
Description

command

numData

strData

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

PaintBackground

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

WindowActions

WindowActionsEventHandler Window Actions

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.

Last updated