Skip to main content
View as Markdown

IComponentTemplateParameter interface

No description yet.

public interface IComponentTemplateParameter : IAbstractObject

Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces

Inherits: IAbstractObject

Properties​

PropertyTypeAccessDescription
DataTypestringget; set
DefaultValueIComponentTemplateParameterValueget; set
DefinitionGUIDstringget; set
DefinitionTypestringget; set
Descriptionstringget; set
IsHiddenboolget; set
IsReadOnlyboolget; set
IsRequiredboolget; set
Namestringget; set
ParamTypestringget; set

DataType​

No description yet.

string GetDataType();
void SetDataType(string argValue);

Type: string · Access: read/write

DefaultValue​

No description yet.

IComponentTemplateParameterValue GetDefaultValue();
void SetDefaultValue(IComponentTemplateParameterValue argValue);

Type: IComponentTemplateParameterValue · Access: read/write

The accessors are extension methods of IComponentTemplateParameterHelper (using ComponentLib;).

DefinitionGUID​

No description yet.

string GetDefinitionGUID();
void SetDefinitionGUID(string argValue);

Type: string · Access: read/write

DefinitionType​

No description yet.

string GetDefinitionType();
void SetDefinitionType(string argValue);

Type: string · Access: read/write

Description​

No description yet.

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

Type: string · Access: read/write

IsHidden​

No description yet.

bool GetIsHidden();
void SetIsHidden(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

Name​

No description yet.

string GetName();
void SetName(string argValue);

Type: string · Access: read/write

ParamType​

No description yet.

string GetParamType();
void SetParamType(string argValue);

Type: string · Access: read/write

Returned by​

IComponentLibraryManager.CreateTemplateParameter, IComponentTemplateParameterList.Get

Accepted by​

IComponentTemplateParameterList.Add, IComponentTemplateParameterList.Contains, IComponentTemplateParameterList.Remove