Thursday, April 20, 2006

SnTT: Forcing Users to Use Your Button

OK, so I'm back with another SnTT tip. This is one we use to force users to click an action button to edit a document rather than use any other means (open from a view in Edit mode, press CTRL-E, click Actions | Edit Document, etc.).

This defines a global variable on the form (since it has to be available to the QueryModeChange and the action button) and includes code for the form's QueryOpen and QueryModeChange events, plus code for the action button itself. I haven't tested this in any other kind of button/hotspot within a form, but I suspect it would work.

We use it in an application where we want users to make changes only through a dialog box so we can restrict the fields they can change. Sure, we could have run the code from the QueryModeChange, but that's the beauty of Notes/Domino: lots of different ways to accomplish the same thing!


Option Public
Dim EditAction As Integer


Sub Querymodechange(Source As Notesuidocument, Continue As Variant)
If Not Source.EditMode and Not EditAction Then
Messagebox "You must use the Edit action button to edit the document",64,"Edit " &_

Continue = False
End If
End Sub
Sub Queryopen(Source As Notesuidocument, Mode As Integer,_

Isnewdoc As Variant, Continue As Variant)
If Not Isnewdoc Then
If Source.EditMode Then
Messagebox "This document cannot be opened in Edit mode",16,"Edit Document"
Continue = False
End If
End If
End Sub

'Edit: (action button)

Sub Click(Source As Button)
Dim ws As New NotesUIWorkspace

EditAction = True

' Do your checks to make sure they can edit the document, then put it into Edit mode

ws.CurrentDocument.EditMode = True

EditAction = False
End Sub

This LotusScript was converted to HTML using the ls2html routine,
provided by Julian Robichaux at

Categories: Show-n-Tell Thursday_


EricT said...

Shouldn't EditAction be Boolean and not a Integer?

Don McNally said...

It could be, but that data type isn't available prior to ND6 (as I recall). Using an Integer will allow the code to work in any prior version.

Thanks for the comment!