Links

VisSpinField

PPJ.Runtime.Vis.VisSpinField
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)
Edit field with associated up/down scroll buttons.
C#
VB.NET
public class VisSpinField : NumericUpDown, ISalWindow, ISalControl, ISalEditControl
Public Class VisSpinField
Inherits NumericUpDown
Implements ISalWindow, ISalControl, ISalEditControl

Constructors

VisSpinField()

Default Constructor.

Properties

Format

String: format

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.

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.

DownButton()

override for down button

EnableWindow()

Enables keyboard and mouse input to a window.
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.

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

FromHandle(handle)

Returns the control associated with the handle.
Parameter
Type
Description
handle
Returns: VisSpinField.

GetClassName()

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

GetControlType()

Returns an object's 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
One or more window types combined (using the OR (|) operator) to create a mask of child window types.
Returns: SalWindowHandle.

GetFont(name, size, enhancement)

Parameter
Type
Description
name
size
enhancement
Returns: SalBoolean.

GetLocation(x, y)

Parameter
Type
Description
x
y
Returns: SalBoolean.

GetName(text)

Parameter
Type
Description
text
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
One or more window types combined (using the OR (|) operator) to create a mask of child window types.
Returns: SalWindowHandle.

GetNumber()

Retrieves current value of the control.
Returns: SalNumber.

GetParent()

Returns the handle of an object's parent window.
Returns: SalWindowHandle.

GetProperty(name, value)

Parameter
Type
Description
name
SalString
value
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
height
Returns: SalBoolean.

GetText(text, maxLen)

Parameter
Type
Description
text
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.

InvalidateWindow()

Causes a window to be repainted.
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.

IsValidNumber()

Validates current value as a number.
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
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.

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

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.

SetNumber(nValue)

Assigns new value to control.
Parameter
Type
Description
nValue
SalNumber
Returns: SalBoolean.

SetNumberProperties(minimum, maximum, increment, decimalAdjust)

Assigns all properties at once.
Parameter
Type
Description
minimum
SalNumber
maximum
SalNumber
increment
SalNumber
decimalAdjust
SalNumber
Returns: SalBoolean.

SetProperty(name, value, length)

Sets the value of a named property.
Parameter
Type
Description
name
SalString
value
SalString
length
SalNumber
Returns: SalBoolean.

SetReadOnly(readOnly)

Sets/clears read-only status of edit field. Returns FALSE if unsuccessful.
Parameter
Type
Description
readOnly
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.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.
Parameter
Type
Description
menuName
SalString
flags
SalNumber
x
SalNumber
y