ISch_Component interface

The ISch_Component references the logical symbol as a component that can contain links to different model implementations such as PCB, Signal Integrity and Simulation models. Only one model of a particular model type (PCB footprint, SIM, SI, EDIF Macro and VHDL) can be enabled as the currently linked model, at any one time.

public interface ISch_Component : ISch_ParametrizedGroup

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_ParametrizedGroup

Derived: ISch_HarnessComponent

Remarks

Each schematic component has two system parameters - the Designator parameter and the Comment parameter. Custom parameters can be added anytime. The Comment parameter can be assigned an indirect name parameter. Once a name parameter (with a equal sign character as a prefix to the name parameter) is assigned to the Comment field of the Component properties dialog, the value for this parameter appears on the document, ensure that the Convert Special Strings option in the Schematic Preferences dialog is enabled.

The Unique ID (UID) is an system generated value that uniquely identifies this current component. It is used for linking to an associated PCB component on a PCB document. Enter a new UID value or click the Reset button to generate a new UID if you wish to force the Schematic component to be linked to a different PCB component. You will need to run the Component Links... dialog to update the linkage on the corresponding PCB document.

This SourceLibraryName property denotes the source library where the symbol and its associated model links are from. The * character in this field denotes the current library of the current project. Note a schematic component is a symbol with a defined designator placed on a schematic document.

The LibraryRef property is the name of the symbol. The symbol is from the library specified in the Library field below.

The SheetPartyFilename property, enter a sub design project file name to be linked to the current schematic component. An example of a sub design project is a programmable logic device project or a schematic sub-sheet.

Properties

Property	Type	Access	Description
AliasAsText	string	get; set
AliasAt	string	get; set	The indexed property returns an alias string.
AliasCount	int	get
ComponentDescription	string	get; set	The ComponentDescription property determines the description string for this component.
ComponentKind	TComponentKind	get; set	The ComponentKind property deteremines the component's type of TComponentKind type.
ConfigurationParameters	string	get
ConfiguratorName	string	get
CurrentPartID	int	get; set
DatabaseLibraryKeys	string	get
DatabaseLibraryName	string	get
DatabaseTableName	string	get; set
DesignatorLocked	bool	get; set
DesignItemId	string	get; set
DisplayFieldNames	bool	get; set
DisplayMode	byte	get; set	The GetState_DisplayMode method returns the TDisplayMode value for this component.
DisplayModeCount	int	get	The property can return up to 255 display modes for the same component.
DisplayModeCount_Check	int	set
FilePosition	int	set
IsMirrored	bool	get; set	The IsMirrored property determines whether the component is mirrored along the x-axis.
IsUserConfigurable	bool	get; set
ItemGUID	string	get; set
LibIdentifierKind	TLibIdentifierKind	get
LibraryIdentifier	string	get
LibraryPath	string	get; set
LibReference	string	get; set
Orientation	TRotationBy90	get; set	This property determines the orientation of the component on the schematic sheet in increments of 0,90,180 and 270 degrees only.
OrientationWithoutRotating	TRotationBy90	set
OverideColors	bool	get; set	The SetState_OverrideColors method sets the local colors for the component.
PartCountNoPart0	int	get; set	A component can consist of more than one part, for example a 74LS00 contains four parts.
PartIdLocked	bool	get; set
PinColor	int	get; set
PinsMoveable	bool	get; set
RevisionGUID	string	get; set
SchComment	ISch_Parameter	get	The Comment property determines the comment object associated with the component object.
SchDesignator	ISch_Designator	get
SelectedInLibrary	bool	get; set
SheetPartFileName	string	get; set
ShowHiddenFields	bool	get; set	The ShowHiddenFields property determines the visibility of the text fields associated with the component, such as its name.
ShowHiddenPins	bool	get; set	This property determines whether the hidden pins of a component can be hidden or not.
SourceLibraryName	string	get; set
SymbolItemGUID	string	get; set
SymbolReference	string	get; set
SymbolRevisionGUID	string	get; set
SymbolVaultGUID	string	get; set
TargetFileName	string	get; set
UseDBTableName	bool	get; set
UseLibraryName	bool	get; set
VariantOption	IVariantOption	get; set
VaultGUID	string	get; set

AliasAsText

No description yet.

string GetState_AliasAsText();
void SetState_AliasAsText(string argValue);

Type: string · Access: read/write

AliasAt

The indexed property returns an alias string. A component can have multiple aliases because a component name can be referred to by multiple names. For example a SN7432 is also SN74LS32 or SN74S32.

string GetState_AliasAt(int argI);
void SetState_AliasAt(int argI, string argValue);

Type: string · Access: read/write · Index: argI (int)

Use the AliasCount property to obtain the number of aliases before going through one by one.

AliasCount

No description yet.

int GetState_AliasCount();

Type: int · Access: read-only

Use the AliasCount to obtain the count before going through each indexed Alias property one by one.

ComponentDescription

The ComponentDescription property determines the description string for this component. Normally this string contains text on what this component is.

string GetState_ComponentDescription();
void SetState_ComponentDescription(string argValue);

Type: string · Access: read/write

Examples: Ciiva

ComponentKind

The ComponentKind property deteremines the component's type of TComponentKind type.

TComponentKind GetState_ComponentKind();
void SetState_ComponentKind(TComponentKind argValue);

Type: TComponentKind · Access: read/write

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

eComponentKind_Standard: These components possess standard electrical properties, are always synchronized and are the type most commonly used on a schematic sheet.

eComponentKind_Mechanical: These components do not have electrical properties and will appear in the BOM. They are synchronized if the same components exist on both the Schematic and PCB documents. An example is a heatsink.

eComponentKind_Graphical: These components are not used during synchronization or checked for electrical errors. These components are used, for example, when adding company logos to documents.

eComponentKind_NetTie_BOM: These components short two or more different nets and these components will appear in the BOM and are maintained during synchronization.

eComponentKind_NetTie_NoBOM: These components short two or more different nets and these components will NOT appear in the BOM and are maintained during synchronization.

eComponentKind_Standard_NoBOM: These components possess standard electrical properties, and are synchronized BUT are not included in any BOM file produced from the file.

ConfigurationParameters

No description yet.

string GetState_ConfigurationParameters();

Type: string · Access: read-only

ConfiguratorName

No description yet.

string GetState_ConfiguratorName();

Type: string · Access: read-only

CurrentPartID

No description yet.

int GetState_CurrentPartID();
void SetState_CurrentPartID(int argValue);

Type: int · Access: read/write

Examples: Extension_CreateSchComponent

DatabaseLibraryKeys

No description yet.

string GetState_DatabaseLibraryKeys(string argDelimiter);

Type: string · Access: read-only · Index: argDelimiter (string)

DatabaseLibraryName

No description yet.

string GetState_DatabaseLibraryName();

Type: string · Access: read-only

DatabaseTableName

No description yet.

string GetState_DatabaseTableName();
void SetState_DatabaseTableName(string argValue);

Type: string · Access: read/write

DesignatorLocked

No description yet.

bool GetState_DesignatorLocked();
void SetState_DesignatorLocked(bool argValue);

Type: bool · Access: read/write

DesignItemId

No description yet.

string GetState_DesignItemId();
void SetState_DesignItemId(string argValue);

Type: string · Access: read/write

Examples: Ciiva

DisplayFieldNames

No description yet.

bool GetState_DisplayFieldNames();
void SetState_DisplayFieldNames(bool argValue);

Type: bool · Access: read/write

DisplayMode

The GetState_DisplayMode method returns the TDisplayMode value for this component. This TDisplayMode is a byte type from RT_Workspace unit.

byte GetState_DisplayMode();
void SetState_DisplayMode(byte argValue);

Type: byte · Access: read/write

Examples: Extension_CreateSchComponent

DisplayModeCount

The property can return up to 255 display modes for the same component. Modes are added or edited in the Schematic Library Editor.

int GetState_DisplayModeCount();

Type: int · Access: read-only

DisplayModeCount_Check

No description yet.

void SetState_DisplayModeCount_Check(int argValue);

Type: int · Access: write-only

FilePosition

No description yet.

void SetState_FilePosition(int argValue);

Type: int · Access: write-only

IsMirrored

The IsMirrored property determines whether the component is mirrored along the x-axis.

bool GetState_IsMirrored();
void SetState_IsMirrored(bool argValue);

Type: bool · Access: read/write

IsUserConfigurable

No description yet.

bool GetState_IsUserConfigurable();
void SetState_IsUserConfigurable(bool argValue);

Type: bool · Access: read/write

ItemGUID

No description yet.

string GetState_ItemGUID();
void SetState_ItemGUID(string argValue);

Type: string · Access: read/write

Examples: Ciiva

LibIdentifierKind

No description yet.

TLibIdentifierKind GetState_LibIdentifierKind();

Type: TLibIdentifierKind · Access: read-only

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

LibraryIdentifier

No description yet.

string GetState_LibraryIdentifier();

Type: string · Access: read-only

Examples: Ciiva

LibraryPath

No description yet.

string GetState_LibraryPath();
void SetState_LibraryPath(string argValue);

Type: string · Access: read/write

LibReference

No description yet.

string GetState_LibReference();
void SetState_LibReference(string argValue);

Type: string · Access: read/write

Examples: Ciiva

Orientation

This property determines the orientation of the component on the schematic sheet in increments of 0,90,180 and 270 degrees only.

TRotationBy90 GetState_Orientation();
void SetState_Orientation(TRotationBy90 argValue);

Type: TRotationBy90 · Access: read/write

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

See also: TRotationBy90

OrientationWithoutRotating

No description yet.

void SetState_OrientationWithoutRotating(TRotationBy90 argValue);

Type: TRotationBy90 · Access: write-only

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

OverideColors

The SetState_OverrideColors method sets the local colors for the component. This component's fill, line and pin colors are overridden with the colors from the Fill, Lines and Pins color boxes respectively.

bool GetState_OverideColors();
void SetState_OverideColors(bool argValue);

Type: bool · Access: read/write

PartCountNoPart0

A component can consist of more than one part, for example a 74LS00 contains four parts.

int GetState_PartCountNoPart0();
void SetState_PartCountNoPart0(int argValue);

Type: int · Access: read/write

Each component also includes a non-graphical part, Part Zero. Part Zero is used for pins that are to be included in all parts of a multi-part component, for example power pins.

PartIdLocked

No description yet.

bool GetState_PartIdLocked();
void SetState_PartIdLocked(bool argValue);

Type: bool · Access: read/write

PinColor

No description yet.

int GetState_PinColor();
void SetState_PinColor(int argValue);

Type: int · Access: read/write

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

PinsMoveable

No description yet.

bool GetState_PinsMoveable();
void SetState_PinsMoveable(bool argValue);

Type: bool · Access: read/write

RevisionGUID

No description yet.

string GetState_RevisionGUID();
void SetState_RevisionGUID(string argValue);

Type: string · Access: read/write

Examples: Ciiva

SchComment

The Comment property determines the comment object associated with the component object. The Component Properties dialog for this component has a Comment field. The Parameter object has a Name and Value fields and this Name field will normally have 'Comment' string and a Value string.

ISch_Parameter GetState_SchComment();

Type: ISch_Parameter · Access: read-only

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

See also: ISch_Parameter

Examples: Ciiva

SchDesignator

No description yet.

ISch_Designator GetState_SchDesignator();

Type: ISch_Designator · Access: read-only

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

Examples: Ciiva

SelectedInLibrary

No description yet.

bool GetState_SelectedInLibrary();
void SetState_SelectedInLibrary(bool argValue);

Type: bool · Access: read/write

SheetPartFileName

No description yet.

string GetState_SheetPartFileName();
void SetState_SheetPartFileName(string argValue);

Type: string · Access: read/write

ShowHiddenFields

The ShowHiddenFields property determines the visibility of the text fields associated with the component, such as its name. If the Value is true, the hidden fields of the component will be displayed on the schematic sheet. If the value is false, the hidden text fields are not shown on the schematic.

bool GetState_ShowHiddenFields();
void SetState_ShowHiddenFields(bool argValue);

Type: bool · Access: read/write

ShowHiddenPins

This property determines whether the hidden pins of a component can be hidden or not. Power pins are often defined as hidden.

bool GetState_ShowHiddenPins();
void SetState_ShowHiddenPins(bool argValue);

Type: bool · Access: read/write

SourceLibraryName

No description yet.

string GetState_SourceLibraryName();
void SetState_SourceLibraryName(string argValue);

Type: string · Access: read/write

Examples: Ciiva

SymbolItemGUID

No description yet.

string GetState_SymbolItemGUID();
void SetState_SymbolItemGUID(string argValue);

Type: string · Access: read/write

SymbolReference

No description yet.

string GetState_SymbolReference();
void SetState_SymbolReference(string argValue);

Type: string · Access: read/write

SymbolRevisionGUID

No description yet.

string GetState_SymbolRevisionGUID();
void SetState_SymbolRevisionGUID(string argValue);

Type: string · Access: read/write

SymbolVaultGUID

No description yet.

string GetState_SymbolVaultGUID();
void SetState_SymbolVaultGUID(string argValue);

Type: string · Access: read/write

TargetFileName

No description yet.

string GetState_TargetFileName();
void SetState_TargetFileName(string argValue);

Type: string · Access: read/write

UseDBTableName

No description yet.

bool GetState_UseDBTableName();
void SetState_UseDBTableName(bool argValue);

Type: bool · Access: read/write

UseLibraryName

No description yet.

bool GetState_UseLibraryName();
void SetState_UseLibraryName(bool argValue);

Type: bool · Access: read/write

VariantOption

No description yet.

IVariantOption GetState_VariantOption();
void SetState_VariantOption(IVariantOption argValue);

Type: IVariantOption · Access: read/write

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

VaultGUID

No description yet.

string GetState_VaultGUID();
void SetState_VaultGUID(string argValue);

Type: string · Access: read/write

Examples: Ciiva

Methods

Method	Returns	Description
AddDisplayMode	void	The AddDisplayMode method adds a graphical representation (mode) for the current component.
AddPart	void
AddSchImplementation	ISch_Implementation	Each schematic component can have models from one or more domains.
AddSchParameter	ISch_Parameter
Alias_Add	void
Alias_Clear	void
Alias_Delete	void
Alias_Remove	void
DeleteDisplayMode	void	This DeleteDisplayMode removes a display mode (graphical representation) from the component.
DeletePart	void
FullPartDesignator	string
GetGraphicalHash	string
HasConfiguredPinMapping	bool
InLibrary	bool
InSheet	bool
IsIntegratedComponent	bool
IsMultiPartComponent	bool
OffsetParameters_Default	void
RemoveSchImplementation	void
SaveToFile	void
SuggestedSearchKeywords	string
UpdatePart_PostProcess	void
UpdatePart_PreProcess	void
UpdatePrimitivesAccessibility	void
ValidateImplementationsCurrentState	void

AddDisplayMode

The AddDisplayMode method adds a graphical representation (mode) for the current component. Up to 255 alternative modes can be created.

void AddDisplayMode();

Returns: nothing (void)

AddPart

No description yet.

void AddPart();

Returns: nothing (void)

AddSchImplementation

Each schematic component can have models from one or more domains. A schematic component can also have multiple models per domain, one of which will be the current model for that domain.

ISch_Implementation AddSchImplementation();

Returns: ISch_Implementation

Extension method of ISch_ComponentHelper (using SCH;).

A model represents all the information needed for a component in a given domain, while a datafile entity (or link) is the only information which is in an external file.

The models of a component are represented by the ISch_Implementation interface.

The mapping of pins of a component and the nodes/ports/pads of a model are represented by the ISch_MapDefiner interfaces.

The link between a model and its external data file links are represented by the ISch_DataFileLink interfaces.

See also: ISch_Implementation, ISch_MapDefiner

AddSchParameter

No description yet.

ISch_Parameter AddSchParameter();

Returns: ISch_Parameter

Extension method of ISch_ComponentHelper (using SCH;).

Alias_Add

No description yet.

void Alias_Add(string argS);

Parameter	Type	Passing
argS	string	value

Returns: nothing (void)

Alias_Clear

No description yet.

void Alias_Clear();

Returns: nothing (void)

Alias_Delete

No description yet.

void Alias_Delete(int argI);

Parameter	Type	Passing
argI	int	value

Returns: nothing (void)

Alias_Remove

No description yet.

void Alias_Remove(string argS);

Parameter	Type	Passing
argS	string	value

Returns: nothing (void)

DeleteDisplayMode

This DeleteDisplayMode removes a display mode (graphical representation) from the component.

void DeleteDisplayMode(byte argMode);

Parameter	Type	Passing
argMode	byte	value

Returns: nothing (void)

DeletePart

No description yet.

void DeletePart(int argPartId);

Parameter	Type	Passing
argPartId	int	value

Returns: nothing (void)

FullPartDesignator

No description yet.

string FullPartDesignator(int argPartId);

Parameter	Type	Passing
argPartId	int	value

Returns: string

GetGraphicalHash

No description yet.

string GetGraphicalHash();

Returns: string

HasConfiguredPinMapping

No description yet.

bool HasConfiguredPinMapping();

Returns: bool

InLibrary

No description yet.

bool InLibrary();

Returns: bool

InSheet

No description yet.

bool InSheet();

Returns: bool

IsIntegratedComponent

No description yet.

bool IsIntegratedComponent();

Returns: bool

IsMultiPartComponent

No description yet.

bool IsMultiPartComponent();

Returns: bool

OffsetParameters_Default

No description yet.

void OffsetParameters_Default();

Returns: nothing (void)

RemoveSchImplementation

No description yet.

void RemoveSchImplementation(ISch_Implementation argnImplementation);
void RemoveSchImplementation(object argnImplementation);

Parameter	Type	Passing
argnImplementation	ISch_Implementation	value

Returns: nothing (void)

The first overload is an extension method of ISch_ComponentHelper (using SCH;) with typed parameters; the second is declared by the interface.

SaveToFile

No description yet.

void SaveToFile(string argVFSAddress);

Parameter	Type	Passing
argVFSAddress	string	value

Returns: nothing (void)

SuggestedSearchKeywords

No description yet.

string SuggestedSearchKeywords();

Returns: string

UpdatePart_PostProcess

No description yet.

void UpdatePart_PostProcess();

Returns: nothing (void)

UpdatePart_PreProcess

No description yet.

void UpdatePart_PreProcess();

Returns: nothing (void)

UpdatePrimitivesAccessibility

No description yet.

void UpdatePrimitivesAccessibility();

Returns: nothing (void)

ValidateImplementationsCurrentState

No description yet.

void ValidateImplementationsCurrentState();

Returns: nothing (void)

Inherited members

• From ISch_ParametrizedGroup: Import_FromUser_Parameters, ResetAllSchParametersPosition
• From ISch_GraphicalObject: AddErrorString, AreaColor, BoundingRectangle, BoundingRectangle_Full, Color, CompilationMasked, Dimmed, Disabled, DisplayError, EnableDraw, ErrorColor, ErrorKind, ErrorString, GetHash, GraphicallyInvalidate, LiveHighlightValue, Location, Mirror, MoveByXY, MoveToXY, OwnerPartDisplayMode, OwnerPartId, ResetErrorFields, RotateBy90, Selection, SetState_xSizeySize
• From ISch_BasicContainer: AddAndPositionSchObject, AddSchObject, CopyTo, DeleteAll, DescriptionString, ExportToParameters, FreeAllContainedObjects, Handle, IdentifierString, Import_FromUser, ObjectId, OwnerSchDocument, RemoveSchObject, Replicate, SchBasicContainer, SchIterator_Create, SchIterator_Destroy, SchParameterByName, Setstate_Default, Text, UniqueId, WiringDiagramOriginUniqueId

Returned by

ISch_Lib.Current_SchComponent, ISch_Lib.SchComponentByLibRef, ISch_Pin.OwnerSchComponent, ISch_ServerInterface.LoadComponent, ISch_ServerInterface.LoadComponentFromDatabaseLibrary, ISch_ServerInterface.LoadComponentFromLibrary

Accepted by

IEmbeddedMemoryManager.ConfigureComponent, IEmbeddedMemoryManager.ConfigureEmbeddedProject, IEmbeddedMemoryManager.UpdateComponentBuses, IComponentConfigurator.ConfigureComponent, IComponentConfigurator.ConfigureComponentParametrically, IComponentConfigurator.GenerateReport, IComponentConfigurator.GetConfigurationValues, IComponentConfigurator.GetParameters, IComponentConfigurator.IsChildCoreUsed, IComponentConfigurator.SetConfigurationParametersToDefault, IComponentConfigurator.UpdateSymbol, IComponentPainterView.SetComponentByHandle, IModelEditor.DrawModel_FromSchImpl, IModelEditor.EditModel, IModelEditor.EditModelMap, IModelEditor.SetDefaultModelState, IModelEditor3.EditModel_ReadOnly, IModelEditor4.InitModel, IOpenBusComponentConfigurator.AutoUpdateConfiguration, IPartSearchManager.EditSupplierLinks, ISch_CustomConnector.SetCustomMode, ISch_Lib.AddSchComponent, ISch_Lib.RemoveSchComponent, ISch_ServerInterface.PaintLoadedComponentThumbnail, ISimModelMetafilePainter.SetSimImpl, ISupplierManager.CreateSupplierLinksFrame, ISupplierManager.EditSupplierLinks

Examples

Used in the SDK examples: Ciiva, Extension_CreateSchComponent, Extension_RemoveSchLibComponent.