IEDM_ParameterizedRecord interface
No description yet.
public interface IEDM_ParameterizedRecord : IEDM_Record
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Inherits: IEDM_Object → IEDM_Record
Derived: IEDM_ReleaseEntityData, IULB_Component, IULB_ItemLink, IULB_ItemRevision, IULB_ItemRevisionLink, IULB_ItemRevisionLinkType
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| IsSystemParameter | bool | get; set | |
| ParameterName | string | get; set | |
| ParameterRealValue | double | get; set | |
| ParameterValue | string | get; set |
IsSystemParameter
No description yet.
bool GetIsSystemParameter(int argIndex);
void SetIsSystemParameter(int argIndex, bool argValue);
Type: bool · Access: read/write · Index: argIndex (int)
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)
ParameterValue
No description yet.
string GetParameterValue(int argIndex);
void SetParameterValue(int argIndex, string argValue);
Type: string · Access: read/write · Index: argIndex (int)
Methods
| Method | Returns | Description |
|---|---|---|
| AddParameter | void | |
| ClearParameters | void | |
| CopyParametersTo | void | |
| DeleteParameter | void | |
| GetParameter | IEDM_Parameter | |
| GetParameterByGUID | IEDM_Parameter | |
| GetParameterByName | string | |
| GetParameterCount | int | |
| GetParameterRealValueByName | double | |
| IndexOfParameter | int | |
| SetParameter | void | |
| SetParameterWithRealValue | void |
AddParameter
No description yet.
void AddParameter(IEDM_Parameter argParameter);
void AddParameter(object argParameter);
| Parameter | Type | Passing |
|---|---|---|
argParameter | IEDM_Parameter | value |
Returns: nothing (void)
The first overload is an extension method of IEDM_ParameterizedRecordHelper (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);
| Parameter | Type | Passing |
|---|---|---|
argRecord | IEDM_ParameterizedRecord | value |
Returns: nothing (void)
The first overload is an extension method of IEDM_ParameterizedRecordHelper (using DXP;) with typed parameters; the second is declared by the interface.
DeleteParameter
No description yet.
void DeleteParameter(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: nothing (void)
GetParameter
No description yet.
IEDM_Parameter GetParameter(int argIndex);
| Parameter | Type | Passing |
|---|---|---|
argIndex | int | value |
Returns: IEDM_Parameter
Extension method of IEDM_ParameterizedRecordHelper (using DXP;).
GetParameterByGUID
No description yet.
IEDM_Parameter GetParameterByGUID(string argGUID);
| Parameter | Type | Passing |
|---|---|---|
argGUID | string | value |
Returns: IEDM_Parameter
Extension method of IEDM_ParameterizedRecordHelper (using DXP;).
GetParameterByName
No description yet.
string GetParameterByName(string argName);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
Returns: string
GetParameterCount
No description yet.
int GetParameterCount();
Returns: int
GetParameterRealValueByName
No description yet.
double GetParameterRealValueByName(string argName);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
Returns: double
IndexOfParameter
No description yet.
int IndexOfParameter(string argName);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
Returns: int
SetParameter
No description yet.
void SetParameter(string argName, string argValue);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
argValue | string | value |
Returns: nothing (void)
SetParameterWithRealValue
No description yet.
void SetParameterWithRealValue(string argName, string argValue, string argType, double argRealValue);
| Parameter | Type | Passing |
|---|---|---|
argName | string | value |
argValue | string | value |
argType | string | value |
argRealValue | double | value |
Returns: nothing (void)
Inherited members
- From IEDM_Record: CreatedByGUID, CreatedByName, CreatedDate, GUID, HRID, LastModifiedByGUID, LastModifiedByName, LastModifiedDate
- From IEDM_Object: CopyTo, Replicate
Returned by
IDXPFileBOM.GetItemUnmanagedByIndex