SalCheckBox

PPJ.Runtime.Windows.SalCheckBox

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

CheckBox implementation.

C#

public class SalCheckBox : CheckBox, ISalWindow, ISalControl, IConvertible

VB.NET

Public Class SalCheckBox
    Inherits CheckBox
    Implements ISalWindow, ISalControl, IConvertible

Constructors

SalCheckBox()

Constructs a SalCheckBox object.

Properties

AllowHtml

Boolean: Allows the text to contain simple html tags. Supported tags: b, u, i, br (Default: False)

AutoCheck

Boolean: Hide AutoCheck property from the serializer.

Checked

Boolean: Returns/Sets the checked state of the check box control.

Label

Control: Returns/Sets the label associated with this control.

NamedProperties

SalNamedProperties: Returns the collection of named properties.

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.

Clear()

Clears the value from a data field, multi line field, or table window column.

Returns: SalBoolean.

ClearCursor(type)

Clears a window's cursor.

Parameter	Type	Description
type	SalNumber

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.

DisableWindowAndLabel()

Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window in the outline. The label control must have a mnemonic. 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.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

EnableWindowAndLabel()

Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

FindChild(windowName)

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

Parameter	Type	Description
windowName	SalString

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
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalNumber.

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	SalNumber
vertical	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.

GetDataType()

Returns a data field's or table window column's data type.

Returns: SalNumber.

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	SalNumber

Returns: SalWindowHandle.

GetFont(name, size, enhancement)

Parameter	Type	Description
name	SalString&
size	SalNumber&
enhancement	SalNumber&

Returns: SalBoolean.

GetLabel()

Retrieves the window handle of the label (label control) that is associated with the hWndTarget parameter. There must be a mnemonic in that label, and it must immediately precede hWndTarget in the outline, or this function will fail.

Returns: SalWindowHandle.

GetLabelText(sText, nMaxLength)

Parameter	Type	Description
sText	SalString&
nMaxLength	SalNumber

Returns: SalNumber.

GetLabelText(nMaxLength)

Retrieves the text of the label associated to a control. Important: The label control does not require a mnemonic for the functions listed above to operate.

Parameter	Type	Description
nMaxLength	SalNumber

Returns: SalString.

GetLocation(x, y)

Parameter	Type	Description
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

GetName(text)

Parameter	Type	Description
text	SalString&

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	SalNumber

Returns: SalWindowHandle.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(name, value)

Parameter	Type	Description
name	SalString
value	SalString&

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter	Type	Description
name	SalString

Returns: SalString.

GetSize(width, height)

Parameter	Type	Description
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

GetText(text, maxLen)

Parameter	Type	Description
text	SalString&
maxLen	SalNumber

Returns: SalNumber.

GetText(maxLen)

Retrieves the text of a window.

Parameter	Type	Description
maxLen	SalNumber

Returns: SalString.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter	Type	Description
colorIndex	SalNumber

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

HideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBoolean.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsChecked()

Determines whether a radio button is set or a check box is checked.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

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

Parameter	Type	Description
typeClass	Type

Returns: SalBoolean.

IsEnabled()

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

Returns: SalBoolean.

IsModified()

Returns the setting of the Field Edit Flag for a data field, multi line field, combo box, table window's context row cell, or picture.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter	Type	Description
idEvent	SalNumber

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

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	SalNumber
vertical	SalBoolean

Returns: SalNumber.

PostMessage(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

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
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

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
msg	SalNumber
mywParam	SalNumber
mylParam	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, flags)

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

Parameter	Type	Description
menuType	Type
flags	SalNumber

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter	Type	Description
resource	SalResourceCursor
type	SalNumber

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter	Type	Description
resourceId	Int32
type	SalNumber

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter	Type	Description
blob	SalString
type	SalNumber

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
file	SalString
type	SalNumber

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
name	SalString
size	SalNumber
enhancement	SalNumber

Returns: SalBoolean.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetLocation(x, y)

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

Parameter	Type	Description
x	SalNumber
y	SalNumber

Returns: SalBoolean.

SetModified(bSet)

Sets or clears the field edit flag for an editable data field, combo box, multi line text field, table window column, or picture.

Parameter	Type	Description
bSet	SalBoolean

Returns: SalBoolean.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter	Type	Description
name	SalString
value	SalString
length	SalNumber

Returns: SalBoolean.

SetSize(width, height)

Resizes a window.

Parameter	Type	Description
width	SalNumber
height	SalNumber

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter	Type	Description
text	SalString

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

Returns: SalBoolean.

SetWindowColor(colorIndex, color)

Sets a window's color.

Parameter	Type	Description
colorIndex	SalNumber
color	SalNumber

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

ShowWindowAndLabel()

Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuName	SalString
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

TrackPopupMenu(menuType, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter	Type	Description
file	SalString
command	SalNumber
numData	SalNumber
strData	SalString

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

WindowActions

WindowActionsEventHandler Window Actions

Inherited By

Name	Description
SalQuickToolTipCheckBox	Check box with tool tip support

Implements

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