VCL
[ class tree: VCL ] [ index: VCL ] [ all elements ]

Class: Field

Source Location: /db.inc.php

Class Overview

Object
   |
   --Field

Encapsulates a table field


Methods


Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Constructs an object and initializes its data before the object is first used.
Object::className()
Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs()
Determines whether an object is of a specific type.
Object::classParent()
Returns the type of the immediate ancestor of a class.
Object::inheritsFrom()
Determines the relationship of two object types.
Object::methodExists()
Check if a method exists declared on this object instance.
Object::readProperty()
Reads a property from the streams
Object::__get()
To virtualize properties
Object::__set()
To virtualize properties

Class Details

[line 40]
Encapsulates a table field

This class is used to encapsulate the name of a table field and the caption to be shown on data-aware component.




[ Top ]


Class Methods


method getDisplayLabel [line 67]

string getDisplayLabel( )

Contains the text to display in the corresponding column heading of a data grid.

Use DisplayLabel to assign column headings to a data grid. The column headings of the data grid use the DisplayName property of the field whose value they represent. Setting DisplayLabel changes the read-only DisplayName property from FieldName to the string specified as DisplayLabel.




Tags:



[ Top ]

method getFieldName [line 54]

string getFieldName( )

Indicates the name of the physical column in the underlying table or query result to which a field component is bound.

Use FieldName to specify which field in the underlying dataset the field component represents. FieldName is used when displaying references to the field to users, unless a DisplayLabel has been set.




Tags:



[ Top ]

method setDisplayLabel [line 68]

void setDisplayLabel( $value)



Parameters:

   $value  

[ Top ]

method setFieldName [line 55]

void setFieldName( $value)



Parameters:

   $value  

[ Top ]


Documentation generated on Sat, 13 Jun 2009 10:51:23 -0700 by phpDocumentor 1.4.1