ISch_HarnessConnector interface
The ISch_HarnessConnector interface is used to represent a harness connector design obejct which is a member of the harness system.
public interface ISch_HarnessConnector : ISch_RectangularGroup
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_ParametrizedGroup → ISch_RectangularGroup
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| LineWidth | TSize | get; set | The LineWidth property defines the line width of the harness connector which is based on one of the TSize values. |
| MasterEntryLocation | Point | get | The MasterEntryLocation property defines the location of the master entry of the harness connector. |
| SchHarnessConnectorType | ISch_HarnessConnectorType | get | The HarnessConnectorType property defines the harness connector type of the harness connector and returns the ISch_HarnessConnectorType interface. |
LineWidth
The LineWidth property defines the line width of the harness connector which is based on one of the TSize values. .
TSize GetState_LineWidth();
void SetState_LineWidth(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_HarnessConnectorHelper (using SCH;).
See also: TSize, ISch_HarnessEntry
MasterEntryLocation
The MasterEntryLocation property defines the location of the master entry of the harness connector. The master entry represents the tip of the harness connector and the position of the tip is determined from the top side of the connector..
Point GetState_MasterEntryLocation();
Type: Point · Access: read-only
The accessors are extension methods of ISch_HarnessConnectorHelper (using SCH;).
See also: ISch_HarnessConnectorType, ISch_HarnessEntry, TSize
SchHarnessConnectorType
The HarnessConnectorType property defines the harness connector type of the harness connector and returns the ISch_HarnessConnectorType interface. The default connector type is 'Harness'.
ISch_HarnessConnectorType GetState_SchHarnessConnectorType();
Type: ISch_HarnessConnectorType · Access: read-only
The accessors are extension methods of ISch_HarnessConnectorHelper (using SCH;).
Example: Read the type text of a harness connector.
using SCH;
// harnessConn is a harness connector design object,
// here the first one found on the current schematic sheet.
ISch_Document schDoc = SCH.GlobalVars.SchServer?.GetCurrentSchDocument();
if (schDoc == null)
return;
ISch_Iterator iterator = schDoc.SchIterator_Create();
iterator.AddFilter_ObjectSet(new SCH.TObjectSet { TObjectId.eHarnessConnector });
var harnessConn = iterator.FirstSchObject() as ISch_HarnessConnector;
schDoc.SchIterator_Destroy(ref iterator);
if (harnessConn == null)
return;
ISch_HarnessConnectorType connType = harnessConn.GetState_SchHarnessConnectorType();
// The Text string for this harness connector.
string s = connType.GetState_Text();
See also: ISch_HarnessConnectorType, ISch_HarnessEntry, TSize
Inherited members
- From ISch_RectangularGroup: XSize, YSize
- 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