DIAdem Help

Object: CommentDropContext

  • Updated2024-09-12
  • 2 minute(s) read

Object: CommentDropContext

The CommentDropContext object provides information about the comment onto which you dragged and dropped an object. Do not set the DoProceed property to TRUE if you delete the comment objects in the associated event or if you execute similar operations.

Note  To test the example script, you must first save the script and register the script as a user command in the dialog box that opens when you select Settings»Extensions»User Commands.

When channels are dragged onto a comment, the following example executes the MyOnDropCommentEvent user command. The user command displays the names of the channels that you dragged onto an object. The user command also displays information about the objects you dragged into the channels. The user command receives two parameters. The first parameter corresponds to a CommentDropContext object and provides information about the comment onto which you dragged and dropped an object. The second parameter corresponds to a DropInformation object and provides information about the object which you dragged and dropped onto another object:

Call AddUserCommandToEvent("Report.Events.OnDropComment", "MyOnDropCommentEvent")

Sub MyOnDropCommentEvent(Context, DropContext)
  Dim oMyDropElement, sOutput, oMyComment
  sOutput = "Names of dropped channels:"
  For Each oMyDropElement in DropContext.DiademElements
    sOutput = sOutput & VBCrLf & oMyDropElement.Name
  Next
  Call Msgbox(sOutput)
  Set oMyComment = Context.Comment
  Call MsgBox(Context.Sheet.Name & VBCrLf & oMyComment.Name)
  Context.DoProceed = TRUE
End Sub

Properties

Comment | DoProceed | Sheet