Attribute |
Definition |
Syntax |
Example |
Admin |
Retrieves or assigns the Admin attribute of a field. This attribute allows the administrator to view and modify a field that is Hidden or Protected. Note This attribute has been deprecated. To emulate this functionality, get the user's user ID from the FCUserID function and set the
Protected and Hidden attributes explicitly. |
[formname].fieldname.Admin [= TRUE/FALSE value] |
|
Bold |
Displays field text in bold. |
[formname].fieldname.Bold [= TRUE/FALSE value] |
|
Border |
Displays a border around a field. If this field attribute is set, only buttons will trigger a click event for the field. |
[formname].fieldname.Border [= TRUE/FALSE value] |
|
Bottom |
Displays field text aligned with the bottom boundary of the field. |
[formname].fieldname.Bottom [= TRUE/FALSE value] |
|
Caption |
Retrieves or assigns the text caption for nontext fields. This attribute is often used to set the text on button fields. |
[formname].fieldname.Caption [=string expression] |
|
Center |
Displays field text centered between the top and bottom boundaries of the field. |
[formname].fieldname.Center [= TRUE|FALSE value] |
|
Color |
Displays the field text in the default color. |
[formname].fieldname.Color [= TRUE|FALSE value] |
|
Condense |
Displays field text in condensed text style. Note The condensed text style is not available on the Windows client; it is only available on the Mac OS client. |
[formname].fieldname.Condense [= TRUE|FALSE value] |
|
CreationDate |
Retrieves the file CreationDate attribute of a file viewer field. |
[formname].fieldname.CreationDate |
|
Data |
Retrieves or assigns a field's binary data. The binary data can, in most instances, be manipulated as a string. This is used in fields such as a picture or file viewer. |
[formname].fieldname.Data |
|
DataSize |
Retrieves the data size attribute of a file viewer field. |
[formname].fieldname.DataSize |
|
DataType |
Retrieves a constant integer value indicating the data type of the field. This field attribute is read only at runtime. |
[formname].fieldname.DataType [constant] These are the possible values for constant:
FCString - character or text data FCInteger - long integer numeric data FCLong - long integer numeric data FCSingle - double floating point numeric data FCDouble - double floating point numeric data FCCurrency - currency data FCDate - date and time data. |
|
Editable |
Retrieves or assigns the Editable attribute of a field. Setting the Editable field attribute allows the user to edit and modify a field's value. |
[formname].fieldname.Editable [= TRUE|FALSE value] |
|
Extend |
Displays field text in extended text style. Note The extended text style is not available on the Windows client; it is only available on the Mac OS client. |
[formname].fieldname.Extend [=TRUE|FALSE value] |
|
FileCreator |
Retrieves the Mac OS file creator attribute of a file viewer field. |
[formname].fieldname.FileCreator |
|
FileFlags |
Retrieves the Mac OS file flags attribute of a file viewer field. |
[formname].fieldname.FileFlags |
|
Filename |
Retrieves the file name attribute of a file viewer field. |
[formname].fieldname.Filename |
|
FileSize |
Retrieves the file size attribute of a file viewer field. |
[formname].fieldname.FileSize |
|
FileType |
Retrieves the Mac OS file type attribute of a file viewer field. |
[formname].fieldname.FileType |
|
FullJust |
Retrieves or assigns whether or not the field is fully justified. |
[formname].fieldname.FullJust [=TRUE|FALSE] |
|
Gray |
Displays field text in gray rather than the default color (black). Use this attribute in conjunction with the Protected attribute to indicate editable fields that are currently protected. |
[formname].fieldname.Gray [=TRUE|FALSE value] |
|
Hidden |
Hides a field.
Note When this attribute is set, all users are prevented from viewing and manipulating the field. Since the field is unavailable to the user, modifying data, receiving events, and processing event procedures are not possible from the user interface. Field attributes, values, and events may still be accessed from within the code. |
[formname].fieldname.Hidden [= TRUE|FALSE] |
|
Icon |
Retrieves or assigns the resource ID of the currently displayed icon. The resource ID must match an icon resource ID that the users have in their settings file, the client itself, or the FirstClass Resource Registry. Otherwise, nothing will be displayed. Note Icon changes do not require transfer of data from client to server, so any icon resource ID changes are very
quick. |
[formname].fieldname.Icon [= resource] |
|
Index |
Retrieves or assigns the ordinal number of the currently selected field in a fixed list or expanding database list. |
[formname].fieldname.Index [= numericvalue] The first element in a list is designated as Index 0. When the focus is set to an item in the list, the Index attribute of the list is set to the field's ordinal value. The Index may also be set by direct assignment to a positive integer value. |
|
Italic |
Displays field text in italics. |
[formname].fieldname.Italic [= TRUE|FALSE value] |
|
Key |
Retrieves or assigns a nondisplaying Key value in association with an element in an expanding database list or fixed list field. Note The Key attribute can be assigned a value of any type, but once assigned at runtime, the data type of the Key attribute for the list cannot be changed. |
[formname].fieldname.Key [=anyvalue] |
|
List |
Retrieves or assigns the List attribute of a list field. |
[formname].fieldname.List [=string expression] The List attribute is stored as a semicolon-delimited list of strings. If the list is used in an enumerated list field, the values will be automatically assigned to each string in the list. Automatically generated numbers begin with 0 and increment one number for each item in the list. Numbers can also be assigned to the list items in an enumerated list. |
Cat;Dog;Fish will be displayed in a list field as three separate strings (one string per list): Cat, Dog, and Fish. Automatically generated numbers: Cat 'returns 0 Dog
'returns 1 Fish 'returns 2 Assigned numbers: Cat=100;Dog=23;Fish=7 Cat 'returns 100 Dog 'returns 23 Fish 'returns 7 |
ListCount |
Returns the current number of items in an expanding or fixed list field. |
[formname].fieldname.ListCount For more information, see fixed lists and expanding lists in FirstClass Rapid Application Developer Guide. |
|
ModificationDate |
Retrieves the modification date attribute of a file viewer field. |
[formname].fieldname.ModificationDate |
|
Name |
Retrieves or assigns the name of a field. Note Changing the name of a field with the program running can cause unpredictable behavior unless code is carefully written. |
[formname].fieldname.Name[= fieldname] where fieldname is the name of the field in string expression format. |
|
NoOpenSpace |
Prevents the form from expanding if the field expands. |
[formname].fieldname.NoOpenSpace [= TRUE|FALSE value] |
|
Outline |
Displays the field text in outline text style. Note The outline text style is not available on the Windows client, only on the Mac OS client. |
[formname].fieldname.Outline [=TRUE|FALSE value] |
|
Password |
Displays all text characters as asterisks. Text values will be exactly as they are input, but any input and output to this field will be displayed as asterisks. |
[formname].fieldname.Password [= TRUE|FALSE value] |
|
Protected |
Prevents all users from manipulating the field. This includes modifying data, receiving events, and processing event procedures. Field attribute values and events may still be accessed from within the code. |
[formname].fieldname.Protected [=TRUE|FALSE value] |
|
ResourceSize |
Retrieves the Mac OS resource fork size attribute of a file viewer field. |
[formname].fieldname.ResourceSize |
|
RJust |
Displays field text with right justification. |
[formname].fieldname.RJust [= TRUE|FALSE value] |
|
Selectable |
Makes a field able to be selected. |
[formname].fieldname.Selectable [=TRUE|FALSE value] |
|
Selected |
Sets the focus to the field.
Note This attribute has been deprecated; use the SetFocus field method. |
[formname].fieldname.Selected [=TRUE|FALSE value] |
|
Shadow |
Displays the field text in shadow text style. Note The shadow text style is not available on the Windows client; it is only available on the Mac OS client. |
[formname].fieldname.Shadow [=TRUE|FALSE value] |
|
Text |
Retrieves or assigns the string that is the text value for the field. Text and Value are the default attributes for fields. This is only applicable to fields of string type, such as text fields and editable lists. |
[formname].fieldname.Text [=string expression] |
|
Transparent |
Displays fields with transparent backgrounds. Background fields, such as graphics and icons, are visible through this field. |
[formname].fieldname.Transparent [TRUE|FALSE] |
|
Underline |
Underlines field text. |
[formname].fieldname.Underline [=TRUE|FALSE value] |
|
Value |
Retrieves or assigns the numeric value of a field. This is only applicable to fields with numeric values, such as checkboxes and enumerated lists. |
[formname].fieldname.Value [=TRUE|FALSE value] The Value field attribute also retrieves date information. Text and the Value field attribute are the default attributes for fields. |
|
Wrap |
Displays field text with word wrap. This is essential for any multiline text box. To enter and display carriage returns in a text field, this attribute must be set. |
[formname].fieldname.Wrap [TRUE|FALSE value] |
|