DIAdem Help

Object: PolarSystemDropContext

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

Object: PolarSystemDropContext

The PolarSystemDropContext object provides information about the polar axis system onto which you dragged and dropped an object. Do not set the DoProceed property to TRUE if you change the number of curves 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 polar axis system, the following example executes the MyOnDropPolarSystemEvent 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 PolarSystemDropContext object and provides information about the worksheet 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.OnDropPolarSystem", "MyOnDropPolarSystemEvent")

Sub MyOnDropPolarSystemEvent(Context, DropContext)
  Dim oMyDropElement, sOutput, oMyAxis
  sOutput = "Names of dropped channels:"
  For Each oMyDropElement in DropContext.DiademElements
    sOutput = sOutput & VBCrLf & oMyDropElement.Name
  Next
  Call Msgbox(sOutput)
  Set oMyAxis = Context.PolarSystem
  If Context.CurveIndex>0 Then
    Call MsgBox(Context.Sheet.Name & VBCrLf & oMyAxis.Name & VBCrLf & oMyAxis.CurvesPolar.Item(Context.CurveIndex).Name)
  Else  
    Call MsgBox(Context.Sheet.Name & VBCrLf & oMyAxis.Name)
  End If  
  Context.DoProceed = TRUE
End Sub