# IVaultExplorerForm interface

*No description yet.*

```csharp
public interface IVaultExplorerForm
```

**Namespace:** DXP · **Assembly:** Altium.SDK.Interfaces

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [BrowseItemsOption](#browseitemsoption) | [TBrowseItemsOptionSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TBrowseItemsOptionSet.md) | get; set |  |
| [ContentTypeFilter](#contenttypefilter) | `string` | get; set |  |
| [DetailsPanelHeight](#detailspanelheight) | `int` | get; set |  |
| [FolderSelectionChange](#folderselectionchange) | [IFolderSelectionHandler](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IFolderSelectionHandler.md) | get; set |  |
| [FolderTypeFilter](#foldertypefilter) | `string` | get; set |  |
| [ModalAction](#modalaction) | [IModalAction](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IModalAction.md) | get; set |  |
| [ShowSearch](#showsearch) | `bool` | get; set |  |
| [ShowVaultRoot](#showvaultroot) | `bool` | get; set |  |
| [TreePanelWidth](#treepanelwidth) | `int` | get; set |  |
| [Vault](#vault) | `bool` | set |  |
| [VisiblePanels](#visiblepanels) | [TVaultExplorerPanelsSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVaultExplorerPanelsSet.md) | get; set |  |

### BrowseItemsOption

*No description yet.*

```csharp
TBrowseItemsOptionSet GetBrowseItemsOption();
void SetBrowseItemsOption(TBrowseItemsOptionSet argOptions);
```

**Type:** [TBrowseItemsOptionSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TBrowseItemsOptionSet.md) · **Access:** read/write

The accessors are extension methods of `IVaultExplorerFormHelper` (`using DXP;`).

### ContentTypeFilter

*No description yet.*

```csharp
string GetContentTypeFilter();
void SetContentTypeFilter(string argValue);
```

**Type:** `string` · **Access:** read/write

### DetailsPanelHeight

*No description yet.*

```csharp
int GetDetailsPanelHeight();
void SetDetailsPanelHeight(int argHeight);
```

**Type:** `int` · **Access:** read/write

### FolderSelectionChange

*No description yet.*

```csharp
IFolderSelectionHandler GetFolderSelectionChange();
void SetFolderSelectionChange(IFolderSelectionHandler argValue);
```

**Type:** [IFolderSelectionHandler](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IFolderSelectionHandler.md) · **Access:** read/write

The accessors are extension methods of `IVaultExplorerFormHelper` (`using DXP;`).

### FolderTypeFilter

*No description yet.*

```csharp
string GetFolderTypeFilter();
void SetFolderTypeFilter(string argValue);
```

**Type:** `string` · **Access:** read/write

### ModalAction

*No description yet.*

```csharp
IModalAction GetModalAction();
void SetModalAction(IModalAction argValue);
```

**Type:** [IModalAction](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IModalAction.md) · **Access:** read/write

The accessors are extension methods of `IVaultExplorerFormHelper` (`using DXP;`).

### ShowSearch

*No description yet.*

```csharp
bool GetShowSearch();
void SetShowSearch(bool argShow);
```

**Type:** `bool` · **Access:** read/write

### ShowVaultRoot

*No description yet.*

```csharp
bool GetShowVaultRoot();
void SetShowVaultRoot(bool argShow);
```

**Type:** `bool` · **Access:** read/write

### TreePanelWidth

*No description yet.*

```csharp
int GetTreePanelWidth();
void SetTreePanelWidth(int argWidth);
```

**Type:** `int` · **Access:** read/write

### Vault

*No description yet.*

```csharp
void SetState_Vault(bool argWait, string argVaultGUID, string argFocusFolderGUID, string argItemGUID, string argRevisionGUID, int argPageInFolder, int argPageSize, bool argFiltered);
```

**Type:** `bool` · **Access:** write-only · **Index:** `argWait` (`bool`), `argVaultGUID` (`string`), `argFocusFolderGUID` (`string`), `argItemGUID` (`string`), `argRevisionGUID` (`string`), `argPageInFolder` (`int`), `argPageSize` (`int`)

### VisiblePanels

*No description yet.*

```csharp
TVaultExplorerPanelsSet GetVisiblePanels();
void SetVisiblePanels(TVaultExplorerPanelsSet argVisiblePanels);
```

**Type:** [TVaultExplorerPanelsSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TVaultExplorerPanelsSet.md) · **Access:** read/write

The accessors are extension methods of `IVaultExplorerFormHelper` (`using DXP;`).

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [AddNavigationWayPoint](#addnavigationwaypoint) | `void` |  |
| [AsForm](#asform) | [ICustomForm](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/ICustomForm.md) |  |
| [ClearModalNavigation](#clearmodalnavigation) | `void` |  |
| [CurrentFolder](#currentfolder) | [IULB_Folder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_Folder.md) |  |
| [CurrentFolderGUID](#currentfolderguid) | `string` |  |
| [CurrentItem](#currentitem) | [IULB_Item](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_Item.md) |  |
| [CurrentItemGUID](#currentitemguid) | `string` |  |
| [CurrentRevision](#currentrevision) | [IULB_ItemRevision](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_ItemRevision.md) |  |
| [CurrentRevisionGUID](#currentrevisionguid) | `string` |  |
| [CurrentVault](#currentvault) | [IEDMS_Vault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md) |  |
| [CurrentVaultGUID](#currentvaultguid) | `string` |  |
| [EnsureFormInitialized](#ensureforminitialized) | `void` |  |
| [GetSelectedItemGUIDs](#getselecteditemguids) | `void` |  |
| [GetSelectedItemRevisionGUIDs](#getselecteditemrevisionguids) | `void` |  |
| [GetVisible](#getvisible) | `bool` |  |
| [ReceiveNotification](#receivenotification) | `void` |  |
| [SectionNamePrefix](#sectionnameprefix) | `string` |  |
| [SetState_RefreshCurrentVault](#setstate_refreshcurrentvault) | `void` |  |
| [ShowHidePanelButtons](#showhidepanelbuttons) | `void` |  |

### AddNavigationWayPoint

*No description yet.*

```csharp
void AddNavigationWayPoint(string argVaultGUID, string argFolderGUID, string argItemGUID, string argRevisionGUID, string argDescription, int argPageInFolder, int argPageSize, bool argFiltered);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVaultGUID` | `string` | value |
| `argFolderGUID` | `string` | value |
| `argItemGUID` | `string` | value |
| `argRevisionGUID` | `string` | value |
| `argDescription` | `string` | value |
| `argPageInFolder` | `int` | value |
| `argPageSize` | `int` | value |
| `argFiltered` | `bool` | value |

**Returns:** nothing (`void`)

### AsForm

*No description yet.*

```csharp
ICustomForm AsForm();
```

**Returns:** [ICustomForm](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/ICustomForm.md)

Extension method of `IVaultExplorerFormHelper` (`using DXP;`).

### ClearModalNavigation

*No description yet.*

```csharp
void ClearModalNavigation();
```

**Returns:** nothing (`void`)

### CurrentFolder

*No description yet.*

```csharp
IULB_Folder CurrentFolder();
```

**Returns:** [IULB_Folder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_Folder.md)

Extension method of `IVaultExplorerFormHelper` (`using DXP;`).

### CurrentFolderGUID

*No description yet.*

```csharp
string CurrentFolderGUID();
```

**Returns:** `string`

### CurrentItem

*No description yet.*

```csharp
IULB_Item CurrentItem();
```

**Returns:** [IULB_Item](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_Item.md)

Extension method of `IVaultExplorerFormHelper` (`using DXP;`).

### CurrentItemGUID

*No description yet.*

```csharp
string CurrentItemGUID();
```

**Returns:** `string`

### CurrentRevision

*No description yet.*

```csharp
IULB_ItemRevision CurrentRevision();
```

**Returns:** [IULB_ItemRevision](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_ItemRevision.md)

Extension method of `IVaultExplorerFormHelper` (`using DXP;`).

### CurrentRevisionGUID

*No description yet.*

```csharp
string CurrentRevisionGUID();
```

**Returns:** `string`

### CurrentVault

*No description yet.*

```csharp
IEDMS_Vault CurrentVault();
```

**Returns:** [IEDMS_Vault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md)

Extension method of `IVaultExplorerFormHelper` (`using DXP;`).

### CurrentVaultGUID

*No description yet.*

```csharp
string CurrentVaultGUID();
```

**Returns:** `string`

### EnsureFormInitialized

*No description yet.*

```csharp
void EnsureFormInitialized(bool argctivateVault);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argctivateVault` | `bool` | value |

**Returns:** nothing (`void`)

### GetSelectedItemGUIDs

*No description yet.*

```csharp
void GetSelectedItemGUIDs(IStrings argItems);
void GetSelectedItemGUIDs(object argItems);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argItems` | [IStrings](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IStrings.md) | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `IVaultExplorerFormHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### GetSelectedItemRevisionGUIDs

*No description yet.*

```csharp
void GetSelectedItemRevisionGUIDs(IStrings argItemRevisons);
void GetSelectedItemRevisionGUIDs(object argItemRevisons);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argItemRevisons` | [IStrings](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IStrings.md) | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `IVaultExplorerFormHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### GetVisible

*No description yet.*

```csharp
bool GetVisible();
```

**Returns:** `bool`

### ReceiveNotification

*No description yet.*

```csharp
void ReceiveNotification(INotification argNotification);
void ReceiveNotification(object argNotification);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argNotification` | [INotification](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/INotification.md) | value |

**Returns:** nothing (`void`)

The first overload is an extension method of `IVaultExplorerFormHelper` (`using DXP;`) with typed parameters; the second is declared by the interface.

### SectionNamePrefix

*No description yet.*

```csharp
string SectionNamePrefix();
```

**Returns:** `string`

### SetState_RefreshCurrentVault

*No description yet.*

```csharp
void SetState_RefreshCurrentVault();
```

**Returns:** nothing (`void`)

### ShowHidePanelButtons

*No description yet.*

```csharp
void ShowHidePanelButtons(bool argShow);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argShow` | `bool` | value |

**Returns:** nothing (`void`)

## Returned by

[IVaultExplorerServer.ModalVaultExplorer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVaultExplorerServer.md#modalvaultexplorer), [IVaultExplorerServer.SimpleVaultExplorer](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVaultExplorerServer.md#simplevaultexplorer)