Developer

AgentryInitialize

This method initializes the ActiveX control. It is called by the Agentry Client immediately after the External Field - ActiveX Control detail screen field is created. If this method returns false, indicating the control failed to initialize, the Agentry Client will not display the ActiveX control.

Parameters

  • initialValue - The value of the property targeted by the External Field - ActiveX Control field in the Agentry Client.
  • formatString - The value of the Format attribute defined in the External Field - ActiveX Control field in the Agentry Client.
  • readOnly - The value of the Read Only attribute defined in the External Field - ActiveX Control field in the Agentry Client. true indicates the field is defined to be read-only.
  • autoChangeFocus - The value of the Automatically change focus to next control attribute of the External Field - ActiveX Control field in the Agentry Client. true indicates this attribute has been set.
  • parentHwnd - The HWND that corresponds to the parent window of the ActiveX control The ActiveX control should use this to send messages to the Agentry Client.
  • messageIDs - NOTE: This value, while still provided, should be considered deprecated See the Agentry Client ActiveX API methods ActiveXControlValueChanged and ActiveXControlValueEntered for the current manner of performing these operations. A safe array stored within a VARIANT. The safe array contains an array of long values that correspond to each message ID for each message that may be sent to the Agentry Client. Within C++ the array index begins at zero and within the Vidual Basic the array index begins with one.
    • First index position: Send this message to the parentHwnd to notify the Agentry Client a value has changed within the control and it is time for the Agentry Client to evaluate the field update rules and enable rules defined for all fields on the current detail screen.
    • Second index position: Sends this message to the parentHwnd to notify the Agentry Client a value has been completely entered in the control and it is time to automatically change focus to the next control.

Return Value

  • true - This method should be implemented to return true when the ActiveX control has been successfully initialized.
  • false - This method should be implemented to return false when the ActiveX control has failed to initialize. The Agentry Client will not display the control on the screen and will not call any other methods within the ActiveX control.