GefObject.HelpText (read-only property)

Get the help text configured for this object.

Syntax:

String = object.HelpText

Description:

Valid for objects with HelpType of gefHelpText.

This string is the string that will be displayed when the user asks for help on the object.

Example:

Sub GefObject_HelpText()

    Dim oCimObj As Gefobject
    Set oCimObj = CimGetObject

    Select Case
oCimObj.HelpType

        Case
gefHelpNone

            MsgBox
"The help text is " & _

"""" & oCimObj.HelpText & """"

        Case
gefHelpText

            MsgBox
"There is help text specified for this object"

        Case
gefHelpTextFile

            MsgBox
"The help file is " & _

"""" & oCimObj.HelpFile & """"

        Case
gefHelpWinHelp

            MsgBox
"The help file is " & _

"""" & oCimObj.HelpFile & """"

            MsgBox
"The help context id expression is " & _

                """" & oCimObj.HelpContextIDExpr & """"
    End Select

End Sub