# IULB_Folder interface

*No description yet.*

```csharp
public interface IULB_Folder : IEDM_ShareableRecord
```

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

**Inherits:** [IEDM_Object](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Object.md) → [IEDM_Record](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md) → [IEDM_ShareableRecord](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_ShareableRecord.md)

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [Attributes](#attributes) | `int` | get; set |  |
| [Description](#description) | `string` | get; set |  |
| [FolderTypeGUID](#foldertypeguid) | `string` | get; set |  |
| [IsActive](#isactive) | `bool` | get; set |  |
| [IsShared](#isshared) | `bool` | get; set |  |
| [NamingScheme](#namingscheme) | `string` | get; set |  |
| [ParentFolderGUID](#parentfolderguid) | `string` | get; set |  |
| [SharedName](#sharedname) | `string` | get; set |  |
| [SharingControl](#sharingcontrol) | `int` | get; set |  |
| [SubFolder](#subfolder) | [IULB_Folder](#) | get; set |  |
| [Weight](#weight) | `int` | get; set |  |

### Attributes

*No description yet.*

```csharp
int GetAttributes();
void SetAttributes(int argValue);
```

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

### Description

*No description yet.*

```csharp
string GetDescription();
void SetDescription(string argValue);
```

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

### FolderTypeGUID

*No description yet.*

```csharp
string GetFolderTypeGUID();
void SetFolderTypeGUID(string argValue);
```

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

### IsActive

*No description yet.*

```csharp
bool GetIsActive();
void SetIsActive(bool argValue);
```

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

### IsShared

*No description yet.*

```csharp
bool GetIsShared();
void SetIsShared(bool argValue);
```

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

### NamingScheme

*No description yet.*

```csharp
string GetNamingScheme();
void SetNamingScheme(string argValue);
```

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

### ParentFolderGUID

*No description yet.*

```csharp
string GetParentFolderGUID();
void SetParentFolderGUID(string argValue);
```

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

### SharedName

*No description yet.*

```csharp
string GetSharedName();
void SetSharedName(string argValue);
```

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

### SharingControl

*No description yet.*

```csharp
int GetSharingControl();
void SetSharingControl(int argValue);
```

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

### SubFolder

*No description yet.*

```csharp
IULB_Folder GetSubFolder(int argIndex);
void SetSubFolder(int argIndex, IULB_Folder argRecord);
```

**Type:** [IULB_Folder](#) · **Access:** read/write · **Index:** `argIndex` (`int`)

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

### Weight

*No description yet.*

```csharp
int GetWeight();
void SetWeight(int argValue);
```

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

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [AddFolderParameter](#addfolderparameter) | `void` |  |
| [AddSubFolder](#addsubfolder) | `void` |  |
| [ClearSubFolders](#clearsubfolders) | `void` |  |
| [DeleteSubFolder](#deletesubfolder) | `void` |  |
| [FilterFolderTree](#filterfoldertree) | `void` |  |
| [FindFolder](#findfolder) | [IULB_Folder](#) |  |
| [GetParameter](#getparameter) | [IULB_FolderParameter](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_FolderParameter.md) |  |
| [GetParameterByGUID](#getparameterbyguid) | [IULB_FolderParameter](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_FolderParameter.md) |  |
| [GetParameterCount](#getparametercount) | `int` |  |
| [GetSubFolderCount](#getsubfoldercount) | `int` |  |
| [RemoveAllParameters](#removeallparameters) | `void` |  |
| [RemoveFolderParameter](#removefolderparameter) | `void` |  |

### AddFolderParameter

*No description yet.*

```csharp
void AddFolderParameter(IULB_FolderParameter argParameter);
void AddFolderParameter(object argParameter);
```

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

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

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

### AddSubFolder

*No description yet.*

```csharp
void AddSubFolder(IULB_Folder argRecord);
void AddSubFolder(object argRecord);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argRecord` | [IULB_Folder](#) | value |

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

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

### ClearSubFolders

*No description yet.*

```csharp
void ClearSubFolders();
```

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

### DeleteSubFolder

*No description yet.*

```csharp
void DeleteSubFolder(int argIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIndex` | `int` | value |

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

### FilterFolderTree

*No description yet.*

```csharp
void FilterFolderTree(string argContentTypes);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argContentTypes` | `string` | value |

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

### FindFolder

*No description yet.*

```csharp
IULB_Folder FindFolder(string argGUID);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argGUID` | `string` | value |

**Returns:** [IULB_Folder](#)

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

### GetParameter

*No description yet.*

```csharp
IULB_FolderParameter GetParameter(int argi);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argi` | `int` | value |

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

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

### GetParameterByGUID

*No description yet.*

```csharp
IULB_FolderParameter GetParameterByGUID(string argGUID);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argGUID` | `string` | value |

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

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

### GetParameterCount

*No description yet.*

```csharp
int GetParameterCount();
```

**Returns:** `int`

### GetSubFolderCount

*No description yet.*

```csharp
int GetSubFolderCount();
```

**Returns:** `int`

### RemoveAllParameters

*No description yet.*

```csharp
void RemoveAllParameters();
```

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

### RemoveFolderParameter

*No description yet.*

```csharp
void RemoveFolderParameter(string argGUID);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argGUID` | `string` | value |

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

## Inherited members

- From [IEDM_ShareableRecord](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_ShareableRecord.md): [CanCreate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_ShareableRecord.md#cancreate), [CanDelete](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_ShareableRecord.md#candelete), [CanRead](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_ShareableRecord.md#canread), [CanUpdate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_ShareableRecord.md#canupdate)
- From [IEDM_Record](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md): [CreatedByGUID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#createdbyguid), [CreatedByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#createdbyname), [CreatedDate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#createddate), [GUID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#guid), [HRID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#hrid), [LastModifiedByGUID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#lastmodifiedbyguid), [LastModifiedByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#lastmodifiedbyname), [LastModifiedDate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Record.md#lastmodifieddate)
- From [IEDM_Object](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Object.md): [CopyTo](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Object.md#copyto), [Replicate](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Object.md#replicate)

## Returned by

[IEDMS_Vault.CreateFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md#createfolder), [IEDMS_Vault.FolderByGUID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md#folderbyguid), [IEDMS_Vault.FolderByHRID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_Vault.md#folderbyhrid), [IFolderDetailsFrame.CurrentFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IFolderDetailsFrame.md#currentfolder), [IModalAction.GetCurrentFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IModalAction.md#getcurrentfolder), [IULB_FoldersResult.GetFirstFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_FoldersResult.md#getfirstfolder), [IULB_FoldersResult.GetFolderByGUID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IULB_FoldersResult.md#getfolderbyguid), [IVaultExplorerForm.CurrentFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVaultExplorerForm.md#currentfolder)

## Accepted by

[IComponentLibraryManager.GenerateItemNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/componentlib/IComponentLibraryManager.md#generateitemnames), [IComponentLibraryManager.GetItemNameGenerator](https://altiumdeveloper.github.io/ad-sdk-docs/reference/componentlib/IComponentLibraryManager.md#getitemnamegenerator), [IEDMS_PermissionSetWrapper.ExportToVault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_PermissionSetWrapper.md#exporttovault), [IEDM_Script.AddFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Script.md#addfolder), [IEDM_Script.UpdateFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDM_Script.md#updatefolder), [IEDesignDataInterface.CreatePermissionSetWrapper](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignDataInterface.md#createpermissionsetwrapper), [IEDesignDataInterface.ExecuteFolderPermissionForm](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignDataInterface.md#executefolderpermissionform), [IEDesignDataInterface.ExecuteNewFolderPermissionForm](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignDataInterface.md#executenewfolderpermissionform), [IEDesignDataInterface.GetCandidateItemName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignDataInterface.md#getcandidateitemname), [IEDesignDataInterface.GetCandidateItemNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignDataInterface.md#getcandidateitemnames), [IEDesignData_GUIActions.BrowseFolders](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_GUIActions.md#browsefolders), [IEDesignData_VaultAspectItemsPopup.BatchEditItemRevision](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#batchedititemrevision), [IEDesignData_VaultAspectItemsPopup.CanCloneItemRevision](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#cancloneitemrevision), [IEDesignData_VaultAspectItemsPopup.CanEditItemRevision](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#canedititemrevision), [IEDesignData_VaultAspectItemsPopup.CloneItemRevision](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#cloneitemrevision), [IEDesignData_VaultAspectItemsPopup.CreateAndEditItem](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#createandedititem), [IEDesignData_VaultAspectItemsPopup.EditItemRevision](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#edititemrevision), [IEDesignData_VaultAspectItemsPopup.Popup](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#popup), [IEDesignData_VaultAspectItemsPopup.PopupEx](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VaultAspectItemsPopup.md#popupex), [IFolderAspectView.SetState](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IFolderAspectView.md#setstate), [IFolderSelectionHandler.HandleEvent](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IFolderSelectionHandler.md#handleevent)

## Examples

Used in the SDK examples: [Extension_GetVaultFolder](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_GetVaultFolder/Source%20Code/Commands.cs#L40).