# IVcsDesignVault interface

*No description yet.*

```csharp
public interface IVcsDesignVault
```

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

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [Activated](#activated) | `bool` | get; set |  |
| [CreateKindKind](#createkindkind) | [TCreateKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TCreateKind.md) | get; set |  |
| [DefaultWorkingCopy](#defaultworkingcopy) | `string` | get; set |  |
| [ManagedRepositoryGUID](#managedrepositoryguid) | `string` | get; set |  |
| [Name](#name) | `string` | get; set |  |
| [Password](#password) | `string` | get; set |  |
| [RepositoryAddress](#repositoryaddress) | `string` | get; set |  |
| [RepositoryType](#repositorytype) | [TRepositoryType](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TRepositoryType.md) | get; set |  |
| [UserName](#username) | `string` | get; set |  |

### Activated

*No description yet.*

```csharp
bool GetActivated();
void SetActivated(bool argValue);
```

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

### CreateKindKind

*No description yet.*

```csharp
TCreateKind GetCreateKindKind();
void SetCreateKindKind(TCreateKind argValue);
```

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

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

### DefaultWorkingCopy

*No description yet.*

```csharp
string GetDefaultWorkingCopy();
void SetDefaultWorkingCopy(string argValue);
```

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

### ManagedRepositoryGUID

*No description yet.*

```csharp
string GetManagedRepositoryGUID();
void SetManagedRepositoryGUID(string argValue);
```

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

### Name

*No description yet.*

```csharp
string GetName();
void SetName(string argValue);
```

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

### Password

*No description yet.*

```csharp
string GetPassword();
void SetPassword(string argValue);
```

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

### RepositoryAddress

*No description yet.*

```csharp
string GetRepositoryAddress();
void SetRepositoryAddress(string argValue);
```

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

### RepositoryType

*No description yet.*

```csharp
TRepositoryType GetRepositoryType();
void SetRepositoryType(TRepositoryType argValue);
```

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

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

### UserName

*No description yet.*

```csharp
string GetUserName();
void SetUserName(string argValue);
```

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

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [CommitCreation](#commitcreation) | `string` |  |
| [CopyTo](#copyto) | `void` |  |
| [GetProvider](#getprovider) | [IVcsProvider](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProvider.md) |  |
| [GetProviderType](#getprovidertype) | [TProviderType](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TProviderType.md) |  |
| [GetRepositoryAddressOnly](#getrepositoryaddressonly) | `string` |  |
| [Import](#import) | `string` |  |
| [Initialize](#initialize) | `void` |  |
| [IsEqual](#isequal) | `bool` |  |
| [LoadFromIni](#loadfromini) | `bool` |  |
| [RunPropertiesForm](#runpropertiesform) | `bool` |  |
| [SaveToIni](#savetoini) | `void` |  |
| [Status](#status) | `string` |  |

### CommitCreation

*No description yet.*

```csharp
string CommitCreation();
```

**Returns:** `string`

### CopyTo

*No description yet.*

```csharp
void CopyTo(IVcsDesignVault argVault);
void CopyTo(object argVault);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVault` | [IVcsDesignVault](#) | value |

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

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

### GetProvider

*No description yet.*

```csharp
IVcsProvider GetProvider();
```

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

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

### GetProviderType

*No description yet.*

```csharp
TProviderType GetProviderType();
```

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

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

### GetRepositoryAddressOnly

*No description yet.*

```csharp
string GetRepositoryAddressOnly();
```

**Returns:** `string`

### Import

*No description yet.*

```csharp
string Import(IVcsProject argVCSProject, string argPath, string argLocalPath, IVcsFileNames argFileNames, string argComment);
string Import(object argVCSProject, string argPath, string argLocalPath, object argFileNames, string argComment);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argPath` | `string` | value |
| `argLocalPath` | `string` | value |
| `argFileNames` | [IVcsFileNames](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsFileNames.md) | value |
| `argComment` | `string` | value |

**Returns:** `string`

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

### Initialize

*No description yet.*

```csharp
void Initialize(IVcsProject argVCSProject, string argPath, string argLocalPath);
void Initialize(object argVCSProject, string argPath, string argLocalPath);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVCSProject` | [IVcsProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md) | value |
| `argPath` | `string` | value |
| `argLocalPath` | `string` | value |

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

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

### IsEqual

*No description yet.*

```csharp
bool IsEqual(IVcsDesignVault argVault);
bool IsEqual(object argVault);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVault` | [IVcsDesignVault](#) | value |

**Returns:** `bool`

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

### LoadFromIni

*No description yet.*

```csharp
bool LoadFromIni(IOptionsReader argReader, string argSectionName, string argSuffix);
bool LoadFromIni(object argReader, string argSectionName, string argSuffix);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argReader` | [IOptionsReader](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IOptionsReader.md) | value |
| `argSectionName` | `string` | value |
| `argSuffix` | `string` | value |

**Returns:** `bool`

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

### RunPropertiesForm

*No description yet.*

```csharp
bool RunPropertiesForm(IVcsFileNames argExistingNames, bool argCreateNew);
bool RunPropertiesForm(object argExistingNames, bool argCreateNew);
```

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

**Returns:** `bool`

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

### SaveToIni

*No description yet.*

```csharp
void SaveToIni(IOptionsWriter argWriter, string argSectionName, string argSuffix);
void SaveToIni(object argWriter, string argSectionName, string argSuffix);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argWriter` | [IOptionsWriter](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IOptionsWriter.md) | value |
| `argSectionName` | `string` | value |
| `argSuffix` | `string` | value |

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

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

### Status

*No description yet.*

```csharp
string Status();
```

**Returns:** `string`

## Returned by

[IEDesignData_VcsBasedProjectActions.CloneDialog](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#clonedialog), [IEDesignData_VcsBasedProjectActions.ConvertDialog](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#convertdialog), [IEDesignData_VcsBasedProjectActions.ConvertDialogEx](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#convertdialogex), [IEDesignData_VcsBasedProjectActions.FindDesignVaultByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#finddesignvaultbyname), [IEDesignData_VcsBasedProjectActions.GetDesignVaultByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#getdesignvaultbyname), [IEDesignData_VcsBasedProjectActions.LinkDialog](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#linkdialog), [IEDesignData_VcsBasedProjectActions.OpenDialog](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#opendialog), [IVcsBasedProjectCommands.GetDesignVaultByGUID](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsBasedProjectCommands.md#getdesignvaultbyguid), [IVcsBasedProjectCommands.GetDesignVaultByPath](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsBasedProjectCommands.md#getdesignvaultbypath), [IVcsProject.DesignVault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md#designvault), [IVcsProvider.AddRegisteredDesignVault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProvider.md#addregistereddesignvault), [IVcsProvider.CreateDesignVault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProvider.md#createdesignvault), [IVcsProvider.DesignVaultForFolder](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProvider.md#designvaultforfolder), [IVcsProvider.GetRegisteredDesignVault](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProvider.md#getregistereddesignvault)

## Accepted by

[IEDesignData_VcsBasedProjectActions.AddProjectFolderToVCS](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#addprojectfoldertovcs), [IEDesignData_VcsBasedProjectActions.AddProjectToVCS](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#addprojecttovcs), [IEDesignData_VcsBasedProjectActions.AddProjectToVCSNoUI](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#addprojecttovcsnoui), [IEDesignData_VcsBasedProjectActions.CanAddProjectToVCS](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#canaddprojecttovcs), [IEDesignData_VcsBasedProjectActions.CheckOut](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#checkout), [IEDesignData_VcsBasedProjectActions.SelectRepositoryPath](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDesignData_VcsBasedProjectActions.md#selectrepositorypath), [IVcsBasedProjectCommands.AddProjectFolderToVCS](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsBasedProjectCommands.md#addprojectfoldertovcs), [IVcsBasedProjectCommands.AddProjectToVCSNoUI](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsBasedProjectCommands.md#addprojecttovcsnoui), [IVcsBasedProjectCommands.CheckoutProjectNoUI](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsBasedProjectCommands.md#checkoutprojectnoui), [IVcsBasedProjectCommands.SelectRepositoryPath](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsBasedProjectCommands.md#selectrepositorypath), [IVcsProject.CheckoutProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md#checkoutproject), [IVcsProject.GetProjPath](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject.md#getprojpath), [IVcsProject6.CheckoutProjectWithOptionalHistory](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IVcsProject6.md#checkoutprojectwithoptionalhistory)