SalPushbutton

PPJ.Runtime.Windows.SalPushbutton

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Web.49 (4.9.0.0)

Represent a control that the user can click to start an action.

public class SalPushbutton : Button, ISalWindow, ISalControl, ISalPictureControl

Constructors

SalPushbutton()

Constructs a SalPushbutton object.

Properties

AcceleratorKey

Keys: Keyboard shortcut for choosing a menu item or pressing a push button. (Default: None)

CanExecute

Boolean:

Image

Image: Returns or sets the image to show in the button.

ImageName

String: Returns or sets the image to load from the embedded resources. (Default: "")

ImageSource

String: Returns or sets the name of the image to load from the theme or a URL. (Default: null)

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, multiline field, or table window column.

Returns: SalBoolean.

ClearCursor(nType)

Clears a window's cursor.

Returns: SalBoolean.

ClearImage()

Deletes the contents of a picture.

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

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

Returns: SalWindowHandle.

FireWindowActions(nMsg, nMywParam, nMylParam)

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

Returns: SalNumber.

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.

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

Returns: SalWindowHandle.

GetFont(sName, nSize, nEnhancement)

Returns: SalBoolean.

GetImageBytes(sImageBytes, nType)

Returns: SalNumber.

GetImageDescription(sDesc, nMaxLen)

Returns: SalNumber.

GetImageDescription(nMaxLen)

Retrieves a description of a picture's contents.

Returns: SalString.

GetImageString(nFormat, sPict)

Returns: SalNumber.

GetImageString(nFormat)

Return the contents of a picture into a string.

Returns: SalString.

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)

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.

Returns: SalString.

GetLocation(nX, nY)

Returns: SalBoolean.

GetName(sText)

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.

Returns: SalWindowHandle.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(sName, sValue)

Returns: SalBoolean.

GetProperty(sName)

Gets the value of a named property.

Returns: SalString.

GetSize(nWidth, nHeight)

Returns: SalBoolean.

GetText(sText, nMaxLen)

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Returns: SalString.

GetWindowColor(nColorIndex)

Gets a window's color.

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.

IsDerivedFromClass(tClass)

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

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, multiline field, combo box, table window's context row cell, or picture.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(nIDEvent)

Destroys an object's system timer.

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.

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.

Returns: SalNumber.

PostMessage(nMsg, nMywParam, nMylParam)

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

Returns: SalBoolean.

SendMessage(nMsg, nMywParam, nMylParam)

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

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

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

Returns: SalBoolean.

SetContextMenu(sMenuName, nFlags)

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

Returns: SalBoolean.

SetContextMenu(menuType, nFlags)

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

Returns: SalBoolean.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Returns: SalBoolean.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

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.

Returns: SalBoolean.

SetDefaultButton()

Sets the default push button of a form window or dialog box.

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.

Returns: SalBoolean.

SetImageBytes(sImageBytes, nType)

Inserts the contents of a picture to an image without the image header.

Returns: SalBoolean.

SetImageFile(sFileName)

Inserts a file's contents into a picture.

Returns: SalBoolean.

SetImageHandle(nType, nHandle)

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.

SetImageResource(tResource, nFormat)

Inserts a resource into a picture.

Returns: SalBoolean.

SetImageString(nFormat, sPicture)

Inserts the contents of a string into a picture.

Returns: SalBoolean.

SetLabelText(sText)

Sets the text of the associated label control.

Returns: SalBoolean.

SetLocation(nX, nY)

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

Returns: SalBoolean.

SetModified(bSet)

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

Returns: SalBoolean.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Returns: SalBoolean.

SetSize(nWidth, nHeight)

Resizes a window.

Returns: SalBoolean.

SetText(sText)

Sets the text of a window.

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.

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

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(sMenuName, nFlags, nX, nY, callback)

Creates pop-up menus at runtime.

Returns: SalBoolean.

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

Creates pop-up menus at runtime.

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Events

WindowActions

WindowActionsEventHandler

Inherited By

Implements

Last updated