SalForm

PPJ.Runtime.Windows.SalForm

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.49 (4.9.0.0)

• Control

  • ScrollableControl

    • ContainerControl

      • Form

        • SalForm

Base class for Sal forms.

C#

public class SalForm : Form, ISalForm, ISalWindow

VB.NET

Public Class SalForm
    Inherits Form
    Implements ISalForm, ISalWindow

Properties

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.

ReturnValue

Int32: Dialog return value

Methods

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(nType)

Clears a window's cursor.

Parameter	Type	Description
nType	SalNumber

Returns: SalBoolean.

Destroy()

Destroys the form.

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	SalNumber

Returns: SalBoolean.

FindChild(sWindowName)

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

Parameter	Type	Description
sWindowName	SalString

Returns: SalWindowHandle.

FormUnitsToPixels(nFormUnits, bVertical)

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
nFormUnits	SalNumber
bVertical	SalBoolean

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(nTypeMask)

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
nTypeMask	SalNumber

Returns: SalWindowHandle.

GetFont(sName, nSize, nEnhancement)

Parameter	Type	Description
sName	SalString&
nSize	SalNumber&
nEnhancement	SalNumber&

Returns: SalBoolean.

GetLocation(nX, nY)

Parameter	Type	Description
nX	SalNumber&
nY	SalNumber&

Returns: SalBoolean.

GetName(sText)

Parameter	Type	Description
sText	SalString&

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(nTypeMask)

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

Parameter	Type	Description
nTypeMask	SalNumber

Returns: SalWindowHandle.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(sName, sValue)

Parameter	Type	Description
sName	SalString
sValue	SalString&

Returns: SalBoolean.

GetProperty(sName)

Gets the value of a named property.

Parameter	Type	Description
sName	SalString

Returns: SalString.

GetSize(nWidth, nHeight)

Parameter	Type	Description
nWidth	SalNumber&
nHeight	SalNumber&

Returns: SalBoolean.

GetStatusBarText(sText, nMaxLen)

Parameter	Type	Description
sText	SalString&
nMaxLen	SalNumber

Returns: SalNumber.

GetStatusBarText(nMaxLen)

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

Parameter	Type	Description
nMaxLen	SalNumber

Returns: SalString.

GetText(sText, nMaxLen)

Parameter	Type	Description
sText	SalString&
nMaxLen	SalNumber

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter	Type	Description
nMaxLen	SalNumber

Returns: SalString.

GetWindowColor(nColorIndex)

Gets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber

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(tClass)

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

Parameter	Type	Description
tClass	Type

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(nIDEvent)

Destroys an object's system timer.

Parameter	Type	Description
nIDEvent	SalNumber

Returns: SalBoolean.

MoveWindow(nXOffset, nYOffset)

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

Parameter	Type	Description
nXOffset	SalNumber
nYOffset	SalNumber

Returns: SalBoolean.

PixelsToFormUnits(nNumPixels, bVertical)

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
nNumPixels	SalNumber
bVertical	SalBoolean

Returns: SalNumber.

PostMessage(nMsg, nMywParam, nMylParam)

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

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

Print()

Invokes the print form command on the client.

SendMessage(nMsg, nMywParam, nMylParam)

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

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

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

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

SetContextMenu(sMenuName, nFlags)

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

Parameter	Type	Description
sMenuName	SalString
nFlags	SalNumber

Returns: SalBoolean.

SetContextMenu(menuType, nFlags)

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

Parameter	Type	Description
menuType	Type
nFlags	SalNumber

Returns: SalBoolean.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Parameter	Type	Description
nResourceId	Int32
nType	SalNumber

Returns: SalBoolean.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

Parameter	Type	Description
sBlob	SalString
nType	SalNumber

Returns: SalBoolean.

SetCursorFile(sFile, nType)

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
sFile	SalString
nType	SalNumber

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(sName, nSize, nEnhancement)

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

Parameter	Type	Description
sName	SalString
nSize	SalNumber
nEnhancement	SalNumber

Returns: SalBoolean.

SetLocation(nX, nY)

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

Parameter	Type	Description
nX	SalNumber
nY	SalNumber

Returns: SalBoolean.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Parameter	Type	Description
sName	SalString
sValue	SalString
nLength	SalNumber

Returns: SalBoolean.

SetSize(nWidth, nHeight)

Resizes a window.

Parameter	Type	Description
nWidth	SalNumber
nHeight	SalNumber

Returns: SalBoolean.

SetStatusBarText(sText)

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

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetText(sText)

Sets the text of a window.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetTimer(nIDEvent, nElapseMilliSec)

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
nIDEvent	SalNumber
nElapseMilliSec	SalNumber

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber
nColor	SalNumber

Returns: SalBoolean.

Show(parent)

Shows the form.

Parameter	Type	Description
parent	Control

ShowAsChild(parent, rect, border)

Shows the form as child control.

Parameter	Type	Description
parent	Control
rect	RectangleF
border	Boolean

ShowAsChild(parent, rect, border)

Shows the form as child control.

Parameter	Type	Description
parent	Control
rect	Rectangle
border	Boolean

ShowDialog()

Shows the modal dialog.

Returns: Int32. Return value set by EndDialog or EndDialog.

ShowDialog(parent)

Shows the modal dialog.

Parameter	Type	Description
parent	Control	The owner of the dialog.

Returns: Int32. Return value set by EndDialog or EndDialog.

ShowDialog(parent, closeHandler)

Shows the modal dialog.

Parameter	Type	Description
parent	Control	The owner of the dialog.
closeHandler	Action<Int32>	Close handler. When specified, the dialog doesn't start the server-side modal state.

Returns: Int32. Return value set by EndDialog or EndDialog.

ShowDialogAsync(parent)

Shows the modal dialog asynchronously.

Parameter	Type	Description
parent	Control	The owner of the dialog.

Returns: Task<Int32>. Return value set by EndDialog or EndDialog.

ShowStatusBar(bShow)

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

Parameter	Type	Description
bShow	SalBoolean

Returns: SalBoolean.

ShowToolBar(bShow)

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

Parameter	Type	Description
bShow	SalBoolean

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

TrackPopupMenu(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter	Type	Description
sMenuName	SalString
nFlags	SalNumber
nX	SalNumber
nY	SalNumber
callback	Action<ContextMenu>

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
nFlags	SalNumber
nX	SalNumber
nY	SalNumber
callback	Action<ContextMenu>

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Events

WindowActions

WindowActionsEventHandler

Inherited By

Name	Description
SalDialogBox	Summary description for SalDialogBox.
SalFormTableWindow	Top level table window implementation.
SalFormWindow	Top level form window implementation.
SalMDIWindow	Top level MDI window implementation.
SalRibbonBarBase	Base class for all RibbonBar forms.
SalRibbonBarForm	Top level form with ribbon.
SalRibbonBarMDI	Top level MDI form with ribbon.
SalQuickTabsDialog	Dialog Box window parent of a tab frame. This class allows editing of the properties of child windows identifying their associated tab.
SalQuickTabsForm	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.
SalQuickTabsParent	Defines late bound functions in QuickTabs parent Form or Dialog Box that will be called when an event occurs in the tab control.
SalQuickTabsParentDialog	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.
SalQuickTabsParentForm	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.
VisSplitterWindow
XSalToolbox

Implements

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