Form and Report Open Arguments
For example: If the Current User belongs to a particular Users Group, in the Security Workgroups, who has only enough privilege to view the data and not to Add or Edit then we can open the Form in Read-only mode otherwise in Normal Mode, when the Current User attempts to open the Form.
The following Code checks whether the Current User belongs to a particular User Group. The following Code of CheckGroup() Function must be copied into a Standard Module in your Database.
Public Function CheckGroup(ByVal strUsr As String, grpName As String) As String '----------------------------------------------------- 'Author : a.p.r. pillai 'Date : Feb-2010 'URL : www.msaccesstips.com 'Remarks: All Rights Reserved by www.msaccesstips.com '----------------------------------------------------- Dim wsp As Workspace Dim GrpArray() As Variant, grpcnt As Integer Dim GrpOut As Variant, j As Integer Set wsp = DBEngine.Workspaces(0) grpcnt = wsp.Users(strUsr).Groups.Count - 1 ReDim GrpArray(0 To grpcnt) As Variant 'User may belong to more than one User Group 'Create an Array of Group Names For j = 0 To grpcnt GrpArray(j) = wsp.Users(strUsr).Groups(j).Name Next 'Compare Admins with the Array List 'if matches then 'Admins' will be output in grpout Array GrpOut = Filter(GrpArray(), grpName, True) CheckGroup = GrpOut(0) End Function
The CheckGroup() Function must be called from a Command Button Click Event Procedure (we will do this at the end of this Article) as shown below to check and returns the User Group Name to open the Form in a particular Mode.
Private Sub cmdOpenForm_Click() Dim strGrp strGrp = CheckGroup(CurrentUser, "Admins") If strGrp = "Admins" Then DoCmd.OpenForm "Products", acNormal, , , acFormReadOnly Else DoCmd.OpenForm "Products", acNormal End If End Sub
The CheckGroup() program creates an Array of Work Groups of the User and checks whether the User belongs to Admins Group and returns the result. If the result value is Admins then the Products Form is open in Read-Only Mode otherwise in Normal Mode.
The Workgroups Array creation is necessary because a particular User can belong to one or more Workgroups, like Admins, Users (default), Supervisor, Manager, Editor or any other group in the Workgroup Information File(database.mdw), which he/she has been joined to.
The Filter() Function compares the text "Admins" in the array elements and if found it is output into the GrpOut(0) element.
Coming back to the Open Arguments of Form and Reports we can pass the name of a Query as Filter Argument or a WHERE condition without the word WHERE. But, there is another parameter known as Open Argument (OpenArgs) through which you can pass a value to the Report or Form and read it back in the Class Module of Report or Form from the same variable OpenArgs and use it for whatever purpose you passed it.
We try a simple example to learn the usage of this parameter. We need few objects from the C:\Program Files\Microsoft Office\Office11\Samples\Northwind.mdb sample database.
- Import the following from the Northwind.mdb sample database:
- Table: Products
- Table: Categories
- Query: Products by Category
- Report: Products by Category
- Open a new Form and create a Combo Box with the Category Name alone from the Categories Table.
A sample Form image is given below for reference.
- Select the Combo Box and display its Property Sheet (View – -> Properties or press Alt+Enter).
- Change the Name Property value to cboCategory.
- Create a Command Button and change its Name Property value to cmdOpen and the Caption Property Value to Open Report.
- Select EventProcedure in the On Click Event Property and click on the build (. . .) button to open the Class Module of the Form with the empty Sub-Routine lines.
- Copy and paste the following VBA Code overwriting the existing line or copy and paste the middle line alone:
Private Sub cmdOPen_Click() DoCmd.OpenReport "Products by Category", acViewPreview, , , , Nz(Me!cboCategory, "") End Sub
- Save the Form with the name Open Argument Demo or any other name you prefer.
- Open Products by Category Report in Design View.
- Display the Class Module (View – -> Code)
- Copy and Paste the following Code into the Class Module:
Private Sub Report_Open(Cancel As Integer) Dim strFilter As String If IsNull([OpenArgs]) Then Exit Sub End If Report.Title.Caption = Report.Title.Caption & " (" & [OpenArgs] & ")" strFilter = "CategoryName = '" & [OpenArgs] & "'" Report.Filter = strFilter Report.FilterOn = True End Sub
- Save the Report with the Code.
- Open the Open Argument Demo Form in Normal View.
- Select a Product Category Name (say Beverages) in the Combo Box.
- Click on the Open Report Command Button.
The Products by Category Report will open with only Beverages items on the Report and the heading label modified to show the Product category Name.
- Make the Combo box value empty by deleting the current value and click on the Open Report Command Button.
This time all the Products by Category will appear on the Report and the heading will remain without any change. We are testing the presence of some values in the OpenArgs Variable in the Report Open Event Procedure, if it is Null then terminate the Sub-Routine.
Do the following to try the first two Programs given on the top of this page:
- Open the Open Argument Demo Form in Design View.
- Create a second Command Button on the Form.
- Display the Property Sheet of the Command Button (View – -> Properties).
- Change the Name Property value to cmdOpenForm and change the Caption Property Value as Open Form.
- Display the Class Module (View – -> Code).
- Copy and paste the second Program from the top into the Module and save the Open Argument Demo Form.
- Create a Tabular type Form for Products Table and name the Form as Products.
- Open the Open Argument Demo Form and click on the Open Form Command Button.
- If you have not implemented Microsoft Access Security, you are by default the Admin User, a member of the Admins Group, and the Products Form will open in Read-Only mode.