IDXPWorkSpace interface

No description yet.

public interface IDXPWorkSpace

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
DM_AddOutputLine	void
DM_ClearOutputLines	void
DM_CreateNewDocument	string
DM_FileOwnership_BulkWarnEnd	void
DM_FileOwnership_BulkWarnRegister	bool
DM_FileOwnership_BulkWarnStart	void
DM_FocusedDocument	IDXPDocument
DM_FocusedProject	IDXPProject
DM_FreeDocumentsProject	IDXPProject
DM_GetDocumentFromPath	IDXPDocument
DM_GetManagedDocumentImageIndex	int
DM_GetOutputLine	string
DM_GetOutputLineCount	int
DM_GetProjectFromPath	IDXPProject
DM_IsReferencedAsDeviceSheet	bool
DM_LoadProjectHidden	IDXPProject
DM_LocalHistoryManager	ILocalHistoryManager
DM_MessagesManager	IDXPMessagesManager
DM_Preferences	IDXPWorkspacePreferences
DM_ProductBranding	IDXPProductBranding
DM_ProjectCount	int
DM_Projects	IDXPProject
DM_ShowMessageView	void
DM_UseItemRevision	bool
DM_WorkspaceFileName	string

DM_AddOutputLine

No description yet.

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

Parameter	Type	Passing
argMessageLine	string	value
argReplaceLastLine	bool	value
argUpdateLastLine	bool	value

Returns: nothing (void)

DM_ClearOutputLines

No description yet.

void DM_ClearOutputLines();

Returns: nothing (void)

DM_CreateNewDocument

No description yet.

string DM_CreateNewDocument(string argDocKind);

Parameter	Type	Passing
argDocKind	string	value

Returns: string

DM_FileOwnership_BulkWarnEnd

No description yet.

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

Parameter	Type	Passing
argWarningLevel	TFileOwnershipWarningLevel	value

Returns: nothing (void)

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

DM_FileOwnership_BulkWarnRegister

No description yet.

bool DM_FileOwnership_BulkWarnRegister(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: bool

DM_FileOwnership_BulkWarnStart

No description yet.

void DM_FileOwnership_BulkWarnStart();

Returns: nothing (void)

DM_FocusedDocument

No description yet.

IDXPDocument DM_FocusedDocument();

Returns: IDXPDocument

Extension method of IDXPWorkSpaceHelper (using DXP;).

Examples: Extension_BOMManager, Extension_PartComment

DM_FocusedProject

No description yet.

IDXPProject DM_FocusedProject();

Returns: IDXPProject

Extension method of IDXPWorkSpaceHelper (using DXP;).

Examples: Extension_BOMManager

DM_FreeDocumentsProject

No description yet.

IDXPProject DM_FreeDocumentsProject();

Returns: IDXPProject

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_GetDocumentFromPath

No description yet.

IDXPDocument DM_GetDocumentFromPath(string argDocumentPath);

Parameter	Type	Passing
argDocumentPath	string	value

Returns: IDXPDocument

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_GetManagedDocumentImageIndex

No description yet.

int DM_GetManagedDocumentImageIndex(string argFilePath);

Parameter	Type	Passing
argFilePath	string	value

Returns: int

DM_GetOutputLine

No description yet.

string DM_GetOutputLine(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

DM_GetOutputLineCount

No description yet.

int DM_GetOutputLineCount();

Returns: int

DM_GetProjectFromPath

No description yet.

IDXPProject DM_GetProjectFromPath(string argProjectPath);

Parameter	Type	Passing
argProjectPath	string	value

Returns: IDXPProject

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_IsReferencedAsDeviceSheet

No description yet.

bool DM_IsReferencedAsDeviceSheet(string argFilePath);

Parameter	Type	Passing
argFilePath	string	value

Returns: bool

DM_LoadProjectHidden

No description yet.

IDXPProject DM_LoadProjectHidden(string argProjectPath);

Parameter	Type	Passing
argProjectPath	string	value

Returns: IDXPProject

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_LocalHistoryManager

No description yet.

ILocalHistoryManager DM_LocalHistoryManager();

Returns: ILocalHistoryManager

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_MessagesManager

No description yet.

IDXPMessagesManager DM_MessagesManager();

Returns: IDXPMessagesManager

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_Preferences

No description yet.

IDXPWorkspacePreferences DM_Preferences();

Returns: IDXPWorkspacePreferences

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_ProductBranding

No description yet.

IDXPProductBranding DM_ProductBranding();

Returns: IDXPProductBranding

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_ProjectCount

No description yet.

int DM_ProjectCount();

Returns: int

DM_Projects

No description yet.

IDXPProject DM_Projects(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDXPProject

Extension method of IDXPWorkSpaceHelper (using DXP;).

DM_ShowMessageView

No description yet.

void DM_ShowMessageView();

Returns: nothing (void)

DM_UseItemRevision

No description yet.

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

Parameter	Type	Passing
argVaultGUID	string	value
argItemGUID	string	value
argRevisionGUID	string	value
argParams	string	value

Returns: bool

DM_WorkspaceFileName

No description yet.

string DM_WorkspaceFileName();

Returns: string

Returned by

IClient.GetDXPWorkspace, GlobalVars.DXPWorkSpace

Examples

Used in the SDK examples: Extension_BOMManager, Extension_PartComment.