IRequiredModel interface
No description yet.
public interface IRequiredModel : IAbstractObject
Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces
Inherits: IAbstractObject
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| DefaultModelLink | IModelLink | get; set | |
| FromTemplate | bool | get; set | |
| IsReadOnly | bool | get; set | |
| IsRequired | bool | get; set | |
| ModelKind | string | get; set |
DefaultModelLink
No description yet.
IModelLink GetDefaultModelLink();
void SetDefaultModelLink(IModelLink argValue);
Type: IModelLink · Access: read/write
The accessors are extension methods of IRequiredModelHelper (using ComponentLib;).
FromTemplate
No description yet.
bool GetFromTemplate();
void SetFromTemplate(bool argValue);
Type: bool · Access: read/write
IsReadOnly
No description yet.
bool GetIsReadOnly();
void SetIsReadOnly(bool argValue);
Type: bool · Access: read/write
IsRequired
No description yet.
bool GetIsRequired();
void SetIsRequired(bool argValue);
Type: bool · Access: read/write
ModelKind
No description yet.
string GetModelKind();
void SetModelKind(string argValue);
Type: string · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| GetID | string | |
| GetIsSystemModel | bool | |
| SetId | void |
GetID
No description yet.
string GetID();
Returns: string
GetIsSystemModel
No description yet.
bool GetIsSystemModel();
Returns: bool
SetId
No description yet.
void SetId(string argValue);
| Parameter | Type | Passing |
|---|---|---|
argValue | string | value |
Returns: nothing (void)
Returned by
IComponentLibraryDocument.CreateRequiredModel, IComponentLibraryManager.CreateRequiredModel, IModelChoice.RequiredModel, IRequiredModelList.AddForModelKind, IRequiredModelList.Find, IRequiredModelList.FindOrCreate, IRequiredModelList.Get