ClientOperationEvents.FireOnClientOperation Method

Parent Object: ClientOperationEvents

Description

Method that fires the OnClientOperation even.

Syntax

ClientOperationEvents.FireOnClientOperation( ClientId As String, OperationName As String, BeforeOrAfter As EventTimingEnum, Context As NameValueMap, HandlingCode As HandlingCodeEnum )

Parameters

Name Type Description
ClientId String Input String value that indicates the client ID(GUID) of an application addin.
OperationName String Input String value that specifies the client operation name. This can be something like “Login”, “Logout” etc..
BeforeOrAfter EventTimingEnum Input EventTimingEnum that indicates if this event is fired just before or after a client operation.
Context NameValueMap Input NameValueMap object that can be used to determine the context of why the event fired. This argument provides additional information as described below:

Name = “CommandName”. Value = String that specifies the command name(ControlDefinition.InternalName) that is executed as the client operation. This can not be provided if there is not a ControlDefinition is executed for the client operation.
HandlingCode HandlingCodeEnum Out HandlingCodeEnum that indicates how you are handling the event. The following three values are supported:
    kEventNotHandled: The client operation will continue.
    kEventHandled: This is ignored currently which has the same effect as kEventNotHandled.
    kEventCanceled: Cancels the operation..

Version

Introduced in version 2025