IComponentDefinition interface
No description yet.
public interface IComponentDefinition : IAbstractItem
Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces
Inherits: IAbstractObject → IGloballyIdentifiedObject → IAbstractItem
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| ItemHRID | string | get; set | |
| OriginalPartChoiceDatas | IPartChoiceDataList | get; set | |
| OriginalPartChoiceListLoaded | bool | get; set | |
| PartChoiceDatas | IPartChoiceDataList | get; set | |
| PartChoiceListChanged | bool | get; set | |
| PartChoiceListChoice | IPartChoiceListChoice | get; set | |
| ReservationResult | TReservationStatus | get; set | |
| RevisionGUID | string | get; set | |
| RevisionId | string | get; set | |
| SourceItemGUID | string | get; set | |
| SourceRevisionGUID | string | get; set | |
| SourceVaultGUID | string | get; set |
ItemHRID
No description yet.
string GetItemHRID();
void SetItemHRID(string argValue);
Type: string · Access: read/write
OriginalPartChoiceDatas
No description yet.
IPartChoiceDataList GetOriginalPartChoiceDatas();
void SetOriginalPartChoiceDatas(IPartChoiceDataList argValue);
Type: IPartChoiceDataList · Access: read/write
The accessors are extension methods of IComponentDefinitionHelper (using ComponentLib;).
OriginalPartChoiceListLoaded
No description yet.
bool GetOriginalPartChoiceListLoaded();
void SetOriginalPartChoiceListLoaded(bool argValue);
Type: bool · Access: read/write
PartChoiceDatas
No description yet.
IPartChoiceDataList GetPartChoiceDatas();
void SetPartChoiceDatas(IPartChoiceDataList argValue);
Type: IPartChoiceDataList · Access: read/write
The accessors are extension methods of IComponentDefinitionHelper (using ComponentLib;).
PartChoiceListChanged
No description yet.
bool GetPartChoiceListChanged();
void SetPartChoiceListChanged(bool argValue);
Type: bool · Access: read/write
PartChoiceListChoice
No description yet.
IPartChoiceListChoice GetPartChoiceListChoice();
void SetPartChoiceListChoice(IPartChoiceListChoice argValue);
Type: IPartChoiceListChoice · Access: read/write
The accessors are extension methods of IComponentDefinitionHelper (using ComponentLib;).
ReservationResult
No description yet.
TReservationStatus GetReservationResult();
void SetReservationResult(TReservationStatus argValue);
Type: TReservationStatus · Access: read/write
The accessors are extension methods of IComponentDefinitionHelper (using ComponentLib;).
RevisionGUID
No description yet.
string GetRevisionGUID();
void SetRevisionGUID(string argValue);
Type: string · Access: read/write
RevisionId
No description yet.
string GetRevisionId();
void SetRevisionId(string argValue);
Type: string · Access: read/write
SourceItemGUID
No description yet.
string GetSourceItemGUID();
void SetSourceItemGUID(string argValue);
Type: string · Access: read/write
SourceRevisionGUID
No description yet.
string GetSourceRevisionGUID();
void SetSourceRevisionGUID(string argValue);
Type: string · Access: read/write
SourceVaultGUID
No description yet.
string GetSourceVaultGUID();
void SetSourceVaultGUID(string argValue);
Type: string · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| GetCanChangePartChoices | bool | |
| GetItemNamingScheme | string | |
| PartChoiceRankChanged | void | |
| SetDefaultValueFromTemplate | void |
GetCanChangePartChoices
No description yet.
bool GetCanChangePartChoices();
Returns: bool
GetItemNamingScheme
No description yet.
string GetItemNamingScheme();
Returns: string
PartChoiceRankChanged
No description yet.
void PartChoiceRankChanged(IPartChoiceData argPartChoiceData, int argOldValue, int argNewValue);
void PartChoiceRankChanged(object argPartChoiceData, int argOldValue, int argNewValue);
| Parameter | Type | Passing |
|---|---|---|
argPartChoiceData | IPartChoiceData | value |
argOldValue | int | value |
argNewValue | int | value |
Returns: nothing (void)
The first overload is an extension method of IComponentDefinitionHelper (using ComponentLib;) with typed parameters; the second is declared by the interface.
SetDefaultValueFromTemplate
No description yet.
void SetDefaultValueFromTemplate();
Returns: nothing (void)
Inherited members
- From IAbstractItem: ComponentTypes, FindParameterByName, GetID, ModelChoices, Parameters, ParentGroup, SetId, StateIndex
- From IGloballyIdentifiedObject: GUID
Returned by
IComponentDefinitionList.Get, IComponentLibraryDocument.CreateComponentDefinition, IComponentLibraryManager.CreateComponentDefinition, IComponentPinMappingEditor.GetComponent