SetEditMode method

Called whenever a page is displayed to notify the page about the current edit mode. A property page should respond by changing the behavior and appearance of the controls to match the edit mode.

Parameters

EditMode

The value is PPEM_EDITMODE if the property or wizard page is in edit mode. The user should be allowed to edit the data that is displayed.

The value is PPEM_READONLY if the property page is in read-only mode. The user should not be allowed to edit any data.

The SetEditMode method accepts an optional Boolean third parameter, UpdateControls. The default value (True) will cause the interface extension designer to automatically change the appearance for all data-bound controls on the page. You can change this argument to False if you want to control the appearance in code.

Remarks

By default, m_Designer.SetEditMode is invoked in order to initialize the data binding for the controls. This code should never be removed.

Following is the default extension of this method in the form templates:

Private Sub IAMExtensionPage_SetEditMode(ByVal EditMode As PPEDITMODES)
    On Error GoTo Error_handler
    Dim bReadOnly As Boolean
    
    bReadOnly = (EditMode = PPEM_READONLY)
  
    If Not m_Designer Is Nothing Then
        ' Set the edit mode of the datasource
        m_Designer.SetEditMode Me, EditMode ', False
        ' Todo
        ' Update the edit mode of the controls
        ' Call m_Designer.EnableControl(txtMyControl)
    End If
        
    Exit Sub
Error_handler:
    MsgBox caption & " SetEditMode: " & Err.Description
End Sub

You must always write code for controls that are not data-bound. There are two ways of setting the edit mode for a control from code, the EnableControl method and the control’s properties.

Related information

IAMUIExtensionDesigner object

Setting the edit mode using the EnableControl method

Setting the edit mode using control properties