M-Files API 22.6.11519.0
GetFolderUIStateForSpecialLocation Method
VaultViewOperations Object : GetFolderUIStateForSpecialLocation Method
True to get the common UI state. False to get the user-specific UI state (can also return the common state when there are no user-specific state).
Description
Retrieves the UI settings of a specified folder.
Syntax
Visual Basic
Public Function GetFolderUIStateForSpecialLocation( _
   ByVal CommonState As Boolean, _
   ByVal LocationType As MFFolderUIStateLocationType _
) As FolderUIState
Parameters
CommonState
True to get the common UI state. False to get the user-specific UI state (can also return the common state when there are no user-specific state).
LocationType
ValueDescription
MFFolderUIStateLocationTypeClearLocalCacheUISpecial folder that displays the non-document files in the local client cache.
MFFolderUIStateLocationTypeCollectionMembersUISpecial folder that displays document collection members.
MFFolderUIStateLocationTypeHistoryUISpecial folder that displays the object history.
MFFolderUIStateLocationTypeLocalTemporaryItemsContainerContainer of local temporary files/folders.
MFFolderUIStateLocationTypeObjectFilesContainerObject folder, contains object files.
MFFolderUIStateLocationTypeObjectsContainerView folder that contains objects only.
MFFolderUIStateLocationTypePropertyFoldersContainerView folder that contains property folders.
MFFolderUIStateLocationTypeRelationshipsUIAllTabSpecial folder that displays all relationships of an object.
MFFolderUIStateLocationTypeRelationshipsUIFromTabSpecial folder that displays relationships out from the object.
MFFolderUIStateLocationTypeRelationshipsUIToTabSpecial folder that displays relationships in to the object.
MFFolderUIStateLocationTypeRootFolderFolder location type that indicates the vault root folder.
MFFolderUIStateLocationTypeSearchResultsContainerSearch folder.
MFFolderUIStateLocationTypeSubobjectsUISpecial folder that displays subobjects of an object.
MFFolderUIStateLocationTypeTraditionalFolderTraditional folder.
MFFolderUIStateLocationTypeUnknownUnknown folder location type.
MFFolderUIStateLocationTypeViewFoldersContainerView folder that acts as a container for other views.
Remarks

The method can be targeted to a special view that is not addressable via a normal view or folder location path.

The UI state contains column settings for the view. The contained columns collection contains all columns that can be displayed in the view.

See Also

VaultViewOperations Object  | VaultViewOperations Members