SalOptionButton
PPJ.Runtime.Windows.SalOptionButton
Last updated
PPJ.Runtime.Windows.SalOptionButton
Last updated
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Web.49 (4.9.0.0)
Represents a button that the user can toggle on or off and can work in conjunction with other SalOptionButton controls.
Constructs a SalOptionRadioButton object.
Appearance: Returns or sets the value that determines the appearance of a SalOptionButton control. (Default: Button)
OptionButtonStyle: Returns/Sets the style of the option button. (Default: Check)
Image: Returns or sets the image to show in the option button when is not checked or when ImagePressed is null.
ContentAlignment: Returns or sets the alignment of the image in the control. (Default: MiddleLeft)
String: Image name. Name of the image to load from the embedded resources. (Default: "")
Image: Image to use when the button is pressed.
String: Image name. Name of the image to load from the embedded resources. (Default: "")
String: Overrides ImageSource. This property is changed by using Image, ImageName, ImagePressed or m_imagePressedName.
Control: Returns/Sets the label associated with this control.
SalNamedProperties: Returns the collection of named properties.
Color: The background color used to simulate the pressed (checked) state. (Default: Color [Empty])
ContentAlignment: Returns or sets the alignment of the text on the SalOptionButton control. (Default: MiddleCenter)
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 the value from a data field, multiline field, or table window column.
Returns: SalBoolean.
Clears a window's cursor.
| Parameter | Type | Description |
|---|---|---|
nType |
Returns: SalBoolean.
Deletes the contents of a picture.
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.
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.
Enables keyboard and mouse input to a window.
Returns: SalBoolean.
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.
This function finds a child window of a given name in the specified window.
| Parameter | Type | Description |
|---|---|---|
sWindowName |
Returns: SalWindowHandle.
Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
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.
| Parameter | Type | Description |
|---|---|---|
nFormUnits | ||
bVertical |
Returns: SalNumber.
Return the name of a window's class as a string.
Returns: SalString.
Returns an object's type.
Returns: SalNumber.
Returns a data field's or table window column's data 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.
| Parameter | Type | Description |
|---|---|---|
nTypeMask |
Returns: SalWindowHandle.
| Parameter | Type | Description |
|---|---|---|
sName | ||
nSize | ||
nEnhancement |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
sImageBytes | ||
nType |
Returns: SalNumber.
| Parameter | Type | Description |
|---|---|---|
sDesc | ||
nMaxLen |
Returns: SalNumber.
Retrieves a description of a picture's contents.
| Parameter | Type | Description |
|---|---|---|
nMaxLen |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
nFormat | ||
sPict |
Returns: SalNumber.
Return the contents of a picture into a string.
| Parameter | Type | Description |
|---|---|---|
nFormat |
Returns: SalString.
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.
| Parameter | Type | Description |
|---|---|---|
sText | ||
nMaxLength |
Returns: SalNumber.
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 |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
nX | ||
nY |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
sText |
Returns: SalBoolean.
Gets the name of an object.
Returns: SalString.
Returns the handle of the next child window that matches a specified type.
| Parameter | Type | Description |
|---|---|---|
nTypeMask |
Returns: SalWindowHandle.
Returns the handle of an object's parent window.
Returns: SalWindowHandle.
| Parameter | Type | Description |
|---|---|---|
sName | ||
sValue |
Returns: SalBoolean.
Gets the value of a named property.
| Parameter | Type | Description |
|---|---|---|
sName |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
nWidth | ||
nHeight |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
sText | ||
nMaxLen |
Returns: SalNumber.
Retrieves the text of a window.
| Parameter | Type | Description |
|---|---|---|
nMaxLen |
Returns: SalString.
Gets a window's color.
| Parameter | Type | Description |
|---|---|---|
nColorIndex |
Returns: SalNumber.
Returns a window's current state.
Returns: SalNumber.
Hides a window.
Returns: SalBoolean.
Hides a window and its associated label.
Returns: SalBoolean.
Causes a window to be repainted.
Returns: SalBoolean.
Determines whether a radio button is set or a check box is checked.
Returns: SalBoolean.
Determines whether a window is an instance of the specified class.
| Parameter | Type | Description |
|---|---|---|
tClass |
Returns: SalBoolean.
Determines whether a window is enabled for mouse and keyboard input.
Returns: SalBoolean.
Returns the setting of the Field Edit Flag for a data field, multiline field, combo box, table window's context row cell, or picture.
Returns: SalBoolean.
Determines whether a window is currently visible.
Returns: SalBoolean.
Destroys an object's system timer.
| Parameter | Type | Description |
|---|---|---|
nIDEvent |
Returns: SalBoolean.
Moves a window a given number of form units on the X and Y axes relative to its current position.
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.
| Parameter | Type | Description |
|---|---|---|
nNumPixels | ||
bVertical |
Returns: SalNumber.
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
Returns: SalBoolean.
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
Returns: SalNumber.
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Sets a window's cursor.
Returns: SalBoolean.
Sets a window's cursor from a string variable.
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.
Returns: SalBoolean.
Sets the focus to a specified window.
Returns: SalWindowHandle.
Sets a window's font, font size, and font enhancements.
Returns: SalBoolean.
Inserts the contents of a picture to an image without the image header.
Returns: SalBoolean.
Inserts a file's contents into a picture.
| Parameter | Type | Description |
|---|---|---|
sFileName |
Returns: SalBoolean.
Sets the picture image of a picture window with the handle of a bitmap (HBITMAP) or icon (HICON). Usually, HBITMAPs and HICONs are loaded from DLLs.
Returns: SalBoolean.
Inserts a resource into a picture.
| Parameter | Type | Description |
|---|---|---|
tResource | ||
nFormat |
Returns: SalBoolean.
Inserts the contents of a string into a picture.
Returns: SalBoolean.
Sets the text of the associaetd label control.
| Parameter | Type | Description |
|---|---|---|
sText |
Returns: SalBoolean.
Moves a window to a new position (x, y) on the X and Y axes.
Returns: SalBoolean.
Sets or clears the field edit flag for an editable data field, combo box, multiline text field, table window column, or picture.
| Parameter | Type | Description |
|---|---|---|
bSet |
Returns: SalBoolean.
Sets the value of a named property.
Returns: SalBoolean.
Resizes a window.
Returns: SalBoolean.
Sets the text of a window.
| Parameter | Type | Description |
|---|---|---|
sText |
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.
Returns: SalBoolean.
Sets a window's color.
Returns: SalBoolean.
Makes a window visible.
Returns: SalBoolean.
Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.
Returns: SalBoolean.
Creates pop-up menus at runtime.
| Parameter | Type | Description |
|---|---|---|
sMenuName | ||
nFlags | ||
nX | ||
nY | ||
callback |
Returns: SalBoolean.
Creates pop-up menus at runtime.
| Parameter | Type | Description |
|---|---|---|
menuType | ||
nFlags | ||
nX | ||
nY | ||
callback |
Returns: SalBoolean.
Forces the update of a window.
Returns: SalBoolean.
| Name | Description |
|---|---|
All SAL controls implement this interface. | |
SAL Controls that display a picture implement this interface. | |
SAL Controls that behave like a radio button implement this interface. | |
All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface. |
