SaveFolderUIStateForFolder Method

Description

Saves the UI settings of a specified folder.

Syntax

Visual Basic
Public Sub SaveFolderUIStateForFolder( _ ByVal SaveAsCommonSettings As Boolean, _ ByVal ResetCommonSettingsToAllUsers As Boolean, _ ByVal FolderLocation As FolderDefs, _ ByVal ObjectFolder As Boolean, _ ByVal State As FolderUIState _ )

Visual Basic

Public Sub SaveFolderUIStateForFolder( _
   ByVal SaveAsCommonSettings As Boolean, _
   ByVal ResetCommonSettingsToAllUsers As Boolean, _
   ByVal FolderLocation As FolderDefs, _
   ByVal ObjectFolder As Boolean, _
   ByVal State As FolderUIState _
)

Parameters

SaveAsCommonSettings: True if the UI settings must also be saved as the common settings of the given folder.
ResetCommonSettingsToAllUsers: True if the common settings must be reset to all users. This parameter is meaningful only if "SaveAsCommonSettings" is true, otherwise it is ignored.
FolderLocation: The folder location.
ObjectFolder: If true, the real location is actually an object folder in the folder location.
State: The UI state of the folder.

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 system may internally rearrange the FolderUIState Object structure, and especially the FolderListingColumns Collection inside it.