ICMP_DocumentChanges interface
No description yet.
public interface ICMP_DocumentChanges
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| BaseDocumentId | string | get; set | |
| BaseDocumentPath | string | get; set | |
| Differences | ICMP_ObjectDifference | get; set | |
| DocumentId | string | get; set | |
| DocumentKind | string | get; set | |
| DocumentPath | string | get; set |
BaseDocumentId
No description yet.
string GetBaseDocumentId();
void SetBaseDocumentId(string argValue);
Type: string · Access: read/write
BaseDocumentPath
No description yet.
string GetBaseDocumentPath();
void SetBaseDocumentPath(string argValue);
Type: string · Access: read/write
Differences
No description yet.
ICMP_ObjectDifference GetDifferences();
void SetDifferences(ICMP_ObjectDifference argValue);
Type: ICMP_ObjectDifference · Access: read/write
The accessors are extension methods of ICMP_DocumentChangesHelper (using EDP;).
DocumentId
No description yet.
string GetDocumentId();
void SetDocumentId(string argValue);
Type: string · Access: read/write
DocumentKind
No description yet.
string GetDocumentKind();
void SetDocumentKind(string argValue);
Type: string · Access: read/write
DocumentPath
No description yet.
string GetDocumentPath();
void SetDocumentPath(string argValue);
Type: string · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| AddOutputFile | void | |
| ClearOutputFiles | void | |
| GetChangesKind | TCMP_ChangesKind | |
| GetDrawingChangesKind | TCMP_ChangesKind | |
| GetOutputFile | CMP_OutputFileInfo | |
| GetOutputFileCount | int |
AddOutputFile
No description yet.
void AddOutputFile(TCMP_OutputFileFormat argFormat, string argPath);
void AddOutputFile(int argFormat, string argPath);
| Parameter | Type | Passing |
|---|---|---|
argFormat | TCMP_OutputFileFormat | value |
argPath | string | value |
Returns: nothing (void)
The first overload is an extension method of ICMP_DocumentChangesHelper (using EDP;) with typed parameters; the second is declared by the interface.
ClearOutputFiles
No description yet.
void ClearOutputFiles();
Returns: nothing (void)
GetChangesKind
No description yet.
TCMP_ChangesKind GetChangesKind(string argObjectHandle);
| Parameter | Type | Passing |
|---|---|---|
argObjectHandle | string | value |
Returns: TCMP_ChangesKind
Extension method of ICMP_DocumentChangesHelper (using EDP;).
GetDrawingChangesKind
No description yet.
TCMP_ChangesKind GetDrawingChangesKind(string argObjectHandle);
| Parameter | Type | Passing |
|---|---|---|
argObjectHandle | string | value |
Returns: TCMP_ChangesKind
Extension method of ICMP_DocumentChangesHelper (using EDP;).
GetOutputFile
No description yet.
CMP_OutputFileInfo GetOutputFile(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: CMP_OutputFileInfo
Extension method of ICMP_DocumentChangesHelper (using EDP;).
GetOutputFileCount
No description yet.
int GetOutputFileCount();
Returns: int
Returned by
ICMP_ChangesSerializer.Deserialize, ICMP_ChangesSerializer.LoadFromFile, ICMP_ComparisonServer.CreateDocumentChanges, ICMP_DocumentComparer.Compare, ICMP_ObjectModelComparer.Compare, ICMP_PCBComparer.CompareBoards, ICMP_PCBThreeWayComparer.GetComparisonResults, ICMP_ProjectChanges.GetDocumentsChanges
Accepted by
ICMP_ChangesSerializer.SaveToFile, ICMP_ChangesSerializer.Serialize