ISch_HarnessWire interface

No description yet.

public interface ISch_HarnessWire : ISch_Wire

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Inherits: ISch_BasicContainer → ISch_GraphicalObject → ISch_Polygon → ISch_BasicPolyline → ISch_Wire

Properties

Property	Type	Access	Description
BorderColor	int	get; set
BorderColorName	string	get; set
ComponentKind	TComponentKind	get; set
ConnectedCablesUniqueIdsCount	int	get
ConnectedCableUniqueId	string	get
ConnectedInlineSplicesUniqueIdsCount	int	get
ConnectedInlineSpliceUniqueId	string	get
ConnectedShieldsUniqueIdsCount	int	get
ConnectedShieldUniqueId	string	get
ConnectedTwistsUniqueIdsCount	int	get
ConnectedTwistUniqueId	string	get
ConnectedWireLabelsUniqueIdsCount	int	get
ConnectedWireLabelUniqueId	string	get
DesignatorLocked	bool	get; set
EndVertex1ConnectedObjectUniqueId	string	get
EndVertex2ConnectedObjectUniqueId	string	get
IsConnectedToAnyCable	bool	get
IsConnectedToAnyInlineSplice	bool	get
IsConnectedToAnyShield	bool	get
IsConnectedToAnyTwist	bool	get
IsConnectedToAnyWireLabel	bool	get
IsEndVertex1ConnectedToAnyObject	bool	get
IsEndVertex2ConnectedToAnyObject	bool	get
IsHighlighted	bool	get
PrimaryColorName	string	get; set
SchComment	ISch_Parameter	get
SchDescription	ISch_Parameter	get
SchDesignator	ISch_Designator	get
SecondaryColor	int	get; set
SecondaryColorName	string	get; set
TertiaryColor	int	get; set
TertiaryColorName	string	get; set

BorderColor

No description yet.

int GetState_BorderColor();
void SetState_BorderColor(int argColor);

Type: int · Access: read/write

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

BorderColorName

No description yet.

string GetState_BorderColorName();
void SetState_BorderColorName(string argColorName);

Type: string · Access: read/write

ComponentKind

No description yet.

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

Type: TComponentKind · Access: read/write

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

ConnectedCablesUniqueIdsCount

No description yet.

int GetState_ConnectedCablesUniqueIdsCount();

Type: int · Access: read-only

ConnectedCableUniqueId

No description yet.

string GetState_ConnectedCableUniqueId(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

ConnectedInlineSplicesUniqueIdsCount

No description yet.

int GetState_ConnectedInlineSplicesUniqueIdsCount();

Type: int · Access: read-only

ConnectedInlineSpliceUniqueId

No description yet.

string GetState_ConnectedInlineSpliceUniqueId(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

ConnectedShieldsUniqueIdsCount

No description yet.

int GetState_ConnectedShieldsUniqueIdsCount();

Type: int · Access: read-only

ConnectedShieldUniqueId

No description yet.

string GetState_ConnectedShieldUniqueId(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

ConnectedTwistsUniqueIdsCount

No description yet.

int GetState_ConnectedTwistsUniqueIdsCount();

Type: int · Access: read-only

ConnectedTwistUniqueId

No description yet.

string GetState_ConnectedTwistUniqueId(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

ConnectedWireLabelsUniqueIdsCount

No description yet.

int GetState_ConnectedWireLabelsUniqueIdsCount();

Type: int · Access: read-only

ConnectedWireLabelUniqueId

No description yet.

string GetState_ConnectedWireLabelUniqueId(int argIndex);

Type: string · Access: read-only · Index: argIndex (int)

DesignatorLocked

No description yet.

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

Type: bool · Access: read/write

EndVertex1ConnectedObjectUniqueId

No description yet.

string GetState_EndVertex1ConnectedObjectUniqueId();

Type: string · Access: read-only

EndVertex2ConnectedObjectUniqueId

No description yet.

string GetState_EndVertex2ConnectedObjectUniqueId();

Type: string · Access: read-only

IsConnectedToAnyCable

No description yet.

bool GetState_IsConnectedToAnyCable();

Type: bool · Access: read-only

IsConnectedToAnyInlineSplice

No description yet.

bool GetState_IsConnectedToAnyInlineSplice();

Type: bool · Access: read-only

IsConnectedToAnyShield

No description yet.

bool GetState_IsConnectedToAnyShield();

Type: bool · Access: read-only

IsConnectedToAnyTwist

No description yet.

bool GetState_IsConnectedToAnyTwist();

Type: bool · Access: read-only

IsConnectedToAnyWireLabel

No description yet.

bool GetState_IsConnectedToAnyWireLabel();

Type: bool · Access: read-only

IsEndVertex1ConnectedToAnyObject

No description yet.

bool GetState_IsEndVertex1ConnectedToAnyObject();

Type: bool · Access: read-only

IsEndVertex2ConnectedToAnyObject

No description yet.

bool GetState_IsEndVertex2ConnectedToAnyObject();

Type: bool · Access: read-only

IsHighlighted

No description yet.

bool GetState_IsHighlighted();

Type: bool · Access: read-only

PrimaryColorName

No description yet.

string GetState_PrimaryColorName();
void SetState_PrimaryColorName(string argColorName);

Type: string · Access: read/write

SchComment

No description yet.

ISch_Parameter GetState_SchComment();

Type: ISch_Parameter · Access: read-only

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

SchDescription

No description yet.

ISch_Parameter GetState_SchDescription();

Type: ISch_Parameter · Access: read-only

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

SchDesignator

No description yet.

ISch_Designator GetState_SchDesignator();

Type: ISch_Designator · Access: read-only

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

SecondaryColor

No description yet.

int GetState_SecondaryColor();
void SetState_SecondaryColor(int argColor);

Type: int · Access: read/write

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

SecondaryColorName

No description yet.

string GetState_SecondaryColorName();
void SetState_SecondaryColorName(string argColorName);

Type: string · Access: read/write

TertiaryColor

No description yet.

int GetState_TertiaryColor();
void SetState_TertiaryColor(int argColor);

Type: int · Access: read/write

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

TertiaryColorName

No description yet.

string GetState_TertiaryColorName();
void SetState_TertiaryColorName(string argColorName);

Type: string · Access: read/write

Methods

Method	Returns	Description
RestoreProperties	void
SaveProperties	void

RestoreProperties

No description yet.

void RestoreProperties();

Returns: nothing (void)

SaveProperties

No description yet.

void SaveProperties();

Returns: nothing (void)

Inherited members

• From ISch_Wire: AutoWire, CompilationMaskedSegment, EditingEndPoint, OrderCrossOverArray, ResetCompilationMaskedSegments, UnderlineColor
• From ISch_BasicPolyline: LineStyle
• From ISch_Polygon: ClearAllVertices, InsertVertex, IsSolid, LineWidth, RemoveVertex, Transparent, Vertex, VerticesCount
• 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