IVcsManager interface

No description yet.

public interface IVcsManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
SVNDbLibRepositoryCacheFolder	string	get; set
SVNDbLibRepositoryWorkingFolder	string	get; set
SVNDbLibUpdateThreshold	int	get; set

SVNDbLibRepositoryCacheFolder

No description yet.

string GetState_SVNDbLibRepositoryCacheFolder();
void SetState_SVNDbLibRepositoryCacheFolder(string argValue);

Type: string · Access: read/write

SVNDbLibRepositoryWorkingFolder

No description yet.

string GetState_SVNDbLibRepositoryWorkingFolder();
void SetState_SVNDbLibRepositoryWorkingFolder(string argValue);

Type: string · Access: read/write

SVNDbLibUpdateThreshold

No description yet.

int GetState_SVNDbLibUpdateThreshold();
void SetState_SVNDbLibUpdateThreshold(int argValue);

Type: int · Access: read/write

Methods

Method	Returns	Description
BackgroundGetRevisions	IVcsRevisions
BackgroundGetStatus	TVCSStatusSet
BackgroundGetStatusString	string
CheckoutSVNDBLIBWorkingFolders	bool
CommitInteractively	string
CreateVcsProject	IVcsProject
GetDeletedFileList	IVcsFileNames
GetDocumentStatus	TVCSStatusSet
GetLocationInRepository	string
GetProjectFromVcs	string
GetProviderByType	IVcsProvider
GetRevisions	IVcsRevisions
GetStatus	TVCSStatusSet
GetStatusString	string
GetSVNDblibDocForDocument	IDXPSVNDatabaseLibDocument
GetSVNDblibWorkingDirectoryNameFromRepositoryPath	string
GetVcsFileNamesFactory	IVcsFileNamesFactory
GetVcsRevisionString	string
GetVcsRevisionStringForDocument	string
GetVcsRevisionStringForDocumentExt	string
IsVCSActive	bool
ListenForVCSStatusChanges	void
NeedToCheckoutSVNDBLIBWorkingFolders	bool
Refresh	void
StopListeningForVCSStatusChanges	void
UpdateInteractively	string

BackgroundGetRevisions

No description yet.

IVcsRevisions BackgroundGetRevisions(IVcsProject argVCSProject, string argFullPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFullPath	string	value

Returns: IVcsRevisions

Extension method of IVcsManagerHelper (using DXP;).

BackgroundGetStatus

No description yet.

TVCSStatusSet BackgroundGetStatus(IVcsProject argVCSProject, string argFullPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFullPath	string	value

Returns: TVCSStatusSet

Extension method of IVcsManagerHelper (using DXP;).

BackgroundGetStatusString

No description yet.

string BackgroundGetStatusString(IVcsProject argVCSProject, string argFullPath);
string BackgroundGetStatusString(object argVCSProject, string argFullPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFullPath	string	value

Returns: string

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

CheckoutSVNDBLIBWorkingFolders

No description yet.

bool CheckoutSVNDBLIBWorkingFolders(IDXPSVNDatabaseLibDocument argSVNDbLibDoc);
bool CheckoutSVNDBLIBWorkingFolders(object argSVNDbLibDoc);

Parameter	Type	Passing
argSVNDbLibDoc	IDXPSVNDatabaseLibDocument	value

Returns: bool

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

CommitInteractively

No description yet.

string CommitInteractively(IVcsProject argVCSProject, IVcsFileNames argFileNames);
string CommitInteractively(object argVCSProject, object argFileNames);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFileNames	IVcsFileNames	value

Returns: string

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

CreateVcsProject

No description yet.

IVcsProject CreateVcsProject(IDXPProject argProject, string argProjectFullPath);

Parameter	Type	Passing
argProject	IDXPProject	value
argProjectFullPath	string	value

Returns: IVcsProject

Extension method of IVcsManagerHelper (using DXP;).

GetDeletedFileList

No description yet.

IVcsFileNames GetDeletedFileList(IVcsProject argVCSProject);

Parameter	Type	Passing
argVCSProject	IVcsProject	value

Returns: IVcsFileNames

Extension method of IVcsManagerHelper (using DXP;).

GetDocumentStatus

No description yet.

TVCSStatusSet GetDocumentStatus(string argDocument);

Parameter	Type	Passing
argDocument	string	value

Returns: TVCSStatusSet

Extension method of IVcsManagerHelper (using DXP;).

GetLocationInRepository

No description yet.

string GetLocationInRepository(IVcsProject argVCSProject, string argFullPath);
string GetLocationInRepository(object argVCSProject, string argFullPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFullPath	string	value

Returns: string

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

GetProjectFromVcs

No description yet.

string GetProjectFromVcs(string argLocalPath);

Parameter	Type	Passing
argLocalPath	string	value

Returns: string

GetProviderByType

No description yet.

IVcsProvider GetProviderByType(TProviderType argProviderType);

Parameter	Type	Passing
argProviderType	TProviderType	value

Returns: IVcsProvider

Extension method of IVcsManagerHelper (using DXP;).

GetRevisions

No description yet.

IVcsRevisions GetRevisions(IVcsProject argVCSProject, string argFullPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFullPath	string	value

Returns: IVcsRevisions

Extension method of IVcsManagerHelper (using DXP;).

GetStatus

No description yet.

TVCSStatusSet GetStatus(IVcsProject argVCSProject, string argFullPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFullPath	string	value

Returns: TVCSStatusSet

Extension method of IVcsManagerHelper (using DXP;).

GetStatusString

No description yet.

string GetStatusString(IVcsProject argVCSProject, string argFullPath);
string GetStatusString(object argVCSProject, string argFullPath);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFullPath	string	value

Returns: string

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

GetSVNDblibDocForDocument

No description yet.

IDXPSVNDatabaseLibDocument GetSVNDblibDocForDocument(IDXPDocument argDocument);

Parameter	Type	Passing
argDocument	IDXPDocument	value

Returns: IDXPSVNDatabaseLibDocument

Extension method of IVcsManagerHelper (using DXP;).

GetSVNDblibWorkingDirectoryNameFromRepositoryPath

No description yet.

string GetSVNDblibWorkingDirectoryNameFromRepositoryPath(string argRepositoryPath, string argRepositoryURL);

Parameter	Type	Passing
argRepositoryPath	string	value
argRepositoryURL	string	value

Returns: string

GetVcsFileNamesFactory

No description yet.

IVcsFileNamesFactory GetVcsFileNamesFactory();

Returns: IVcsFileNamesFactory

Extension method of IVcsManagerHelper (using DXP;).

GetVcsRevisionString

No description yet.

string GetVcsRevisionString(IVcsRevisions argRevisions, TVCSStatusSet argRevStatus);
string GetVcsRevisionString(object argRevisions, ITransportSet argRevStatus);

Parameter	Type	Passing
argRevisions	IVcsRevisions	value
argRevStatus	TVCSStatusSet	value

Returns: string

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

GetVcsRevisionStringForDocument

No description yet.

string GetVcsRevisionStringForDocument(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: string

GetVcsRevisionStringForDocumentExt

No description yet.

string GetVcsRevisionStringForDocumentExt(string argFileName, bool argIsShortFormat);

Parameter	Type	Passing
argFileName	string	value
argIsShortFormat	bool	value

Returns: string

IsVCSActive

No description yet.

bool IsVCSActive();

Returns: bool

ListenForVCSStatusChanges

No description yet.

void ListenForVCSStatusChanges(uint argHandle);

Parameter	Type	Passing
argHandle	uint	value

Returns: nothing (void)

NeedToCheckoutSVNDBLIBWorkingFolders

No description yet.

bool NeedToCheckoutSVNDBLIBWorkingFolders(IDXPSVNDatabaseLibDocument argSVNDbLibDoc);
bool NeedToCheckoutSVNDBLIBWorkingFolders(object argSVNDbLibDoc);

Parameter	Type	Passing
argSVNDbLibDoc	IDXPSVNDatabaseLibDocument	value

Returns: bool

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

Refresh

No description yet.

void Refresh(IVcsFileNames argDocuments);
void Refresh(object argDocuments);

Parameter	Type	Passing
argDocuments	IVcsFileNames	value

Returns: nothing (void)

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

StopListeningForVCSStatusChanges

No description yet.

void StopListeningForVCSStatusChanges(uint argHandle);

Parameter	Type	Passing
argHandle	uint	value

Returns: nothing (void)

UpdateInteractively

No description yet.

string UpdateInteractively(IVcsProject argVCSProject, IVcsFileNames argFileNames);
string UpdateInteractively(object argVCSProject, object argFileNames);

Parameter	Type	Passing
argVCSProject	IVcsProject	value
argFileNames	IVcsFileNames	value

Returns: string

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