wwHelpEvents::OnCommentBlockPaste

This method fires before the Paste operation occurs on the 'Copy Comment Block' menu option as well as the hotkey operation that automatically updates a code snippet from a help topic in Help Builder.

This method allows customizing the output generated for embedding into a code snippet. 

o.OnCommentBlockPaste(oTopic)

Return Value

String containing the output that is moved to the clipboard. This output should be a comment block that can be embedded into a class method.

Parameters

oTopic
Topic object that contains all the fields for this help topic.

Example

*** The following is Help Builder's default functionality
*** wwHelp_Events::OnCommentBlockPaste
LPARAMETER loTopic
     *** Take the current topic and create a help block from it
     lcOutput = "#IF .F." + CRLF +;
                "********************************"+CRLF+;
                "*   HELP BUILDER COMMENT BLOCK *"+CRLF+;
                "********************************"+CRLF +;
                "*:Help Documentation" +CRLF

     lcOutput = lcOutput + "*:Topic:"+CRLF +;
                           loTopic.Topic+CRLF+CRLF

     lcOutput = lcOutput + "*:Description:"+CRLF +;
                           loTopic.Body+CRLF+CRLF
                      
     lcOutput = lcOutput + "*:Parameters:"+CRLF +;
                           loTopic.Parameters+CRLF+CRLF

     lcOutput = lcOutput + "*:Returns:"+CRLF +;
                           loTopic.Returns+CRLF+CRLF

     lcOutput = lcOutput + "*:Example:"+CRLF +;
                           loTopic.Example+CRLF+CRLF
                           
     lcOutput = lcOutput + "*:Remarks:"+CRLF +;
                           loTopic.Remarks+CRLF+CRLF
                           
     lcOutput = lcOutput + "*:SeeAlso:"+CRLF +;
                           loTopic.SeeAlso+CRLF+CRLF

     lcOutput = lcOutput + "*:Keywords:"+CRLF +;
                           loTopic.KeyWords + CRLF+CRLF

     lcOutput = lcOutput + "*:HelpId:"+CRLF +;
                           TRANSFORM(loTopic.HelpId)+CRLF+CRLF
                           
     
     lcOutput = lcOutput + "*:ENDHELP"+CRLF+CRLF + "#ENDIF"+CRLF
RETURN lcOutput

See also:

Class wwHelpEvents | Topic data field layout
© West Wind Techologies, 1996-2023 • Updated: 09/28/99
Comment or report problem with topic