Skip to main content
View as Markdown

ISch_HarnessEntry interface

The ISch_HarnessEntry interface is used to represent a harness entry which is a member of the harness system. Harness Entries are the graphical definition of a Signal Harness member. They are placed within a Harness Connector and they are the connection point through which actual nets, buses and Signal Harnesses are combined to form a higher level Signal Harness. Harness Entries along with Harness Connectors, Signal Harnesses and Harness Definition Files make up a complete Signal Harness.

public interface ISch_HarnessEntry : ISch_GraphicalObject

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: ISch_BasicContainer → ISch_GraphicalObject

Properties​

PropertyTypeAccessDescription
DistanceFromTopintget; setThe DistanceFromTop property defines the location of the harness entry in respect to the associated harness connector.
Namestringget; setThe Name property defines the name of the harness entry.
OverrideDisplayStringstringget; setThe OverrideDisplayString property defines the OverRideDisplayString property.
SchOwnerHarnessConnectorISch_HarnessConnectorgetThe OwnerHarnessConnector property retrieves the HarnessConnector interface this harness entry is associated with.
SideTLeftRightSideget; setThe Side property defines the orientation of the harness entry in respect to the associated harness connector.
TextColorintget; setThe TextColor property defines the color (a value of TColor type) for the Harness Entry's Name string.

DistanceFromTop​

The DistanceFromTop property defines the location of the harness entry in respect to the associated harness connector.

int GetState_DistanceFromTop();
void SetState_DistanceFromTop(int argValue);

Type: int · Access: read/write

Name​

The Name property defines the name of the harness entry. Normally the name property is a number but can be alphanumeric...

string GetState_Name();
void SetState_Name(string argValue);

Type: string · Access: read/write

OverrideDisplayString​

The OverrideDisplayString property defines the OverRideDisplayString property.

string GetState_OverrideDisplayString();
void SetState_OverrideDisplayString(string argValue);

Type: string · Access: read/write

SchOwnerHarnessConnector​

The OwnerHarnessConnector property retrieves the HarnessConnector interface this harness entry is associated with.

ISch_HarnessConnector GetState_SchOwnerHarnessConnector();

Type: ISch_HarnessConnector · Access: read-only

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

Side​

The Side property defines the orientation of the harness entry in respect to the associated harness connector.

TLeftRightSide GetState_Side();
void SetState_Side(TLeftRightSide argValue);

Type: TLeftRightSide · Access: read/write

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

See also: TLeftRightSide

TextColor​

The TextColor property defines the color (a value of TColor type) for the Harness Entry's Name string.

int GetState_TextColor();
void SetState_TextColor(int argValue);

Type: int · Access: read/write

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

The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)).

Methods​

MethodReturnsDescription
IsVerticalboolThe IsVertical property defines the orientation of the harness entry in respect to the harness connector.

IsVertical​

The IsVertical property defines the orientation of the harness entry in respect to the harness connector.

bool IsVertical();

Returns: bool

Inherited members​