See Also: Studio Meta-Data
Below is the listing of all class meta-data tags. Read Meta-Data Tag and Format Rules for details on how to apply these tags to your DataFlex source code.
All class meta-data tag values are inherited by their sub-classes. In most cases, your classes will be derived from classes where all of the meta-data is already properly set and you will not need to set any new meta-data values. The exception to this will be the OverrideProperty meta-data tag.
This table represents all valid public meta-data tags for classes. Using class meta-data tags other than the public tags listed here is considered a coding error.
Tag Name |
Description |
Used by Studio CodeSense and designers to determine the class type. |
|
Used by the Studio to determine what component category a source file belongs to. |
|
Used to assign a tab page class to a tab dialog class, to be used by Studio designers to determine which class to use when placing tab page objects inside tab dialog objects. |
|
Used by Studio designers to determine how to represent a class. |
|
Used by the Studio to determine the JavaScript class name that will be used to model the class in the WebApp Designer. The Studio WebApp Designer only recognizes standard web framework JavaScript classes. |
|
Specifies that the class is obsolete |
|
Used to specify that the information in this tag set should be applied to the function name for this class. |
|
Used to specify that the information in this tag set should be applied to the procedure name for this class. |
|
Used to specify that the information in this tag set should be applied to the procedure set name for this class. |
|
Used to specify that the information in this tag set should be applied to the property name for this class. |
|
Used by Studio CodeSense and designers to determine how a class should be exposed. |
This table represents all private meta-data tags for classes. You may see these tags used in the DataFlex package library. Private tags are not documented and not intended for developer implementation. Developers' classes will inherit tags indicated by private meta-data tags when subclassing from the DataFlex class library and these inherited settings should not be changed.
Tag Name |
Description |
Determines if a class is to be used by windows projects, web projects or both. This is used internally by the DataFlex class documentation to generate class reference help. |
|
Determines if a class is column based (e.g. grids). |
|
Determines if the class uses a DataDictionary Server and supports the Data Dictionary interface. Applied to container objects. |
|
Determines if the class is bound to a data source (i.e., is bound to table/column values). A data bindable class is always data aware. Applied to control objects. |
|
Determines if the class supports data dictionary object (DDO) structures. An example of a ddoHost is a dbView. |
|
The name of the class to be used when using the help system. This gives developer defined sub-classes, which are not part of the product help system, the ability to find help on the most appropriate superclass from the Studio's Properties panel. This works through meta-tag class inheritance. |
|
Sets the ProgId of an COM object. This is used by the Studio to display COM controls within the Visual Designer. This is assigned by the COM class generator. |