M-Files UI Extensibility Framework
OnModifyObjectVersionLabels Event
M-Files UI Extensibility Framework > Events > OnModifyObjectVersionLabels Event
Triggered when a object version label modification is requested. This event occurs before the request is passed for M-Files Server.

objVer : IObjVer [ in ]

Identifies the object version.

clearFromOtherVersions : Boolean [ in ]

True if labels identified should be cleared from other object versions.


append : Boolean [ in ]

True if labels identified should be appended to existing labels, instead of replacing existing labels.

labelIDs : IIDs [ in, out ]

Identifies the labels to set or append.

singleLabelRequired : Boolean [ in ]

True if the operation expects a single label. The callee must not specify more labels.

Return Type

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


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

OnSuccess Method [ optional ]

Called when the operation is successfully performed.

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.


False to prevent the operation.


Prevents the operation.

Supported in M-Files 9.0.3372.6 and newer.
See Also