BuiltinCommand

The BuiltinCommand enumeration contains all the ids of the builtin commands that can be hidden, shown, disabled or enabled from the menus. This enumeration is used in conjunction with the SetCommandState method.

Name	Value	Description	Callback arguments
MakeCopy	9	Make a copy of the selected object.	shellItems (IShellItems ) The shell items being copied. If undefined, uses current selection.
CheckOut	10	Checkout the active selection.	shellItems (IShellItems ) The shell items being checked out. If undefined, uses current selection.
CheckIn	11	Checkin the active selection.	shellItems (IShellItems ) The shell items being checked in. If undefined, uses current selection.
UndoCheckOut	13	Undo the checkout for the selected object.	shellItems (IShellItems ) The shell items whose checkout is being undone. If undefined, uses current selection.
ConvertToSFD	31	Converts the selection into single-file document.
ConvertToMFD	32	Converts the selection into multi-file document. This commands works for only one selected object.
ReplaceWithFile	33	Triggers the file selection dialog for the currenly selected object and replaces that file with the selected file.	shellItems (IShellItems ) The shell items for the target object(s). If undefined, uses current selection.
ConvertToSearchablePDF	46	Convert to searchable pdf command.
SaveAsPDF	50	Save the selected object as PDF.	shellItems (IShellItems ) The shell items to convert. If undefined, uses current selection.
Delete	76	Delete the current selected object. Shows a modal dialog for confirmation.	shellItems (IShellItems ) The shell items being deleted. If undefined, uses current selection.
Export	79	Exports the content of the current view to a CSV file.
ConvertToSingleFilePDF	81	Converts the selection into single-file PDF.
ConvertToMultiFilePDF	82	Converts the selection into multi-file PDF.
NewObject	87	Creates a new Object.	objectType (number ) The object type ID for the new object. objectType (number ) The object type ID for the new object. isFromDragAndDrop (boolean ) true if triggered via drag and drop. uploadedFiles (any ) Files uploaded via drag and drop. targetFromDrop (null | IShellItems ) Drop target information. clearSelection (boolean ) Whether selection should be cleared. options (any ) Full options object containing TemplateInfo.
Refresh	88	Refresh the listing.
RollBack	89	Rollback command. The rollbacked object is either command argument provided as ObjVer or the current selection in the Listing View.
SubMenu_NewObject	101	New object command which has the different object type child commands.
CheckOutForCoauthoring	129	Checks out the object for co-authoring.	shellItems (IShellItems ) The shell items to check out. If undefined, uses current selection.
ResolveConflictKeepThis	134	Resolves a version conflict by keeping the changes made in the selected version.
ResolveConflictDiscardThis	135	Resolves a version conflict by discarding the changes made in the selected version.
ViewInMFDesktop	174	Open the selected file in the desktop application.	shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
DownloadFile	175	Downloads the selected file.	shellItems (IShellItems ) The shell items being downloaded. If undefined, uses current selection.
OpenFile	176	Open the selected file.	shellItems (IShellItems ) The shell items being opened. If undefined, uses current selection.
AddPersonalTab	180	Add personal tab and send request to server to store related information.
RemovePersonalTab	181	Remove personal tab and send request to server to store related information.
RemoveFromThisView	182	Remove object from recent tab and send request to server to update related information.
OpenInDesktopApp	183	Open file in Native Desktop application using web Companion.	shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
OpenInBrowser	184	Opens the currently selected object via online office editor.
Follow	185	Starts following the specified object. While the object is being followed, the current user will be notified if the object changes.
Unfollow	186	Stop following the specified object.
LaunchDefaultApp	187	Open the file in associated application in desktop environment (DesktopNext).	shellItems (IShellItems ) The shell items being opened. If undefined, uses current selection.
SubMenu_Convert	188	Convert command which has the different convert child commands.
SubMenu_Show_More	189	Show more commands.
AddFile	190	Add File command.	shellItems (IShellItems ) The shell items for the target object(s). If undefined, uses current selection.
CopyInternalLink	201	Copies the link of the object to the pointed out version.	shellItems (IShellItems ) The shell items for link copy. If undefined, uses current selection.
SendCheckInRequest	202	Sends check in request to the user who has checked out a object.	shellItems (IShellItems ) The shell items to process. If undefined, uses current selection.
CreateView	203	Creates a view.
OpenInExternalEditor	204	Opens the file in the back-end specific external editing system.	shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
OpenFileForWeb	205	Opens the file based on the available options in a specific order for web. Order 1. Web companion 2. Office for the web 3. Download the document	param ({OpenMode: undefined | null | Read | Edit}) Optional open mode.
BrowseRelatedObjects	206	Browses related objects.	shellItems (IShellItems ) The shell items being browsed. If undefined, uses current selection.
SaveNewVersion	208	Save new version of the file
CopyWebLink	209	Copies the web link of the object.	shellItems (IShellItems ) The shell items for link copy. If undefined, uses current selection.
SPERead	210	Opens the currently selected object with a native desktop application in read-only mode	shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
ExclusiveEdit	211	Edit command for exclusive editing (Edit alone).	shellItems (IShellItems ) The shell items to check out for exclusive edit. If undefined, uses current selection.
AddToDocumentCollection	213	Adds the selected object to the document collection. Supported in M-Files Client version 25.8 and later.
OpenSharingCenter	214	Opens Sharing Center Dialog with the selected object. Supported in M-Files Client version 25.11 and later.	shellItems (IShellItems ) The shell items being shared. If undefined, uses current selection.
OpenInExternalEditorWeb	215	Opens the file in the back-end specific web editing system. Supported in M-Files Client version 25.12 and later.	shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
DestroyHistoryVersion	216	Destroys a specific history version of an object. This command is only available for admin users in the history view and permanently removes the selected old version from the version history. Supported in M-Files Client version 26.1 and later.	param ({obj_id: IObjID version: IObjVerVersion location: string }) Optional object/version override for history operation.
OpenInExternalEditorWebReadOnly	217	Opens the file in the back-end specific web editing system in read-only mode. Supported in M-Files Client version 26.1 and later.	shellItems (IShellItems ) The shell items to open. If undefined, uses current selection.
SubMenu_OpenForEditing	218	Submenu for editing options. Supported in M-Files Client version 26.1 and later.
SubMenu_OpenForReading	219	Submenu for reading options. Supported in M-Files Client version 26.1 and later.
SubMenu_Compare	220	Compare submenu parent command. Supported in M-Files Client version 26.1 and later.
CompareWithPreviousVersion	221	Compares the selected document with its previous version. Available for DOC/DOCX/PDF/RTF files with more than one version. Supported in M-Files Client version 26.1 and later.
CompareWithAnotherDocument	222	Compares the selected document with another document that the user selects from the file explorer. Available for DOC/DOCX/PDF/RTF files. Supported in M-Files Client version 26.1 and later.
CompareSelectedDocuments	223	Compares two selected documents. Available for DOC/DOCX/PDF/RTF files. Supported in M-Files Client version 26.1 and later.
CopyWorkspaceLink	224	Copies the workspace link of the workspace object. Supported in M-Files Client version 26.2 and later.	shellItems (IShellItems ) The shell items for link copy. If undefined, uses current selection.
ShowConflictHistory	225	Shows the conflict history for the selected object. Supported in M-Files Client version 26.2 and later.
ConflictHistoryRestore	229	Restores the selected version from the conflict history. Supported in M-Files Client version 26.2 and later.	param ({location: string }) Optional telemetry location.

Runtime Access

This enumeration is available at runtime on the MFiles global object. Access enum values using MFiles.BuiltinCommand.<value>.

Example:

const value = MFiles.BuiltinCommand.MakeCopy;

See also: MFiles Global Object