TypeCurrencyMax Property

Applies To

fpSpread control

Description

Sets or returns the maximum value allowed in a currency cell. This property is available at run time only.

Syntax

C++

double CSpreadSheet::GetTypeCurrencyMax( );
void CSpreadSheet::SetTypeCurrencyMax(double value);

Visual Basic

[form.]fpSpread.TypeCurrencyMax[ = value#]

Remarks

The default value for the TypeCurrencyMax property is 9,999,999.99. The largest recommended value for the TypeCurrencyMax property is 99,999,999,999,999.

The value you set for the TypeCurrencyMax property is the maximum value the control allows the user to type or paste into the specified cell. If the user tries to type or paste a value greater than the value specified by the TypeCurrencyMax property, the control beeps (if the NoBeep property is set to False) and the user is not allowed to type the value.

Values larger than the specified maximum value can still be added to the cell in code at run time or from a database; when they are added in code or from a database, the value is allowed in the cell. However, the control changes those values to zero the next time the cell is in edit mode. If the cell leaves edit mode with no change to the value, though, the control changes the value back to the invalid value.

To use the TypeCurrencyMax property, specify the sheet with which you want to work by setting the Sheet property. Then specify the cell or cells to which to apply the property, as described in Using Column and Row Properties. Once you set the TypeCurrencyMax property for a cell or cells, any subsequent currency cells you create will use the same TypeCurrencyMax setting unless you reset it for those cells.

The TypeCurrencyMax property does not have an effect unless the CellType property is set to 12 (Currency) for the specified cell or cells.

To specify the minimum value allowed in a currency cell, set the TypeCurrencyMin property.

You can have the currency cell display a spin button that lets users increment the value to the minimum or maximum value allowed in the cell. To have the cell display a spin button, set the TypeSpin property for the cell to True. The spin button can wrap the value from the maximum to the minimum or vice versa if you set the TypeSpinWrap property to True. You can specify by how many increments the value changes when the user presses the spin button by setting the TypeSpinInc property.

Spread Designer

Choose the Cell menu, the Cell Type menu, the Currency menu, and then the Settings tab, and then type a number in the Max Value edit box in the Cell Type Settings dialog box.

Data Type

Double

DLL Correspondence

SSSetTypeCurrency function