IVcsDesignVault interface

No description yet.

public interface IVcsDesignVault

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
Activated	bool	get; set
CreateKindKind	TCreateKind	get; set
DefaultWorkingCopy	string	get; set
ManagedRepositoryGUID	string	get; set
Name	string	get; set
Password	string	get; set
RepositoryAddress	string	get; set
RepositoryType	TRepositoryType	get; set
UserName	string	get; set

Activated

No description yet.

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

Type: bool · Access: read/write

CreateKindKind

No description yet.

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

Type: TCreateKind · Access: read/write

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

DefaultWorkingCopy

No description yet.

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

Type: string · Access: read/write

ManagedRepositoryGUID

No description yet.

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

Type: string · Access: read/write

Name

No description yet.

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

Type: string · Access: read/write

Password

No description yet.

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

Type: string · Access: read/write

RepositoryAddress

No description yet.

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

Type: string · Access: read/write

RepositoryType

No description yet.

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

Type: TRepositoryType · Access: read/write

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

UserName

No description yet.

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

Type: string · Access: read/write

Methods

Method	Returns	Description
CommitCreation	string
CopyTo	void
GetProvider	IVcsProvider
GetProviderType	TProviderType
GetRepositoryAddressOnly	string
Import	string
Initialize	void
IsEqual	bool
LoadFromIni	bool
RunPropertiesForm	bool
SaveToIni	void
Status	string

CommitCreation

No description yet.

string CommitCreation();

Returns: string

CopyTo

No description yet.

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.

IVcsProvider GetProvider();

Returns: IVcsProvider

Extension method of IVcsDesignVaultHelper (using DXP;).

GetProviderType

No description yet.

TProviderType GetProviderType();

Returns: TProviderType

Extension method of IVcsDesignVaultHelper (using DXP;).

GetRepositoryAddressOnly

No description yet.

string GetRepositoryAddressOnly();

Returns: string

Import

No description yet.

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	value
argPath	string	value
argLocalPath	string	value
argFileNames	IVcsFileNames	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.

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

Parameter	Type	Passing
argVCSProject	IVcsProject	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.

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.

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

Parameter	Type	Passing
argReader	IOptionsReader	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.

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

Parameter	Type	Passing
argExistingNames	IVcsFileNames	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.

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

Parameter	Type	Passing
argWriter	IOptionsWriter	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.

string Status();

Returns: string

Returned by

IEDesignData_VcsBasedProjectActions.CloneDialog, IEDesignData_VcsBasedProjectActions.ConvertDialog, IEDesignData_VcsBasedProjectActions.ConvertDialogEx, IEDesignData_VcsBasedProjectActions.FindDesignVaultByName, IEDesignData_VcsBasedProjectActions.GetDesignVaultByName, IEDesignData_VcsBasedProjectActions.LinkDialog, IEDesignData_VcsBasedProjectActions.OpenDialog, IVcsBasedProjectCommands.GetDesignVaultByGUID, IVcsBasedProjectCommands.GetDesignVaultByPath, IVcsProject.DesignVault, IVcsProvider.AddRegisteredDesignVault, IVcsProvider.CreateDesignVault, IVcsProvider.DesignVaultForFolder, IVcsProvider.GetRegisteredDesignVault

Accepted by

IEDesignData_VcsBasedProjectActions.AddProjectFolderToVCS, IEDesignData_VcsBasedProjectActions.AddProjectToVCS, IEDesignData_VcsBasedProjectActions.AddProjectToVCSNoUI, IEDesignData_VcsBasedProjectActions.CanAddProjectToVCS, IEDesignData_VcsBasedProjectActions.CheckOut, IEDesignData_VcsBasedProjectActions.SelectRepositoryPath, IVcsBasedProjectCommands.AddProjectFolderToVCS, IVcsBasedProjectCommands.AddProjectToVCSNoUI, IVcsBasedProjectCommands.CheckoutProjectNoUI, IVcsBasedProjectCommands.SelectRepositoryPath, IVcsProject.CheckoutProject, IVcsProject.GetProjPath, IVcsProject6.CheckoutProjectWithOptionalHistory