IDXPProject interface

No description yet.

public interface IDXPProject

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods

Method	Returns	Description
DM_AddControlPanel	void
DM_AddGeneratedDocument	void
DM_AddParameter	void
DM_AddSourceDocument	void
DM_GeneratedDocumentCount	int
DM_GeneratedDocuments	IDXPDocument
DM_GetDocumentByDocumentId	IDXPDocument
DM_GetDocumentFromPath	IDXPDocument
DM_GetOutputPath	string
DM_GetParameterCount	int
DM_GetParameterExist	bool
DM_GetParameterName	string
DM_GetParameterValue	string
DM_GetVCSProject	object
DM_IsSharedWithMe	bool
DM_ItemGUID	string
DM_LogicalDocumentCount	int
DM_LogicalDocuments	IDXPDocument
DM_ManagedProjectGUID	string
DM_OptionsStorage	IOptionsStorage
DM_OwnedProjectCount	int
DM_OwnedProjects	IDXPProject
DM_ProjectFileName	string
DM_ProjectFullPath	string
DM_RefreshInWorkspaceForm	void
DM_RemoveParameter	void
DM_RemoveSourceDocument	void
DM_RevisionGUID	string
DM_SetParameter	void
DM_SetVCSProject	void
DM_VaultGUID	string

DM_AddControlPanel

No description yet.

void DM_AddControlPanel(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

DM_AddGeneratedDocument

No description yet.

void DM_AddGeneratedDocument(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

DM_AddParameter

No description yet.

void DM_AddParameter(string argName, string argValue);

Parameter	Type	Passing
argName	string	value
argValue	string	value

Returns: nothing (void)

DM_AddSourceDocument

No description yet.

void DM_AddSourceDocument(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

DM_GeneratedDocumentCount

No description yet.

int DM_GeneratedDocumentCount();

Returns: int

DM_GeneratedDocuments

No description yet.

IDXPDocument DM_GeneratedDocuments(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDXPDocument

Extension method of IDXPProjectHelper (using DXP;).

DM_GetDocumentByDocumentId

No description yet.

IDXPDocument DM_GetDocumentByDocumentId(string argDocumentId);

Parameter	Type	Passing
argDocumentId	string	value

Returns: IDXPDocument

Extension method of IDXPProjectHelper (using DXP;).

DM_GetDocumentFromPath

No description yet.

IDXPDocument DM_GetDocumentFromPath(string argDocumentPath);

Parameter	Type	Passing
argDocumentPath	string	value

Returns: IDXPDocument

Extension method of IDXPProjectHelper (using DXP;).

DM_GetOutputPath

No description yet.

string DM_GetOutputPath();

Returns: string

DM_GetParameterCount

No description yet.

int DM_GetParameterCount();

Returns: int

DM_GetParameterExist

No description yet.

bool DM_GetParameterExist(string argName);

Parameter	Type	Passing
argName	string	value

Returns: bool

DM_GetParameterName

No description yet.

string DM_GetParameterName(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

DM_GetParameterValue

No description yet.

string DM_GetParameterValue(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

DM_GetVCSProject

No description yet.

object DM_GetVCSProject();

Returns: object

DM_IsSharedWithMe

No description yet.

bool DM_IsSharedWithMe();

Returns: bool

DM_ItemGUID

No description yet.

string DM_ItemGUID();

Returns: string

DM_LogicalDocumentCount

No description yet.

int DM_LogicalDocumentCount();

Returns: int

DM_LogicalDocuments

No description yet.

IDXPDocument DM_LogicalDocuments(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDXPDocument

Extension method of IDXPProjectHelper (using DXP;).

DM_ManagedProjectGUID

No description yet.

string DM_ManagedProjectGUID();

Returns: string

DM_OptionsStorage

No description yet.

IOptionsStorage DM_OptionsStorage();

Returns: IOptionsStorage

Extension method of IDXPProjectHelper (using DXP;).

DM_OwnedProjectCount

No description yet.

int DM_OwnedProjectCount();

Returns: int

DM_OwnedProjects

No description yet.

IDXPProject DM_OwnedProjects(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IDXPProject

Extension method of IDXPProjectHelper (using DXP;).

DM_ProjectFileName

No description yet.

string DM_ProjectFileName();

Returns: string

DM_ProjectFullPath

No description yet.

string DM_ProjectFullPath();

Returns: string

DM_RefreshInWorkspaceForm

No description yet.

void DM_RefreshInWorkspaceForm();

Returns: nothing (void)

DM_RemoveParameter

No description yet.

void DM_RemoveParameter(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: nothing (void)

DM_RemoveSourceDocument

No description yet.

void DM_RemoveSourceDocument(string argFileName);

Parameter	Type	Passing
argFileName	string	value

Returns: nothing (void)

DM_RevisionGUID

No description yet.

string DM_RevisionGUID();

Returns: string

DM_SetParameter

No description yet.

void DM_SetParameter(string argName, string argValue);

Parameter	Type	Passing
argName	string	value
argValue	string	value

Returns: nothing (void)

DM_SetVCSProject

No description yet.

void DM_SetVCSProject(object argValue);

Parameter	Type	Passing
argValue	object	value

Returns: nothing (void)

DM_VaultGUID

No description yet.

string DM_VaultGUID();

Returns: string

Returned by

IDXPDocument.DM_Project, IDXPWorkSpace.DM_FocusedProject, IDXPWorkSpace.DM_FreeDocumentsProject, IDXPWorkSpace.DM_GetProjectFromPath, IDXPWorkSpace.DM_LoadProjectHidden, IDXPWorkSpace.DM_Projects, IDataForProjectReleaseNotification.GetProject, IDataForProjectReleaseNotification.GetSnapshotProject, IVcsProject.Project, Utils.GetProjectOfDocument

Accepted by

IVcsManager.CreateVcsProject, ICommentService.CommentingAvailable, Utils.IsConnectedToProjectServer