Skip to main content
View as Markdown

IModel interface

No description yet.

public interface IModel

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties​

PropertyTypeAccessDescription
DataFileEntityCountintget
DataFileEntityLocationstringget
DataFileEntityNamestringget
ModelDescriptionstringget; set
ModelMapAsStringstringget; set
ModelNamestringget; set
ModelParameterIItemParameterget
ModelParameterCountintget
ModelParameterNamestringget
ModelParameterValuestringget
ModelParameterValueByNamestringget; set
OwnerILibraryComponentget
UseComponentLibraryboolget; set

DataFileEntityCount​

No description yet.

int Get_DataFileEntityCount();

Type: int · Access: read-only

DataFileEntityLocation​

No description yet.

string Get_DataFileEntityLocation(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

DataFileEntityName​

No description yet.

string Get_DataFileEntityName(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

ModelDescription​

No description yet.

string Get_ModelDescription();
void Set_ModelDescription(string argValue);

Type: string · Access: read/write

ModelMapAsString​

No description yet.

string Get_ModelMapAsString();
void Set_ModelMapAsString(string argValue);

Type: string · Access: read/write

ModelName​

No description yet.

string Get_ModelName();
void Set_ModelName(string argValue);

Type: string · Access: read/write

ModelParameter​

No description yet.

IItemParameter Get_ModelParameter(int argIndex);

Type: IItemParameter · Access: read-only · Index: argIndex (int)

The accessors are extension methods of IModelHelper (using SCH;).

ModelParameterCount​

No description yet.

int Get_ModelParameterCount();

Type: int · Access: read-only

ModelParameterName​

No description yet.

string Get_ModelParameterName(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

ModelParameterValue​

No description yet.

string Get_ModelParameterValue(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

ModelParameterValueByName​

No description yet.

string GetModelParameterValueByName(string argName);
void SetModelParameterValueByName(string argName, string argValue);

Type: string · Access: read/write · Index: argName (string)

Owner​

No description yet.

ILibraryComponent Get_Owner();

Type: ILibraryComponent · Access: read-only

The accessors are extension methods of IModelHelper (using SCH;).

UseComponentLibrary​

No description yet.

bool Get_UseComponentLibrary();
void Set_UseComponentLibrary(bool argValue);

Type: bool · Access: read/write

Methods​

MethodReturnsDescription
DeleteModelParametervoid
DeleteModelParameterByNamevoid
GetModelParameterByNameIItemParameter

DeleteModelParameter​

No description yet.

void DeleteModelParameter(int argIndex);
ParameterTypePassing
argIndexintvalue

Returns: nothing (void)

DeleteModelParameterByName​

No description yet.

void DeleteModelParameterByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: nothing (void)

GetModelParameterByName​

No description yet.

IItemParameter GetModelParameterByName(string argName);
ParameterTypePassing
argNamestringvalue

Returns: IItemParameter

Extension method of IModelHelper (using SCH;).

Returned by​

IIntegratedLibraryManager.GetModel

Accepted by​

IModelEditor.DrawModel_FromModel, IModelEditor.EditModel_1