Comment Property

  • Article

Stores information about an object. Available at design time and run time.

Object.Comment[ = cTextString]

Return Value

  • cTextString
    Specifies a text string.

Remarks

Applies To: CheckBox Control | Collection Class | ComboBox Control | CommandButton Control | CommandGroup Control | Container Object | Control Object (Visual FoxPro) | CursorAdapter Class | Custom Object | EditBox Control | Exception Class (Visual FoxPro) | Form Object | FormSet Object | Grid Control | Image Control (Visual FoxPro) | Label Control (Visual FoxPro) | Line Control | ListBox Control | OLE Bound Control | OLE Container Control | OptionButton Control | OptionGroup Control | Page Object | PageFrame Control | ProjectHook Object | ReportListener Object | _SCREEN System Variable | Session Object | Shape Control | Spinner Control | TextBox Control (Visual FoxPro) | Timer Control | ToolBar Object

Unlike other properties, the value of the Comment property is not used by Visual FoxPro; you can use this property to identify or describe objects.

You can use this property to assign an identification string to an object without affecting any of its other property settings. The Comment property is useful for checking the identity of a control or form that is passed as a variable to a procedure.

By default, the Comment property is set to a zero-length string ("").

Tip

When you create a new instance of a form, assign a unique value to the Comment property.

See Also

Reference

Caption Property (Visual FoxPro)
Name Property (Visual FoxPro)

Other Resources

Properties (Visual FoxPro)
Language Reference (Visual FoxPro)