# IServerPanelInfo interface

The `IServerPanelInfo` interface encapsulates the details of a panel in Altium Designer and the details can be Name, Bitmap, whether the panel can be docked horizontally or vertically and so on.

```csharp
public interface IServerPanelInfo
```

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

## Remarks

This interface is used by the [`IServerRecord`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md) interface and the [`IClient`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md) interface.

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [GetBitmap](#getbitmap) | `string` | The method returns the name of the bitmap. |
| [GetButtonVisible](#getbuttonvisible) | `bool` | The method returns whether the button on the panel is visible or not. |
| [GetCanDockHorizontal](#getcandockhorizontal) | `bool` | This method determines whether the panel can be docked horizontally to the Altium Designer User Interface. |
| [GetCanDockVertical](#getcandockvertical) | `bool` | This method determines whether the panel can be docked vertically to the Altium Designer User Interface. |
| [GetCategory](#getcategory) | `string` | This method returns the Category string, ie which module it is part of within Altium Designer. |
| [GetCreationClassName](#getcreationclassname) | `string` | Internal use. |
| [GetDocumentKindCount](#getdocumentkindcount) | `int` | This method reports how many document kinds this panel can be associated with. |
| [GetDocumentKinds](#getdocumentkinds) | `string` | This method returns the indexed Document Kind string that this panel is associated with. |
| [GetHotkey](#gethotkey) | `string` | The method returns the HotKey string that is used to render the panel visible or not. |
| [GetMultipleCreation](#getmultiplecreation) | `bool` | Internal use. |
| [GetName](#getname) | `string` | This method returns the name of the panel. |
| [GetProjectKindCount](#getprojectkindcount) | `int` | Internal use. |
| [GetProjectKinds](#getprojectkinds) | `string` | Internal use. |
| [SupportsDocumentKind](#supportsdocumentkind) | `bool` | This method determines whether the document kind is supported by the panel. |
| [SupportsProjectKind](#supportsprojectkind) | `bool` | Internal use. |

### GetBitmap

The method returns the name of the bitmap.

```csharp
string GetBitmap();
```

**Returns:** `string`

### GetButtonVisible

The method returns whether the button on the panel is visible or not.

```csharp
bool GetButtonVisible();
```

**Returns:** `bool`

### GetCanDockHorizontal

This method determines whether the panel can be docked horizontally to the Altium Designer User Interface.

```csharp
bool GetCanDockHorizontal();
```

**Returns:** `bool`

### GetCanDockVertical

This method determines whether the panel can be docked vertically to the Altium Designer User Interface.

```csharp
bool GetCanDockVertical();
```

**Returns:** `bool`

### GetCategory

This method returns the Category string, ie which module it is part of within Altium Designer. For example the Favorites panel is part of the System.

```csharp
string GetCategory();
```

**Returns:** `string`

### GetCreationClassName

Internal use.

```csharp
string GetCreationClassName();
```

**Returns:** `string`

### GetDocumentKindCount

This method reports how many document kinds this panel can be associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents.

```csharp
int GetDocumentKindCount();
```

**Returns:** `int`

Use this method with the [`GetDocumentKinds`](#getdocumentkinds) method.

This property reports how many document kinds this panel can be associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents.

Use this property with the DocumentKinds property.

### GetDocumentKinds

This method returns the indexed Document Kind string that this panel is associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents. This method is to be used in conjunction with the [`GetDocumentKindCount`](#getdocumentkindcount) method.

```csharp
string GetDocumentKinds(int argIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIndex` | `int` | value |

**Returns:** `string`

This property returns the indexed Document Kind string that this panel is associated with. For example with Simulation Breakpoints panel, it can be associated with VHDL and VHDTST documents. This property is to be used in conjunction with the [`GetDocumentKindCount`](#getdocumentkindcount) method.

### GetHotkey

The method returns the HotKey string that is used to render the panel visible or not.

```csharp
string GetHotkey();
```

**Returns:** `string`

### GetMultipleCreation

Internal use.

```csharp
bool GetMultipleCreation();
```

**Returns:** `bool`

### GetName

This method returns the name of the panel. For example the PCB Library panel has a PCBLibPanel name.

```csharp
string GetName();
```

**Returns:** `string`

### GetProjectKindCount

Internal use.

```csharp
int GetProjectKindCount();
```

**Returns:** `int`

### GetProjectKinds

Internal use.

```csharp
string GetProjectKinds(int argIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIndex` | `int` | value |

**Returns:** `string`

### SupportsDocumentKind

This method determines whether the document kind is supported by the panel.

```csharp
bool SupportsDocumentKind(string argKind);
```

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

**Returns:** `bool`

### SupportsProjectKind

Internal use.

```csharp
bool SupportsProjectKind(string argKind);
```

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

**Returns:** `bool`

## Returned by

[IClient.GetPanelInfoByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md#getpanelinfobyname), [IServerRecord.GetPanelInfo](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md#getpanelinfo), [IServerRecord.GetPanelInfoByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md#getpanelinfobyname)