IClientAPI_Interface interface

No description yet.

public interface IClientAPI_Interface

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ActivateLastActiveOnClose	bool	get; set
AlwaysShowNavBarInTasks	bool	get; set
AutoHideDocumentsBar	bool	get; set
AutoShowComponentSymbols	bool	get; set
BuiltInNavigationBar	bool	get; set
CurrentOutputGenerator	object	get; set
EqualButtonsInDocumentsBar	bool	get; set
FavoritesThumbnailSize	TagSIZE	get; set
GroupingInDocumentsBar	TDocumentsBarGrouping	get; set
IntegratedHelpSystem	bool	get; set
MiddleClickClosesDocumentTab	bool	get; set
MultilineDocumentsBar	bool	get; set
PrefAnimatedPanels	bool	get; set
PrefAnimationSpeed	int	get; set
PrefAutoTransparency	bool	get; set
PrefConnectivityInsightClickPreview	bool	get; set
PrefConnectivityInsightClickTextHint	bool	get; set
PrefConnectivityInsightClickTree	bool	get; set
PrefConnectivityInsightHoverDelay	int	get; set
PrefConnectivityInsightHoverPreview	bool	get; set
PrefConnectivityInsightHoverTextHint	bool	get; set
PrefConnectivityInsightHoverTree	bool	get; set
PrefDynamicAutoTransparency	bool	get; set
PrefEnableConnectivityInsight	bool	get; set
PrefEnableDocumentInsight	bool	get; set
PrefEnableHyperlinkInsight	bool	get; set
PrefEnableProjectInsight	bool	get; set
PrefEnableSupplyChainInsight	bool	get; set
PrefHideBinderViewTabs	bool	get; set
PrefHideDelay	int	get; set
PrefHideFloatingPanels	bool	get; set
PrefHyperlinkInsightClickEnabled	bool	get; set
PrefHyperlinkInsightHoverEnabled	bool	get; set
PrefOpenTasksIfNothingOpen	bool	get; set
PrefPathInTitleBar	bool	get; set
PrefPopupDelay	int	get; set
PrefRememberFormForDocKind	bool	get; set
PrefRestoreOpenDocuments	bool	get; set
PrefSaveToolsLayout	bool	get; set
PrefSuppressStartupScreen	bool	get; set
PrefTransparencyForce	int	get; set
PrefTransparencyHighest	int	get; set
PrefTransparencyLowest	int	get; set
PrefUseLuna	bool	get; set
PrefUseShadow	bool	get; set
ReloadDocumentsModifiedOutside	TConfirmationOption	get; set
UIDialogManager	IUIDialogManager	get; set
UseExternalWebBrowser	bool	get; set
UseLocalizedDialogs	bool	get; set
UseLocalizedResources	bool	get; set
UseSystemLocaleLanguage	bool	get; set
VSStyleCtrlTab	bool	get; set
Win7TaskbarJumpLists	bool	get; set
Win7TaskbarProgress	bool	get; set
Win7TaskbarThumbnails	bool	get; set

ActivateLastActiveOnClose

No description yet.

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

Type: bool · Access: read/write

AlwaysShowNavBarInTasks

No description yet.

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

Type: bool · Access: read/write

AutoHideDocumentsBar

No description yet.

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

Type: bool · Access: read/write

AutoShowComponentSymbols

No description yet.

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

Type: bool · Access: read/write

BuiltInNavigationBar

No description yet.

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

Type: bool · Access: read/write

CurrentOutputGenerator

No description yet.

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

Type: object · Access: read/write

EqualButtonsInDocumentsBar

No description yet.

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

Type: bool · Access: read/write

FavoritesThumbnailSize

No description yet.

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

Type: TagSIZE · Access: read/write

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

GroupingInDocumentsBar

No description yet.

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

Type: TDocumentsBarGrouping · Access: read/write

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

Examples: Extension_SetGroupingInDocumentsBar

IntegratedHelpSystem

No description yet.

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

Type: bool · Access: read/write

MiddleClickClosesDocumentTab

No description yet.

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

Type: bool · Access: read/write

MultilineDocumentsBar

No description yet.

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

Type: bool · Access: read/write

PrefAnimatedPanels

No description yet.

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

Type: bool · Access: read/write

PrefAnimationSpeed

No description yet.

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

Type: int · Access: read/write

PrefAutoTransparency

No description yet.

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

Type: bool · Access: read/write

PrefConnectivityInsightClickPreview

No description yet.

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

Type: bool · Access: read/write

PrefConnectivityInsightClickTextHint

No description yet.

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

Type: bool · Access: read/write

PrefConnectivityInsightClickTree

No description yet.

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

Type: bool · Access: read/write

PrefConnectivityInsightHoverDelay

No description yet.

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

Type: int · Access: read/write

PrefConnectivityInsightHoverPreview

No description yet.

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

Type: bool · Access: read/write

PrefConnectivityInsightHoverTextHint

No description yet.

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

Type: bool · Access: read/write

PrefConnectivityInsightHoverTree

No description yet.

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

Type: bool · Access: read/write

PrefDynamicAutoTransparency

No description yet.

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

Type: bool · Access: read/write

PrefEnableConnectivityInsight

No description yet.

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

Type: bool · Access: read/write

PrefEnableDocumentInsight

No description yet.

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

Type: bool · Access: read/write

PrefEnableHyperlinkInsight

No description yet.

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

Type: bool · Access: read/write

PrefEnableProjectInsight

No description yet.

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

Type: bool · Access: read/write

PrefEnableSupplyChainInsight

No description yet.

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

Type: bool · Access: read/write

PrefHideBinderViewTabs

No description yet.

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

Type: bool · Access: read/write

PrefHideDelay

No description yet.

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

Type: int · Access: read/write

PrefHideFloatingPanels

No description yet.

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

Type: bool · Access: read/write

PrefHyperlinkInsightClickEnabled

No description yet.

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

Type: bool · Access: read/write

PrefHyperlinkInsightHoverEnabled

No description yet.

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

Type: bool · Access: read/write

PrefOpenTasksIfNothingOpen

No description yet.

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

Type: bool · Access: read/write

PrefPathInTitleBar

No description yet.

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

Type: bool · Access: read/write

PrefPopupDelay

No description yet.

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

Type: int · Access: read/write

PrefRememberFormForDocKind

No description yet.

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

Type: bool · Access: read/write

PrefRestoreOpenDocuments

No description yet.

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

Type: bool · Access: read/write

PrefSaveToolsLayout

No description yet.

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

Type: bool · Access: read/write

PrefSuppressStartupScreen

No description yet.

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

Type: bool · Access: read/write

PrefTransparencyForce

No description yet.

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

Type: int · Access: read/write

PrefTransparencyHighest

No description yet.

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

Type: int · Access: read/write

PrefTransparencyLowest

No description yet.

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

Type: int · Access: read/write

PrefUseLuna

No description yet.

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

Type: bool · Access: read/write

PrefUseShadow

No description yet.

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

Type: bool · Access: read/write

ReloadDocumentsModifiedOutside

No description yet.

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

Type: TConfirmationOption · Access: read/write

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

UIDialogManager

No description yet.

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

Type: IUIDialogManager · Access: read/write

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

UseExternalWebBrowser

No description yet.

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

Type: bool · Access: read/write

UseLocalizedDialogs

No description yet.

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

Type: bool · Access: read/write

UseLocalizedResources

No description yet.

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

Type: bool · Access: read/write

UseSystemLocaleLanguage

No description yet.

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

Type: bool · Access: read/write

VSStyleCtrlTab

No description yet.

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

Type: bool · Access: read/write

Win7TaskbarJumpLists

No description yet.

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

Type: bool · Access: read/write

Win7TaskbarProgress

No description yet.

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

Type: bool · Access: read/write

Win7TaskbarThumbnails

No description yet.

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

Type: bool · Access: read/write

Methods

Method	Returns	Description
AddShutdownMessage	void
AddStartupMessage	void
BeginCursor	void
BeginExceptionHandling	void
CheckSynchronize	void
ClearErrorInfo	void
ConvertFileNameToExeFileName	string
ConvertFileNameToWildCard	string
EndCursor	void
EndExceptionHandling	void
EraseFile	void
ExistSpecific	bool
ExtractFileDirFromPath	string
ExtractFileExtFromPath	string
ExtractFileNameFromPath	string
ExtractWholeFileNameFromPath	string
FilePathInShort	string
ForceFileNameExtension	string
GetAnalyticsMonitor	IAnalyticsMonitor
GetContractedEnvironmentPath	string
GetDialogsSizeRegKeyName	string
GetDpiScalingSuffix	string
GetDxpNavigator	IDXPNavigator
GetExpandedEnvironmentPath	string
GetFeatureChecker	IFeatureChecker
GetFileSize	int
GetHelpRootURL	string
GetHelpSuffix	string
GetHelpTopic	bool
GetLogManager	ILogManager
GetOptionsManager	IOptionsManager
GetPrefNoRestoreKind	string
GetPrefNoRestoreKindCount	int
GetPrevSettings_SpecialKey_SoftwareAltiumAppDXP	string
GetRecentLayout	string
GetRecentLayoutCount	int
GetServerName	bool
GetStringFromFile	string
GetTranslationManager	ITranslationManager
HandleException	void
HideProductStartup	void
IsAltiumViewer	bool
IsErrorInfoSet	bool
IsFileReadOnly	bool
MakeNewBackUp	void
RemoveModuleFromMemory	int
RemoveSynchronize	void
SameFileName	bool
SetErrorInfo	void
SetFileFromString	void
SetPrefNoRestoreKindAdd	void
SetPrefNoRestoreKindClear	void
SetSoftErrorInfo	void
ShowHelpTopic	void
ShowProductStartup	void
SpecialFolder_AllUserDocuments	string
SpecialFolder_AltiumAllUserApplicationData	string
SpecialFolder_AltiumAllUserDocuments	string
SpecialFolder_AltiumApplicationData	string
SpecialFolder_AltiumConstraintFiles	string
SpecialFolder_AltiumDesignExplorer	string
SpecialFolder_AltiumEmbeddedConstraintFiles	string
SpecialFolder_AltiumExtensions	string
SpecialFolder_AltiumHelp	string
SpecialFolder_AltiumLibrary	string
SpecialFolder_AltiumLibraryEDIF	string
SpecialFolder_AltiumLocalApplicationData	string
SpecialFolder_AltiumLocalHelp	string
SpecialFolder_AltiumSecurityAllUserApplicationData	string
SpecialFolder_AltiumSystem	string
SpecialFolder_AltiumSystemButtons	string
SpecialFolder_AltiumSystemDocumentImages	string
SpecialFolder_AltiumSystemLibrary	string
SpecialFolder_AltiumSystemTemplates	string
SpecialFolder_AltiumSystemWizardImages	string
SpecialFolder_AltiumTaskingApplicationData	string
SpecialFolder_CommonDocumnetTemplates	string
SpecialFolder_DesignTemplates	string
SpecialFolder_ExportPreferences	string
SpecialFolder_MyDesigns	string
SpecialFolder_MyDocuments	string
SpecialFolder_TemplatesForAllUsers	string
SpecialKey_SoftwareAltiumApp	string
SpecialKey_SoftwareAltiumAppDXP	string
Synchronize	void
UpdateFont	bool

AddShutdownMessage

No description yet.

void AddShutdownMessage(string argS);

Parameter	Type	Passing
argS	string	value

Returns: nothing (void)

AddStartupMessage

No description yet.

void AddStartupMessage(string argS);

Parameter	Type	Passing
argS	string	value

Returns: nothing (void)

BeginCursor

No description yet.

void BeginCursor(int argCursor);

Parameter	Type	Passing
argCursor	int	value

Returns: nothing (void)

Examples: Ciiva

BeginExceptionHandling

No description yet.

void BeginExceptionHandling();

Returns: nothing (void)

CheckSynchronize

No description yet.

void CheckSynchronize();

Returns: nothing (void)

ClearErrorInfo

No description yet.

void ClearErrorInfo();

Returns: nothing (void)

ConvertFileNameToExeFileName

No description yet.

string ConvertFileNameToExeFileName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: string

ConvertFileNameToWildCard

No description yet.

string ConvertFileNameToWildCard(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

EndCursor

No description yet.

void EndCursor();

Returns: nothing (void)

Examples: Ciiva

EndExceptionHandling

No description yet.

void EndExceptionHandling();

Returns: nothing (void)

EraseFile

No description yet.

void EraseFile(string argFName);

Parameter	Type	Passing
argFName	string	value

Returns: nothing (void)

ExistSpecific

No description yet.

bool ExistSpecific(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: bool

ExtractFileDirFromPath

No description yet.

string ExtractFileDirFromPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

ExtractFileExtFromPath

No description yet.

string ExtractFileExtFromPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

ExtractFileNameFromPath

No description yet.

string ExtractFileNameFromPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

ExtractWholeFileNameFromPath

No description yet.

string ExtractWholeFileNameFromPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

FilePathInShort

No description yet.

string FilePathInShort(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

ForceFileNameExtension

No description yet.

string ForceFileNameExtension(string argName, string argExt);

Parameter	Type	Passing
argName	string	value
argExt	string	value

Returns: string

GetAnalyticsMonitor

No description yet.

IAnalyticsMonitor GetAnalyticsMonitor();

Returns: IAnalyticsMonitor

Extension method of IClientAPI_InterfaceHelper (using DXP;).

GetContractedEnvironmentPath

No description yet.

string GetContractedEnvironmentPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

GetDialogsSizeRegKeyName

No description yet.

string GetDialogsSizeRegKeyName();

Returns: string

GetDpiScalingSuffix

No description yet.

string GetDpiScalingSuffix();

Returns: string

GetDxpNavigator

No description yet.

IDXPNavigator GetDxpNavigator();

Returns: IDXPNavigator

Extension method of IClientAPI_InterfaceHelper (using DXP;).

GetExpandedEnvironmentPath

No description yet.

string GetExpandedEnvironmentPath(string argPath);

Parameter	Type	Passing
argPath	string	value

Returns: string

GetFeatureChecker

No description yet.

IFeatureChecker GetFeatureChecker();

Returns: IFeatureChecker

Extension method of IClientAPI_InterfaceHelper (using DXP;).

GetFileSize

No description yet.

int GetFileSize(string argFName);

Parameter	Type	Passing
argFName	string	value

Returns: int

GetHelpRootURL

No description yet.

string GetHelpRootURL();

Returns: string

GetHelpSuffix

No description yet.

string GetHelpSuffix();

Returns: string

GetHelpTopic

No description yet.

bool GetHelpTopic(string argHelpTopicID, out string argHelpTopicName);

Parameter	Type	Passing
argHelpTopicID	string	value
argHelpTopicName	string	out

Returns: bool

GetLogManager

No description yet.

ILogManager GetLogManager();

Returns: ILogManager

Extension method of IClientAPI_InterfaceHelper (using DXP;).

GetOptionsManager

No description yet.

IOptionsManager GetOptionsManager();

Returns: IOptionsManager

Extension method of IClientAPI_InterfaceHelper (using DXP;).

GetPrefNoRestoreKind

No description yet.

string GetPrefNoRestoreKind(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

GetPrefNoRestoreKindCount

No description yet.

int GetPrefNoRestoreKindCount();

Returns: int

GetPrevSettings_SpecialKey_SoftwareAltiumAppDXP

No description yet.

string GetPrevSettings_SpecialKey_SoftwareAltiumAppDXP(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

GetRecentLayout

No description yet.

string GetRecentLayout(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

GetRecentLayoutCount

No description yet.

int GetRecentLayoutCount();

Returns: int

GetServerName

No description yet.

bool GetServerName(string argDllName, out string argServerName);

Parameter	Type	Passing
argDllName	string	value
argServerName	string	out

Returns: bool

GetStringFromFile

No description yet.

string GetStringFromFile(string argFileName, string argUserID);

Parameter	Type	Passing
argFileName	string	value
argUserID	string	value

Returns: string

GetTranslationManager

No description yet.

ITranslationManager GetTranslationManager();

Returns: ITranslationManager

Extension method of IClientAPI_InterfaceHelper (using DXP;).

HandleException

No description yet.

void HandleException(string argMessage);

Parameter	Type	Passing
argMessage	string	value

Returns: nothing (void)

HideProductStartup

No description yet.

void HideProductStartup();

Returns: nothing (void)

IsAltiumViewer

No description yet.

bool IsAltiumViewer();

Returns: bool

IsErrorInfoSet

No description yet.

bool IsErrorInfoSet();

Returns: bool

IsFileReadOnly

No description yet.

bool IsFileReadOnly(string argS);

Parameter	Type	Passing
argS	string	value

Returns: bool

MakeNewBackUp

No description yet.

void MakeNewBackUp(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

RemoveModuleFromMemory

No description yet.

int RemoveModuleFromMemory(string argS);

Parameter	Type	Passing
argS	string	value

Returns: int

RemoveSynchronize

No description yet.

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

Parameter	Type	Passing
argSync	IThreadSynchronize	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.

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	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.

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.

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.

void SetPrefNoRestoreKindAdd(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

SetPrefNoRestoreKindClear

No description yet.

void SetPrefNoRestoreKindClear();

Returns: nothing (void)

SetSoftErrorInfo

No description yet.

void SetSoftErrorInfo(string argErrorMsg);

Parameter	Type	Passing
argErrorMsg	string	value

Returns: nothing (void)

ShowHelpTopic

No description yet.

void ShowHelpTopic(string argTopicName);

Parameter	Type	Passing
argTopicName	string	value

Returns: nothing (void)

ShowProductStartup

No description yet.

void ShowProductStartup(string argBitmap);

Parameter	Type	Passing
argBitmap	string	value

Returns: nothing (void)

SpecialFolder_AllUserDocuments

No description yet.

string SpecialFolder_AllUserDocuments();

Returns: string

SpecialFolder_AltiumAllUserApplicationData

No description yet.

string SpecialFolder_AltiumAllUserApplicationData();

Returns: string

SpecialFolder_AltiumAllUserDocuments

No description yet.

string SpecialFolder_AltiumAllUserDocuments();

Returns: string

SpecialFolder_AltiumApplicationData

No description yet.

string SpecialFolder_AltiumApplicationData();

Returns: string

SpecialFolder_AltiumConstraintFiles

No description yet.

string SpecialFolder_AltiumConstraintFiles();

Returns: string

SpecialFolder_AltiumDesignExplorer

No description yet.

string SpecialFolder_AltiumDesignExplorer();

Returns: string

SpecialFolder_AltiumEmbeddedConstraintFiles

No description yet.

string SpecialFolder_AltiumEmbeddedConstraintFiles();

Returns: string

SpecialFolder_AltiumExtensions

No description yet.

string SpecialFolder_AltiumExtensions();

Returns: string

SpecialFolder_AltiumHelp

No description yet.

string SpecialFolder_AltiumHelp();

Returns: string

SpecialFolder_AltiumLibrary

No description yet.

string SpecialFolder_AltiumLibrary();

Returns: string

SpecialFolder_AltiumLibraryEDIF

No description yet.

string SpecialFolder_AltiumLibraryEDIF();

Returns: string

SpecialFolder_AltiumLocalApplicationData

No description yet.

string SpecialFolder_AltiumLocalApplicationData();

Returns: string

SpecialFolder_AltiumLocalHelp

No description yet.

string SpecialFolder_AltiumLocalHelp();

Returns: string

SpecialFolder_AltiumSecurityAllUserApplicationData

No description yet.

string SpecialFolder_AltiumSecurityAllUserApplicationData();

Returns: string

SpecialFolder_AltiumSystem

No description yet.

string SpecialFolder_AltiumSystem();

Returns: string

SpecialFolder_AltiumSystemButtons

No description yet.

string SpecialFolder_AltiumSystemButtons();

Returns: string

SpecialFolder_AltiumSystemDocumentImages

No description yet.

string SpecialFolder_AltiumSystemDocumentImages();

Returns: string

SpecialFolder_AltiumSystemLibrary

No description yet.

string SpecialFolder_AltiumSystemLibrary();

Returns: string

SpecialFolder_AltiumSystemTemplates

No description yet.

string SpecialFolder_AltiumSystemTemplates();

Returns: string

SpecialFolder_AltiumSystemWizardImages

No description yet.

string SpecialFolder_AltiumSystemWizardImages();

Returns: string

SpecialFolder_AltiumTaskingApplicationData

No description yet.

string SpecialFolder_AltiumTaskingApplicationData();

Returns: string

SpecialFolder_CommonDocumnetTemplates

No description yet.

string SpecialFolder_CommonDocumnetTemplates();

Returns: string

SpecialFolder_DesignTemplates

No description yet.

string SpecialFolder_DesignTemplates();

Returns: string

SpecialFolder_ExportPreferences

No description yet.

string SpecialFolder_ExportPreferences();

Returns: string

Examples: Ciiva, Extension_Preference

SpecialFolder_MyDesigns

No description yet.

string SpecialFolder_MyDesigns();

Returns: string

SpecialFolder_MyDocuments

No description yet.

string SpecialFolder_MyDocuments();

Returns: string

SpecialFolder_TemplatesForAllUsers

No description yet.

string SpecialFolder_TemplatesForAllUsers();

Returns: string

SpecialKey_SoftwareAltiumApp

No description yet.

string SpecialKey_SoftwareAltiumApp();

Returns: string

SpecialKey_SoftwareAltiumAppDXP

No description yet.

string SpecialKey_SoftwareAltiumAppDXP();

Returns: string

Synchronize

No description yet.

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

Parameter	Type	Passing
argSync	IThreadSynchronize	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.

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

Parameter	Type	Passing
argFont	TagLOGFONTW	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, GlobalVars.ClientApi

Examples

Used in the SDK examples: Ciiva, Ciiva, Extension_Preference, Extension_SetGroupingInDocumentsBar.