Skip to main content
View as Markdown

IPCB_PadViaLibrary interface

No description yet.

public interface IPCB_PadViaLibrary

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Properties​

PropertyTypeAccessDescription
Activatedboolget; set
Countintget
DisplayUnitsTUnitget; set
LibraryIDstringget
LibraryNamestringget
LibraryPathstringget
TemplateIPCB_PadViaTemplateget

Activated​

No description yet.

bool GetState_Activated();
void SetState_Activated(bool argValue);

Type: bool · Access: read/write

Count​

No description yet.

int GetState_Count();

Type: int · Access: read-only

DisplayUnits​

No description yet.

TUnit GetState_DisplayUnits();
void SetState_DisplayUnits(TUnit argValue);

Type: TUnit · Access: read/write

The accessors are extension methods of IPCB_PadViaLibraryHelper (using PCB;).

LibraryID​

No description yet.

string GetState_LibraryID();

Type: string · Access: read-only

LibraryName​

No description yet.

string GetState_LibraryName();

Type: string · Access: read-only

LibraryPath​

No description yet.

string GetState_LibraryPath();

Type: string · Access: read-only

Template​

No description yet.

IPCB_PadViaTemplate GetState_Template(int argIndex);

Type: IPCB_PadViaTemplate · Access: read-only · Index: argIndex (int)

The accessors are extension methods of IPCB_PadViaLibraryHelper (using PCB;).

Methods​

MethodReturnsDescription
AddExternalTemplateIPCB_PadViaTemplate
AddTemplatevoid
AddTemplate_1void
CheckDublicatebool
Clearvoid
CopyTovoid
DeleteTemplatevoid
FindTemplateIPCB_PadViaTemplate
FindTemplate_1IPCB_PadViaTemplate
RemoveTemplatebool

AddExternalTemplate​

No description yet.

IPCB_PadViaTemplate AddExternalTemplate(IPCB_PadViaTemplate argTemplate);
ParameterTypePassing
argTemplateIPCB_PadViaTemplatevalue

Returns: IPCB_PadViaTemplate

Extension method of IPCB_PadViaLibraryHelper (using PCB;).

AddTemplate​

No description yet.

void AddTemplate(IPCB_Primitive argPrimitive);
void AddTemplate(object argPrimitive);
ParameterTypePassing
argPrimitiveIPCB_Primitivevalue

Returns: nothing (void)

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

AddTemplate_1​

No description yet.

void AddTemplate_1(IPCB_PadViaTemplate argTemplate);
void AddTemplate_1(object argTemplate);
ParameterTypePassing
argTemplateIPCB_PadViaTemplatevalue

Returns: nothing (void)

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

CheckDublicate​

No description yet.

bool CheckDublicate(IPCB_PadViaTemplate argTemplate);
bool CheckDublicate(object argTemplate);
ParameterTypePassing
argTemplateIPCB_PadViaTemplatevalue

Returns: bool

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

Clear​

No description yet.

void Clear();

Returns: nothing (void)

CopyTo​

No description yet.

void CopyTo(IPCB_PadViaLibrary argDest);
void CopyTo(object argDest);
ParameterTypePassing
argDestIPCB_PadViaLibraryvalue

Returns: nothing (void)

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

DeleteTemplate​

No description yet.

void DeleteTemplate(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: nothing (void)

FindTemplate​

No description yet.

IPCB_PadViaTemplate FindTemplate(string argTemplate);
ParameterTypePassing
argTemplatestringvalue

Returns: IPCB_PadViaTemplate

Extension method of IPCB_PadViaLibraryHelper (using PCB;).

FindTemplate_1​

No description yet.

IPCB_PadViaTemplate FindTemplate_1(string argExternalLibraryID, string argExternalTemplateID);
ParameterTypePassing
argExternalLibraryIDstringvalue
argExternalTemplateIDstringvalue

Returns: IPCB_PadViaTemplate

Extension method of IPCB_PadViaLibraryHelper (using PCB;).

RemoveTemplate​

No description yet.

bool RemoveTemplate(IPCB_PadViaTemplate argTemplate);
bool RemoveTemplate(object argTemplate);
ParameterTypePassing
argTemplateIPCB_PadViaTemplatevalue

Returns: bool

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

Returned by​

IPCB_Board.FindLinkedBoardLibrary, IPCB_Board.PadViaCache, IPCB_Board.PadViaLibrary, IPCB_PadViaLibraryDocument.PadViaLibrary, IPCB_PadViaLibraryManager.FindLibrary, IPCB_PadViaLibraryManager.GetInstalledLibrary

Accepted by​

IPCB_PadViaLibraryManager.UninstallLibrary