Object: ToolTipFrameContext

Download PDF

Updated2024-09-12
2 minute(s) read

The ToolTipFrameContext object provides information about a rectangle in DIAdem REPORT when DIAdem calls the event assigned to the OnFrame 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 rectangle and assigns the user command MyToolTipEvent to the OnFrame for ToolTipEvents property:

Copy script

Dim oMyFrame
Call Report.NewLayout()
Set oMyFrame = Report.ActiveSheet.Objects.Add(eReportObjectFrame,"MyFrame")
oMyFrame.ForceSquare = True
oMyFrame.Position.ByCoordinate.X1 = 10
oMyFrame.Position.ByCoordinate.X2 = 40
oMyFrame.Position.ByCoordinate.Y1 = 50
oMyFrame.Position.ByCoordinate.Y2 = 80

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

If you press the shift key and move the mouse over the rectangle, 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 ToolTipFrameContext object and provides the information about the rectangle in DIAdem REPORT when you press the shift key and move the mouse over the rectangle. The second parameter is a text and corresponds with the tooltip for display:

Copy script

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

Properties

Frame | Position | Sheet | SubObject

DIAdem Help

Table of Contents

Object: ToolTipFrameContext

Properties

See Also