Skip to main content
View as Markdown

IRequiredParameter interface

No description yet.

public interface IRequiredParameter : IAbstractObject

Namespace: ComponentLib · Assembly: Altium.SDK.Interfaces

Inherits: IAbstractObject

Properties​

PropertyTypeAccessDescription
DefaultValuestringget; set
DefinitionGUIDstringget; set
DefinitionTypestringget; set
FromTemplateboolget; set
IsReadOnlyboolget; set
IsRequiredboolget; set
ParameterNamestringget; set
ParameterTypestringget; set
ParameterUnitstringget; set
Visibleboolget; set

DefaultValue​

No description yet.

string GetDefaultValue();
void SetDefaultValue(string argValue);

Type: string · Access: read/write

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

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

ParameterName​

No description yet.

string GetParameterName();
void SetParameterName(string argValue);

Type: string · Access: read/write

ParameterType​

No description yet.

string GetParameterType();
void SetParameterType(string argValue);

Type: string · Access: read/write

ParameterUnit​

No description yet.

string GetParameterUnit();
void SetParameterUnit(string argValue);

Type: string · Access: read/write

Visible​

No description yet.

bool GetVisible();
void SetVisible(bool argValue);

Type: bool · Access: read/write

Methods​

MethodReturnsDescription
IsSystemParameterbool

IsSystemParameter​

No description yet.

bool IsSystemParameter();

Returns: bool

Returned by​

IComponentLibraryDocument.CreateRequiredParameter, IComponentLibraryManager.CreateRequiredParameter, IParameter.RequiredParameter, IRequiredParameterList.Find, IRequiredParameterList.FindOrCreate, IRequiredParameterList.Get

Accepted by​

IRequiredParameterList.Add