Obsolete Meta-Tag

See Also: Class Member Meta-Data Tags

 

  Purpose

Used by Studio's Object Property Panel to determine that a class member is obsolete and should not be listed.

Applies To

Properties

Syntax

 

{ Obsolete=True | False }

where False is the default.

Use

If a developer considers one of their methods to be obsolete they can set this tag. This will remove this method from the list of suggested methods provided by CodeSense and will remove the method from the Object Properties Panel

Example:

 

Class cContact is a cObject

 

    Procedure Construct_Object

        forward send Construct_Object

 

        { Visibility=Private }

        Property String psPrivateFirstName

    End_Procedure

 

    { MethodType=Property }

    { Obsolete=True }

    Procedure Set psFirstName String sFirstName

        set psPrivateFirstName to "John"

    End_Procedure

 

End_Class