M-Files UI Extensibility Framework
OnSetPropertiesOfObjectVersion Event
M-Files UI Extensibility Framework > Events > OnSetPropertiesOfObjectVersion Event
Description
Triggered when the properties of an object version are changed. This event occurs before the request is passed for M-Files Server.
https://developer.m-files.com/APIs/COM-API/Reference/
Parameters

setPropertiesParams : ISetPropertiesParams [ in, out ]

Specifies the target object version and the change in properties. Note: the callee must not change the target object version.

singlePropertyUpdate : Boolean [ in ]

If true, a single property value update is requested. A single value must be specified in PropertyValuesToSet collection. The callee must not specify different change set.

singlePropertyRemove : Boolean [ in ]

If true, a single property value remove is requested. A single value must be specified in PropertyValuesToRemove collection. The callee must not specify different change set.

Return Type

The return type can be one of the types as follows:

Object

Callback object to be activated after the operation. Callback methods:

OnSuccess Method [ optional ]

Called when the operation is successfully performed. The call receives parameters as follows:

objectVersion : IObjectVersion [ in ]

The object version updated in the operation.

OnError Method [ optional ]

Called when the operation failed. The call receives parameters as follows:

errorCode : Long [ in ]

The error code (HRESULT).

errorMessage : String [ in ]

The error message.

errorStack : String [ in ]

The call stack that identifies the error source in the program code.

Finally Method [ optional ]

Called after the operation was performed regardless of the operation success or failure.

Boolean

False to prevent the operation.

Null

Prevents the operation.

Remarks

The OnSetPropertiesOfObjectVersions Event is triggered, too.

Supported in M-Files 9.0.3372.6 and newer.

See Also