# IServerWindowKind interface

This `IServerWindowKind` interface reports the type of a design document in Altium Designer and it is a composite object used in [`IServerRecord`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md) and [`IClient`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md) interface objects

```csharp
public interface IServerWindowKind
```

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

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [FileExportDescriptionCount](#fileexportdescriptioncount) | `int` |  |
| [FileImportDescriptionCount](#fileimportdescriptioncount) | `int` |  |
| [FileLoadDescriptionCount](#fileloaddescriptioncount) | `int` | The method returns the number of File Load Descriptions for the document editor type of server. |
| [FileSaveDescriptionCount](#filesavedescriptioncount) | `int` | The method returns the number of File Save Descriptions for the document editor server. |
| [GetFileExportDescription](#getfileexportdescription) | `string` |  |
| [GetFileImportDescription](#getfileimportdescription) | `string` |  |
| [GetFileLoadDescription](#getfileloaddescription) | `string` | The method returns the indexed file load description. |
| [GetFileSaveDescription](#getfilesavedescription) | `string` | The method returns the indexed file save description. |
| [GetIconName](#geticonname) | `string` | The method returns the name of the icon associated with the server window of a document in DXP. |
| [GetIsDocumentEditor](#getisdocumenteditor) | `bool` | The method returns a Boolean value whether this server is a document editor or not. |
| [GetIsDomain](#getisdomain) | `bool` | The method returns the Boolean value for this Domain. |
| [GetName](#getname) | `string` | Returns the name of the window kind. |
| [GetNewWindowCaption](#getnewwindowcaption) | `string` | The `GetNewWindowCaption` method returns the new document caption string for the new document in Altium Designer. |
| [GetNewWindowExtension](#getnewwindowextension) | `string` | The method returns the new document's extension string in DXP. |
| [GetServerRecord](#getserverrecord) | [IServerRecord](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md) | Returns the [`IServerRecord`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md) interface that the `IServerWindowKind` interface is associated with. |
| [GetWindowKindClass](#getwindowkindclass) | `string` | The method returns the indexed window kind class. |
| [GetWindowKindClassCount](#getwindowkindclasscount) | `int` | The method returns the number of window kind classes. |
| [GetWindowKindDescription](#getwindowkinddescription) | `string` | The method returns the window kind description string for a window in Altium Designer. |
| [IsOfWindowKindClass](#isofwindowkindclass) | `bool` | The method returns a boolean value whether the class string is part of a window kind class or not. |

### FileExportDescriptionCount

*No description yet.*

```csharp
int FileExportDescriptionCount();
```

**Returns:** `int`

### FileImportDescriptionCount

*No description yet.*

```csharp
int FileImportDescriptionCount();
```

**Returns:** `int`

### FileLoadDescriptionCount

The method returns the number of File Load Descriptions for the document editor type of server. A document editor can support multiple document types and thus facilitate multiple load methods.

```csharp
int FileLoadDescriptionCount();
```

**Returns:** `int`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### FileSaveDescriptionCount

The method returns the number of File Save Descriptions for the document editor server. A document editor can have multiple document types and thus have multiple corresponding file save methods.

```csharp
int FileSaveDescriptionCount();
```

**Returns:** `int`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetFileExportDescription

*No description yet.*

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

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

**Returns:** `string`

### GetFileImportDescription

*No description yet.*

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

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

**Returns:** `string`

### GetFileLoadDescription

The method returns the indexed file load description. To be used in conjunction with the [`FileLoadDescriptionCount`](#fileloaddescriptioncount) method.

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

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

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetFileSaveDescription

The method returns the indexed file save description. To be used in conjunction with the [`FileSaveDescriptionCount`](#filesavedescriptioncount) method.

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

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

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetIconName

The method returns the name of the icon associated with the server window of a document in DXP.

```csharp
string GetIconName();
```

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetIsDocumentEditor

The method returns a Boolean value whether this server is a document editor or not. Addons are not document editors. A document editor is a server that hosts its own documents and provide editing facilities. For example the PCB Editor is a Document Editor.

```csharp
bool GetIsDocumentEditor();
```

**Returns:** `bool`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetIsDomain

The method returns the Boolean value for this Domain. Normally false.

```csharp
bool GetIsDomain();
```

**Returns:** `bool`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetName

Returns the name of the window kind.

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

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetNewWindowCaption

The `GetNewWindowCaption` method returns the new document caption string for the new document in Altium Designer.

```csharp
string GetNewWindowCaption();
```

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetNewWindowExtension

The method returns the new document's extension string in DXP.

```csharp
string GetNewWindowExtension();
```

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetServerRecord

Returns the [`IServerRecord`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md) interface that the `IServerWindowKind` interface is associated with. Since the server installation file defines document kinds (window kinds) and the [`IServerRecord`](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md) interface represents this installation file.

```csharp
IServerRecord GetServerRecord();
```

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

Extension method of `IServerWindowKindHelper` (`using DXP;`).

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetWindowKindClass

The method returns the indexed window kind class.

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

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

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetWindowKindClassCount

The method returns the number of window kind classes.

```csharp
int GetWindowKindClassCount();
```

**Returns:** `int`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### GetWindowKindDescription

The method returns the window kind description string for a window in Altium Designer.

```csharp
string GetWindowKindDescription();
```

**Returns:** `string`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

### IsOfWindowKindClass

The method returns a boolean value whether the class string is part of a window kind class or not.

```csharp
bool IsOfWindowKindClass(string argClass);
```

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

**Returns:** `bool`

**See also:** [IClient](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md)

## Returned by

[IClient.GetWindowKindByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md#getwindowkindbyname), [IServerRecord.GetWindowKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md#getwindowkind), [IServerRecord.GetWindowKindByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerRecord.md#getwindowkindbyname)