Utils class

No description yet.

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	bool	get

IsRunningOn32Bit

No description yet.

bool IsRunningOn32Bit { get; }

Type: bool · Access: read-only

Methods

Method	Returns	Description
AddSlash	string
AddWorkspaceMessage	void
CenterControlOnActiveMonitor	void
ConfirmNoYes	bool
ConfirmNoYesCancel	bool
ConfirmNoYesWithCaption	bool
ConfirmOKCancel	bool
CreateNewDocumentFromDocumentKind	IServerDocument
CurrentPercentState	TPercentState
CutNotificationLeft	string
DXPNavigateInNewWindow	void
DXPNavigateTo	void
FileOwnershipCleanDanglingOwnershipFile	void
FileOwnershipDetails	bool
FileOwnershipIsOwnedByOther	bool
FileOwnershipRegisterAcquisition	FileStream
FileOwnershipReportAcquisitionMessage	void
FileOwnershipUnRegisterAcquisition	void
FileOwnershipWarnOwnedByOther	void
FileOwnershipWarnOwnedByOtherDialog	void
FileOwnershipWarnOwnedByOtherMessage	void
GetDownloadsFolderPath	string
GetDXPSDKModuleHandle	IntPtr
GetDXPServerManager	IEDMS_DXPServerManager
GetFileMD5Hash	string
GetFxHashCode	int
GetLogManager	ILogManager
GetMainModuleHandle	IntPtr
GetOwnershipFileName	string
GetParamterValue	bool
GetProjectOfDocument	IDXPProject
GetRedableFileSize	string
GetRevisionDisplayName	string
GetStringMD5Hash	string
GetStringPrefixAndIndex	bool
GetStrParameterValue	string
GetTemporaryFileName	string
IsActiveServerFeatureAllowed	bool
IsAltiumViewer	bool
IsConnectedToProjectServer	bool
IsFeatureAllowed	bool
IsLongPathsSupported	bool
IsSuffixedFeatureAllowed	bool
IsTargetServerConnected	bool
MarqueeActive	bool
MessageRouterGetCommandEnabled	bool
MessageRouterGetCommandState	void
MessageRouterGetStateMainWindowHandle	IntPtr
MessageRouterPostCommandToModule	void
MessageRouterSendCommandToModule	void
NotificationStartsFrom	bool
OwnershipFileIsDangling	bool
PercentActive	bool
PercentBeginComplexOperation	void
PercentBeginUndeterminedOperation	void
PercentEndComplexOperation	void
PercentEndUndeterminedOperation	void
PercentFinish	void
PercentInit	void
PercentUpdate	void
PercentUpdateByNumber	void
PercentUpdateSetNumber	void
ProcessKeyByClient	bool
RunCommand	void
RunTaskDialog	TaskDialogResult
RunTaskDialogEx	TaskDialogResult
ServerOptionsReader	IOptionsReader
ServerOptionsWriter	IOptionsWriter
SetParamterValue	void
ShowError	void
ShowInfo	void
ShowMessage	void
ShowWarning	void
SpecialFolderMyDesigns	string
StatusBarGetState	string
StatusBarPopStatus	void
StatusBarPushStatus	void
StatusBarSetState	void
StatusBarSetStateDefault	void
StringReplace	string
SupportsService	bool
TerminateHosttIfTestMode	void
ToIntPtr	IntPtr

AddSlash

No description yet.

static string AddSlash(string argStr, char argSlash);

Parameter	Type	Passing
argStr	string	value
argSlash	char	value

Returns: string

AddWorkspaceMessage

No description yet.

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

static void CenterControlOnActiveMonitor(Control argControl);

Parameter	Type	Passing
argControl	Control	value

Returns: nothing (void)

ConfirmNoYes

No description yet.

static bool ConfirmNoYes(string argText);

Parameter	Type	Passing
argText	string	value

Returns: bool

ConfirmNoYesCancel

No description yet.

static bool ConfirmNoYesCancel(string argText);

Parameter	Type	Passing
argText	string	value

Returns: bool

ConfirmNoYesWithCaption

No description yet.

static bool ConfirmNoYesWithCaption(string argCaption, string argText);

Parameter	Type	Passing
argCaption	string	value
argText	string	value

Returns: bool

ConfirmOKCancel

No description yet.

static bool ConfirmOKCancel(string argText);

Parameter	Type	Passing
argText	string	value

Returns: bool

CreateNewDocumentFromDocumentKind

No description yet.

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.

Overload 2: static IServerDocument CreateNewDocumentFromDocumentKind(ref string argDocumentKind)

Parameter	Type	Passing
argDocumentKind	string	ref

Returns IServerDocument.

CurrentPercentState

No description yet.

static TPercentState CurrentPercentState();

Returns: TPercentState

CutNotificationLeft

No description yet.

static string CutNotificationLeft(string argStr, string argSubStr);

Parameter	Type	Passing
argStr	string	value
argSubStr	string	value

Returns: string

DXPNavigateInNewWindow

No description yet.

static void DXPNavigateInNewWindow(string link);

Parameter	Type	Passing
link	string	value

Returns: nothing (void)

DXPNavigateTo

No description yet.

static void DXPNavigateTo(string link);

Parameter	Type	Passing
link	string	value

Returns: nothing (void)

FileOwnershipCleanDanglingOwnershipFile

No description yet.

static void FileOwnershipCleanDanglingOwnershipFile(string argDataFileName);

Parameter	Type	Passing
argDataFileName	string	value

Returns: nothing (void)

FileOwnershipDetails

No description yet.

static bool FileOwnershipDetails(string argDataFileName, TFileOwnershipDetails argDetails);

Parameter	Type	Passing
argDataFileName	string	value
argDetails	TFileOwnershipDetails	value

Returns: bool

FileOwnershipIsOwnedByOther

No description yet.

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.

static FileStream FileOwnershipRegisterAcquisition(string argDataFileName);

Parameter	Type	Passing
argDataFileName	string	value

Returns: FileStream

FileOwnershipReportAcquisitionMessage

No description yet.

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.

static void FileOwnershipUnRegisterAcquisition(string argDataFileName, FileStream argLockFileHandle);

Parameter	Type	Passing
argDataFileName	string	value
argLockFileHandle	FileStream	value

Returns: nothing (void)

FileOwnershipWarnOwnedByOther

No description yet.

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	value

Returns: nothing (void)

FileOwnershipWarnOwnedByOtherDialog

No description yet.

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.

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.

static string GetDownloadsFolderPath();

Returns: string

GetDXPSDKModuleHandle

No description yet.

static IntPtr GetDXPSDKModuleHandle();

Returns: IntPtr

GetDXPServerManager

No description yet.

static IEDMS_DXPServerManager GetDXPServerManager();

Returns: IEDMS_DXPServerManager

GetFileMD5Hash

No description yet.

static string GetFileMD5Hash(string fullFileName);

Parameter	Type	Passing
fullFileName	string	value

Returns: string

GetFxHashCode

No description yet.

static int GetFxHashCode(string str);

Parameter	Type	Passing
str	string	value

Returns: int

GetLogManager

No description yet.

static ILogManager GetLogManager();

Returns: ILogManager

GetMainModuleHandle

No description yet.

static IntPtr GetMainModuleHandle();

Returns: IntPtr

GetOwnershipFileName

No description yet.

static string GetOwnershipFileName(string argDataFileName);

Parameter	Type	Passing
argDataFileName	string	value

Returns: string

GetParamterValue

No description yet.

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.

static IDXPProject GetProjectOfDocument(string argDocPath);

Parameter	Type	Passing
argDocPath	string	value

Returns: IDXPProject

GetRedableFileSize

No description yet.

static string GetRedableFileSize(string fullFileName);

Parameter	Type	Passing
fullFileName	string	value

Returns: string

GetRevisionDisplayName

No description yet.

static string GetRevisionDisplayName(IULB_ItemRevision revision);

Parameter	Type	Passing
revision	IULB_ItemRevision	value

Returns: string

GetStringMD5Hash

No description yet.

static string GetStringMD5Hash(string value);

Parameter	Type	Passing
value	string	value

Returns: string

GetStringPrefixAndIndex

No description yet.

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.

static string GetStrParameterValue(string parameters, string paramName);

Parameter	Type	Passing
parameters	string	value
paramName	string	value

Returns: string

GetTemporaryFileName

No description yet.

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.

static bool IsActiveServerFeatureAllowed(string featureName);

Parameter	Type	Passing
featureName	string	value

Returns: bool

IsAltiumViewer

No description yet.

static bool IsAltiumViewer();

Returns: bool

IsConnectedToProjectServer

No description yet.

static bool IsConnectedToProjectServer(IDXPProject project);

Parameter	Type	Passing
project	IDXPProject	value

Returns: bool

IsFeatureAllowed

No description yet.

static bool IsFeatureAllowed(IEDMS_Vault vault, string featureName);

Parameter	Type	Passing
vault	IEDMS_Vault	value
featureName	string	value

Returns: bool

IsLongPathsSupported

No description yet.

static bool IsLongPathsSupported();

Returns: bool

IsSuffixedFeatureAllowed

No description yet.

static bool IsSuffixedFeatureAllowed(IEDMS_Vault vault, string featureName);

Parameter	Type	Passing
vault	IEDMS_Vault	value
featureName	string	value

Returns: bool

IsTargetServerConnected

No description yet.

static bool IsTargetServerConnected(string serverGUID);

Parameter	Type	Passing
serverGUID	string	value

Returns: bool

MarqueeActive

No description yet.

static bool MarqueeActive();

Returns: bool

MessageRouterGetCommandEnabled

No description yet.

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

Parameter	Type	Passing
argProcess	string	value
argParameters	string	value
argDocumentView	IServerDocumentView	value

Returns: bool

MessageRouterGetCommandState

No description yet.

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	value
argEnabled	bool	ref
argChecked	bool	ref
argVisible	bool	ref
argCaption	string	ref
argImageFile	string	ref

Returns: nothing (void)

MessageRouterGetStateMainWindowHandle

No description yet.

static IntPtr MessageRouterGetStateMainWindowHandle();

Returns: IntPtr

MessageRouterPostCommandToModule

No description yet.

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

Parameter	Type	Passing
argProcess	string	value
argParameters	string	ref
argDocumentView	IServerDocumentView	value

Returns: nothing (void)

MessageRouterSendCommandToModule

No description yet.

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

Returns nothing (void).

NotificationStartsFrom

No description yet.

static bool NotificationStartsFrom(string argStr, string argSubStr);

Parameter	Type	Passing
argStr	string	value
argSubStr	string	value

Returns: bool

OwnershipFileIsDangling

No description yet.

static bool OwnershipFileIsDangling(string argLockFileName);

Parameter	Type	Passing
argLockFileName	string	value

Returns: bool

PercentActive

No description yet.

static bool PercentActive();

Returns: bool

PercentBeginComplexOperation

No description yet.

static void PercentBeginComplexOperation(string argInitialString);

Parameter	Type	Passing
argInitialString	string	value

Returns: nothing (void)

PercentBeginUndeterminedOperation

No description yet.

static void PercentBeginUndeterminedOperation(string argInitialString);

Parameter	Type	Passing
argInitialString	string	value

Returns: nothing (void)

PercentEndComplexOperation

No description yet.

static void PercentEndComplexOperation();

Returns: nothing (void)

PercentEndUndeterminedOperation

No description yet.

static void PercentEndUndeterminedOperation();

Returns: nothing (void)

PercentFinish

No description yet.

static void PercentFinish();

Returns: nothing (void)

PercentInit

No description yet.

static void PercentInit(string argInitialString, int argTotalCount);

Parameter	Type	Passing
argInitialString	string	value
argTotalCount	int	value

Returns: nothing (void)

PercentUpdate

No description yet.

static void PercentUpdate();

Returns: nothing (void)

PercentUpdateByNumber

No description yet.

static void PercentUpdateByNumber(int argAmountToIncrement);

Parameter	Type	Passing
argAmountToIncrement	int	value

Returns: nothing (void)

PercentUpdateSetNumber

No description yet.

static void PercentUpdateSetNumber(int argAmountToSet);

Parameter	Type	Passing
argAmountToSet	int	value

Returns: nothing (void)

ProcessKeyByClient

No description yet.

static bool ProcessKeyByClient(ushort keyID);

Parameter	Type	Passing
keyID	ushort	value

Returns: bool

RunCommand

No description yet.

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	value

Returns nothing (void).

RunTaskDialog

No description yet.

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	value
hideCancelButton	bool	value

Returns: TaskDialogResult

RunTaskDialogEx

No description yet.

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	value
hideCancelButton	bool	value
verifyCaption	string	value
verifyValue	bool	ref

Returns: TaskDialogResult

ServerOptionsReader

No description yet.

static IOptionsReader ServerOptionsReader(string serverName);

Parameter	Type	Passing
serverName	string	value

Returns: IOptionsReader

ServerOptionsWriter

No description yet.

static IOptionsWriter ServerOptionsWriter(string serverName);

Parameter	Type	Passing
serverName	string	value

Returns: IOptionsWriter

SetParamterValue

No description yet.

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.

static void ShowError(string argText, string argCaption);

Parameter	Type	Passing
argText	string	value
argCaption	string	value

Returns: nothing (void)

ShowInfo

No description yet.

static void ShowInfo(string argText, string argCaption);

Parameter	Type	Passing
argText	string	value
argCaption	string	value

Returns: nothing (void)

ShowMessage

No description yet.

static void ShowMessage(string argText);

Parameter	Type	Passing
argText	string	value

Returns: nothing (void)

ShowWarning

No description yet.

static void ShowWarning(string argText, string argCaption);

Parameter	Type	Passing
argText	string	value
argCaption	string	value

Returns: nothing (void)

SpecialFolderMyDesigns

No description yet.

static string SpecialFolderMyDesigns();

Returns: string

StatusBarGetState

No description yet.

static string StatusBarGetState(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

StatusBarPopStatus

No description yet.

static void StatusBarPopStatus();

Returns: nothing (void)

StatusBarPushStatus

No description yet.

static void StatusBarPushStatus();

Returns: nothing (void)

StatusBarSetState

No description yet.

static void StatusBarSetState(int argIndex, string argStr);

Parameter	Type	Passing
argIndex	int	value
argStr	string	value

Returns: nothing (void)

StatusBarSetStateDefault

No description yet.

static void StatusBarSetStateDefault();

Returns: nothing (void)

StringReplace

No description yet.

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.

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.

static void TerminateHosttIfTestMode(Func<string> outMessageToConsoleOnTerminate);

Parameter	Type	Passing
outMessageToConsoleOnTerminate	Func<string>	value

Returns: nothing (void)

ToIntPtr

No description yet.

static IntPtr ToIntPtr(UIntPtr ptr);

Parameter	Type	Passing
ptr	UIntPtr	value

Returns: IntPtr