Ask Your Question

How to access the settings under the 'Events' tab of a form control to get / set the routines?

asked 2019-12-25 19:11:44 +0100

Lupp gravatar image

updated 2020-01-04 12:43:44 +0100

I tried to put all the keywords into the subject here, and therefore there isn't much detail to add.
If I didn't word the question clear enough, please tell what's missing.

===Edit 2020-01-04 about 11:30UTC===
This may be regarded a new question, but in fact I got answers concerning how to set an event method for a given EventType, but not about how the EventTypes available for a specific control can be listed.
Or is it "simple", and the ListenerTypes are always just 3 (XApproveActionListener, XActionListener, XMouseListener) - and the rest is left to the called code.

edit retag flag offensive close merge delete

2 Answers

Sort by » oldest newest most voted

answered 2019-12-25 22:47:09 +0100

I'm not sure it this helps you:

Sub AddButton(oDoc, oSheet, oCol%, oRow%, nam$, label$, macro$)
Dim vCell, oDrawPage, oControlShape, oButtonModel, sScriptURL$, oForm, oSize
Dim aEvent As new

    oDrawPage = oSheet.DrawPage

    oControlShape = oDoc.createInstance("") 
    vCell = oSheet.getCellByPosition(oCol, oRow)
    oSize = vCell.Size
    oSize.Height = oSize.Height - 50

    oButtonModel = CreateUnoService("") 
    oButtonModel.Label = label
    oButtonModel.VerticalAlign =
    oButtonModel.Name = nam
    oButtonModel.Tag = "1234567889r565"
    oButtonModel.Printable = False


    sScriptURL = "" & macro & "?language=Basic&location=document"
    oForm = oDrawPage.getForms().getByIndex(0)
    With aEvent
        .AddListenerParam = ""
        .EventMethod = "actionPerformed"
        .ListenerType = "XActionListener"
        .ScriptCode = sScriptURL
        .ScriptType = "Script"
    End With
    oForm.registerScriptEvent(oForm.Count-1, aEvent)

    oControlShape.Anchor = vCell
    oControlShape.MoveProtect = True

End Sub

(adapted from,7892.45/msg,52975.html)

edit flag offensive delete link more


Hmmm. I didn't completely understand the Russian posts. ;-)
Thanks. This seems to affirm that the second tab of the UI window 'Control Properties...' doesn't show properties accessible via the API from the control object, but an extract from the properties of the Form the control is contained in, ruled by the index of the control which must be obtained going a devious way in the user code. I wonder for what reason it's done this way.
(Sorry for being late.)

Lupp gravatar imageLupp ( 2020-01-04 11:11:05 +0100 )edit

answered 2019-12-26 01:07:47 +0100

Ratslinger gravatar image

updated 2020-01-05 02:33:59 +0100


Have worked a bit with this based upon this post -> How to programmatically get/set a form control's events.

Have attached a sample Calc file based upon this to demo. Has four buttons. First is to display a message on click. Second and third buttons are to modify what macro is called by the first button and the message changes accordingly. The last button is to clear the macro completely from the first button. This is a problem as sometimes the clear button must be clicked two or even three times. Have tried various failed remedies in the macro but no complete resolution.

Also on a Sheet 2 of the document are most of the controls with associated Listener, Event Method and Control Event.


Corrected sample -------------- ModifyButtonEvents.ods

Code cleaned up and fix applied to last button:

As the answer in the link states: can't just update the .ScriptCode property. You need to remove, then re-add the event.

Edit 2020-01-04:

@Lupp in regard to the listing of event types I will try to explain what I found.

There are more than three Listener Types. Have noted that in my sample provided there is a second sheet which lists most controls with the associated Listener, Event Method and Control Event. I have found no method to get these by simply examining a control. I actually created this listing by generating a control and attaching a macro to every event in that control.

After obtaining the index of the control (as you have in code in comment) used a simple routine to list the information:

aControlEvents = oObj1.getScriptEvents(controlIndex)
    LowBound = LBound(aControlEvents)
    UpBound = UBound(aControlEvents)
Row = 50
For x = LowBound to UpBound
    with aControlEvents(x)
        oSheet.GetCellRangeByName("C" & Row).String = .ListenerType
        oSheet.GetCellRangeByName("D" & Row).String = .EventMethod
        oSheet.GetCellRangeByName("E" & Row).String = .AddListenerParam
        oSheet.GetCellRangeByName("F" & Row).String = .ScriptType
        oSheet.GetCellRangeByName("G" & Row).String = .ScriptCode
    end with
    Row = Row + 1

Did this for every control listed on Sheet2 of the sample and created the resulting matrix.

Edit #2 2020-01-04:

Updated sample ----- ModifyButtonEvents.ods

The mods were to Sheet2 which contain the events and now has all controls and added ClassID (control constant).

There are no events for a Hidden Control.

There are two ClassID #9's - Text Box and Formatted Field.

edit flag offensive delete link more


(Sorry for being late.)
Thanks for the example.

Lupp gravatar imageLupp ( 2020-01-04 11:11:43 +0100 )edit

Since it is approved now that the API doesn't directly give access to the events assignet to a control:
I would prefer to get the needed index into the Form on a different way not relying on the .Name property:

Function getControlIndexIntoForm(pControlModel)
getControlIndexIntoForm = -1
On Local Error Goto fail
container = pControlModel.Parent
n = container.Count
For index = 0 To n - 1
  If EqualUnoObjects(pControlModel, container(index)) Then Exit For
Next index
getControlIndexIntoForm = index
End Function
Lupp gravatar imageLupp ( 2020-01-04 12:09:15 +0100 )edit

@Ratslinger: Yes I saw the contingency matrix on Sheet2. Will take it to my _doc folder concerning LibO.Great thing. Myself I was much too lazy to do this.
This API reference page is listing 22 FormComponentType Constants, one of them a filler.
I couldn't yet nap the differing names unambiguously.

Lupp gravatar imageLupp ( 2020-01-04 23:28:32 +0100 )edit
Login/Signup to Answer

Question Tools

1 follower


Asked: 2019-12-25 19:11:44 +0100

Seen: 151 times

Last updated: Jan 05 '20