ILocalHistoryManager interface
No description yet.
public interface ILocalHistoryManager
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| AddAutoSaves | bool | get; set | |
| GlobalRepositoryPath | string | get; set | |
| StartPurgingAfter | int | get; set |
AddAutoSaves
No description yet.
bool GetAddAutoSaves();
void SetAddAutoSaves(bool argValue);
Type: bool · Access: read/write
GlobalRepositoryPath
No description yet.
string GetGlobalRepositoryPath();
void SetGlobalRepositoryPath(string argValue);
Type: string · Access: read/write
StartPurgingAfter
No description yet.
int GetStartPurgingAfter();
void SetStartPurgingAfter(int argValue);
Type: int · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| Add | int | |
| ApplyLabel | bool | |
| CopyLabel | bool | |
| CopyVersion | bool | |
| Delete | bool | |
| DisableLocalHistory | void | |
| EnableLocalHistory | void | |
| GetGlobalRepositoryPathNotExpanded | string | |
| GetHistory | IDocumentBackups | |
| GetHistoryPathForFile | string | |
| GetInfo | bool | |
| Purge | void | |
| RevertToLabel | bool | |
| RevertToVer | bool |
Add
No description yet.
int Add(string argFileName, string argLabel);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
argLabel | string | value |
Returns: int
ApplyLabel
No description yet.
bool ApplyLabel(string argFileName, int argVersion, string argLabel);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
argVersion | int | value |
argLabel | string | value |
Returns: bool
CopyLabel
No description yet.
bool CopyLabel(string argFileName, string argLabel, string argDestName);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
argLabel | string | value |
argDestName | string | value |
Returns: bool
CopyVersion
No description yet.
bool CopyVersion(string argFileName, int argVersion, string argDestName);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
argVersion | int | value |
argDestName | string | value |
Returns: bool
Delete
No description yet.
bool Delete(string argFileName, int argVersion, bool argDelLabel);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
argVersion | int | value |
argDelLabel | bool | value |
Returns: bool
DisableLocalHistory
No description yet.
void DisableLocalHistory();
Returns: nothing (void)
EnableLocalHistory
No description yet.
void EnableLocalHistory();
Returns: nothing (void)
GetGlobalRepositoryPathNotExpanded
No description yet.
string GetGlobalRepositoryPathNotExpanded();
Returns: string
GetHistory
No description yet.
IDocumentBackups GetHistory(string argFileName);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
Returns: IDocumentBackups
Extension method of ILocalHistoryManagerHelper (using DXP;).
GetHistoryPathForFile
No description yet.
string GetHistoryPathForFile(string argFileName);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
Returns: string
GetInfo
No description yet.
bool GetInfo(string argHistoryFileName, ref string argFileName, ref string argLabel, ref int argVersion);
| Parameter | Type | Passing |
|---|---|---|
argHistoryFileName | string | value |
argFileName | string | ref |
argLabel | string | ref |
argVersion | int | ref |
Returns: bool
Purge
No description yet.
void Purge(string argFileName);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
Returns: nothing (void)
RevertToLabel
No description yet.
bool RevertToLabel(string argFileName, string argLabel);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
argLabel | string | value |
Returns: bool
RevertToVer
No description yet.
bool RevertToVer(string argFileName, int argVersion);
| Parameter | Type | Passing |
|---|---|---|
argFileName | string | value |
argVersion | int | value |
Returns: bool
Returned by
IDXPWorkSpace.DM_LocalHistoryManager, IWorkspace.DM_LocalHistoryManager