Skip to main content
View as Markdown

IComponentLibraryManager interface

No description yet.

public interface IComponentLibraryManager

Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
CreateComponentDefinitionIComponentDefinition
CreateComponentLibraryIComponentLibraryDocument
CreateComponentSetIComponentSet
CreateGroupIGroup
CreateModelChoiceIModelChoice
CreateModelLinkIModelLink
CreateParameterIParameter
CreateReplaceComponentRevisionLinkInfoIReplaceComponentRevisionLinkInfo
CreateRequiredModelIRequiredModel
CreateRequiredParameterIRequiredParameter
CreateTemplateIComponentTemplate
CreateTemplateComponentTypeIComponentTemplateComponentType
CreateTemplateModelLinkIComponentTemplateModelLink
CreateTemplateParameterIComponentTemplateParameter
DestroyAbstractObjectvoid
DownloadWithReplacementComponentLinksbool
GenerateItemNamesbool
GetComponentLibraryByFileNameIComponentLibraryDocument
GetComponentTypeComponentTemplatePairListIInterfaceList
GetCurrentComponentLibraryIComponentLibraryDocument
GetItemNameGeneratorIBatchItemNameGenerator
RunCreateComponentDialogbool

CreateComponentDefinition​

No description yet.

IComponentDefinition CreateComponentDefinition();

Returns: IComponentDefinition

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateComponentLibrary​

No description yet.

IComponentLibraryDocument CreateComponentLibrary(string argFileName);
ParameterTypePassing
argFileNamestringvalue

Returns: IComponentLibraryDocument

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateComponentSet​

No description yet.

IComponentSet CreateComponentSet();

Returns: IComponentSet

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateGroup​

No description yet.

IGroup CreateGroup();

Returns: IGroup

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateModelChoice​

No description yet.

IModelChoice CreateModelChoice();

Returns: IModelChoice

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

No description yet.

IModelLink CreateModelLink();

Returns: IModelLink

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateParameter​

No description yet.

IParameter CreateParameter();

Returns: IParameter

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateReplaceComponentRevisionLinkInfo​

No description yet.

IReplaceComponentRevisionLinkInfo CreateReplaceComponentRevisionLinkInfo(string argOldRevisionGUID, IULB_ItemRevision argNewRevision, IInterfaceList argItems);
ParameterTypePassing
argOldRevisionGUIDstringvalue
argNewRevisionIULB_ItemRevisionvalue
argItemsIInterfaceListvalue

Returns: IReplaceComponentRevisionLinkInfo

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateRequiredModel​

No description yet.

IRequiredModel CreateRequiredModel();

Returns: IRequiredModel

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateRequiredParameter​

No description yet.

IRequiredParameter CreateRequiredParameter();

Returns: IRequiredParameter

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateTemplate​

No description yet.

IComponentTemplate CreateTemplate();

Returns: IComponentTemplate

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateTemplateComponentType​

No description yet.

IComponentTemplateComponentType CreateTemplateComponentType();

Returns: IComponentTemplateComponentType

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

No description yet.

IComponentTemplateModelLink CreateTemplateModelLink();

Returns: IComponentTemplateModelLink

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

CreateTemplateParameter​

No description yet.

IComponentTemplateParameter CreateTemplateParameter();

Returns: IComponentTemplateParameter

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

DestroyAbstractObject​

No description yet.

void DestroyAbstractObject(IAbstractObject argbstractObject);
void DestroyAbstractObject(object argbstractObject);
ParameterTypePassing
argbstractObjectIAbstractObjectvalue

Returns: nothing (void)

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

No description yet.

bool DownloadWithReplacementComponentLinks(IEDMS_Vault argVault, IInterfaceList argReplaceInfoList);
bool DownloadWithReplacementComponentLinks(object argVault, object argReplaceInfoList);
ParameterTypePassing
argVaultIEDMS_Vaultvalue
argReplaceInfoListIInterfaceListvalue

Returns: bool

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

GenerateItemNames​

No description yet.

bool GenerateItemNames(IEDMS_Vault argVault, IULB_Folder argFolder, IULB_ContentType argContentType, int argCount, IStrings argList);
bool GenerateItemNames(object argVault, object argFolder, object argContentType, int argCount, object argList);
ParameterTypePassing
argVaultIEDMS_Vaultvalue
argFolderIULB_Foldervalue
argContentTypeIULB_ContentTypevalue
argCountintvalue
argListIStringsvalue

Returns: bool

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

GetComponentLibraryByFileName​

No description yet.

IComponentLibraryDocument GetComponentLibraryByFileName(string argFileName);
ParameterTypePassing
argFileNamestringvalue

Returns: IComponentLibraryDocument

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

GetComponentTypeComponentTemplatePairList​

No description yet.

IInterfaceList GetComponentTypeComponentTemplatePairList();

Returns: IInterfaceList

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

GetCurrentComponentLibrary​

No description yet.

IComponentLibraryDocument GetCurrentComponentLibrary();

Returns: IComponentLibraryDocument

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

GetItemNameGenerator​

No description yet.

IBatchItemNameGenerator GetItemNameGenerator(IEDMS_Vault argVault, IULB_Folder argFolder, IULB_ContentType argContentType);
ParameterTypePassing
argVaultIEDMS_Vaultvalue
argFolderIULB_Foldervalue
argContentTypeIULB_ContentTypevalue

Returns: IBatchItemNameGenerator

Extension method of IComponentLibraryManagerHelper (using ComponentLib;).

RunCreateComponentDialog​

No description yet.

bool RunCreateComponentDialog(out IULB_ItemRevision argItemRevision, out IComponentTemplate argTemplate, out IULB_Tag argCmpType);
ParameterTypePassing
argItemRevisionIULB_ItemRevisionout
argTemplateIComponentTemplateout
argCmpTypeIULB_Tagout

Returns: bool

Returned by​

GlobalVars.CmplibManager