Click or drag to resize

StringFS Class

X#
Create a string field specification, which holds string data type information.
Inheritance Hierarchy
Object
  FieldSpec
    StringFS

Namespace:  VO
Assembly:  VOSystemClasses (in VOSystemClasses.dll) Version: 2.19
Syntax
 CLASS StringFS INHERIT FieldSpec
Request Example View Source

The StringFS type exposes the following members.

Constructors
  NameDescription
Public methodStringFS
Construct a string field specification.
Top
Properties
  NameDescription
Public propertyDecimals
A numeric value representing the number of decimals defined to this field specification.
(Inherited from FieldSpec.)
Public propertyHyperLabel
The hyperlabel connected to this field specification.
(Inherited from FieldSpec.)
Public propertyLength
A numeric value representing the length defined to this field specification.
(Inherited from FieldSpec.)
Public propertyMaximum
A numeric value representing the maximum value in the range validation for this field specification.
(Inherited from FieldSpec.)
Public propertyMinimum
A numeric value representing the minimum value in the range validation for this field specification.
(Inherited from FieldSpec.)
Public propertyMinLength
A numeric value representing the new minimum length validation for this field specification.
(Inherited from FieldSpec.)
Public propertyMinLengthHL
Error message when MinLength validation fails.
(Inherited from FieldSpec.)
Public propertyNullable
Is the field Nullable ?
(Inherited from FieldSpec.)
Public propertyPicture
A string representing the picture clause defined to this field specification. It is used by the FieldSpec:Transform() method.
(Inherited from FieldSpec.)
Public propertyRangeHL
Error message when Range validation fails.
(Inherited from FieldSpec.)
Public propertyRequired
Logical value indicating whether the field is required (TRUE) or not (FALSE).
(Inherited from FieldSpec.)
Public propertyRequiredHL
Error message when Required validation fails.
(Inherited from FieldSpec.)
Public propertyCode exampleStatus
After a validation request (see FieldSpec:PerformValidations() for details), this contains a HyperLabel object that describes the results of the validation or NULL_OBJECT if the validation passed.
(Inherited from FieldSpec.)
Public propertyUsualType
A constant, representing the data type defined to this field specification:
(Inherited from FieldSpec.)
Public propertyValidation
A code block that sets the validation rule for this field specification.
(Inherited from FieldSpec.)
Public propertyValidationHL
Error message when Validation fails.
(Inherited from FieldSpec.)
Public propertyValType
A one-character string representing the data type defined to this field specification:
(Inherited from FieldSpec.)
Top
Methods
  NameDescription
Public methodAsString
Return the caption defined to this field specification's hyperlabel; if no caption is defined, return the name defined to the hyperlabel.
(Inherited from FieldSpec.)
Public methodCode examplePerformValidations
Test a specified value to see if it passes all of this field specification's validation rules.
(Inherited from FieldSpec.)
Public methodSetLength
Set a new length for this field specification and new hyperlabel diagnostics for the length check.
(Inherited from FieldSpec.)
Public methodSetMinLength
Set a new minimum length validation for this field specification and new hyperlabel diagnostics for the minimum length check.
(Inherited from FieldSpec.)
Public methodSetRange
Set a new range validation for this field specification and new hyperlabel diagnostics for the range check.
(Inherited from FieldSpec.)
Public methodSetRequired
Set a new required validation for this field specification and new hyperlabel diagnostics for the required check.
(Inherited from FieldSpec.)
Public methodSetType
Set a new data type for this field specification and new hyperlabel diagnostics for the data type check.
(Inherited from FieldSpec.)
Public methodSetValidation
Set a new validation rule for this field specification and new hyperlabel diagnostics for the validation rule check.
(Inherited from FieldSpec.)
Public methodTransform
Convert a specified value into a string, formatted according to this field specification's picture clause.
(Inherited from FieldSpec.)
Public methodVal
Convert a string to a value, according to this field specification's defined data type.
(Inherited from FieldSpec.)
Public methodValidate
A replaceable method for performing validations. The standard implementation evaluates the code block specified through FieldSpec:SetValidation().
(Inherited from FieldSpec.)
Top
See Also

Reference