System Reference Summary : 3. System Classes : DisplayForm Class : DisplayForm Methods
 
Share this page                  
DisplayForm Methods
Method
Return
Value
Description
Inherited
From
CheckFailedMandatory
(
[setfocusonfailure = smallint])
ActiveField
Checks all child mandatory fields for entered values
ActiveField
DeclareData
(
[result = byref(variable)]
[,userclass = byref(UserClassObject)])
integer
Declares a specified active field so that you can refer to it in a dynamic expression
ActiveField
Duplicate()
DisplayForm
Makes a duplicate of the object, placing a reference to the new object in a reference variable
Object
FetchTaggedValue
(tag =
varchar(256) |
row = integer)
TaggedValue
Returns the TaggedValue associated with the supplied tag name or row number in the TaggedValues array of this field
FieldObject
FieldByName
(name =
varchar(256))
FieldObject
Finds a field object that matches a specified name
CompositeField
FieldsByProperty
(
[[attributename = varchar(32) |
tagname = varchar(256),
value = expression] |
[attributename = varchar(32) |
tagname = varchar(256),
searchstring = string
[,format = string]
[,casesensitive = integer]]
[,searchset = array of FormField]
[,singleton = i4]
[,errorstatus = i4]])
array of FormField
Searches all the composite field’s descendants (not just its immediate children) and returns an array of fields that match the specified field property or tagged value
CompositeField
FindTag(tag = varchar(256))
index
Returns the the index of the specified tag in the TaggedValues array of the field
FieldObject
GetAttribute
(
attributename = byref(variable)
{,attributename = byref(variable)})
integer
Gets the values of any number of attributes for the object
Object
GetFieldValue
(value = byref(
variable))
integer
Gets the current value of a field
FieldObject
GetTaggedValues
(
[tag = varchar(256)
[,delimiter = varchar(256)]])
array of TaggedValue
Returns an array of all the TaggedValues that either have this tag or whose tags begin with the tag plus delimiter in the TaggedValues array of this field
FieldObject
GetTagText
(tag =
varchar(256) |
row = integer)
varchar
(maxsize)
Returns a varchar containing the text of the TaggedValue associated with the supplied tag name or row number in the TaggedValues array of this method
FieldObject
GetTagValue
(tag =
varchar(256) |
row = integer)
StringObject
Returns a string object containing the text value associated with the supplied tag name or row number in the TaggedValues array of the field
FieldObject
IsA
(class =
classname)
integer
Is TRUE if the object is of the same class as, or one of the subclasses of, the class specified by classname
Object
IsAncestorOf
(descendant =
FormField)
smallint
Is TRUE if the composite is an ancestor at any level of a specified form field
CompositeField
IsDescendantOf
(ancestor =
FieldObject)
smallint
Is TRUE if the field object is a descendant at any level of the specified ancestor
FieldObject
RemoveTaggedValue
(tag =
varchar(256) |
row = integer)
status
Removes removes a TaggedValue identified by its index or tag name from the field's TaggedValues array
FieldObject
SelectAll()
none
Sets all selectable direct descendants of a composite field to the selected state
CompositeField
SetAttribute
(
attributename = value
{,attributename = value})
integer
Sets any number of attributes for the object
Object
SetFieldValue
(value =
value)
integer
Sets the value of a field
FieldObject
SetTaggedValue
(tag =
varchar(256),
value = stringobject |
textvalue = varchar(maxsize))
status
Adds a tagged value to the field's TaggedValues array if the tag is not already present, or amends the TaggedValue if it is present
FieldObject
SetToDefault()
none
Sets the value of the field to its default value
ActiveField
UndeclareData()
integer
Dissociates the named active field from variables previously associated with the DeclareData method
ActiveField
UpdBackground()
none
Changes a field's background
FormField
UpdField
(
[clearhasdatachanged = integer])
none
Refreshes a displayed field
ActiveField
UpdValue()
integer
Loads the internal memory area that stores a field's value with the value contained with the visual representation of the value
FieldObject
WhichTableField()
TableField
Determines which table field contains the field that triggered this method
FieldObject