File_Field_Mask_Type - DataDictionary
Returns the mask type of the column
Type: Property
Access: Read-Only
Data Type: Integer
Parameters: None
Parameters
| Parameter | Type | Description |
|---|---|---|
| iFile | Integer | Number of table in current filelist |
| iField | Integer | Number of column in the table |
Syntax
Property Integer File_Field_Mask_Type
| Access Type | Syntax |
|---|---|
| Read Access: | Get File_Field_Mask_Type to IntegerVariable |
Description
The File_Field_Mask_Type property returns the mask type of the column. This property may be set to any mask type consistent with the data type of the column. Doing so will automatically use the default mask (if any) for the mask type.
The returned value can be one of these:
| Constant | Meaning |
|---|---|
| Mask_Window | Masked String data type |
| Mask_Numeric_Window | Masked Numeric data type |
| Mask_Date_Window | Masked Date data type |
| Mask_DateTime_Window | Masked DateTime data type |
| Mask_Time | Masked Time data type |
| Mask_Currency_Window | Masked Currency data type |
| Ascii_Window | Unmasked String data type |
| Date_Window | Unmasked Date data type |
| Number | Unmasked number data type with number digits (0..8) to the right of the decimal point |
Use of Mask_Currency_Window will apply a mask generated from the Default_Currency_Mask ($,;($,)) for the column.
Use of Mask_Numeric_Window will apply a mask generated from the Default_Numeric_Mask (*).
The Field_Mask property can be used to specify the mask for columns of any mask type, and will override the defaults of those types that have defaults.
File and File_Field Interfaces
Many of the DataDictionary methods contain a two variants of the same message: Field_Message and File_Field_Message. For a complete description of these messages please refer to The Field and File_Field DD Interfaces.
The Field_ version of a message must use the keyword FIELD to identify the file.field name. The File_Field_ version must use the keyword FILE_FIELD to identify the file.field values. These should never be mixed!
// When using Field_ message use the FIELD keyword
Get Field_Mask_Type FIELD OrderHea.Date to sMaskType
// When using the File_Field_ message use the FILE_FIELD keyword
Get File_Field_Mask_Type of oOrderHea_DD FILE_FIELD OrderHea.Date to sMaskType
See Also