ComponentOne True DBInput Pro 8.0
Wrap Property (Spin)

 

Reference> Spin Object> Spin Object Properties> Wrap Property (Spin)

Wrap Property (Spin)

Syntax

object.Wrap= boolean

Read/Write at run time and design time.

Values

True - Wraps the Value property to the beginning or the end when the user moves past the MaxDate or the MinDate property using the arrow buttons and keys. (Default)

False - Does not wrap the Value property.

Remarks

Sets/returns to determine whether the Value property wraps around to the beginning or the end when once reaching the maximum or the minimum limit date. When Wrap is set to True, the Value property wraps according to the maximum, minimum limit dates(100/01/1 - 9999/12/31), and the Increment property. The Wrap property allows the Value property to increment past the maximum limit date and start again at the minimum limit date, or vice versa. Note that the maximum and the minimum limit dates may change according to the settings specified with the ValidateMode property. The valid range is not determined by the MaxDate and the MinDate properties.

The control increments or decrements the current field in which the caret is placed. If the caret is placed on a literal, the spin action will not take any effect.

When wrapping values, the Value property will first jump to the maximum and the minimum value or vice versa, before continuing. For example, when clicking the up arrow button within the month field, with the ValidateMode property set to 0-Validate Extend and the Increment property set to 5, the underlying value, "9999/12/30", will be first rounded to "9999/12/31", then "100/01/01" before continuing to increment the next 5 months.

If the Wrap property is set to False, after reaching the maximum or the minimum limit date, the control disallows further spin button movement.

See Also

Increment Property (Spin)

MaxDate Property (TDBDate)

MinDate Property (TDBDate)

Value Property (TDBDate)

ValidateMode Property (TDBTime)

 

 


Copyright (c) GrapeCity, inc. All rights reserved.

Product Support Forum  |  Documentation Feedback