SalNumber

PPJ.Runtime.SalNumber

Namespace: PPJ.Runtime

Assembly: PPJ.Runtime.49 (4.9.0.0)

SAL Number basic type. It wraps .NET native Decimal type. SalNumber objects are automatically cast to and from SalBoolean, Decimal, and int.

public struct SalNumber : ValueType, IComparable, IConvertible, IFormattable, INullable, ISalType, IXmlSerializable

Constructors

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

SalNumber(x)

Creates a new SalNumber.

Name
Type
Description

Properties

IsNull

Boolean: Checks if this SalNumber object contain a null value.

Value

Decimal: Returns the inner decimal value

Methods

Abs()

Computes a number's absolute value.

Returns: SalNumber. nNum

Add(x, y)

  • operators for adding two SalNumber objects

Parameter
Type
Description

Returns: SalNumber.

ArcCos()

Computes the arc cosine of a value in the range 0 to 1. The value's domain is -1 to 1.

Returns: SalNumber. nArcCos

ArcSin()

Computes a value's arc sine. The value's domain is -1 to 1.

Returns: SalNumber. nArcSin

ArcTan()

Computes a value's arc tangent.

Returns: SalNumber. nArcTan

ArcTan2(nm_valueY, nm_valueX)

Computes the arc tangent of two values. This function uses the signs of both parameters to determine the quadrant of the return value.

Parameter
Type
Description

nm_valueY

One of two values whose arc tangent you want.

nm_valueX

The other of two values whose arc tangent you want.

Returns: SalNumber. nArcTan2

Compare(x, y)

Compares two SalNumbers values.

Parameter
Type
Description

Returns: Int32.

CompareTo(obj)

compare to an object

Parameter
Type
Description

Returns: Int32.

CompareTo(x)

compare to a number

Parameter
Type
Description

Returns: Int32.

Cos()

Computes an angle's cosine.

Returns: SalNumber. nCos

CosH()

Computes an angle's hyperbolic cosine.

Returns: SalNumber. nCosH

Divide(x, y)

/ operator for dividing two SalNumber objects

Parameter
Type
Description

Returns: SalNumber.

Exponent()

Computes a value's exponential function.

Returns: SalNumber. nNumExp

HighWord()

Returns a number's high-order word value (most significant 16 bits).

Returns: SalNumber.

Hypot(nX, nY)

Computes the length of the hypotenuse of a right triangle, given the lengths of the other two sides.

Parameter
Type
Description

nX

The length of one side of a right triangle.

nY

The length of another side of a right triangle.

Returns: SalNumber. nHypotenuse

Log()

Computes a number's natural logarithm.

Returns: SalNumber. nLog

LogBase10()

Computes a number's base 10 logarithm.

Returns: SalNumber. nLogBase10

LowWord()

Returns a number's low-order word value (least significant 16 bits).

Returns: SalNumber. nLo

Max(x, y)

Returns the greater of two values.

Parameter
Type
Description

x

The first of two values.

y

The second of two values.

Returns: SalNumber. nNumMax

Min(x, y)

Returns the lesser of two values.

Parameter
Type
Description

x

The first value.

y

The second value.

Returns: SalNumber. nNumMin

Mod(nDividend)

Returns a number's modulo.

Parameter
Type
Description

nDividend

The dividend value.

Returns: SalNumber. nModulo

Multiply(x, y)

  • operator for multiplying two SalNumber objects

Parameter
Type
Description

Returns: SalNumber.

Negate(x)

Negation operator.

Parameter
Type
Description

Returns: SalNumber.

Pi()

Multiples a number by Pi. Pi is equal to 3.1415926535979323.

Returns: SalNumber. nNumPi

Power(power)

Computes nX raised to the power of nY. This function does not recognize integral, floating-point values greater than 2 to the 64th power, such as 1.0E100.

Parameter
Type
Description

power

The exponent.

Returns: SalNumber. nNumPower

RandInit(seed)

Sets the starting point for generating a series of pseudo-random numbers using SalNumberRandom.

Parameter
Type
Description

seed

The starting point. A whole number in the range of 0 to 32767.

Returns: Boolean. bOk

Random()

Generates a pseudo-random number. The numbers generated by this function are integers (whole numbers) in the range 0 to 32767 (0 to 0x7FFF).

Returns: SalNumber. nRandomNum

Round()

Returns a rounded number. If the fractional part of a number is greater than or equal to .5, rounds the number up. For example, the number 124.33 returns 124; the number 124.56 returns 125.

Returns: SalNumber. nResult

Sin()

Computes an angle's sine.

Returns: SalNumber. nSin

SinH()

Computes an angle's hyperbolic sine.

Returns: SalNumber. nSinH

Sqrt()

Computes a number's square root.

Returns: SalNumber. nSqrt

Subtract(x, y)

  • operator for subtracting two SalNumber objects

Parameter
Type
Description

Returns: SalNumber.

Tan()

Computes an angle's tangent.

Returns: SalNumber. nTan

TanH()

Computes an angle's hyperbolic tangent.

Returns: SalNumber. nTanH

ToBoolean()

to boolean

Returns: Boolean.

ToByte()

to byte

Returns: Byte.

ToChar()

to char

Returns: Char.

ToCharacter()

Converts a decimal value to a UNICODE character.

Returns: SalString.

ToDecimal()

to decimal

Returns: Decimal.

ToDouble()

to double

Returns: Double.

ToInt16()

to int16

Returns: Int16.

ToInt32()

to int32

Returns: Int32.

ToInt64()

to int64

Returns: Int64.

ToIntPtr()

to intptr

Returns: IntPtr.

ToSByte()

to sbyte

Returns: SByte.

ToSingle()

to single

Returns: Single.

ToUInt16()

to uint16

Returns: UInt16.

ToUInt32()

to uint32

Returns: UInt32.

ToUInt64()

to uint64

Returns: UInt64.

ToWindowHandle()

Converts a number to a window handle.

Returns: SalWindowHandle. nNumber

Truncate(precision, scale)

Truncates a number.

Parameter
Type
Description

precision

The number of digits to display, starting with the leftmost.

scale

The number of digits to the right of the decimal point. The nPrecision parameter must be large enough to hold the number of digits that you specify in this parameter.

Returns: SalNumber. nResult

Used By

Name
Description

Returns the buffer's length.

Returns the current buffer length of the string.

Returns the year portion of a date or returns -1 if you specify DATETIME_Null as a parameter.

Returns the total number of items in the array. For MD arrays returns the number of items in the first dimension.

Returns the number of dimensions.

Returns the average value of all the numbers in an array.

Returns the seconds portion (0 to 59) of a date/time value or returns -1 if you specify DATETIME_Null as a parameter.

Returns the next character in an open file.

Computes a number's absolute value.

Returns the string's length up to the terminator char.

Inserts the contents of a string into a picture.

Inserts a pane into the navigation bar control.

Removes a pane from the navigation bar control.

Adds a new group to the specified pane of a navigation bar.

Removes a group from the navigation bar control.

Returns the index of the currently selected pane.

Returns the last error code.

Returns the last error position.

Fetches the previous row in a result set.

Returns the last error code.

Returns the last error position.

Sets the value of the specified session property.

Not supported.

Not supported.

skip element

get number of objects

Creates a new SafeArray.

Returns the lower bound.

Inserts a pane into the navigation bar control.

Removes a pane from the navigation bar control.

Adds a new group to the specified pane of a navigation bar.

Removes a group from the navigation bar control.

Returns the index of the currently selected pane.

Starts the Windows help system.

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

Gets a window's color.

Stores a value associated with the node.

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

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.

Gets a window's color.

Returns a window's current state.

Destroys an object's system timer.

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.

Creates pop-up menus at runtime.

Sets the value of a named property.

Starts the Windows help system.

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

Gets a window's color.

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

Sets a window's cursor from a string variable.

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

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.

Number value property.

Sets a window's cursor.

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

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

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.

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

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.

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

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

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

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 the number of list box or combo box entries.

Destroys a modal dialog box and returns control to the caller of SalModalDialog.

Message return value. When set, the flag HasReturnValue is also flipped to true.

Validates and formats a data field's or table window column's contents.

Sets a limit on the number of characters that a user can enter into a data field, multi line text field, or table window column.

Returns the maximum length of a data field, multi line text field, or table window column.

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

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 a window's current state.

Sets the value of a named property.

Starts the Windows help system.

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

Gets a window's color.

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 the handle of the next child window that matches a specified type.

Returns an object's type.

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

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.

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

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

Destroys a modal dialog box and returns control to the caller of SalModalDialog.

Retrieves the height of a row in lines.

Alters the specified parameter for the custom profile associated to the specified field.

Number value property.

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

Resizes a window.

Destroys an object's system timer.

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.

Creates pop-up menus at runtime.

Sets the value of a named property.

Starts the Windows help system.

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

Gets a window's color.

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

Obtain an array of directory names based on a search path specified.

Establish communication with an HTTP server through a proxy.

Find a tab give a tab name

Indicates that a tab has been activated. This function is called before the child windows have been shown

Indicates that a tab has been activated. This function is called after the child windows have been shown

Indicates that user is attempting to change the current tab by clicking, tabbing or some other user action. NOTE: Call CancelMode() to deny the user's request

Associate a tip with a control. The control can be any type of window.

Retrieves all links for a page

Last updated