# IDXPWorkSpace interface

*No description yet.*

```csharp
public interface IDXPWorkSpace
```

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

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [DM_AddOutputLine](#dm_addoutputline) | `void` |  |
| [DM_ClearOutputLines](#dm_clearoutputlines) | `void` |  |
| [DM_CreateNewDocument](#dm_createnewdocument) | `string` |  |
| [DM_FileOwnership_BulkWarnEnd](#dm_fileownership_bulkwarnend) | `void` |  |
| [DM_FileOwnership_BulkWarnRegister](#dm_fileownership_bulkwarnregister) | `bool` |  |
| [DM_FileOwnership_BulkWarnStart](#dm_fileownership_bulkwarnstart) | `void` |  |
| [DM_FocusedDocument](#dm_focuseddocument) | [IDXPDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPDocument.md) |  |
| [DM_FocusedProject](#dm_focusedproject) | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) |  |
| [DM_FreeDocumentsProject](#dm_freedocumentsproject) | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) |  |
| [DM_GetDocumentFromPath](#dm_getdocumentfrompath) | [IDXPDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPDocument.md) |  |
| [DM_GetManagedDocumentImageIndex](#dm_getmanageddocumentimageindex) | `int` |  |
| [DM_GetOutputLine](#dm_getoutputline) | `string` |  |
| [DM_GetOutputLineCount](#dm_getoutputlinecount) | `int` |  |
| [DM_GetProjectFromPath](#dm_getprojectfrompath) | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) |  |
| [DM_IsReferencedAsDeviceSheet](#dm_isreferencedasdevicesheet) | `bool` |  |
| [DM_LoadProjectHidden](#dm_loadprojecthidden) | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) |  |
| [DM_LocalHistoryManager](#dm_localhistorymanager) | [ILocalHistoryManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/ILocalHistoryManager.md) |  |
| [DM_MessagesManager](#dm_messagesmanager) | [IDXPMessagesManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPMessagesManager.md) |  |
| [DM_Preferences](#dm_preferences) | [IDXPWorkspacePreferences](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPWorkspacePreferences.md) |  |
| [DM_ProductBranding](#dm_productbranding) | [IDXPProductBranding](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProductBranding.md) |  |
| [DM_ProjectCount](#dm_projectcount) | `int` |  |
| [DM_Projects](#dm_projects) | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) |  |
| [DM_ShowMessageView](#dm_showmessageview) | `void` |  |
| [DM_UseItemRevision](#dm_useitemrevision) | `bool` |  |
| [DM_WorkspaceFileName](#dm_workspacefilename) | `string` |  |

### DM_AddOutputLine

*No description yet.*

```csharp
void DM_AddOutputLine(string argMessageLine, bool argReplaceLastLine, bool argUpdateLastLine);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argMessageLine` | `string` | value |
| `argReplaceLastLine` | `bool` | value |
| `argUpdateLastLine` | `bool` | value |

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

### DM_ClearOutputLines

*No description yet.*

```csharp
void DM_ClearOutputLines();
```

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

### DM_CreateNewDocument

*No description yet.*

```csharp
string DM_CreateNewDocument(string argDocKind);
```

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

**Returns:** `string`

### DM_FileOwnership_BulkWarnEnd

*No description yet.*

```csharp
void DM_FileOwnership_BulkWarnEnd(TFileOwnershipWarningLevel argWarningLevel);
void DM_FileOwnership_BulkWarnEnd(int argWarningLevel);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argWarningLevel` | [TFileOwnershipWarningLevel](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TFileOwnershipWarningLevel.md) | value |

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

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

### DM_FileOwnership_BulkWarnRegister

*No description yet.*

```csharp
bool DM_FileOwnership_BulkWarnRegister(string argFileName);
```

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

**Returns:** `bool`

### DM_FileOwnership_BulkWarnStart

*No description yet.*

```csharp
void DM_FileOwnership_BulkWarnStart();
```

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

### DM_FocusedDocument

*No description yet.*

```csharp
IDXPDocument DM_FocusedDocument();
```

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

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

**Examples:** [Extension_BOMManager](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_BOMManager/Source%20Code/Commands.cs#L66), [Extension_PartComment](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_PartComment/Source%20Code/Commands.cs#L41)

### DM_FocusedProject

*No description yet.*

```csharp
IDXPProject DM_FocusedProject();
```

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

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

**Examples:** [Extension_BOMManager](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_BOMManager/Source%20Code/Commands.cs#L65)

### DM_FreeDocumentsProject

*No description yet.*

```csharp
IDXPProject DM_FreeDocumentsProject();
```

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

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

### DM_GetDocumentFromPath

*No description yet.*

```csharp
IDXPDocument DM_GetDocumentFromPath(string argDocumentPath);
```

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

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

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

### DM_GetManagedDocumentImageIndex

*No description yet.*

```csharp
int DM_GetManagedDocumentImageIndex(string argFilePath);
```

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

**Returns:** `int`

### DM_GetOutputLine

*No description yet.*

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

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

**Returns:** `string`

### DM_GetOutputLineCount

*No description yet.*

```csharp
int DM_GetOutputLineCount();
```

**Returns:** `int`

### DM_GetProjectFromPath

*No description yet.*

```csharp
IDXPProject DM_GetProjectFromPath(string argProjectPath);
```

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

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

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

### DM_IsReferencedAsDeviceSheet

*No description yet.*

```csharp
bool DM_IsReferencedAsDeviceSheet(string argFilePath);
```

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

**Returns:** `bool`

### DM_LoadProjectHidden

*No description yet.*

```csharp
IDXPProject DM_LoadProjectHidden(string argProjectPath);
```

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

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

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

### DM_LocalHistoryManager

*No description yet.*

```csharp
ILocalHistoryManager DM_LocalHistoryManager();
```

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

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

### DM_MessagesManager

*No description yet.*

```csharp
IDXPMessagesManager DM_MessagesManager();
```

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

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

### DM_Preferences

*No description yet.*

```csharp
IDXPWorkspacePreferences DM_Preferences();
```

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

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

### DM_ProductBranding

*No description yet.*

```csharp
IDXPProductBranding DM_ProductBranding();
```

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

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

### DM_ProjectCount

*No description yet.*

```csharp
int DM_ProjectCount();
```

**Returns:** `int`

### DM_Projects

*No description yet.*

```csharp
IDXPProject DM_Projects(int argIndex);
```

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

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

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

### DM_ShowMessageView

*No description yet.*

```csharp
void DM_ShowMessageView();
```

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

### DM_UseItemRevision

*No description yet.*

```csharp
bool DM_UseItemRevision(string argVaultGUID, string argItemGUID, string argRevisionGUID, string argParams);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argVaultGUID` | `string` | value |
| `argItemGUID` | `string` | value |
| `argRevisionGUID` | `string` | value |
| `argParams` | `string` | value |

**Returns:** `bool`

### DM_WorkspaceFileName

*No description yet.*

```csharp
string DM_WorkspaceFileName();
```

**Returns:** `string`

## Returned by

[IClient.GetDXPWorkspace](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md#getdxpworkspace), [GlobalVars.DXPWorkSpace](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/GlobalVars.md#dxpworkspace)

## Examples

Used in the SDK examples: [Extension_BOMManager](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_BOMManager/Source%20Code/Commands.cs#L61), [Extension_PartComment](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_PartComment/Source%20Code/Commands.cs#L35).