# IClientAPI_Interface interface

*No description yet.*

```csharp
public interface IClientAPI_Interface
```

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

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [ActivateLastActiveOnClose](#activatelastactiveonclose) | `bool` | get; set |  |
| [AlwaysShowNavBarInTasks](#alwaysshownavbarintasks) | `bool` | get; set |  |
| [AutoHideDocumentsBar](#autohidedocumentsbar) | `bool` | get; set |  |
| [AutoShowComponentSymbols](#autoshowcomponentsymbols) | `bool` | get; set |  |
| [BuiltInNavigationBar](#builtinnavigationbar) | `bool` | get; set |  |
| [CurrentOutputGenerator](#currentoutputgenerator) | `object` | get; set |  |
| [EqualButtonsInDocumentsBar](#equalbuttonsindocumentsbar) | `bool` | get; set |  |
| [FavoritesThumbnailSize](#favoritesthumbnailsize) | [TagSIZE](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TagSIZE.md) | get; set |  |
| [GroupingInDocumentsBar](#groupingindocumentsbar) | [TDocumentsBarGrouping](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TDocumentsBarGrouping.md) | get; set |  |
| [IntegratedHelpSystem](#integratedhelpsystem) | `bool` | get; set |  |
| [MiddleClickClosesDocumentTab](#middleclickclosesdocumenttab) | `bool` | get; set |  |
| [MultilineDocumentsBar](#multilinedocumentsbar) | `bool` | get; set |  |
| [PrefAnimatedPanels](#prefanimatedpanels) | `bool` | get; set |  |
| [PrefAnimationSpeed](#prefanimationspeed) | `int` | get; set |  |
| [PrefAutoTransparency](#prefautotransparency) | `bool` | get; set |  |
| [PrefConnectivityInsightClickPreview](#prefconnectivityinsightclickpreview) | `bool` | get; set |  |
| [PrefConnectivityInsightClickTextHint](#prefconnectivityinsightclicktexthint) | `bool` | get; set |  |
| [PrefConnectivityInsightClickTree](#prefconnectivityinsightclicktree) | `bool` | get; set |  |
| [PrefConnectivityInsightHoverDelay](#prefconnectivityinsighthoverdelay) | `int` | get; set |  |
| [PrefConnectivityInsightHoverPreview](#prefconnectivityinsighthoverpreview) | `bool` | get; set |  |
| [PrefConnectivityInsightHoverTextHint](#prefconnectivityinsighthovertexthint) | `bool` | get; set |  |
| [PrefConnectivityInsightHoverTree](#prefconnectivityinsighthovertree) | `bool` | get; set |  |
| [PrefDynamicAutoTransparency](#prefdynamicautotransparency) | `bool` | get; set |  |
| [PrefEnableConnectivityInsight](#prefenableconnectivityinsight) | `bool` | get; set |  |
| [PrefEnableDocumentInsight](#prefenabledocumentinsight) | `bool` | get; set |  |
| [PrefEnableHyperlinkInsight](#prefenablehyperlinkinsight) | `bool` | get; set |  |
| [PrefEnableProjectInsight](#prefenableprojectinsight) | `bool` | get; set |  |
| [PrefEnableSupplyChainInsight](#prefenablesupplychaininsight) | `bool` | get; set |  |
| [PrefHideBinderViewTabs](#prefhidebinderviewtabs) | `bool` | get; set |  |
| [PrefHideDelay](#prefhidedelay) | `int` | get; set |  |
| [PrefHideFloatingPanels](#prefhidefloatingpanels) | `bool` | get; set |  |
| [PrefHyperlinkInsightClickEnabled](#prefhyperlinkinsightclickenabled) | `bool` | get; set |  |
| [PrefHyperlinkInsightHoverEnabled](#prefhyperlinkinsighthoverenabled) | `bool` | get; set |  |
| [PrefOpenTasksIfNothingOpen](#prefopentasksifnothingopen) | `bool` | get; set |  |
| [PrefPathInTitleBar](#prefpathintitlebar) | `bool` | get; set |  |
| [PrefPopupDelay](#prefpopupdelay) | `int` | get; set |  |
| [PrefRememberFormForDocKind](#prefrememberformfordockind) | `bool` | get; set |  |
| [PrefRestoreOpenDocuments](#prefrestoreopendocuments) | `bool` | get; set |  |
| [PrefSaveToolsLayout](#prefsavetoolslayout) | `bool` | get; set |  |
| [PrefSuppressStartupScreen](#prefsuppressstartupscreen) | `bool` | get; set |  |
| [PrefTransparencyForce](#preftransparencyforce) | `int` | get; set |  |
| [PrefTransparencyHighest](#preftransparencyhighest) | `int` | get; set |  |
| [PrefTransparencyLowest](#preftransparencylowest) | `int` | get; set |  |
| [PrefUseLuna](#prefuseluna) | `bool` | get; set |  |
| [PrefUseShadow](#prefuseshadow) | `bool` | get; set |  |
| [ReloadDocumentsModifiedOutside](#reloaddocumentsmodifiedoutside) | [TConfirmationOption](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TConfirmationOption.md) | get; set |  |
| [UIDialogManager](#uidialogmanager) | [IUIDialogManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IUIDialogManager.md) | get; set |  |
| [UseExternalWebBrowser](#useexternalwebbrowser) | `bool` | get; set |  |
| [UseLocalizedDialogs](#uselocalizeddialogs) | `bool` | get; set |  |
| [UseLocalizedResources](#uselocalizedresources) | `bool` | get; set |  |
| [UseSystemLocaleLanguage](#usesystemlocalelanguage) | `bool` | get; set |  |
| [VSStyleCtrlTab](#vsstylectrltab) | `bool` | get; set |  |
| [Win7TaskbarJumpLists](#win7taskbarjumplists) | `bool` | get; set |  |
| [Win7TaskbarProgress](#win7taskbarprogress) | `bool` | get; set |  |
| [Win7TaskbarThumbnails](#win7taskbarthumbnails) | `bool` | get; set |  |

### ActivateLastActiveOnClose

*No description yet.*

```csharp
bool GetActivateLastActiveOnClose();
void SetActivateLastActiveOnClose(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### AlwaysShowNavBarInTasks

*No description yet.*

```csharp
bool GetAlwaysShowNavBarInTasks();
void SetAlwaysShowNavBarInTasks(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### AutoHideDocumentsBar

*No description yet.*

```csharp
bool GetAutoHideDocumentsBar();
void SetAutoHideDocumentsBar(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### AutoShowComponentSymbols

*No description yet.*

```csharp
bool GetAutoShowComponentSymbols();
void SetAutoShowComponentSymbols(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### BuiltInNavigationBar

*No description yet.*

```csharp
bool GetBuiltInNavigationBar();
void SetBuiltInNavigationBar(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### CurrentOutputGenerator

*No description yet.*

```csharp
object GetCurrentOutputGenerator();
void SetCurrentOutputGenerator(object argGenerator);
```

**Type:** `object` · **Access:** read/write

### EqualButtonsInDocumentsBar

*No description yet.*

```csharp
bool GetEqualButtonsInDocumentsBar();
void SetEqualButtonsInDocumentsBar(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### FavoritesThumbnailSize

*No description yet.*

```csharp
TagSIZE GetFavoritesThumbnailSize();
void SetFavoritesThumbnailSize(TagSIZE argValue);
```

**Type:** [TagSIZE](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TagSIZE.md) · **Access:** read/write

The accessors are extension methods of `IClientAPI_InterfaceHelper` (`using DXP;`).

### GroupingInDocumentsBar

*No description yet.*

```csharp
TDocumentsBarGrouping GetGroupingInDocumentsBar();
void SetGroupingInDocumentsBar(TDocumentsBarGrouping argValue);
```

**Type:** [TDocumentsBarGrouping](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TDocumentsBarGrouping.md) · **Access:** read/write

The accessors are extension methods of `IClientAPI_InterfaceHelper` (`using DXP;`).

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

### IntegratedHelpSystem

*No description yet.*

```csharp
bool GetIntegratedHelpSystem();
void SetIntegratedHelpSystem(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### MiddleClickClosesDocumentTab

*No description yet.*

```csharp
bool GetMiddleClickClosesDocumentTab();
void SetMiddleClickClosesDocumentTab(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### MultilineDocumentsBar

*No description yet.*

```csharp
bool GetMultilineDocumentsBar();
void SetMultilineDocumentsBar(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefAnimatedPanels

*No description yet.*

```csharp
bool GetPrefAnimatedPanels();
void SetPrefAnimatedPanels(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefAnimationSpeed

*No description yet.*

```csharp
int GetPrefAnimationSpeed();
void SetPrefAnimationSpeed(int argValue);
```

**Type:** `int` · **Access:** read/write

### PrefAutoTransparency

*No description yet.*

```csharp
bool GetPrefAutoTransparency();
void SetPrefAutoTransparency(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefConnectivityInsightClickPreview

*No description yet.*

```csharp
bool GetPrefConnectivityInsightClickPreview();
void SetPrefConnectivityInsightClickPreview(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefConnectivityInsightClickTextHint

*No description yet.*

```csharp
bool GetPrefConnectivityInsightClickTextHint();
void SetPrefConnectivityInsightClickTextHint(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefConnectivityInsightClickTree

*No description yet.*

```csharp
bool GetPrefConnectivityInsightClickTree();
void SetPrefConnectivityInsightClickTree(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefConnectivityInsightHoverDelay

*No description yet.*

```csharp
int GetPrefConnectivityInsightHoverDelay();
void SetPrefConnectivityInsightHoverDelay(int argValue);
```

**Type:** `int` · **Access:** read/write

### PrefConnectivityInsightHoverPreview

*No description yet.*

```csharp
bool GetPrefConnectivityInsightHoverPreview();
void SetPrefConnectivityInsightHoverPreview(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefConnectivityInsightHoverTextHint

*No description yet.*

```csharp
bool GetPrefConnectivityInsightHoverTextHint();
void SetPrefConnectivityInsightHoverTextHint(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefConnectivityInsightHoverTree

*No description yet.*

```csharp
bool GetPrefConnectivityInsightHoverTree();
void SetPrefConnectivityInsightHoverTree(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefDynamicAutoTransparency

*No description yet.*

```csharp
bool GetPrefDynamicAutoTransparency();
void SetPrefDynamicAutoTransparency(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefEnableConnectivityInsight

*No description yet.*

```csharp
bool GetPrefEnableConnectivityInsight();
void SetPrefEnableConnectivityInsight(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefEnableDocumentInsight

*No description yet.*

```csharp
bool GetPrefEnableDocumentInsight();
void SetPrefEnableDocumentInsight(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefEnableHyperlinkInsight

*No description yet.*

```csharp
bool GetPrefEnableHyperlinkInsight();
void SetPrefEnableHyperlinkInsight(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefEnableProjectInsight

*No description yet.*

```csharp
bool GetPrefEnableProjectInsight();
void SetPrefEnableProjectInsight(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefEnableSupplyChainInsight

*No description yet.*

```csharp
bool GetPrefEnableSupplyChainInsight();
void SetPrefEnableSupplyChainInsight(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefHideBinderViewTabs

*No description yet.*

```csharp
bool GetPrefHideBinderViewTabs();
void SetPrefHideBinderViewTabs(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefHideDelay

*No description yet.*

```csharp
int GetPrefHideDelay();
void SetPrefHideDelay(int argValue);
```

**Type:** `int` · **Access:** read/write

### PrefHideFloatingPanels

*No description yet.*

```csharp
bool GetPrefHideFloatingPanels();
void SetPrefHideFloatingPanels(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefHyperlinkInsightClickEnabled

*No description yet.*

```csharp
bool GetPrefHyperlinkInsightClickEnabled();
void SetPrefHyperlinkInsightClickEnabled(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefHyperlinkInsightHoverEnabled

*No description yet.*

```csharp
bool GetPrefHyperlinkInsightHoverEnabled();
void SetPrefHyperlinkInsightHoverEnabled(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefOpenTasksIfNothingOpen

*No description yet.*

```csharp
bool GetPrefOpenTasksIfNothingOpen();
void SetPrefOpenTasksIfNothingOpen(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefPathInTitleBar

*No description yet.*

```csharp
bool GetPrefPathInTitleBar();
void SetPrefPathInTitleBar(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefPopupDelay

*No description yet.*

```csharp
int GetPrefPopupDelay();
void SetPrefPopupDelay(int argValue);
```

**Type:** `int` · **Access:** read/write

### PrefRememberFormForDocKind

*No description yet.*

```csharp
bool GetPrefRememberFormForDocKind();
void SetPrefRememberFormForDocKind(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefRestoreOpenDocuments

*No description yet.*

```csharp
bool GetPrefRestoreOpenDocuments();
void SetPrefRestoreOpenDocuments(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefSaveToolsLayout

*No description yet.*

```csharp
bool GetPrefSaveToolsLayout();
void SetPrefSaveToolsLayout(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefSuppressStartupScreen

*No description yet.*

```csharp
bool GetPrefSuppressStartupScreen();
void SetPrefSuppressStartupScreen(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefTransparencyForce

*No description yet.*

```csharp
int GetPrefTransparencyForce();
void SetPrefTransparencyForce(int argValue);
```

**Type:** `int` · **Access:** read/write

### PrefTransparencyHighest

*No description yet.*

```csharp
int GetPrefTransparencyHighest();
void SetPrefTransparencyHighest(int argValue);
```

**Type:** `int` · **Access:** read/write

### PrefTransparencyLowest

*No description yet.*

```csharp
int GetPrefTransparencyLowest();
void SetPrefTransparencyLowest(int argValue);
```

**Type:** `int` · **Access:** read/write

### PrefUseLuna

*No description yet.*

```csharp
bool GetPrefUseLuna();
void SetPrefUseLuna(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### PrefUseShadow

*No description yet.*

```csharp
bool GetPrefUseShadow();
void SetPrefUseShadow(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### ReloadDocumentsModifiedOutside

*No description yet.*

```csharp
TConfirmationOption GetReloadDocumentsModifiedOutside();
void SetReloadDocumentsModifiedOutside(TConfirmationOption argValue);
```

**Type:** [TConfirmationOption](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TConfirmationOption.md) · **Access:** read/write

The accessors are extension methods of `IClientAPI_InterfaceHelper` (`using DXP;`).

### UIDialogManager

*No description yet.*

```csharp
IUIDialogManager GetUIDialogManager();
void SetUIDialogManager(IUIDialogManager argValue);
```

**Type:** [IUIDialogManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IUIDialogManager.md) · **Access:** read/write

The accessors are extension methods of `IClientAPI_InterfaceHelper` (`using DXP;`).

### UseExternalWebBrowser

*No description yet.*

```csharp
bool GetUseExternalWebBrowser();
void SetUseExternalWebBrowser(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### UseLocalizedDialogs

*No description yet.*

```csharp
bool GetUseLocalizedDialogs();
void SetUseLocalizedDialogs(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### UseLocalizedResources

*No description yet.*

```csharp
bool GetUseLocalizedResources();
void SetUseLocalizedResources(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### UseSystemLocaleLanguage

*No description yet.*

```csharp
bool GetUseSystemLocaleLanguage();
void SetUseSystemLocaleLanguage(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### VSStyleCtrlTab

*No description yet.*

```csharp
bool GetVSStyleCtrlTab();
void SetVSStyleCtrlTab(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### Win7TaskbarJumpLists

*No description yet.*

```csharp
bool GetWin7TaskbarJumpLists();
void SetWin7TaskbarJumpLists(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### Win7TaskbarProgress

*No description yet.*

```csharp
bool GetWin7TaskbarProgress();
void SetWin7TaskbarProgress(bool argValue);
```

**Type:** `bool` · **Access:** read/write

### Win7TaskbarThumbnails

*No description yet.*

```csharp
bool GetWin7TaskbarThumbnails();
void SetWin7TaskbarThumbnails(bool argValue);
```

**Type:** `bool` · **Access:** read/write

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [AddShutdownMessage](#addshutdownmessage) | `void` |  |
| [AddStartupMessage](#addstartupmessage) | `void` |  |
| [BeginCursor](#begincursor) | `void` |  |
| [BeginExceptionHandling](#beginexceptionhandling) | `void` |  |
| [CheckSynchronize](#checksynchronize) | `void` |  |
| [ClearErrorInfo](#clearerrorinfo) | `void` |  |
| [ConvertFileNameToExeFileName](#convertfilenametoexefilename) | `string` |  |
| [ConvertFileNameToWildCard](#convertfilenametowildcard) | `string` |  |
| [EndCursor](#endcursor) | `void` |  |
| [EndExceptionHandling](#endexceptionhandling) | `void` |  |
| [EraseFile](#erasefile) | `void` |  |
| [ExistSpecific](#existspecific) | `bool` |  |
| [ExtractFileDirFromPath](#extractfiledirfrompath) | `string` |  |
| [ExtractFileExtFromPath](#extractfileextfrompath) | `string` |  |
| [ExtractFileNameFromPath](#extractfilenamefrompath) | `string` |  |
| [ExtractWholeFileNameFromPath](#extractwholefilenamefrompath) | `string` |  |
| [FilePathInShort](#filepathinshort) | `string` |  |
| [ForceFileNameExtension](#forcefilenameextension) | `string` |  |
| [GetAnalyticsMonitor](#getanalyticsmonitor) | [IAnalyticsMonitor](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IAnalyticsMonitor.md) |  |
| [GetContractedEnvironmentPath](#getcontractedenvironmentpath) | `string` |  |
| [GetDialogsSizeRegKeyName](#getdialogssizeregkeyname) | `string` |  |
| [GetDpiScalingSuffix](#getdpiscalingsuffix) | `string` |  |
| [GetDxpNavigator](#getdxpnavigator) | [IDXPNavigator](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IDXPNavigator.md) |  |
| [GetExpandedEnvironmentPath](#getexpandedenvironmentpath) | `string` |  |
| [GetFeatureChecker](#getfeaturechecker) | [IFeatureChecker](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IFeatureChecker.md) |  |
| [GetFileSize](#getfilesize) | `int` |  |
| [GetHelpRootURL](#gethelprooturl) | `string` |  |
| [GetHelpSuffix](#gethelpsuffix) | `string` |  |
| [GetHelpTopic](#gethelptopic) | `bool` |  |
| [GetLogManager](#getlogmanager) | [ILogManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/ILogManager.md) |  |
| [GetOptionsManager](#getoptionsmanager) | [IOptionsManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IOptionsManager.md) |  |
| [GetPrefNoRestoreKind](#getprefnorestorekind) | `string` |  |
| [GetPrefNoRestoreKindCount](#getprefnorestorekindcount) | `int` |  |
| [GetPrevSettings_SpecialKey_SoftwareAltiumAppDXP](#getprevsettings_specialkey_softwarealtiumappdxp) | `string` |  |
| [GetRecentLayout](#getrecentlayout) | `string` |  |
| [GetRecentLayoutCount](#getrecentlayoutcount) | `int` |  |
| [GetServerName](#getservername) | `bool` |  |
| [GetStringFromFile](#getstringfromfile) | `string` |  |
| [GetTranslationManager](#gettranslationmanager) | [ITranslationManager](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/ITranslationManager.md) |  |
| [HandleException](#handleexception) | `void` |  |
| [HideProductStartup](#hideproductstartup) | `void` |  |
| [IsAltiumViewer](#isaltiumviewer) | `bool` |  |
| [IsErrorInfoSet](#iserrorinfoset) | `bool` |  |
| [IsFileReadOnly](#isfilereadonly) | `bool` |  |
| [MakeNewBackUp](#makenewbackup) | `void` |  |
| [RemoveModuleFromMemory](#removemodulefrommemory) | `int` |  |
| [RemoveSynchronize](#removesynchronize) | `void` |  |
| [SameFileName](#samefilename) | `bool` |  |
| [SetErrorInfo](#seterrorinfo) | `void` |  |
| [SetFileFromString](#setfilefromstring) | `void` |  |
| [SetPrefNoRestoreKindAdd](#setprefnorestorekindadd) | `void` |  |
| [SetPrefNoRestoreKindClear](#setprefnorestorekindclear) | `void` |  |
| [SetSoftErrorInfo](#setsofterrorinfo) | `void` |  |
| [ShowHelpTopic](#showhelptopic) | `void` |  |
| [ShowProductStartup](#showproductstartup) | `void` |  |
| [SpecialFolder_AllUserDocuments](#specialfolder_alluserdocuments) | `string` |  |
| [SpecialFolder_AltiumAllUserApplicationData](#specialfolder_altiumalluserapplicationdata) | `string` |  |
| [SpecialFolder_AltiumAllUserDocuments](#specialfolder_altiumalluserdocuments) | `string` |  |
| [SpecialFolder_AltiumApplicationData](#specialfolder_altiumapplicationdata) | `string` |  |
| [SpecialFolder_AltiumConstraintFiles](#specialfolder_altiumconstraintfiles) | `string` |  |
| [SpecialFolder_AltiumDesignExplorer](#specialfolder_altiumdesignexplorer) | `string` |  |
| [SpecialFolder_AltiumEmbeddedConstraintFiles](#specialfolder_altiumembeddedconstraintfiles) | `string` |  |
| [SpecialFolder_AltiumExtensions](#specialfolder_altiumextensions) | `string` |  |
| [SpecialFolder_AltiumHelp](#specialfolder_altiumhelp) | `string` |  |
| [SpecialFolder_AltiumLibrary](#specialfolder_altiumlibrary) | `string` |  |
| [SpecialFolder_AltiumLibraryEDIF](#specialfolder_altiumlibraryedif) | `string` |  |
| [SpecialFolder_AltiumLocalApplicationData](#specialfolder_altiumlocalapplicationdata) | `string` |  |
| [SpecialFolder_AltiumLocalHelp](#specialfolder_altiumlocalhelp) | `string` |  |
| [SpecialFolder_AltiumSecurityAllUserApplicationData](#specialfolder_altiumsecurityalluserapplicationdata) | `string` |  |
| [SpecialFolder_AltiumSystem](#specialfolder_altiumsystem) | `string` |  |
| [SpecialFolder_AltiumSystemButtons](#specialfolder_altiumsystembuttons) | `string` |  |
| [SpecialFolder_AltiumSystemDocumentImages](#specialfolder_altiumsystemdocumentimages) | `string` |  |
| [SpecialFolder_AltiumSystemLibrary](#specialfolder_altiumsystemlibrary) | `string` |  |
| [SpecialFolder_AltiumSystemTemplates](#specialfolder_altiumsystemtemplates) | `string` |  |
| [SpecialFolder_AltiumSystemWizardImages](#specialfolder_altiumsystemwizardimages) | `string` |  |
| [SpecialFolder_AltiumTaskingApplicationData](#specialfolder_altiumtaskingapplicationdata) | `string` |  |
| [SpecialFolder_CommonDocumnetTemplates](#specialfolder_commondocumnettemplates) | `string` |  |
| [SpecialFolder_DesignTemplates](#specialfolder_designtemplates) | `string` |  |
| [SpecialFolder_ExportPreferences](#specialfolder_exportpreferences) | `string` |  |
| [SpecialFolder_MyDesigns](#specialfolder_mydesigns) | `string` |  |
| [SpecialFolder_MyDocuments](#specialfolder_mydocuments) | `string` |  |
| [SpecialFolder_TemplatesForAllUsers](#specialfolder_templatesforallusers) | `string` |  |
| [SpecialKey_SoftwareAltiumApp](#specialkey_softwarealtiumapp) | `string` |  |
| [SpecialKey_SoftwareAltiumAppDXP](#specialkey_softwarealtiumappdxp) | `string` |  |
| [Synchronize](#synchronize) | `void` |  |
| [UpdateFont](#updatefont) | `bool` |  |

### AddShutdownMessage

*No description yet.*

```csharp
void AddShutdownMessage(string argS);
```

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

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

### AddStartupMessage

*No description yet.*

```csharp
void AddStartupMessage(string argS);
```

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

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

### BeginCursor

*No description yet.*

```csharp
void BeginCursor(int argCursor);
```

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

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

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

### BeginExceptionHandling

*No description yet.*

```csharp
void BeginExceptionHandling();
```

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

### CheckSynchronize

*No description yet.*

```csharp
void CheckSynchronize();
```

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

### ClearErrorInfo

*No description yet.*

```csharp
void ClearErrorInfo();
```

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

### ConvertFileNameToExeFileName

*No description yet.*

```csharp
string ConvertFileNameToExeFileName(string argName);
```

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

**Returns:** `string`

### ConvertFileNameToWildCard

*No description yet.*

```csharp
string ConvertFileNameToWildCard(string argPath);
```

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

**Returns:** `string`

### EndCursor

*No description yet.*

```csharp
void EndCursor();
```

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

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

### EndExceptionHandling

*No description yet.*

```csharp
void EndExceptionHandling();
```

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

### EraseFile

*No description yet.*

```csharp
void EraseFile(string argFName);
```

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

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

### ExistSpecific

*No description yet.*

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

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

**Returns:** `bool`

### ExtractFileDirFromPath

*No description yet.*

```csharp
string ExtractFileDirFromPath(string argPath);
```

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

**Returns:** `string`

### ExtractFileExtFromPath

*No description yet.*

```csharp
string ExtractFileExtFromPath(string argPath);
```

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

**Returns:** `string`

### ExtractFileNameFromPath

*No description yet.*

```csharp
string ExtractFileNameFromPath(string argPath);
```

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

**Returns:** `string`

### ExtractWholeFileNameFromPath

*No description yet.*

```csharp
string ExtractWholeFileNameFromPath(string argPath);
```

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

**Returns:** `string`

### FilePathInShort

*No description yet.*

```csharp
string FilePathInShort(string argPath);
```

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

**Returns:** `string`

### ForceFileNameExtension

*No description yet.*

```csharp
string ForceFileNameExtension(string argName, string argExt);
```

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

**Returns:** `string`

### GetAnalyticsMonitor

*No description yet.*

```csharp
IAnalyticsMonitor GetAnalyticsMonitor();
```

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

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

### GetContractedEnvironmentPath

*No description yet.*

```csharp
string GetContractedEnvironmentPath(string argPath);
```

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

**Returns:** `string`

### GetDialogsSizeRegKeyName

*No description yet.*

```csharp
string GetDialogsSizeRegKeyName();
```

**Returns:** `string`

### GetDpiScalingSuffix

*No description yet.*

```csharp
string GetDpiScalingSuffix();
```

**Returns:** `string`

### GetDxpNavigator

*No description yet.*

```csharp
IDXPNavigator GetDxpNavigator();
```

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

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

### GetExpandedEnvironmentPath

*No description yet.*

```csharp
string GetExpandedEnvironmentPath(string argPath);
```

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

**Returns:** `string`

### GetFeatureChecker

*No description yet.*

```csharp
IFeatureChecker GetFeatureChecker();
```

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

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

### GetFileSize

*No description yet.*

```csharp
int GetFileSize(string argFName);
```

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

**Returns:** `int`

### GetHelpRootURL

*No description yet.*

```csharp
string GetHelpRootURL();
```

**Returns:** `string`

### GetHelpSuffix

*No description yet.*

```csharp
string GetHelpSuffix();
```

**Returns:** `string`

### GetHelpTopic

*No description yet.*

```csharp
bool GetHelpTopic(string argHelpTopicID, out string argHelpTopicName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argHelpTopicID` | `string` | value |
| `argHelpTopicName` | `string` | out |

**Returns:** `bool`

### GetLogManager

*No description yet.*

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

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

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

### GetOptionsManager

*No description yet.*

```csharp
IOptionsManager GetOptionsManager();
```

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

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

### GetPrefNoRestoreKind

*No description yet.*

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

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

**Returns:** `string`

### GetPrefNoRestoreKindCount

*No description yet.*

```csharp
int GetPrefNoRestoreKindCount();
```

**Returns:** `int`

### GetPrevSettings_SpecialKey_SoftwareAltiumAppDXP

*No description yet.*

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

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

**Returns:** `string`

### GetRecentLayout

*No description yet.*

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

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

**Returns:** `string`

### GetRecentLayoutCount

*No description yet.*

```csharp
int GetRecentLayoutCount();
```

**Returns:** `int`

### GetServerName

*No description yet.*

```csharp
bool GetServerName(string argDllName, out string argServerName);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argDllName` | `string` | value |
| `argServerName` | `string` | out |

**Returns:** `bool`

### GetStringFromFile

*No description yet.*

```csharp
string GetStringFromFile(string argFileName, string argUserID);
```

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

**Returns:** `string`

### GetTranslationManager

*No description yet.*

```csharp
ITranslationManager GetTranslationManager();
```

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

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

### HandleException

*No description yet.*

```csharp
void HandleException(string argMessage);
```

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

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

### HideProductStartup

*No description yet.*

```csharp
void HideProductStartup();
```

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

### IsAltiumViewer

*No description yet.*

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

**Returns:** `bool`

### IsErrorInfoSet

*No description yet.*

```csharp
bool IsErrorInfoSet();
```

**Returns:** `bool`

### IsFileReadOnly

*No description yet.*

```csharp
bool IsFileReadOnly(string argS);
```

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

**Returns:** `bool`

### MakeNewBackUp

*No description yet.*

```csharp
void MakeNewBackUp(string argFileName);
```

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

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

### RemoveModuleFromMemory

*No description yet.*

```csharp
int RemoveModuleFromMemory(string argS);
```

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

**Returns:** `int`

### RemoveSynchronize

*No description yet.*

```csharp
void RemoveSynchronize(IThreadSynchronize argSync);
void RemoveSynchronize(object argSync);
```

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

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

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

### SameFileName

*No description yet.*

```csharp
bool SameFileName(string argS1, string argS2, TMatchFileNameKind argMatchFileNameKind);
bool SameFileName(string argS1, string argS2, int argMatchFileNameKind);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argS1` | `string` | value |
| `argS2` | `string` | value |
| `argMatchFileNameKind` | [TMatchFileNameKind](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TMatchFileNameKind.md) | value |

**Returns:** `bool`

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

### SetErrorInfo

*No description yet.*

```csharp
void SetErrorInfo(string argErrorMsg, string argErrorReport, long argErrorAddr);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argErrorMsg` | `string` | value |
| `argErrorReport` | `string` | value |
| `argErrorAddr` | `long` | value |

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

### SetFileFromString

*No description yet.*

```csharp
void SetFileFromString(string argFileName, string argUserID, string argData);
```

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

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

### SetPrefNoRestoreKindAdd

*No description yet.*

```csharp
void SetPrefNoRestoreKindAdd(string argValue);
```

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

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

### SetPrefNoRestoreKindClear

*No description yet.*

```csharp
void SetPrefNoRestoreKindClear();
```

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

### SetSoftErrorInfo

*No description yet.*

```csharp
void SetSoftErrorInfo(string argErrorMsg);
```

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

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

### ShowHelpTopic

*No description yet.*

```csharp
void ShowHelpTopic(string argTopicName);
```

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

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

### ShowProductStartup

*No description yet.*

```csharp
void ShowProductStartup(string argBitmap);
```

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

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

### SpecialFolder_AllUserDocuments

*No description yet.*

```csharp
string SpecialFolder_AllUserDocuments();
```

**Returns:** `string`

### SpecialFolder_AltiumAllUserApplicationData

*No description yet.*

```csharp
string SpecialFolder_AltiumAllUserApplicationData();
```

**Returns:** `string`

### SpecialFolder_AltiumAllUserDocuments

*No description yet.*

```csharp
string SpecialFolder_AltiumAllUserDocuments();
```

**Returns:** `string`

### SpecialFolder_AltiumApplicationData

*No description yet.*

```csharp
string SpecialFolder_AltiumApplicationData();
```

**Returns:** `string`

### SpecialFolder_AltiumConstraintFiles

*No description yet.*

```csharp
string SpecialFolder_AltiumConstraintFiles();
```

**Returns:** `string`

### SpecialFolder_AltiumDesignExplorer

*No description yet.*

```csharp
string SpecialFolder_AltiumDesignExplorer();
```

**Returns:** `string`

### SpecialFolder_AltiumEmbeddedConstraintFiles

*No description yet.*

```csharp
string SpecialFolder_AltiumEmbeddedConstraintFiles();
```

**Returns:** `string`

### SpecialFolder_AltiumExtensions

*No description yet.*

```csharp
string SpecialFolder_AltiumExtensions();
```

**Returns:** `string`

### SpecialFolder_AltiumHelp

*No description yet.*

```csharp
string SpecialFolder_AltiumHelp();
```

**Returns:** `string`

### SpecialFolder_AltiumLibrary

*No description yet.*

```csharp
string SpecialFolder_AltiumLibrary();
```

**Returns:** `string`

### SpecialFolder_AltiumLibraryEDIF

*No description yet.*

```csharp
string SpecialFolder_AltiumLibraryEDIF();
```

**Returns:** `string`

### SpecialFolder_AltiumLocalApplicationData

*No description yet.*

```csharp
string SpecialFolder_AltiumLocalApplicationData();
```

**Returns:** `string`

### SpecialFolder_AltiumLocalHelp

*No description yet.*

```csharp
string SpecialFolder_AltiumLocalHelp();
```

**Returns:** `string`

### SpecialFolder_AltiumSecurityAllUserApplicationData

*No description yet.*

```csharp
string SpecialFolder_AltiumSecurityAllUserApplicationData();
```

**Returns:** `string`

### SpecialFolder_AltiumSystem

*No description yet.*

```csharp
string SpecialFolder_AltiumSystem();
```

**Returns:** `string`

### SpecialFolder_AltiumSystemButtons

*No description yet.*

```csharp
string SpecialFolder_AltiumSystemButtons();
```

**Returns:** `string`

### SpecialFolder_AltiumSystemDocumentImages

*No description yet.*

```csharp
string SpecialFolder_AltiumSystemDocumentImages();
```

**Returns:** `string`

### SpecialFolder_AltiumSystemLibrary

*No description yet.*

```csharp
string SpecialFolder_AltiumSystemLibrary();
```

**Returns:** `string`

### SpecialFolder_AltiumSystemTemplates

*No description yet.*

```csharp
string SpecialFolder_AltiumSystemTemplates();
```

**Returns:** `string`

### SpecialFolder_AltiumSystemWizardImages

*No description yet.*

```csharp
string SpecialFolder_AltiumSystemWizardImages();
```

**Returns:** `string`

### SpecialFolder_AltiumTaskingApplicationData

*No description yet.*

```csharp
string SpecialFolder_AltiumTaskingApplicationData();
```

**Returns:** `string`

### SpecialFolder_CommonDocumnetTemplates

*No description yet.*

```csharp
string SpecialFolder_CommonDocumnetTemplates();
```

**Returns:** `string`

### SpecialFolder_DesignTemplates

*No description yet.*

```csharp
string SpecialFolder_DesignTemplates();
```

**Returns:** `string`

### SpecialFolder_ExportPreferences

*No description yet.*

```csharp
string SpecialFolder_ExportPreferences();
```

**Returns:** `string`

**Examples:** [Ciiva](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Ciiva/Source%20Code/OptionsPage.cs#L100), [Extension_Preference](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_Preference/Source%20Code/OptionsPage.cs#L136)

### SpecialFolder_MyDesigns

*No description yet.*

```csharp
string SpecialFolder_MyDesigns();
```

**Returns:** `string`

### SpecialFolder_MyDocuments

*No description yet.*

```csharp
string SpecialFolder_MyDocuments();
```

**Returns:** `string`

### SpecialFolder_TemplatesForAllUsers

*No description yet.*

```csharp
string SpecialFolder_TemplatesForAllUsers();
```

**Returns:** `string`

### SpecialKey_SoftwareAltiumApp

*No description yet.*

```csharp
string SpecialKey_SoftwareAltiumApp();
```

**Returns:** `string`

### SpecialKey_SoftwareAltiumAppDXP

*No description yet.*

```csharp
string SpecialKey_SoftwareAltiumAppDXP();
```

**Returns:** `string`

### Synchronize

*No description yet.*

```csharp
void Synchronize(IThreadSynchronize argSync);
void Synchronize(object argSync);
```

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

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

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

### UpdateFont

*No description yet.*

```csharp
bool UpdateFont(ref TagLOGFONTW argFont);
bool UpdateFont(ref ItagLOGFONTW argFont);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argFont` | [TagLOGFONTW](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/TagLOGFONTW.md) | ref |

**Returns:** `bool`

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

## Returned by

[IClient.GetClientAPI](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IClient.md#getclientapi), [GlobalVars.ClientApi](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/GlobalVars.md#clientapi)

## Examples

Used in the SDK examples: [Ciiva](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Ciiva/Source%20Code/CiivaBOMDocument.cs#L359), [Ciiva](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Ciiva/Source%20Code/OptionsPage.cs#L96), [Extension_Preference](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_Preference/Source%20Code/OptionsPage.cs#L132), [Extension_SetGroupingInDocumentsBar](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_SetGroupingInDocumentsBar/Source%20Code/Commands.cs#L26).