Skip to main content
View as Markdown

IULB_Item interface

No description yet.

public interface IULB_Item : IEDM_ShareableRecord

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Inherits: IEDM_Object → IEDM_Record → IEDM_ShareableRecord

Properties​

PropertyTypeAccessDescription
ContentTypeGUIDstringget; set
Descriptionstringget; set
FolderGUIDstringget; set
IsActiveboolget; set
IsSystemParameterboolget; set
LifeCycleDefinitionGUIDstringget; set
ParameterNamestringget; set
ParameterRealValuedoubleget; set
ParameterTypestringget; set
ParameterValuestringget; set
RevisionNamingSchemeGUIDstringget; set
SharingControlintget; set

ContentTypeGUID​

No description yet.

string GetContentTypeGUID();
void SetContentTypeGUID(string argValue);

Type: string · Access: read/write

Description​

No description yet.

string GetDescription();
void SetDescription(string argValue);

Type: string · Access: read/write

FolderGUID​

No description yet.

string GetFolderGUID();
void SetFolderGUID(string argValue);

Type: string · Access: read/write

IsActive​

No description yet.

bool GetIsActive();
void SetIsActive(bool argValue);

Type: bool · Access: read/write

IsSystemParameter​

No description yet.

bool GetIsSystemParameter(int argIndex);
void SetIsSystemParameter(int argIndex, bool argValue);

Type: bool · Access: read/write · Index: argIndex (int)

LifeCycleDefinitionGUID​

No description yet.

string GetLifeCycleDefinitionGUID();
void SetLifeCycleDefinitionGUID(string argValue);

Type: string · Access: read/write

ParameterName​

No description yet.

string GetParameterName(int argIndex);
void SetParameterName(int argIndex, string argName);

Type: string · Access: read/write · Index: argIndex (int)

ParameterRealValue​

No description yet.

double GetParameterRealValue(int argIndex);
void SetParameterRealValue(int argIndex, double argRealValue);

Type: double · Access: read/write · Index: argIndex (int)

ParameterType​

No description yet.

string GetParameterType(int argIndex);
void SetParameterType(int argIndex, string argType);

Type: string · Access: read/write · Index: argIndex (int)

ParameterValue​

No description yet.

string GetParameterValue(int argIndex);
void SetParameterValue(int argIndex, string argValue);

Type: string · Access: read/write · Index: argIndex (int)

RevisionNamingSchemeGUID​

No description yet.

string GetRevisionNamingSchemeGUID();
void SetRevisionNamingSchemeGUID(string argValue);

Type: string · Access: read/write

SharingControl​

No description yet.

int GetSharingControl();
void SetSharingControl(int argValue);

Type: int · Access: read/write

Methods​

MethodReturnsDescription
AddParametervoid
ClearParametersvoid
CopyParametersTovoid
DeleteParametervoid
GetParameterIEDM_Parameter
GetParameterByGUIDIEDM_Parameter
GetParameterByNamestring
GetParameterCountint
GetParameterRealValueByNamedouble
GetParameterTypeByNamestring
GetRevisionsIInterfaceList
IndexOfParameterint
SetParametervoid
SetParameterWithRealValuevoid

AddParameter​

No description yet.

void AddParameter(IEDM_Parameter argParameter);
void AddParameter(object argParameter);
ParameterTypePassing
argParameterIEDM_Parametervalue

Returns: nothing (void)

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

ClearParameters​

No description yet.

void ClearParameters();

Returns: nothing (void)

CopyParametersTo​

No description yet.

void CopyParametersTo(IEDM_ParameterizedRecord argRecord);
void CopyParametersTo(object argRecord);
ParameterTypePassing
argRecordIEDM_ParameterizedRecordvalue

Returns: nothing (void)

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

DeleteParameter​

No description yet.

void DeleteParameter(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: nothing (void)

GetParameter​

No description yet.

IEDM_Parameter GetParameter(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: IEDM_Parameter

Extension method of IULB_ItemHelper (using DXP;).

GetParameterByGUID​

No description yet.

IEDM_Parameter GetParameterByGUID(string argGUID);
ParameterTypePassing
argGUIDstringvalue

Returns: IEDM_Parameter

Extension method of IULB_ItemHelper (using DXP;).

GetParameterByName​

No description yet.

string GetParameterByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: string

GetParameterCount​

No description yet.

int GetParameterCount();

Returns: int

GetParameterRealValueByName​

No description yet.

double GetParameterRealValueByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: double

GetParameterTypeByName​

No description yet.

string GetParameterTypeByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: string

GetRevisions​

No description yet.

IInterfaceList GetRevisions();

Returns: IInterfaceList

Extension method of IULB_ItemHelper (using DXP;).

IndexOfParameter​

No description yet.

int IndexOfParameter(string argName);
ParameterTypePassing
argNamestringvalue

Returns: int

SetParameter​

No description yet.

void SetParameter(string argName, string argValue);
ParameterTypePassing
argNamestringvalue
argValuestringvalue

Returns: nothing (void)

SetParameterWithRealValue​

No description yet.

void SetParameterWithRealValue(string argName, string argValue, string argType, double argRealValue);
ParameterTypePassing
argNamestringvalue
argValuestringvalue
argTypestringvalue
argRealValuedoublevalue

Returns: nothing (void)

Inherited members​

Returned by​

IDataForProjectReleaseNotification.GetItem, IEDMS_Vault.CreateItem, IEDMS_Vault.ItemByGUID, IEDMS_Vault.ItemByHRID, IEDesignDataInterface.CreateNewItem, IEDesignDataInterface.CreateNewItemExt, IFolderAspectView.Item, IFolderDetailsFrame.GetCurrentItem, IItemRevisionPair.Item, IReleasable.PrepareItem, IScriptDirective.Item, IULB_ItemsResult.GetFirstItem, IULB_ItemsResult.GetItemByGUID, IVEN_Folder_ItemRevisionPlace.GetItem, IVEN_Folder_ItemsSelectionChanged.GetItem, IVaultExplorerForm.CurrentItem, IPCBConfiguration.DM_ReleaseItem, IVaultConfiguration.DM_ReleaseItem

Accepted by​

IAspectView.SetState, IEDM_Script.AddItem, IEDesignDataInterface.EditItemProperties, IEDesignDataInterface.MakeNewItem, IEDesignDataInterface.ShowItemProperties, IEDesignData_ReleaseManager.ShowItemProperties, IEDesignData_SupplyChainFrame2.SetItem, IEDesignData_VaultAspectItemsPopup.CloneItemRevision, IEDesignData_VaultAspectItemsPopup.EditItemRevision, IReleasedItemForm.Execute, IRevisionDetailsFrame.SetState, ISupplyInformationView.SetState, IVaultAspectSummary.ShowFullItemDetails, IVaultAspectSummary.ShowItemProperties

Examples​

Used in the SDK examples: Extension_PartChoice.