Skip to main content
View as Markdown

IUnifiedDataModel interface

No description yet.

public interface IUnifiedDataModel

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
AddDocumentvoid
BeginReadvoid
BeginWritevoid
CreateGlobalObjectobject
DestroyGlobalObjectvoid
DocumentChangedvoid
DocumentPathChangedvoid
EndReadvoid
EndWritevoid
GetDocumentPathstring
InDocumentLoadingbool
InDocumentLoading_1bool
LoadDocumentByPathobject
MakeGlobalvoid
ReleaseDocumentbool
RemoveDocumentbool
RemoveDocumentByPathbool
SupportsDocumentExtbool
SupportsDocumentInterfacebool
SupportsExtbool
SupportsInterfacebool
UnloadDocumentbool

AddDocument​

No description yet.

void AddDocument(string argDocumentID, string argFullPath, object argIntf);
ParameterTypePassing
argDocumentIDstringvalue
argFullPathstringvalue
argIntfobjectvalue

Returns: nothing (void)

BeginRead​

No description yet.

void BeginRead();

Returns: nothing (void)

Examples: Extension_TestPortHarnessDev

BeginWrite​

No description yet.

void BeginWrite();

Returns: nothing (void)

CreateGlobalObject​

No description yet.

object CreateGlobalObject(string argDocumentKind, int argObjectId);
ParameterTypePassing
argDocumentKindstringvalue
argObjectIdintvalue

Returns: object

DestroyGlobalObject​

No description yet.

void DestroyGlobalObject(string argHandle);
ParameterTypePassing
argHandlestringvalue

Returns: nothing (void)

DocumentChanged​

No description yet.

void DocumentChanged(string argFullPath, string argNewID);
ParameterTypePassing
argFullPathstringvalue
argNewIDstringvalue

Returns: nothing (void)

DocumentPathChanged​

No description yet.

void DocumentPathChanged(string argOldPath, string argNewPath);
ParameterTypePassing
argOldPathstringvalue
argNewPathstringvalue

Returns: nothing (void)

EndRead​

No description yet.

void EndRead();

Returns: nothing (void)

Examples: Extension_TestPortHarnessDev

EndWrite​

No description yet.

void EndWrite();

Returns: nothing (void)

GetDocumentPath​

No description yet.

string GetDocumentPath(string argHandle);
ParameterTypePassing
argHandlestringvalue

Returns: string

InDocumentLoading​

No description yet.

bool InDocumentLoading();

Returns: bool

InDocumentLoading_1​

No description yet.

bool InDocumentLoading_1(string argFullPath);
ParameterTypePassing
argFullPathstringvalue

Returns: bool

LoadDocumentByPath​

No description yet.

object LoadDocumentByPath(string argFullPath);
ParameterTypePassing
argFullPathstringvalue

Returns: object

MakeGlobal​

No description yet.

void MakeGlobal(object argObject);
ParameterTypePassing
argObjectobjectvalue

Returns: nothing (void)

ReleaseDocument​

No description yet.

bool ReleaseDocument(string argDocumentID);
ParameterTypePassing
argDocumentIDstringvalue

Returns: bool

RemoveDocument​

No description yet.

bool RemoveDocument(string argDocumentID);
ParameterTypePassing
argDocumentIDstringvalue

Returns: bool

RemoveDocumentByPath​

No description yet.

bool RemoveDocumentByPath(string argFullPath);
ParameterTypePassing
argFullPathstringvalue

Returns: bool

SupportsDocumentExt​

No description yet.

bool SupportsDocumentExt(string argDocumentID, string argIID, out object argIntf);
ParameterTypePassing
argDocumentIDstringvalue
argIIDstringvalue
argIntfobjectout

Returns: bool

SupportsDocumentInterface​

No description yet.

bool SupportsDocumentInterface(string argDocumentID, out object argIntf);
ParameterTypePassing
argDocumentIDstringvalue
argIntfobjectout

Returns: bool

SupportsExt​

No description yet.

bool SupportsExt(string argHandle, string argIID, out object argIntf);
ParameterTypePassing
argHandlestringvalue
argIIDstringvalue
argIntfobjectout

Returns: bool

SupportsInterface​

No description yet.

bool SupportsInterface(string argHandle, out object argIntf);
ParameterTypePassing
argHandlestringvalue
argIntfobjectout

Returns: bool

Examples: Extension_TestPortHarnessDev

UnloadDocument​

No description yet.

bool UnloadDocument(string argDocumentID);
ParameterTypePassing
argDocumentIDstringvalue

Returns: bool

Returned by​

IProject.DM_DataModel

Examples​

Used in the SDK examples: Extension_TestPortHarnessDev.