Category Meta-Tag

See Also: Class Member Meta-Data Tags

Purpose

Used by Studio CodeSense and designers to determine how a property should be grouped in the Studio's Properties panel.

Applies To

Properties

Syntax

 

{ Category="{CategoryName}" }

where {CategoryName} is the name of the category under which the property will be listed in the Studio's Properties Panel. {CategoryName} should be enclosed in single or double quotes.

Use

Developers may categorize class properties in their classes in any manner they see fit. For example, appearance-related properties may be listed under category Appearance, or properties related to a specific project may be listed under a category with the project name.

Example:

This sample code shows how to indicate that a property declared on a property declaration line belongs in category Shape.

Class cCube is a cShape

 

    Procedure Construct_Object

        forward send Construct_Object

 

        { Category="Shape" }

        Property Integer piNumberOfSides

 

    End_Procedure

 

End_Class

Example:

This sample code shows how to indicate that a property declared using a Procedure Set belongs in category Shape.

Class cCube is a cShape

 

    { MethodType=Property Category="Shape" }

    Procedure Set NumberOfSides Integer iSides

        Set piNumberOfSides to iSides

    End_Procedure

 

End_Class

Of Special Note

The Category class member meta-data tag is inherited. If a superclass property or method is flagged as being in a specific category (e.g. CategoryA), the same property or method in subclasses of that class will be flagged as being in the same category (e.g. CategoryA), unless it is explicitly flagged as being in another category in that subclass.