# FolderUIState

Location: [gRPC API](https://developer.m-files.com/APIs/gRPC-API/index.md) > [Reference](https://developer.m-files.com/APIs/gRPC-API/Reference/index.md) > [Messages](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/index.md)

HTML version: https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.FolderUIState/

Folder UIState.

- **Full name:** `MFiles.FolderUIState`
- **Proto file:** [`mfiles/structs.proto`](https://developer.m-files.com/APIs/gRPC-API/downloads/proto/mfiles/structs.proto)

<a id="fields"></a>

## Fields

| Field | Type | Number | Description |
|---|---|---|---|
| <a id="f-folder_id"></a>`folder_id` | [`UISettingsFolderID`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.UISettingsFolderID/index.md) | 1 | The ID that describes the folder. |
| <a id="f-folder_type"></a>`folder_type` | [`ShellFolderType`](https://developer.m-files.com/APIs/gRPC-API/Reference/Enums/MFiles.ShellFolderType/index.md) | 2 | Specifies shell folder type. Values: `SHELL_FOLDER_TYPE_NORMAL` (0), `SHELL_FOLDER_TYPE_OBJECT_HISTORY` (2), `SHELL_FOLDER_TYPE_NON_OBJECT_ITEMS` (3), `SHELL_FOLDER_TYPE_RELATIONSHIPS` (4), `SHELL_FOLDER_TYPE_SUBOBJECTS` (5), `SHELL_FOLDER_TYPE_COLLECTION_MEMBERS` (6), `SHELL_FOLDER_TYPE_DELETED_CONFLICT_HISTORY` (7). |
| <a id="f-show_right_pane"></a>`show_right_pane` | `bool` | 3 | Specifies whether the right pane is displayed. |
| <a id="f-show_bottom_pane"></a>`show_bottom_pane` | `bool` | 4 | Specifies whether the bottom pane is displayed. |
| <a id="f-is_bottom_pane_minimized"></a>`is_bottom_pane_minimized` | `bool` | 5 | Specifies whether the bottom pane is minimized. |
| <a id="f-is_right_pane_minimized"></a>`is_right_pane_minimized` | `bool` | 6 | Specifies whether the right pane is minimized. |
| <a id="f-show_metadata_editorn_right_pane"></a>`show_metadata_editorn_right_pane` | `bool` | 7 | Specifies whether the metadata editor is displayed in the right pane. If false, the metadata editor appears in the bottom pane. |
| <a id="f-is_hit_highlighting_enabled"></a>`is_hit_highlighting_enabled` | `bool` | 8 | Specifies whether hit highlighting in file content is enabled. |
| <a id="f-bottom_pane_height"></a>`bottom_pane_height` | `int32` | 9 | Specifies the bottom pane height. The height is relative to the size of the frame window holding the bottom pane bar. |
| <a id="f-right_pane_width"></a>`right_pane_width` | `int32` | 10 | Specifies the right pane width. |
| <a id="f-show_task_pane"></a>`show_task_pane` | `bool` | 11 | Specifies whether the task area is displayed. |
| <a id="f-is_task_pane_minimized"></a>`is_task_pane_minimized` | `bool` | 12 | Specifies whether the task area is minimized. |
| <a id="f-listing_ui_state"></a>`listing_ui_state` | [`FolderListingUIState`](https://developer.m-files.com/APIs/gRPC-API/Reference/Messages/MFiles.FolderListingUIState/index.md) | 13 | The listing UI state. |

<a id="used-by-methods"></a>

## Used by methods

- [IRPCFolderUISettings.GetFolderUIState](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/GetFolderUIState/index.md): Gets the display settings of a folder location as a structure.
- [IRPCFolderUISettings.ResetFolderUIStateToDefaults](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/ResetFolderUIStateToDefaults/index.md): Resets the caller's display settings of a folder to the program defaults or to the common settings, and returns the resulting state as a structure.
- [IRPCFolderUISettings.SetFolderUIState](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/SetFolderUIState/index.md): Saves the display settings of a folder location from a structure, for the caller and optionally as the common settings.

<a id="used-in-fields"></a>

## Used in fields

- [`GetFolderUIStateResponse.folder_uistate`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/GetFolderUIState/index.md#response): The display settings, including the resolved `folder_id`.
- [`SetFolderUIStateRequest.folder_uistate`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/SetFolderUIState/index.md#request): The display settings to store.
- [`ResetFolderUIStateToDefaultsResponse.folder_uistate`](https://developer.m-files.com/APIs/gRPC-API/Reference/MFiles.IRPCFolderUISettings/ResetFolderUIStateToDefaults/index.md#response): The caller's display settings after the reset.