IComponentTemplate interface

No description yet.

public interface IComponentTemplate : IAbstractObject

Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces

Inherits: IAbstractObject

Properties

Property	Type	Access	Description
DefaultFolder	IComponentTemplateDefaultFolder	get; set
ItemGUID	string	get; set
ItemNamingTemplate	IComponentTemplateItemNamingTemplate	get; set
LifecycleDefinition	IComponentTemplateLifecyleDefinition	get; set
Parameters	IComponentTemplateParameterList	get; set
RevisionGUID	string	get; set
RevisionNamingScheme	IComponentTemplateRevisionNamingScheme	get; set
TargetVault	IComponentTemplateVault	get; set
VaultGUID	string	get; set
Version	string	get; set

DefaultFolder

No description yet.

IComponentTemplateDefaultFolder GetDefaultFolder();
void SetDefaultFolder(IComponentTemplateDefaultFolder argValue);

Type: IComponentTemplateDefaultFolder · Access: read/write

The accessors are extension methods of IComponentTemplateHelper (using ComponentLib;).

ItemGUID

No description yet.

string GetItemGUID();
void SetItemGUID(string argItemGUID);

Type: string · Access: read/write

ItemNamingTemplate

No description yet.

IComponentTemplateItemNamingTemplate GetItemNamingTemplate();
void SetItemNamingTemplate(IComponentTemplateItemNamingTemplate argValue);

Type: IComponentTemplateItemNamingTemplate · Access: read/write

The accessors are extension methods of IComponentTemplateHelper (using ComponentLib;).

LifecycleDefinition

No description yet.

IComponentTemplateLifecyleDefinition GetLifecycleDefinition();
void SetLifecycleDefinition(IComponentTemplateLifecyleDefinition argValue);

Type: IComponentTemplateLifecyleDefinition · Access: read/write

The accessors are extension methods of IComponentTemplateHelper (using ComponentLib;).

Parameters

No description yet.

IComponentTemplateParameterList GetParameters();
void SetParameters(IComponentTemplateParameterList argValue);

Type: IComponentTemplateParameterList · Access: read/write

The accessors are extension methods of IComponentTemplateHelper (using ComponentLib;).

RevisionGUID

No description yet.

string GetRevisionGUID();
void SetRevisionGUID(string argRevisionGUID);

Type: string · Access: read/write

RevisionNamingScheme

No description yet.

IComponentTemplateRevisionNamingScheme GetRevisionNamingScheme();
void SetRevisionNamingScheme(IComponentTemplateRevisionNamingScheme argValue);

Type: IComponentTemplateRevisionNamingScheme · Access: read/write

The accessors are extension methods of IComponentTemplateHelper (using ComponentLib;).

TargetVault

No description yet.

IComponentTemplateVault GetTargetVault();
void SetTargetVault(IComponentTemplateVault argValue);

Type: IComponentTemplateVault · Access: read/write

The accessors are extension methods of IComponentTemplateHelper (using ComponentLib;).

VaultGUID

No description yet.

string GetVaultGUID();
void SetVaultGUID(string argVaultGUID);

Type: string · Access: read/write

Version

No description yet.

string GetVersion();
void SetVersion(string argValue);

Type: string · Access: read/write

Methods

Method	Returns	Description
GetComponentTypes	IComponentTemplateComponentTypeList
GetModelLinks	IComponentTemplateModelLinkList
LoadComponentTemplateFromCmpLibFile	bool
LoadComponentTemplateFromFile	bool
LoadComponentTemplateFromRevisionGUID	bool
SaveComponentTemplateToFile	bool

GetComponentTypes

No description yet.

IComponentTemplateComponentTypeList GetComponentTypes();

Returns: IComponentTemplateComponentTypeList

Extension method of IComponentTemplateHelper (using ComponentLib;).

GetModelLinks

No description yet.

IComponentTemplateModelLinkList GetModelLinks();

Returns: IComponentTemplateModelLinkList

Extension method of IComponentTemplateHelper (using ComponentLib;).

LoadComponentTemplateFromCmpLibFile

No description yet.

bool LoadComponentTemplateFromCmpLibFile(string argFilePath);

Parameter	Type	Passing
argFilePath	string	value

Returns: bool

LoadComponentTemplateFromFile

No description yet.

bool LoadComponentTemplateFromFile(string argFilePath);

Parameter	Type	Passing
argFilePath	string	value

Returns: bool

LoadComponentTemplateFromRevisionGUID

No description yet.

bool LoadComponentTemplateFromRevisionGUID(string argVaultGUID, string argRevisionGUID);

Parameter	Type	Passing
argVaultGUID	string	value
argRevisionGUID	string	value

Returns: bool

SaveComponentTemplateToFile

No description yet.

bool SaveComponentTemplateToFile(string argFilePath);

Parameter	Type	Passing
argFilePath	string	value

Returns: bool

Returned by

IComponentLibraryManager.CreateTemplate, IComponentLibraryManager.RunCreateComponentDialog, IComponentSet.ComponentTemplate