GetFolderUIStateForFolder Method

Description

Retrieves the UI settings of a specified folder.

Syntax

Visual Basic
Public Function GetFolderUIStateForFolder( _ ByVal CommonState As Boolean, _ ByVal FolderLocation As FolderDefs, _ ByVal ObjectFolder As Boolean _ ) As FolderUIState

Visual Basic

Public Function GetFolderUIStateForFolder( _
   ByVal CommonState As Boolean, _
   ByVal FolderLocation As FolderDefs, _
   ByVal ObjectFolder As Boolean _
) 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).
FolderLocation: The folder location.
ObjectFolder: If true, the actual location is actually a object folder in the folder location.

Remarks

The method can be targeted to a view location that is addressable as FolderDefs Collection location, or an object content folder under such a location. The "ObjectFolder" flag is set, for example, when pointing inside a multi-file document in a certain view location.

The UI state contains column settings for the view. The columns collection contains all columns that can be displayed in the view, regardless whether they are currently visible or not.