Object: CommentSubObj

Object: CommentSubObj

The CommentSubObj object provides information about a subobject of a comment in DIAdem REPORT when DIAdem calls the event assigned to the OnComment for ToolTipEvents property. DIAdem calls this event if you press the shift key and move the mouse over a REPORT object.

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

The following example creates a comment and assigns the user command MyToolTipEvent to the OnComment for ToolTipEvents property:

Dim oMyComment
Call Report.NewLayout()
Set oMyComment = Report.ActiveSheet.Objects.Add(eReportObjectComment,"MyComment")
oMyComment.Comment.Text = "This is a comment"

'This event will be raised if the mouse is moved AND the shift key pressed 
Report.Events.ToolTip.OnComment = "MyToolTipEvent"
Call Report.Refresh()

If you press the shift key and move the mouse over the comment, the example displays the mouse position and the name and the type of the subobject over which you idle the mouse. The user command receives two parameters. The first parameter corresponds with the ToolTipCommentContext object and provides the information about the comment in DIAdem REPORT when you press the shift key and move the mouse over the comment. The second parameter is a text and corresponds with the tooltip for display:

Sub MyToolTipEvent(Context,ToolTipText)
  Dim oSubObject
  Set oSubObject = Context.SubObject
  ToolTipText = "Sheet: " & Context.Sheet.Name & VBCrLf & "Sub object" & VBCrLf & "Name: " &  oSubObject.Name & VBCrLf & "Type: " & GetConstNameForREPORTSubObj(oSubObject, oSubObject.Type)
  ToolTipText = ToolTipText & VBCrLf & "X position: " & Context.Position.X & VBCrLf & "Y position: " & Context.Position.Y 
End Sub