IPCB_PadViaTemplateLink interface
A link to a pad and via template, which holds the identifiers of the template's library, of the template and of its revision.
public interface IPCB_PadViaTemplateLink
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Remarks
The link holds only the identifiers, not the template itself. TemplateLink of IPCB_Pad and of IPCB_Via returns the pad's or via's own link, not a copy. CreateTemplateLink of IPCB_PadViaTemplate creates a separate link.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| LibraryID | string | get; set | The identifier of the pad and via library that holds the linked template. |
| RevisionID | string | get; set | The identifier of the revision of the linked template. |
| TemplateID | string | get; set | The identifier of the linked template within its library. |
LibraryID
The identifier of the pad and via library that holds the linked template.
string GetState_LibraryID();
void SetState_LibraryID(string argValue);
Type: string · Access: read/write
Empty after Clear.
RevisionID
The identifier of the revision of the linked template.
string GetState_RevisionID();
void SetState_RevisionID(string argValue);
Type: string · Access: read/write
Empty after Clear.
TemplateID
The identifier of the linked template within its library.
string GetState_TemplateID();
void SetState_TemplateID(string argValue);
Type: string · Access: read/write
Empty after Clear.
Methods
| Method | Returns | Description |
|---|---|---|
| Clear | void | Sets LibraryID, TemplateID and RevisionID to empty strings. |
| CopyTo | void | Copies LibraryID, TemplateID and RevisionID to another link. |
| GetFullTemplateID | string | Returns the full identifier of the linked template, LibraryID and TemplateID joined by @. |
Clear
Sets LibraryID, TemplateID and RevisionID to empty strings.
void Clear();
Returns: nothing (void)
CopyTo
Copies LibraryID, TemplateID and RevisionID to another link.
void CopyTo(IPCB_PadViaTemplateLink argDest);
void CopyTo(object argDest);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argDest | IPCB_PadViaTemplateLink | value | The link that receives the identifiers. |
Returns: nothing (void)
The first overload is an extension method of IPCB_PadViaTemplateLinkHelper (using PCB;) with typed parameters; the second is declared by the interface.
GetFullTemplateID
Returns the full identifier of the linked template, LibraryID and TemplateID joined by @.
string GetFullTemplateID();
Returns: string
Returned by
IPCB_Pad.TemplateLink, IPCB_PadViaTemplate.CreateTemplateLink, IPCB_PadViaTemplate.ExternalLink, IPCB_StackObject.TemplateLink, IPCB_Via.TemplateLink