Component Object

This object represents a component placed on a schematic.

The following table lists methods and properties of the Component object with links to the respective reference pages:

Table 1. Component Object Methods and Properties

Method or Property

Description

AddAttribute Method (Component Object)Adds an attribute to the component at the coordinates passed.
AddBatchAttributes Method (Component Object)Adds multiple attributes to the component as an encoded string.
AddBatchOats Method (Component Object)Adds multiple instance values (formerly known as OATs) to the component as an encoded string.
AddLabel Method (Component Object)Adds a label to the component at the coordinates passed.
AddOat Method (Component Object)Sets the instance value (formerly referred to as an OAT) for a component attribute.
FindAttribute Method (Component Object)Searches all component attributes for one matching Name.
GetBatchAttributes Method (Component Object)Returns all attributes on the component as an encoded string.
GetBatchOats Method (Component Object)Returns all instance values (OATs) on the component as an encoded string.
GetBboxPoint Method (Component Object)Returns the coordinates of a specified corner of a bounding box.
GetConnections Method (Component Object)Returns a collection of Connection Objects associated with component.
GetForwardPCB Method (Component Object)Indicates whether the component should be forward annotated to the PCB.
GetLocation Method (Component Object)Returns the location coordinates (X,Y) for the component.
GetName Method (Component Object)Returns the hierarchical path to the component.
SetLocation Method (Component Object)Specifies the location for the component.
Application Property (Component Object)Returns the Application Object.
Attributes Property (Component Object)Returns a collection of Attribute Objects representing the attributes attached to this component.
Id Property (Component Object)Returns a unique identifying integer for this component.
Label Property (Component Object)Returns a label object.
Orientation Property (Component Object)Returns or sets the component orientation (rotation).
Parent Property (Component Object)Returns the parent Block Object of the component.
Refdes Property (Component Object)Returns or sets the PCB reference designator for the component.
Scale Property (Component Object)Returns or sets the scale factor of the component.
Selected Property (Component Object)Sets the selection status of the component.
SymbolBlock Property (Component Object)Returns the symbol which represents the component instance.
Type Property (Component Object)Returns the type for the component.
UID Property (Component Object)Returns the unique identifying string (UID) of this component.