IEDM_Script interface

No description yet.

public interface IEDM_Script

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
TimeOut	int	get; set

TimeOut

No description yet.

int GetTimeOut();
void SetTimeOut(int argTimeOut);

Type: int · Access: read/write

Methods

Method	Returns	Description
AddAcquisitionPointer	void
AddFolder	void
AddItem	void
AddItemLink	void
AddItemRevision	void
AddLifeCycleDefinition	void
AddOption	void
AddRevisionNamingScheme	void
AssignItemTags	void
DeleteFolder	void
DeleteItem	void
DeleteItemRevision	void
DeleteLifeCycleDefinition	void
DeleteRevisionNamingScheme	void
GetAtomicGroupCount	int
GetAtomicGroupIdentifier	string
ReleaseItemRevision	void
StartAtomicGroup	void
UpdateFolder	void
UpdateItemRevision	void
UpdateLifeCycleDefinition	void
UpdateModelToLatest	void
UpdateModelToLatestEx	void
UpdateRevisionNamingScheme	void

AddAcquisitionPointer

No description yet.

void AddAcquisitionPointer(IULB_AcquisitionPointer argAcquisitionPointer);
void AddAcquisitionPointer(object argAcquisitionPointer);

Parameter	Type	Passing
argAcquisitionPointer	IULB_AcquisitionPointer	value

Returns: nothing (void)

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

AddFolder

No description yet.

void AddFolder(IULB_Folder argFolder);
void AddFolder(object argFolder);

Parameter	Type	Passing
argFolder	IULB_Folder	value

Returns: nothing (void)

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

AddItem

No description yet.

void AddItem(IULB_Item argItem, IULB_ItemRevision argItemRevision);
void AddItem(object argItem, object argItemRevision);

Parameter	Type	Passing
argItem	IULB_Item	value
argItemRevision	IULB_ItemRevision	value

Returns: nothing (void)

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

AddItemLink

No description yet.

void AddItemLink(IULB_ItemLink argItemLink);
void AddItemLink(object argItemLink);

Parameter	Type	Passing
argItemLink	IULB_ItemLink	value

Returns: nothing (void)

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

AddItemRevision

No description yet.

void AddItemRevision(IULB_ItemRevision argItemRevision);
void AddItemRevision(object argItemRevision);

Parameter	Type	Passing
argItemRevision	IULB_ItemRevision	value

Returns: nothing (void)

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

AddLifeCycleDefinition

No description yet.

void AddLifeCycleDefinition(IULB_LifeCycleDefinition argLifeCycleDefinition);
void AddLifeCycleDefinition(object argLifeCycleDefinition);

Parameter	Type	Passing
argLifeCycleDefinition	IULB_LifeCycleDefinition	value

Returns: nothing (void)

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

AddOption

No description yet.

void AddOption(string argOption);

Parameter	Type	Passing
argOption	string	value

Returns: nothing (void)

AddRevisionNamingScheme

No description yet.

void AddRevisionNamingScheme(IULB_RevisionNamingScheme argRevisionNamingScheme);
void AddRevisionNamingScheme(object argRevisionNamingScheme);

Parameter	Type	Passing
argRevisionNamingScheme	IULB_RevisionNamingScheme	value

Returns: nothing (void)

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

AssignItemTags

No description yet.

void AssignItemTags(IInterfaceList argItemTags);
void AssignItemTags(object argItemTags);

Parameter	Type	Passing
argItemTags	IInterfaceList	value

Returns: nothing (void)

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

DeleteFolder

No description yet.

void DeleteFolder(string argFolderGUID);

Parameter	Type	Passing
argFolderGUID	string	value

Returns: nothing (void)

DeleteItem

No description yet.

void DeleteItem(string argItemGUID);

Parameter	Type	Passing
argItemGUID	string	value

Returns: nothing (void)

DeleteItemRevision

No description yet.

void DeleteItemRevision(string argItemRevisionGUID);

Parameter	Type	Passing
argItemRevisionGUID	string	value

Returns: nothing (void)

DeleteLifeCycleDefinition

No description yet.

void DeleteLifeCycleDefinition(string argLifeCycleDefinitionGUID);

Parameter	Type	Passing
argLifeCycleDefinitionGUID	string	value

Returns: nothing (void)

DeleteRevisionNamingScheme

No description yet.

void DeleteRevisionNamingScheme(string argSchemeGUID);

Parameter	Type	Passing
argSchemeGUID	string	value

Returns: nothing (void)

GetAtomicGroupCount

No description yet.

int GetAtomicGroupCount();

Returns: int

GetAtomicGroupIdentifier

No description yet.

string GetAtomicGroupIdentifier(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

ReleaseItemRevision

No description yet.

void ReleaseItemRevision(IULB_ItemRevision argItemRevision, IInterfaceList argItemRevisionLinks, IULB_DataFoldersList argFolderList, string argReleaseNote);
void ReleaseItemRevision(object argItemRevision, object argItemRevisionLinks, object argFolderList, string argReleaseNote);

Parameter	Type	Passing
argItemRevision	IULB_ItemRevision	value
argItemRevisionLinks	IInterfaceList	value
argFolderList	IULB_DataFoldersList	value
argReleaseNote	string	value

Returns: nothing (void)

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

StartAtomicGroup

No description yet.

void StartAtomicGroup(string argGroupIdentifier);

Parameter	Type	Passing
argGroupIdentifier	string	value

Returns: nothing (void)

UpdateFolder

No description yet.

void UpdateFolder(IULB_Folder argFolder);
void UpdateFolder(object argFolder);

Parameter	Type	Passing
argFolder	IULB_Folder	value

Returns: nothing (void)

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

UpdateItemRevision

No description yet.

void UpdateItemRevision(IULB_ItemRevision argItemRevision);
void UpdateItemRevision(object argItemRevision);

Parameter	Type	Passing
argItemRevision	IULB_ItemRevision	value

Returns: nothing (void)

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

UpdateLifeCycleDefinition

No description yet.

void UpdateLifeCycleDefinition(IULB_LifeCycleDefinition argDefinition);
void UpdateLifeCycleDefinition(object argDefinition);

Parameter	Type	Passing
argDefinition	IULB_LifeCycleDefinition	value

Returns: nothing (void)

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

UpdateModelToLatest

No description yet.

void UpdateModelToLatest(string argModelRevisionGUID);

Parameter	Type	Passing
argModelRevisionGUID	string	value

Returns: nothing (void)

UpdateModelToLatestEx

No description yet.

void UpdateModelToLatestEx(string argModelRevisionGUID, bool argSkipRestrictedFromUse);

Parameter	Type	Passing
argModelRevisionGUID	string	value
argSkipRestrictedFromUse	bool	value

Returns: nothing (void)

UpdateRevisionNamingScheme

No description yet.

void UpdateRevisionNamingScheme(IULB_RevisionNamingScheme argRevisionNamingScheme);
void UpdateRevisionNamingScheme(object argRevisionNamingScheme);

Parameter	Type	Passing
argRevisionNamingScheme	IULB_RevisionNamingScheme	value

Returns: nothing (void)

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

Returned by

IEDMS_Vault.CreateScript

Accepted by

IEDMS_Vault.ExecuteScript, IEDesignData_ReleaseManager.PrepareScript