IShellListing

Instances of IShellListing represent the Objects inside the Listing View tree in the M-Files Client application UI. The interface is available for example from ActiveListing property of IShellFrame.

See the Overview chapter Listing View for more details how to operate the object.

Properties

Name	Type	Description
CurrentPath	string	Gets the current location as a path.
CurrentSelection	IShellItems
Events	IShellListingEvents	Returns the event registering interface of the IShellListing interface.
IsActive	boolean	Checks if this listing window is currently the active listing window.
Items	IShellItems

Methods

Name	Description
ActivateListing	Makes this listing window the active listing in the shell frame.
ActivateSelected	Performs the default action for currently selected item.
AddListingItem	Adds a new item to the relevant listings. It is a new method added for vNext.
AddObjectFile	Perform add file for MFD.
RefreshListing	Refreshes the current listing.
RefreshObject	Refreshes the specified object in the listing.
RemoveListingItem	Removes an item or items in an array from the listing. It is a new method added for vNext.
ReplaceFile	Perform file replace.
SelectFolder	Moves the selection to the folder item.
SelectNextFolder	Moves the current selection to the next folder item.
SelectNextObject	Moves the current selection to the next object (object version) item.
SelectNextObjectFile	Moves the current selection to the next object file.
SelectObjectFile	Selects the object (object version) item.
SelectObjectOrObjectFileVersion	Selects object or file version in the listing window.
SelectObjectVersion	Selects the object file item.
SelectPrevFolder	Moves the current selection to the previous folder.
SelectPrevObject	Moves the current selection to the previous object (object version) item.
SelectPrevObjectFile	Moves the current selection to the previous object file item.
SetFolderOrObjectVersionSelectionStates	Selects or unselects both property folders and object versions.
SetFolderSelectionStates	Selects or unselects property folders.
SetObjectOrObjectFileVersionSelectionStates	Selects or unselects objects or object files.
SetObjectVersionSelectionStates	Selects or unselects object versions.
SetVirtualSelection	Overrides the items selection with a virtual selection. Items should be valid objects, otherwise the method will throw an exception and selection will not be changed.
UnselectAll	Unselects the current selection.
UpdateListingItem	Update the items in the listing. It is a new method added for vNext.

Events

Event	Description	Arguments
Started	Registers event handler for the IShellListingEvents started event.
Stop	Registers event handler for the IShellListingEvents stopped event.
SelectionChanged	Registers event handler for the IShellListingEvents SelectionChanged event. This event is triggered when the selection in the listing view is set, changed or removed.	shellItems Contains the selected items.
SelectNextObject	Registers event handler for the IShellListingEvents SelectNextObject event. This event is triggered when the next object in the listing is selected.
SelectPreviousObject	Registers event handler for the IShellListingEvents SelectPreviousObject event. This event is triggered when the previous object in the listing is selected.
SelectNextFolder	Registers event handler for the IShellListingEvents SelectNextFolder event. This event is triggered when the next folder in the listing is selected.	folderType type of the folder, which have been selected.
SelectPreviousFolder	Registers event handler for the IShellListingEvents SelectPreviousFolder event. This event is triggered when the previous folder in the listing is selected.	folderType type of the folder, which have been selected.
ListingDeactivated	Registers event handler for the IShellListingEvents ListingDeactivated event. This event is triggered when the listing object becomes inactive and loses the input focus.	shellListing The next active shell listing object. Can be null.
ListingActivated	Registers event handler for the IShellListingEvents ListingActivated event. This event is triggered when the listing object becomes active and receives the input focus.	shellListing The previous active shell listing object. Can be null.
ContentChanged	Registers event handler for the IShellListingEvents ContentChanged event. This event is triggered when the current listing content is changed, or listed items are modified.	shellItems Contains all items in the listing.
ListItemAdded	Registers event handler for the IShellListingEvents ListItemAdded event. This event is triggered when one or more items are added to the listing.	objectVersion Object
ListItemRemoved	Registers event handler for the IShellListingEvents ListItemRemoved event. This event is triggered when one or more items are removed from the listing.	listItem Either an array of ObjectVersionEx if non-folder objects are removed or a single ObjectVersionEx, in case folder is removed. removedExternalFolder In case folder was removed, include information about the old external folder item being removed in case of
ListItemModified	Registers event handler for the IShellListingEvents ListItemModified event. This event is triggered when one or more of the items that are currently selected are modified.	oldServerObjVer Array of old object versions. newObjVer Array of new objects.
SelectedItemsChanged	Registers event handler for the IShellListingEvents SelectedItemsChanged event. This event is triggered when one or more of the items that are currently selected are modified.	shellItems Contains the selected items.