
# IComponentLibraryCommandHandler interface

*No description yet.*

```csharp
public interface IComponentLibraryCommandHandler
```

**Namespace:** ComponentLib · **Assembly:** Altium.SDK.Interfaces

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [Add](#add) | `void` |  |
| [BatchRenameByTemplate](#batchrenamebytemplate) | `void` |  |
| [ChangeTargetItem](#changetargetitem) | `void` |  |
| [ClearContents](#clearcontents) | `void` |  |
| [ClearTargetItems](#cleartargetitems) | `void` |  |
| [Clone](#clone) | `void` |  |
| [Copy](#copy) | `void` |  |
| [CopyComponent](#copycomponent) | `void` |  |
| [Cut](#cut) | `void` |  |
| [CutComponent](#cutcomponent) | `void` |  |
| [Delete](#delete) | `void` |  |
| [Disable](#disable) | `void` |  |
| [EditPinMapping](#editpinmapping) | `void` |  |
| [Enable](#enable) | `void` |  |
| [GenerateComponents](#generatecomponents) | `void` |  |
| [GetSelectedComponents](#getselectedcomponents) | [IComponentDefinitionList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/componentlib/IComponentDefinitionList.md) |  |
| [GetState_Add](#getstate_add) | `void` |  |
| [GetState_BatchRenameByTemplate](#getstate_batchrenamebytemplate) | `void` |  |
| [GetState_ChangeTargetItem](#getstate_changetargetitem) | `void` |  |
| [GetState_ClearContents](#getstate_clearcontents) | `void` |  |
| [GetState_ClearTargetItems](#getstate_cleartargetitems) | `void` |  |
| [GetState_Clone](#getstate_clone) | `void` |  |
| [GetState_Copy](#getstate_copy) | `void` |  |
| [GetState_CopyComponent](#getstate_copycomponent) | `void` |  |
| [GetState_Cut](#getstate_cut) | `void` |  |
| [GetState_CutComponent](#getstate_cutcomponent) | `void` |  |
| [GetState_Delete](#getstate_delete) | `void` |  |
| [GetState_Disable](#getstate_disable) | `void` |  |
| [GetState_EditPinMapping](#getstate_editpinmapping) | `void` |  |
| [GetState_Enable](#getstate_enable) | `void` |  |
| [GetState_GenerateComponents](#getstate_generatecomponents) | `void` |  |
| [GetState_Insert](#getstate_insert) | `void` |  |
| [GetState_LinkToVault](#getstate_linktovault) | `void` |  |
| [GetState_Paste](#getstate_paste) | `void` |  |
| [GetState_PasteComponent](#getstate_pastecomponent) | `void` |  |
| [GetState_Redo](#getstate_redo) | `void` |  |
| [GetState_ReleaseToVault](#getstate_releasetovault) | `void` |  |
| [GetState_ShowInVaultExplorer](#getstate_showinvaultexplorer) | `void` |  |
| [GetState_Undo](#getstate_undo) | `void` |  |
| [HandleSetComponentSet](#handlesetcomponentset) | `void` |  |
| [Insert](#insert) | `void` |  |
| [LinkToVault](#linktovault) | `void` |  |
| [Paste](#paste) | `void` |  |
| [PasteComponent](#pastecomponent) | `void` |  |
| [Redo](#redo) | `void` |  |
| [Refresh](#refresh) | `void` |  |
| [RefreshModelLink](#refreshmodellink) | `void` |  |
| [ReleaseToVault](#releasetovault) | `void` |  |
| [ShowInVaultExplorer](#showinvaultexplorer) | `void` |  |
| [Undo](#undo) | `void` |  |
| [UpdateItemToLatestRevision](#updateitemtolatestrevision) | `void` |  |

### Add

*No description yet.*

```csharp
void Add(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### BatchRenameByTemplate

*No description yet.*

```csharp
void BatchRenameByTemplate(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### ChangeTargetItem

*No description yet.*

```csharp
void ChangeTargetItem(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### ClearContents

*No description yet.*

```csharp
void ClearContents(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### ClearTargetItems

*No description yet.*

```csharp
void ClearTargetItems(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Clone

*No description yet.*

```csharp
void Clone(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Copy

*No description yet.*

```csharp
void Copy(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### CopyComponent

*No description yet.*

```csharp
void CopyComponent(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Cut

*No description yet.*

```csharp
void Cut(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### CutComponent

*No description yet.*

```csharp
void CutComponent(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Delete

*No description yet.*

```csharp
void Delete(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Disable

*No description yet.*

```csharp
void Disable(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### EditPinMapping

*No description yet.*

```csharp
void EditPinMapping(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Enable

*No description yet.*

```csharp
void Enable(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### GenerateComponents

*No description yet.*

```csharp
void GenerateComponents(object argComponentGenerator);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argComponentGenerator` | `object` | value |

**Returns:** nothing (`void`)

### GetSelectedComponents

*No description yet.*

```csharp
IComponentDefinitionList GetSelectedComponents();
```

**Returns:** [IComponentDefinitionList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/componentlib/IComponentDefinitionList.md)

Extension method of `IComponentLibraryCommandHandlerHelper` (`using ComponentLib;`).

### GetState_Add

*No description yet.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

```csharp
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.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argComponentSet` | [IComponentSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/componentlib/IComponentSet.md) | 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.*

```csharp
void Insert(string argObjectKind, int argObjectIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argObjectKind` | `string` | value |
| `argObjectIndex` | `int` | value |

**Returns:** nothing (`void`)

### LinkToVault

*No description yet.*

```csharp
void LinkToVault(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Paste

*No description yet.*

```csharp
void Paste(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### PasteComponent

*No description yet.*

```csharp
void PasteComponent(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Redo

*No description yet.*

```csharp
void Redo(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Refresh

*No description yet.*

```csharp
void Refresh(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### RefreshModelLink

*No description yet.*

```csharp
void RefreshModelLink(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### ReleaseToVault

*No description yet.*

```csharp
void ReleaseToVault(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### ShowInVaultExplorer

*No description yet.*

```csharp
void ShowInVaultExplorer(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### Undo

*No description yet.*

```csharp
void Undo(ref string argParameters);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParameters` | `string` | ref |

**Returns:** nothing (`void`)

### UpdateItemToLatestRevision

*No description yet.*

```csharp
void UpdateItemToLatestRevision(string argItemGUID);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argItemGUID` | `string` | value |

**Returns:** nothing (`void`)

## Returned by

[IComponentLibraryDocument.CommandHandler](https://altiumdeveloper.github.io/ad-sdk-docs/reference/componentlib/IComponentLibraryDocument.md#commandhandler)
