ISch_Pin interface
Pins are special objects that have electrical characteristics and are used to direct signals in and out of components. Pins connect directly to other pins, wires, net labels, sheet entries or ports.
public interface ISch_Pin : ISch_ParametrizedGroup
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_ParametrizedGroup
Derived: ISch_HarnessPin
Properties
DefaultValue
No description yet.
string GetState_DefaultValue();
void SetState_DefaultValue(string argValue);
Type: string · Access: read/write
Description
No description yet.
string GetState_Description();
void SetState_Description(string argValue);
Type: string · Access: read/write
Designator
No description yet.
string GetState_Designator();
void SetState_Designator(string argValue);
Type: string · Access: read/write
Examples: Ciiva
Designator_CustomColor
No description yet.
int GetState_Designator_CustomColor();
void SetState_Designator_CustomColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Designator_CustomFontID
No description yet.
int GetState_Designator_CustomFontID();
void SetState_Designator_CustomFontID(int argValue);
Type: int · Access: read/write
Designator_CustomPosition_Margin
No description yet.
int GetState_Designator_CustomPosition_Margin();
void SetState_Designator_CustomPosition_Margin(int argValue);
Type: int · Access: read/write
Designator_CustomPosition_RotationAnchor
No description yet.
TPinTextRotationAnchor GetState_Designator_CustomPosition_RotationAnchor();
void SetState_Designator_CustomPosition_RotationAnchor(TPinTextRotationAnchor argValue);
Type: TPinTextRotationAnchor · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Designator_CustomPosition_RotationRelative
No description yet.
TRotationBy90 GetState_Designator_CustomPosition_RotationRelative();
void SetState_Designator_CustomPosition_RotationRelative(TRotationBy90 argValue);
Type: TRotationBy90 · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Designator_FontMode
No description yet.
TPinItemMode GetState_Designator_FontMode();
void SetState_Designator_FontMode(TPinItemMode argValue);
Type: TPinItemMode · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Designator_PositionMode
No description yet.
TPinItemMode GetState_Designator_PositionMode();
void SetState_Designator_PositionMode(TPinItemMode argValue);
Type: TPinItemMode · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Electrical
No description yet.
TPinElectrical GetState_Electrical();
void SetState_Electrical(TPinElectrical argValue);
Type: TPinElectrical · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
FormalType
No description yet.
TStdLogicState GetState_FormalType();
void SetState_FormalType(TStdLogicState argValue);
Type: TStdLogicState · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
HiddenNetName
No description yet.
string GetState_HiddenNetName();
void SetState_HiddenNetName(string argValue);
Type: string · Access: read/write
IsHidden
No description yet.
bool GetState_IsHidden();
void SetState_IsHidden(bool argValue);
Type: bool · Access: read/write
Name
The Name property determines the name for the Pin object.
string GetState_Name();
void SetState_Name(string argValue);
Type: string · Access: read/write
Name_CustomColor
No description yet.
int GetState_Name_CustomColor();
void SetState_Name_CustomColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Name_CustomFontID
No description yet.
int GetState_Name_CustomFontID();
void SetState_Name_CustomFontID(int argValue);
Type: int · Access: read/write
Name_CustomPosition_Margin
No description yet.
int GetState_Name_CustomPosition_Margin();
void SetState_Name_CustomPosition_Margin(int argValue);
Type: int · Access: read/write
Name_CustomPosition_RotationAnchor
No description yet.
TPinTextRotationAnchor GetState_Name_CustomPosition_RotationAnchor();
void SetState_Name_CustomPosition_RotationAnchor(TPinTextRotationAnchor argValue);
Type: TPinTextRotationAnchor · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Name_CustomPosition_RotationRelative
No description yet.
TRotationBy90 GetState_Name_CustomPosition_RotationRelative();
void SetState_Name_CustomPosition_RotationRelative(TRotationBy90 argValue);
Type: TRotationBy90 · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Name_FontMode
No description yet.
TPinItemMode GetState_Name_FontMode();
void SetState_Name_FontMode(TPinItemMode argValue);
Type: TPinItemMode · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Name_PositionMode
No description yet.
TPinItemMode GetState_Name_PositionMode();
void SetState_Name_PositionMode(TPinItemMode argValue);
Type: TPinItemMode · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Orientation
No description yet.
TRotationBy90 GetState_Orientation();
void SetState_Orientation(TRotationBy90 argValue);
Type: TRotationBy90 · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
PinLength
No description yet.
int GetState_PinLength();
void SetState_PinLength(int argValue);
Type: int · Access: read/write
ShowDesignator
No description yet.
bool GetState_ShowDesignator();
void SetState_ShowDesignator(bool argValue);
Type: bool · Access: read/write
ShowName
No description yet.
bool GetState_ShowName();
void SetState_ShowName(bool argValue);
Type: bool · Access: read/write
SwapIdPair
No description yet.
string GetState_SwapIdPair();
void SetState_SwapIdPair(string argValue);
Type: string · Access: read/write
SwapIdPart
No description yet.
string GetState_SwapIdPart();
void SetState_SwapIdPart(string argValue);
Type: string · Access: read/write
SwapIdPartPin
No description yet.
string GetState_SwapIdPartPin();
void SetState_SwapIdPartPin(string argValue);
Type: string · Access: read/write
SwapIdPin
No description yet.
string GetState_SwapIdPin();
void SetState_SwapIdPin(string argValue);
Type: string · Access: read/write
Symbol_Inner
No description yet.
TIeeeSymbol GetState_Symbol_Inner();
void SetState_Symbol_Inner(TIeeeSymbol argValue);
Type: TIeeeSymbol · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Symbol_InnerEdge
No description yet.
TIeeeSymbol GetState_Symbol_InnerEdge();
void SetState_Symbol_InnerEdge(TIeeeSymbol argValue);
Type: TIeeeSymbol · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Symbol_LineWidth
No description yet.
TSize GetState_Symbol_LineWidth();
void SetState_Symbol_LineWidth(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Symbol_Outer
No description yet.
TIeeeSymbol GetState_Symbol_Outer();
void SetState_Symbol_Outer(TIeeeSymbol argValue);
Type: TIeeeSymbol · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Symbol_OuterEdge
No description yet.
TIeeeSymbol GetState_Symbol_OuterEdge();
void SetState_Symbol_OuterEdge(TIeeeSymbol argValue);
Type: TIeeeSymbol · Access: read/write
The accessors are extension methods of ISch_PinHelper (using SCH;).
Width
No description yet.
int GetState_Width();
void SetState_Width(int argValue);
Type: int · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| FullDesignator | string | |
| OwnerSchComponent | ISch_Component | |
| SetState_FunctionsFromName | void |
FullDesignator
No description yet.
string FullDesignator();
Returns: string
OwnerSchComponent
No description yet.
ISch_Component OwnerSchComponent();
Returns: ISch_Component
Extension method of ISch_PinHelper (using SCH;).
SetState_FunctionsFromName
No description yet.
void SetState_FunctionsFromName();
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
Examples
Used in the SDK examples: Ciiva, Extension_CreateSchComponent.