CustomValueRange¶

Qualified name: delphifmx.CustomValueRange

class CustomValueRange¶

Bases: BaseValueRange

Methods

`Assign`	Assigns to this object the values of another TPersistent object
`BeginUpdate`	Called when the ValueRange properties start to update.
`Changed`	Recalculates values of properties, fires proper events, and sets IsChanged to False.
`Clear`	Assigns the default values to all properties (Value, Min, Max, and so on).
`Dec`	Embarcadero Technologies does not currently have any additional information.
`EndUpdate`	Called when the ValueRange properties have finished updating.
`GetNamePath`	Returns the name of the object as it appears in the Object Inspector.
`Inc`	Embarcadero Technologies does not currently have any additional information.
`IsEmpty`	Checks whether any of the current object properties has an assigned value.

Attributes

`Changing`	This property identifies that the TCustomValueRange type object is recalculating property values.
`ClassName`	Returns the TObject.ClassName
`Frequency`	The step of possible Value variations.
`Increment`	Embarcadero Technologies does not currently have any additional information.
`IsChanged`	Handles whether some properties have been changed, but values are still not recalculated.
`LastValue`	Embarcadero Technologies does not currently have any additional information.
`Max`	Maximum permissible value of the floating-point Value range.
`Min`	Minimum permissible value of the floating-point Value range.
`New`	Keeps the new values of ValueRange properties.
`Owner`	The owner component of this class instance.
`RelativeValue`	The Value-based position of the thumb in the scrollable control.
`Tracking`	Controls whether the BeforeChange and AfterChange events are fired on each property change.
`UpdateCount`	Counter of how many times update changes of the ValueRange properties have been started and not accomplished.
`Value`	A changeable floating-point parameter.
`ViewportSize`	Used by controls such as TScrollBar to define the thumb size.

Assign(persistent)¶: Assigns to this object the values of another TPersistent object

BeginUpdate()¶: Called when the ValueRange properties start to update. The BeginUpdate method is called when the object starts to change values of the ValueRange properties (Value, Min, Max, ViewportSize, and Frequency). BeginUpdate increments the UpdateCount property’s value by 1.

Changed(IgnoreLoading: bool) → None¶: Recalculates values of properties, fires proper events, and sets IsChanged to False. Changed is called immediately after the value of any property (Value, Min, Max, ViewportSize, and Frequency) of the current object has been changed. It recalculates values, raises the proper events (if needed), and sets IsChanged to False. If the Owner component of the action is loading (csLoading) or UpdateCount > 0, then no operations are performed and IsChanged is set to True. After loading the Owner component is finished, the component should check the IsChanged property’s value and call the Changed method (if needed). If IgnoreLoading = True, then Changed does not check the loading state (csLoading).

Changing¶

This property identifies that the TCustomValueRange type object is recalculating property values.

Type:: bool

ClassName¶: Returns the TObject.ClassName

Clear()¶

Assigns the default values to all properties (Value, Min, Max, and so on). In TCustomValueRange, Clear assigns the following default values:

Value = 0, Min = 0, Max = 100.0, ViewportSize = 0, Frequency = 0.

Dec()¶: Embarcadero Technologies does not currently have any additional information.

EndUpdate()¶: Called when the ValueRange properties have finished updating. The EndUpdate method is called when the object accomplishes to change values of the ValueRange properties (Value, Min, Max, ViewportSize, and Frequency). EndUpdate decrements the UpdateCount property value by 1.

Frequency¶

The step of possible Value variations. FMX.StdActns.TCustomValueRange.Frequency inherits from FMX.StdActns.TBaseValueRange.Frequency. All content below this line refers to FMX.StdActns.TBaseValueRange.Frequency. The step of possible Value variations. Value can be multiple of Frequency, Min, or Max. For example, if

Min = 0.1 Max = 2.1 ViewportSize = 0 Frequency = 1

then Value can be:

0.1 1 2 2.1

but it cannot be:

Value = 1.1

Type:: float

GetNamePath()¶: Returns the name of the object as it appears in the Object Inspector.

Inc()¶: Embarcadero Technologies does not currently have any additional information.

Increment¶

Embarcadero Technologies does not currently have any additional information.

Type:: float

IsChanged¶

Handles whether some properties have been changed, but values are still not recalculated.

Type:: bool

IsEmpty()¶: Checks whether any of the current object properties has an assigned value. Returns True if any of the Value, Min, Max, ViewportSize, and Frequency properties of the current object has an assigned value.

LastValue¶

Embarcadero Technologies does not currently have any additional information.

Type:: float

Max¶

Maximum permissible value of the floating-point Value range. FMX.StdActns.TCustomValueRange.Max inherits from FMX.StdActns.TBaseValueRange.Max. All content below this line refers to FMX.StdActns.TBaseValueRange.Max. Maximum permissible value of the floating-point Value range.

Type:: float

Min¶

Minimum permissible value of the floating-point Value range. FMX.StdActns.TCustomValueRange.Min inherits from FMX.StdActns.TBaseValueRange.Min. All content below this line refers to FMX.StdActns.TBaseValueRange.Min. Minimum permissible value of the floating-point Value range.

Type:: float

New¶

Keeps the new values of ValueRange properties. New is the TBaseValueRange type property that keeps the new values of the Value, Min, Max, ViewportSize, and Frequency properties of the current object, declared in the TBaseValueRange class. It can be used in the BeforeChange event handler.

Type:: BaseValueRange

Owner¶

The owner component of this class instance.

Type:: Component

RelativeValue¶

The Value-based position of the thumb in the scrollable control. The RelativeValue property is calculated relatively to Value, according to the following expression:

RelativeValue = (Value-Min)/(Max-Min-ViewportSize)

It can be in the range from 0 through 1. It can be used for positioning a thumb in a scrollable control, whose parameters are defined by the ValueRange properties (Value, Min, Max, ViewportSize, and Frequency).

Type:: float

Tracking¶

Controls whether the BeforeChange and AfterChange events are fired on each property change. If Tracking = True, then the BeforeChange and AfterChange events are fired on each property change. If Tracking = False, then the BeforeChange and AfterChange events are not fired.

Note: The OnChanged and OnTrackingChange events are fired independently from the Tracking value.

Type:: bool

UpdateCount¶

Counter of how many times update changes of the ValueRange properties have been started and not accomplished. If UpdateCount > 0, then no update changes will be actually implemented, and all (Value, Min, Max, ViewportSize, and Frequency) properties will have old values. Update changes will be actually implemented only after calls to the EndUpdate method decrement UpdateCount to 0. To set new values to these properties, use the New property.

Type:: int

Value¶

A changeable floating-point parameter. FMX.StdActns.TCustomValueRange.Value inherits from FMX.StdActns.TBaseValueRange.Value. All content below this line refers to FMX.StdActns.TBaseValueRange.Value. A changeable floating-point parameter. The TBaseValueRange class associates a floating-point number Value to its Min and Max ranges.

Type:: float

ViewportSize¶

Used by controls such as TScrollBar to define the thumb size. FMX.StdActns.TCustomValueRange.ViewportSize inherits from FMX.StdActns.TBaseValueRange.ViewportSize. All content below this line refers to FMX.StdActns.TBaseValueRange.ViewportSize. Used by controls such as TScrollBar to define the thumb size. Note that the effective maximum value of Value decreases according to Max - ViewportSize.

Type:: float