# Utils class

*No description yet.*

```csharp
public class Utils
```

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

## Fields

| Name | Type | Value |
| --- | --- | --- |
| `LockedFilesRecordName` | `string` | "LockedFiles.loc" |
| `SectionName` | `string` | "LockedFile" |
| `LockedFileName` | `string` | "Filename" |
| `ComputerName` | `string` | "ComputerName" |
| `UserName` | `string` | "UserName" |
| `ProcessID` | `string` | "ProcessID" |
| `LockFileExtensionSuffix` | `string` | "loc" |
| `LockFileNamePrefix` | `string` | "~$" |
| `MaxPath` | `int` | 260 |
| `AltiumSystemPath` (static) | `string` |  |

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [IsRunningOn32Bit](#isrunningon32bit) | `bool` | get |  |

### IsRunningOn32Bit

*No description yet.*

```csharp
bool IsRunningOn32Bit { get; }
```

**Type:** `bool` · **Access:** read-only

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [AddSlash](#addslash) | `string` |  |
| [AddWorkspaceMessage](#addworkspacemessage) | `void` |  |
| [CenterControlOnActiveMonitor](#centercontrolonactivemonitor) | `void` |  |
| [ConfirmNoYes](#confirmnoyes) | `bool` |  |
| [ConfirmNoYesCancel](#confirmnoyescancel) | `bool` |  |
| [ConfirmNoYesWithCaption](#confirmnoyeswithcaption) | `bool` |  |
| [ConfirmOKCancel](#confirmokcancel) | `bool` |  |
| [CreateNewDocumentFromDocumentKind](#createnewdocumentfromdocumentkind) | [IServerDocument](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocument.md) |  |
| [CurrentPercentState](#currentpercentstate) | [TPercentState](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TPercentState.md) |  |
| [CutNotificationLeft](#cutnotificationleft) | `string` |  |
| [DXPNavigateInNewWindow](#dxpnavigateinnewwindow) | `void` |  |
| [DXPNavigateTo](#dxpnavigateto) | `void` |  |
| [FileOwnershipCleanDanglingOwnershipFile](#fileownershipcleandanglingownershipfile) | `void` |  |
| [FileOwnershipDetails](#fileownershipdetails) | `bool` |  |
| [FileOwnershipIsOwnedByOther](#fileownershipisownedbyother) | `bool` |  |
| [FileOwnershipRegisterAcquisition](#fileownershipregisteracquisition) | `FileStream` |  |
| [FileOwnershipReportAcquisitionMessage](#fileownershipreportacquisitionmessage) | `void` |  |
| [FileOwnershipUnRegisterAcquisition](#fileownershipunregisteracquisition) | `void` |  |
| [FileOwnershipWarnOwnedByOther](#fileownershipwarnownedbyother) | `void` |  |
| [FileOwnershipWarnOwnedByOtherDialog](#fileownershipwarnownedbyotherdialog) | `void` |  |
| [FileOwnershipWarnOwnedByOtherMessage](#fileownershipwarnownedbyothermessage) | `void` |  |
| [GetDownloadsFolderPath](#getdownloadsfolderpath) | `string` |  |
| [GetDXPSDKModuleHandle](#getdxpsdkmodulehandle) | `IntPtr` |  |
| [GetDXPServerManager](#getdxpservermanager) | [IEDMS_DXPServerManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IEDMS_DXPServerManager.md) |  |
| [GetFileMD5Hash](#getfilemd5hash) | `string` |  |
| [GetFxHashCode](#getfxhashcode) | `int` |  |
| [GetLogManager](#getlogmanager) | [ILogManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/ILogManager.md) |  |
| [GetMainModuleHandle](#getmainmodulehandle) | `IntPtr` |  |
| [GetOwnershipFileName](#getownershipfilename) | `string` |  |
| [GetParamterValue](#getparamtervalue) | `bool` |  |
| [GetProjectOfDocument](#getprojectofdocument) | [IDXPProject](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPProject.md) |  |
| [GetRedableFileSize](#getredablefilesize) | `string` |  |
| [GetRevisionDisplayName](#getrevisiondisplayname) | `string` |  |
| [GetStringMD5Hash](#getstringmd5hash) | `string` |  |
| [GetStringPrefixAndIndex](#getstringprefixandindex) | `bool` |  |
| [GetStrParameterValue](#getstrparametervalue) | `string` |  |
| [GetTemporaryFileName](#gettemporaryfilename) | `string` |  |
| [IsActiveServerFeatureAllowed](#isactiveserverfeatureallowed) | `bool` |  |
| [IsAltiumViewer](#isaltiumviewer) | `bool` |  |
| [IsConnectedToProjectServer](#isconnectedtoprojectserver) | `bool` |  |
| [IsFeatureAllowed](#isfeatureallowed) | `bool` |  |
| [IsLongPathsSupported](#islongpathssupported) | `bool` |  |
| [IsSuffixedFeatureAllowed](#issuffixedfeatureallowed) | `bool` |  |
| [IsTargetServerConnected](#istargetserverconnected) | `bool` |  |
| [MarqueeActive](#marqueeactive) | `bool` |  |
| [MessageRouterGetCommandEnabled](#messageroutergetcommandenabled) | `bool` |  |
| [MessageRouterGetCommandState](#messageroutergetcommandstate) | `void` |  |
| [MessageRouterGetStateMainWindowHandle](#messageroutergetstatemainwindowhandle) | `IntPtr` |  |
| [MessageRouterPostCommandToModule](#messagerouterpostcommandtomodule) | `void` |  |
| [MessageRouterSendCommandToModule](#messageroutersendcommandtomodule) | `void` |  |
| [NotificationStartsFrom](#notificationstartsfrom) | `bool` |  |
| [OwnershipFileIsDangling](#ownershipfileisdangling) | `bool` |  |
| [PercentActive](#percentactive) | `bool` |  |
| [PercentBeginComplexOperation](#percentbegincomplexoperation) | `void` |  |
| [PercentBeginUndeterminedOperation](#percentbeginundeterminedoperation) | `void` |  |
| [PercentEndComplexOperation](#percentendcomplexoperation) | `void` |  |
| [PercentEndUndeterminedOperation](#percentendundeterminedoperation) | `void` |  |
| [PercentFinish](#percentfinish) | `void` |  |
| [PercentInit](#percentinit) | `void` |  |
| [PercentUpdate](#percentupdate) | `void` |  |
| [PercentUpdateByNumber](#percentupdatebynumber) | `void` |  |
| [PercentUpdateSetNumber](#percentupdatesetnumber) | `void` |  |
| [ProcessKeyByClient](#processkeybyclient) | `bool` |  |
| [RunCommand](#runcommand) | `void` |  |
| [RunTaskDialog](#runtaskdialog) | [TaskDialogResult](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TaskDialogResult.md) |  |
| [RunTaskDialogEx](#runtaskdialogex) | [TaskDialogResult](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TaskDialogResult.md) |  |
| [ServerOptionsReader](#serveroptionsreader) | [IOptionsReader](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IOptionsReader.md) |  |
| [ServerOptionsWriter](#serveroptionswriter) | [IOptionsWriter](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IOptionsWriter.md) |  |
| [SetParamterValue](#setparamtervalue) | `void` |  |
| [ShowError](#showerror) | `void` |  |
| [ShowInfo](#showinfo) | `void` |  |
| [ShowMessage](#showmessage) | `void` |  |
| [ShowWarning](#showwarning) | `void` |  |
| [SpecialFolderMyDesigns](#specialfoldermydesigns) | `string` |  |
| [StatusBarGetState](#statusbargetstate) | `string` |  |
| [StatusBarPopStatus](#statusbarpopstatus) | `void` |  |
| [StatusBarPushStatus](#statusbarpushstatus) | `void` |  |
| [StatusBarSetState](#statusbarsetstate) | `void` |  |
| [StatusBarSetStateDefault](#statusbarsetstatedefault) | `void` |  |
| [StringReplace](#stringreplace) | `string` |  |
| [SupportsService](#supportsservice) | `bool` |  |
| [TerminateHosttIfTestMode](#terminatehosttiftestmode) | `void` |  |
| [ToIntPtr](#tointptr) | `IntPtr` |  |

### AddSlash

*No description yet.*

```csharp
static string AddSlash(string argStr, char argSlash);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argStr` | `string` | value |
| `argSlash` | `char` | value |

**Returns:** `string`

### AddWorkspaceMessage

*No description yet.*

```csharp
static void AddWorkspaceMessage(string message, string source, string document, TErrorLevel errorLevel, bool showMessages, string callbackProcess, string callbackParameters, string callbackProcess2, string callbackParameters2);
static void AddWorkspaceMessage(string messageClass, string message, string source, string document, int imageIndex, bool showMessages, string callbackProcess, string callbackParameters, string callbackProcess2, string callbackParameters2);
```

**Overload 1:** `static void AddWorkspaceMessage(string message, string source, string document, TErrorLevel errorLevel, bool showMessages, string callbackProcess, string callbackParameters, string callbackProcess2, string callbackParameters2)`

| Parameter | Type | Passing |
| --- | --- | --- |
| `message` | `string` | value |
| `source` | `string` | value |
| `document` | `string` | value |
| `errorLevel` | [TErrorLevel](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TErrorLevel.md) | value |
| `showMessages` | `bool` | value |
| `callbackProcess` | `string` | value |
| `callbackParameters` | `string` | value |
| `callbackProcess2` | `string` | value |
| `callbackParameters2` | `string` | value |

Returns nothing (`void`).

**Overload 2:** `static void AddWorkspaceMessage(string messageClass, string message, string source, string document, int imageIndex, bool showMessages, string callbackProcess, string callbackParameters, string callbackProcess2, string callbackParameters2)`

| Parameter | Type | Passing |
| --- | --- | --- |
| `messageClass` | `string` | value |
| `message` | `string` | value |
| `source` | `string` | value |
| `document` | `string` | value |
| `imageIndex` | `int` | value |
| `showMessages` | `bool` | value |
| `callbackProcess` | `string` | value |
| `callbackParameters` | `string` | value |
| `callbackProcess2` | `string` | value |
| `callbackParameters2` | `string` | value |

Returns nothing (`void`).

### CenterControlOnActiveMonitor

*No description yet.*

```csharp
static void CenterControlOnActiveMonitor(Control argControl);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argControl` | `Control` | value |

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

### ConfirmNoYes

*No description yet.*

```csharp
static bool ConfirmNoYes(string argText);
```

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

**Returns:** `bool`

### ConfirmNoYesCancel

*No description yet.*

```csharp
static bool ConfirmNoYesCancel(string argText);
```

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

**Returns:** `bool`

### ConfirmNoYesWithCaption

*No description yet.*

```csharp
static bool ConfirmNoYesWithCaption(string argCaption, string argText);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCaption` | `string` | value |
| `argText` | `string` | value |

**Returns:** `bool`

### ConfirmOKCancel

*No description yet.*

```csharp
static bool ConfirmOKCancel(string argText);
```

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

**Returns:** `bool`

### CreateNewDocumentFromDocumentKind

*No description yet.*

```csharp
static IServerDocument CreateNewDocumentFromDocumentKind(string argDocumentKind);
static IServerDocument CreateNewDocumentFromDocumentKind(ref string argDocumentKind);
```

**Overload 1:** `static IServerDocument CreateNewDocumentFromDocumentKind(string argDocumentKind)`

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

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

**Overload 2:** `static IServerDocument CreateNewDocumentFromDocumentKind(ref string argDocumentKind)`

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

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

### CurrentPercentState

*No description yet.*

```csharp
static TPercentState CurrentPercentState();
```

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

### CutNotificationLeft

*No description yet.*

```csharp
static string CutNotificationLeft(string argStr, string argSubStr);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argStr` | `string` | value |
| `argSubStr` | `string` | value |

**Returns:** `string`

### DXPNavigateInNewWindow

*No description yet.*

```csharp
static void DXPNavigateInNewWindow(string link);
```

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

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

### DXPNavigateTo

*No description yet.*

```csharp
static void DXPNavigateTo(string link);
```

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

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

### FileOwnershipCleanDanglingOwnershipFile

*No description yet.*

```csharp
static void FileOwnershipCleanDanglingOwnershipFile(string argDataFileName);
```

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

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

### FileOwnershipDetails

*No description yet.*

```csharp
static bool FileOwnershipDetails(string argDataFileName, TFileOwnershipDetails argDetails);
```

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

**Returns:** `bool`

### FileOwnershipIsOwnedByOther

*No description yet.*

```csharp
static bool FileOwnershipIsOwnedByOther(string argDataFileName, out string argComputerName, out string argUserName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDataFileName` | `string` | value |
| `argComputerName` | `string` | out |
| `argUserName` | `string` | out |

**Returns:** `bool`

### FileOwnershipRegisterAcquisition

*No description yet.*

```csharp
static FileStream FileOwnershipRegisterAcquisition(string argDataFileName);
```

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

**Returns:** `FileStream`

### FileOwnershipReportAcquisitionMessage

*No description yet.*

```csharp
static void FileOwnershipReportAcquisitionMessage(string argFullFileName, string argComputerName, string argUserName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argFullFileName` | `string` | value |
| `argComputerName` | `string` | value |
| `argUserName` | `string` | value |

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

### FileOwnershipUnRegisterAcquisition

*No description yet.*

```csharp
static void FileOwnershipUnRegisterAcquisition(string argDataFileName, FileStream argLockFileHandle);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDataFileName` | `string` | value |
| `argLockFileHandle` | `FileStream` | value |

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

### FileOwnershipWarnOwnedByOther

*No description yet.*

```csharp
static void FileOwnershipWarnOwnedByOther(string argFullFileName, string argComputerName, string argUserName, TFileOwnershipWarningLevel argFileOwnershipWarningLevel);
```

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

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

### FileOwnershipWarnOwnedByOtherDialog

*No description yet.*

```csharp
static void FileOwnershipWarnOwnedByOtherDialog(string argFullFileName, string argComputerName, string argUserName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argFullFileName` | `string` | value |
| `argComputerName` | `string` | value |
| `argUserName` | `string` | value |

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

### FileOwnershipWarnOwnedByOtherMessage

*No description yet.*

```csharp
static void FileOwnershipWarnOwnedByOtherMessage(string argFullFileName, string argComputerName, string argUserName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argFullFileName` | `string` | value |
| `argComputerName` | `string` | value |
| `argUserName` | `string` | value |

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

### GetDownloadsFolderPath

*No description yet.*

```csharp
static string GetDownloadsFolderPath();
```

**Returns:** `string`

### GetDXPSDKModuleHandle

*No description yet.*

```csharp
static IntPtr GetDXPSDKModuleHandle();
```

**Returns:** `IntPtr`

### GetDXPServerManager

*No description yet.*

```csharp
static IEDMS_DXPServerManager GetDXPServerManager();
```

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

### GetFileMD5Hash

*No description yet.*

```csharp
static string GetFileMD5Hash(string fullFileName);
```

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

**Returns:** `string`

### GetFxHashCode

*No description yet.*

```csharp
static int GetFxHashCode(string str);
```

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

**Returns:** `int`

### GetLogManager

*No description yet.*

```csharp
static ILogManager GetLogManager();
```

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

### GetMainModuleHandle

*No description yet.*

```csharp
static IntPtr GetMainModuleHandle();
```

**Returns:** `IntPtr`

### GetOwnershipFileName

*No description yet.*

```csharp
static string GetOwnershipFileName(string argDataFileName);
```

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

**Returns:** `string`

### GetParamterValue

*No description yet.*

```csharp
static bool GetParamterValue(string argParams, string argParamName, ref string argVal);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argParams` | `string` | value |
| `argParamName` | `string` | value |
| `argVal` | `string` | ref |

**Returns:** `bool`

### GetProjectOfDocument

*No description yet.*

```csharp
static IDXPProject GetProjectOfDocument(string argDocPath);
```

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

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

### GetRedableFileSize

*No description yet.*

```csharp
static string GetRedableFileSize(string fullFileName);
```

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

**Returns:** `string`

### GetRevisionDisplayName

*No description yet.*

```csharp
static string GetRevisionDisplayName(IULB_ItemRevision revision);
```

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

**Returns:** `string`

### GetStringMD5Hash

*No description yet.*

```csharp
static string GetStringMD5Hash(string value);
```

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

**Returns:** `string`

### GetStringPrefixAndIndex

*No description yet.*

```csharp
static bool GetStringPrefixAndIndex(string argStr, string argPrefix, out int argIndex);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argStr` | `string` | value |
| `argPrefix` | `string` | value |
| `argIndex` | `int` | out |

**Returns:** `bool`

### GetStrParameterValue

*No description yet.*

```csharp
static string GetStrParameterValue(string parameters, string paramName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `parameters` | `string` | value |
| `paramName` | `string` | value |

**Returns:** `string`

### GetTemporaryFileName

*No description yet.*

```csharp
static string GetTemporaryFileName();
static string GetTemporaryFileName(string argBaseFolder);
```

**Overload 1:** `static string GetTemporaryFileName()`

Returns `string`.

**Overload 2:** `static string GetTemporaryFileName(string argBaseFolder)`

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

Returns `string`.

### IsActiveServerFeatureAllowed

*No description yet.*

```csharp
static bool IsActiveServerFeatureAllowed(string featureName);
```

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

**Returns:** `bool`

### IsAltiumViewer

*No description yet.*

```csharp
static bool IsAltiumViewer();
```

**Returns:** `bool`

### IsConnectedToProjectServer

*No description yet.*

```csharp
static bool IsConnectedToProjectServer(IDXPProject project);
```

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

**Returns:** `bool`

### IsFeatureAllowed

*No description yet.*

```csharp
static bool IsFeatureAllowed(IEDMS_Vault vault, string featureName);
```

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

**Returns:** `bool`

### IsLongPathsSupported

*No description yet.*

```csharp
static bool IsLongPathsSupported();
```

**Returns:** `bool`

### IsSuffixedFeatureAllowed

*No description yet.*

```csharp
static bool IsSuffixedFeatureAllowed(IEDMS_Vault vault, string featureName);
```

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

**Returns:** `bool`

### IsTargetServerConnected

*No description yet.*

```csharp
static bool IsTargetServerConnected(string serverGUID);
```

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

**Returns:** `bool`

### MarqueeActive

*No description yet.*

```csharp
static bool MarqueeActive();
```

**Returns:** `bool`

### MessageRouterGetCommandEnabled

*No description yet.*

```csharp
static bool MessageRouterGetCommandEnabled(string argProcess, string argParameters, IServerDocumentView argDocumentView);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProcess` | `string` | value |
| `argParameters` | `string` | value |
| `argDocumentView` | [IServerDocumentView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocumentView.md) | value |

**Returns:** `bool`

### MessageRouterGetCommandState

*No description yet.*

```csharp
static void MessageRouterGetCommandState(string argProcess, ref string argParameters, IServerDocumentView argDocumentView, ref bool argEnabled, ref bool argChecked, ref bool argVisible, ref string argCaption, ref string argImageFile);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProcess` | `string` | value |
| `argParameters` | `string` | ref |
| `argDocumentView` | [IServerDocumentView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocumentView.md) | value |
| `argEnabled` | `bool` | ref |
| `argChecked` | `bool` | ref |
| `argVisible` | `bool` | ref |
| `argCaption` | `string` | ref |
| `argImageFile` | `string` | ref |

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

### MessageRouterGetStateMainWindowHandle

*No description yet.*

```csharp
static IntPtr MessageRouterGetStateMainWindowHandle();
```

**Returns:** `IntPtr`

### MessageRouterPostCommandToModule

*No description yet.*

```csharp
static void MessageRouterPostCommandToModule(string argProcess, ref string argParameters, IServerDocumentView argDocumentView);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProcess` | `string` | value |
| `argParameters` | `string` | ref |
| `argDocumentView` | [IServerDocumentView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocumentView.md) | value |

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

### MessageRouterSendCommandToModule

*No description yet.*

```csharp
static void MessageRouterSendCommandToModule(string argProcess, ref string argParameters, IServerDocumentView argDocumentView);
static void MessageRouterSendCommandToModule(string argProcess, string argParameters, IServerDocumentView argDocumentView);
```

**Overload 1:** `static void MessageRouterSendCommandToModule(string argProcess, ref string argParameters, IServerDocumentView argDocumentView)`

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProcess` | `string` | value |
| `argParameters` | `string` | ref |
| `argDocumentView` | [IServerDocumentView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocumentView.md) | value |

Returns nothing (`void`).

**Overload 2:** `static void MessageRouterSendCommandToModule(string argProcess, string argParameters, IServerDocumentView argDocumentView)`

| Parameter | Type | Passing |
| --- | --- | --- |
| `argProcess` | `string` | value |
| `argParameters` | `string` | value |
| `argDocumentView` | [IServerDocumentView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocumentView.md) | value |

Returns nothing (`void`).

### NotificationStartsFrom

*No description yet.*

```csharp
static bool NotificationStartsFrom(string argStr, string argSubStr);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argStr` | `string` | value |
| `argSubStr` | `string` | value |

**Returns:** `bool`

### OwnershipFileIsDangling

*No description yet.*

```csharp
static bool OwnershipFileIsDangling(string argLockFileName);
```

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

**Returns:** `bool`

### PercentActive

*No description yet.*

```csharp
static bool PercentActive();
```

**Returns:** `bool`

### PercentBeginComplexOperation

*No description yet.*

```csharp
static void PercentBeginComplexOperation(string argInitialString);
```

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

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

### PercentBeginUndeterminedOperation

*No description yet.*

```csharp
static void PercentBeginUndeterminedOperation(string argInitialString);
```

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

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

### PercentEndComplexOperation

*No description yet.*

```csharp
static void PercentEndComplexOperation();
```

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

### PercentEndUndeterminedOperation

*No description yet.*

```csharp
static void PercentEndUndeterminedOperation();
```

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

### PercentFinish

*No description yet.*

```csharp
static void PercentFinish();
```

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

### PercentInit

*No description yet.*

```csharp
static void PercentInit(string argInitialString, int argTotalCount);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argInitialString` | `string` | value |
| `argTotalCount` | `int` | value |

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

### PercentUpdate

*No description yet.*

```csharp
static void PercentUpdate();
```

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

### PercentUpdateByNumber

*No description yet.*

```csharp
static void PercentUpdateByNumber(int argAmountToIncrement);
```

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

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

### PercentUpdateSetNumber

*No description yet.*

```csharp
static void PercentUpdateSetNumber(int argAmountToSet);
```

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

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

### ProcessKeyByClient

*No description yet.*

```csharp
static bool ProcessKeyByClient(ushort keyID);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `keyID` | `ushort` | value |

**Returns:** `bool`

### RunCommand

*No description yet.*

```csharp
static void RunCommand(string argIdString, ref string argSpecialParameter);
static void RunCommand(string argIdString, string argSpecialParameter);
static void RunCommand(string argIdString, string argSpecialParameter, IServerDocumentView argDocumentView);
```

**Overload 1:** `static void RunCommand(string argIdString, ref string argSpecialParameter)`

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIdString` | `string` | value |
| `argSpecialParameter` | `string` | ref |

Returns nothing (`void`).

**Overload 2:** `static void RunCommand(string argIdString, string argSpecialParameter)`

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIdString` | `string` | value |
| `argSpecialParameter` | `string` | value |

Returns nothing (`void`).

**Overload 3:** `static void RunCommand(string argIdString, string argSpecialParameter, IServerDocumentView argDocumentView)`

| Parameter | Type | Passing |
| --- | --- | --- |
| `argIdString` | `string` | value |
| `argSpecialParameter` | `string` | value |
| `argDocumentView` | [IServerDocumentView](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IServerDocumentView.md) | value |

Returns nothing (`void`).

### RunTaskDialog

*No description yet.*

```csharp
static TaskDialogResult RunTaskDialog(string title, string instruction, List<string> commandButtons, TaskDialogIcon icon, bool hideCancelButton);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `title` | `string` | value |
| `instruction` | `string` | value |
| `commandButtons` | `List<string>` | value |
| `icon` | [TaskDialogIcon](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TaskDialogIcon.md) | value |
| `hideCancelButton` | `bool` | value |

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

### RunTaskDialogEx

*No description yet.*

```csharp
static TaskDialogResult RunTaskDialogEx(string title, string instruction, List<string> commandButtons, TaskDialogIcon icon, bool hideCancelButton, string verifyCaption, ref bool verifyValue);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `title` | `string` | value |
| `instruction` | `string` | value |
| `commandButtons` | `List<string>` | value |
| `icon` | [TaskDialogIcon](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TaskDialogIcon.md) | value |
| `hideCancelButton` | `bool` | value |
| `verifyCaption` | `string` | value |
| `verifyValue` | `bool` | ref |

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

### ServerOptionsReader

*No description yet.*

```csharp
static IOptionsReader ServerOptionsReader(string serverName);
```

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

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

### ServerOptionsWriter

*No description yet.*

```csharp
static IOptionsWriter ServerOptionsWriter(string serverName);
```

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

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

### SetParamterValue

*No description yet.*

```csharp
static void SetParamterValue(ref string result, string argParamName, string argVal);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `result` | `string` | ref |
| `argParamName` | `string` | value |
| `argVal` | `string` | value |

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

### ShowError

*No description yet.*

```csharp
static void ShowError(string argText, string argCaption);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argText` | `string` | value |
| `argCaption` | `string` | value |

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

### ShowInfo

*No description yet.*

```csharp
static void ShowInfo(string argText, string argCaption);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argText` | `string` | value |
| `argCaption` | `string` | value |

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

### ShowMessage

*No description yet.*

```csharp
static void ShowMessage(string argText);
```

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

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

### ShowWarning

*No description yet.*

```csharp
static void ShowWarning(string argText, string argCaption);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argText` | `string` | value |
| `argCaption` | `string` | value |

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

### SpecialFolderMyDesigns

*No description yet.*

```csharp
static string SpecialFolderMyDesigns();
```

**Returns:** `string`

### StatusBarGetState

*No description yet.*

```csharp
static string StatusBarGetState(int argIndex);
```

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

**Returns:** `string`

### StatusBarPopStatus

*No description yet.*

```csharp
static void StatusBarPopStatus();
```

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

### StatusBarPushStatus

*No description yet.*

```csharp
static void StatusBarPushStatus();
```

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

### StatusBarSetState

*No description yet.*

```csharp
static void StatusBarSetState(int argIndex, string argStr);
```

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

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

### StatusBarSetStateDefault

*No description yet.*

```csharp
static void StatusBarSetStateDefault();
```

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

### StringReplace

*No description yet.*

```csharp
static string StringReplace(string argStr, string argOldPattern, string argNewPattern, bool argReplaceAll, bool argIgnoreCase);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argStr` | `string` | value |
| `argOldPattern` | `string` | value |
| `argNewPattern` | `string` | value |
| `argReplaceAll` | `bool` | value |
| `argIgnoreCase` | `bool` | value |

**Returns:** `string`

### SupportsService

*No description yet.*

```csharp
static bool SupportsService(object obj, string serviceName, Action<Exception> exceptionHandler);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `obj` | `object` | value |
| `serviceName` | `string` | value |
| `exceptionHandler` | `Action<Exception>` | value |

**Returns:** `bool`

### TerminateHosttIfTestMode

*No description yet.*

```csharp
static void TerminateHosttIfTestMode(Func<string> outMessageToConsoleOnTerminate);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `outMessageToConsoleOnTerminate` | `Func<string>` | value |

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

### ToIntPtr

*No description yet.*

```csharp
static IntPtr ToIntPtr(UIntPtr ptr);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `ptr` | `UIntPtr` | value |

**Returns:** `IntPtr`