SalUserControl

PPJ.Runtime.Windows.SalUserControl

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

UserControl adapted to support the PPJ Framework.

public class SalUserControl : UserControl, ISalWindow

Constructors

Default constructor. Uses TYPE_CustControl.

Constructs the control emulating any SAL control type TYPE_*.

NameTypeDescription

salType

Properties

SalNamedProperties: Returns the collection of named properties.

Methods

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

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.

Clears a window's cursor.

ParameterTypeDescription

type

Returns: SalBoolean.

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

Returns: SalBoolean.

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.

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

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

ParameterTypeDescription

windowName

Returns: SalWindowHandle.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalNumber.

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.

ParameterTypeDescription

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.

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

Returns: SalString.

Returns an object's type.

Returns: SalNumber.

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.

ParameterTypeDescription

typeMask

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

Returns: SalWindowHandle.

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

ParameterTypeDescription

x

y

Returns: SalBoolean.

ParameterTypeDescription

text

Returns: SalBoolean.

Gets the name of an object.

Returns: SalString.

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

ParameterTypeDescription

typeMask

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

Returns: SalWindowHandle.

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

ParameterTypeDescription

name

value

Returns: SalBoolean.

Gets the value of a named property.

ParameterTypeDescription

name

Returns: SalString.

ParameterTypeDescription

width

height

Returns: SalBoolean.

ParameterTypeDescription

text

maxLen

Returns: SalNumber.

Retrieves the text of a window.

ParameterTypeDescription

maxLen

Returns: SalString.

Gets a window's color.

ParameterTypeDescription

colorIndex

Returns: SalNumber.

Returns a window's current state.

Returns: SalNumber.

Hides a window.

Returns: SalBoolean.

Causes a window to be repainted.

Returns: SalBoolean.

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

ParameterTypeDescription

typeClass

Returns: SalBoolean.

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

Returns: SalBoolean.

Determines whether a window is currently visible.

Returns: SalBoolean.

Destroys an object's system timer.

ParameterTypeDescription

idEvent

Returns: SalBoolean.

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

ParameterTypeDescription

xOffset

yOffset

Returns: SalBoolean.

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.

ParameterTypeDescription

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.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalNumber.

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

ParameterTypeDescription

msg

mywParam

mylParam

Returns: SalBoolean.

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

ParameterTypeDescription

sMenuName

nFlags

Returns: SalBoolean.

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

ParameterTypeDescription

menuType

flags

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resource

type

Returns: SalBoolean.

Sets a window's cursor.

ParameterTypeDescription

resourceId

type

Returns: SalBoolean.

Sets a window's cursor from a string variable.

ParameterTypeDescription

blob

type

Returns: SalBoolean.

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

ParameterTypeDescription

file

type

Returns: SalBoolean.

Sets the focus to a specified window.

Returns: SalWindowHandle.

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

ParameterTypeDescription

name

size

enhancement

Returns: SalBoolean.

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

ParameterTypeDescription

x

y

Returns: SalBoolean.

Sets the value of a named property.

ParameterTypeDescription

name

value

length

Returns: SalBoolean.

Resizes a window.

ParameterTypeDescription

width

height

Returns: SalBoolean.

Sets the text of a window.

ParameterTypeDescription

text

Returns: SalBoolean.

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.

ParameterTypeDescription

idEvent

elapseMilliSec

Returns: SalBoolean.

Sets a window's color.

ParameterTypeDescription

colorIndex

color

Returns: SalBoolean.

Makes a window visible.

Returns: SalBoolean.

Creates pop-up menus at runtime.

ParameterTypeDescription

menuName

flags

x

y

Returns: SalBoolean.

Creates pop-up menus at runtime.

ParameterTypeDescription

menuType

flags

x

y

Returns: SalBoolean.

Forces the update of a window.

Returns: SalBoolean.

Starts the Windows help system.

ParameterTypeDescription

file

command

numData

strData

Returns: SalBoolean.

Processes messages for this control.

Events

SalMessageHandler Message Actions

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

WindowActionsEventHandler Window Actions

Inherited By

NameDescription

Tab frame window class. Instances of this class should be created as children of SalQuickTabsForm objects or SalQuickTabsDialog objects.

Web Browser Control.

Implements

NameDescription

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

Last updated