IComponentLibraryCommandHandler interface

No description yet.

public interface IComponentLibraryCommandHandler

Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
Add	void
BatchRenameByTemplate	void
ChangeTargetItem	void
ClearContents	void
ClearTargetItems	void
Clone	void
Copy	void
CopyComponent	void
Cut	void
CutComponent	void
Delete	void
Disable	void
EditPinMapping	void
Enable	void
GenerateComponents	void
GetSelectedComponents	IComponentDefinitionList
GetState_Add	void
GetState_BatchRenameByTemplate	void
GetState_ChangeTargetItem	void
GetState_ClearContents	void
GetState_ClearTargetItems	void
GetState_Clone	void
GetState_Copy	void
GetState_CopyComponent	void
GetState_Cut	void
GetState_CutComponent	void
GetState_Delete	void
GetState_Disable	void
GetState_EditPinMapping	void
GetState_Enable	void
GetState_GenerateComponents	void
GetState_Insert	void
GetState_LinkToVault	void
GetState_Paste	void
GetState_PasteComponent	void
GetState_Redo	void
GetState_ReleaseToVault	void
GetState_ShowInVaultExplorer	void
GetState_Undo	void
HandleSetComponentSet	void
Insert	void
LinkToVault	void
Paste	void
PasteComponent	void
Redo	void
Refresh	void
RefreshModelLink	void
ReleaseToVault	void
ShowInVaultExplorer	void
Undo	void
UpdateItemToLatestRevision	void

Add

No description yet.

void Add(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

BatchRenameByTemplate

No description yet.

void BatchRenameByTemplate(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

ChangeTargetItem

No description yet.

void ChangeTargetItem(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

ClearContents

No description yet.

void ClearContents(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

ClearTargetItems

No description yet.

void ClearTargetItems(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Clone

No description yet.

void Clone(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Copy

No description yet.

void Copy(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

CopyComponent

No description yet.

void CopyComponent(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Cut

No description yet.

void Cut(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

CutComponent

No description yet.

void CutComponent(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Delete

No description yet.

void Delete(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Disable

No description yet.

void Disable(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

EditPinMapping

No description yet.

void EditPinMapping(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Enable

No description yet.

void Enable(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

GenerateComponents

No description yet.

void GenerateComponents(object argComponentGenerator);

Parameter	Type	Passing
argComponentGenerator	object	value

Returns: nothing (void)

GetSelectedComponents

No description yet.

IComponentDefinitionList GetSelectedComponents();

Returns: IComponentDefinitionList

Extension method of IComponentLibraryCommandHandlerHelper (using ComponentLib;).

GetState_Add

No description yet.

void GetState_Add(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_BatchRenameByTemplate

No description yet.

void GetState_BatchRenameByTemplate(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_ChangeTargetItem

No description yet.

void GetState_ChangeTargetItem(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_ClearContents

No description yet.

void GetState_ClearContents(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_ClearTargetItems

No description yet.

void GetState_ClearTargetItems(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Clone

No description yet.

void GetState_Clone(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Copy

No description yet.

void GetState_Copy(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_CopyComponent

No description yet.

void GetState_CopyComponent(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Cut

No description yet.

void GetState_Cut(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_CutComponent

No description yet.

void GetState_CutComponent(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Delete

No description yet.

void GetState_Delete(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Disable

No description yet.

void GetState_Disable(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_EditPinMapping

No description yet.

void GetState_EditPinMapping(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Enable

No description yet.

void GetState_Enable(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_GenerateComponents

No description yet.

void GetState_GenerateComponents(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Insert

No description yet.

void GetState_Insert(string argObjectKind, int argObjectIndex, ref bool argEnabled, ref bool argVisible, ref string argCaption);

Parameter	Type	Passing
argObjectKind	string	value
argObjectIndex	int	value
argEnabled	bool	ref
argVisible	bool	ref
argCaption	string	ref

Returns: nothing (void)

GetState_LinkToVault

No description yet.

void GetState_LinkToVault(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Paste

No description yet.

void GetState_Paste(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_PasteComponent

No description yet.

void GetState_PasteComponent(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Redo

No description yet.

void GetState_Redo(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_ReleaseToVault

No description yet.

void GetState_ReleaseToVault(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_ShowInVaultExplorer

No description yet.

void GetState_ShowInVaultExplorer(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

GetState_Undo

No description yet.

void GetState_Undo(ref string argParameters, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, string argImage);

Parameter	Type	Passing
argParameters	string	ref
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImage	string	value

Returns: nothing (void)

HandleSetComponentSet

No description yet.

void HandleSetComponentSet(IComponentSet argComponentSet);
void HandleSetComponentSet(object argComponentSet);

Parameter	Type	Passing
argComponentSet	IComponentSet	value

Returns: nothing (void)

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

Insert

No description yet.

void Insert(string argObjectKind, int argObjectIndex);

Parameter	Type	Passing
argObjectKind	string	value
argObjectIndex	int	value

Returns: nothing (void)

LinkToVault

No description yet.

void LinkToVault(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Paste

No description yet.

void Paste(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

PasteComponent

No description yet.

void PasteComponent(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Redo

No description yet.

void Redo(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Refresh

No description yet.

void Refresh(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

RefreshModelLink

No description yet.

void RefreshModelLink(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

ReleaseToVault

No description yet.

void ReleaseToVault(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

ShowInVaultExplorer

No description yet.

void ShowInVaultExplorer(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

Undo

No description yet.

void Undo(ref string argParameters);

Parameter	Type	Passing
argParameters	string	ref

Returns: nothing (void)

UpdateItemToLatestRevision

No description yet.

void UpdateItemToLatestRevision(string argItemGUID);

Parameter	Type	Passing
argItemGUID	string	value

Returns: nothing (void)

Returned by

IComponentLibraryDocument.CommandHandler