BaseWdConnectableObject Class

In This Topic

Base connectable object occurrence in workdesk.

Object Model

Inheritance Hierarchy

Syntax

public abstract class BaseWdConnectableObject : EPLAN.Harness.API.Occurrences.BaseWdOccurrence, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.I3DOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IComplexEntityAddable, EPLAN.Harness.API.Occurrences.Interfaces.IConnectableObjectBase, EPLAN.Harness.API.Occurrences.Interfaces.IElectricalOptionsMember, EPLAN.Harness.API.Occurrences.Interfaces.IExportable3D, EPLAN.Harness.API.Occurrences.Interfaces.IGraphicalOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IOccurrence, EPLAN.Harness.API.Occurrences.Interfaces.IPatternable, EPLAN.Harness.API.Occurrences.Interfaces.IPinHost, EPLAN.Harness.API.Occurrences.Interfaces.IReplaceable<BaseLibConnectableObject>, EPLAN.Harness.API.Occurrences.Interfaces.IReplaceable<LibWireTerminal>, EPLAN.Harness.API.Occurrences.Interfaces.IRotateable, EPLAN.Harness.API.Occurrences.Interfaces.ITransformable, EPLAN.Harness.API.Occurrences.Interfaces.ITranslatable, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties, EPLAN.Harness.API.Occurrences.Interfaces.IWireHarnessAddable

Public Properties

	Name	Description
	Anchored	Switch on or switch off the anchor.
	CavityPlugRequired	Gets or sets the value of the 'Cavity plug required' property of this occurrence.
	CavitySealRequired	Gets or sets the value of the 'Cavity seal required' property of this occurrence.
	Children	Gets children occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	ElectricalOptions	Gets or sets the electrical options of this occurrence.
	Exportable3D	Determines if this part is to be exported or not when using EPLAN.Harness.API.Projects.Documents.Designer.Export3DFile.
	FixedExtraLength	Gets the fixed extra length of this occurrence.
	Gender	Gets the gender of this occurrence.
	GroupedPin	Gets grouped pin of this connectable object, if exists.
	ID	ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
	InBom	Gets or sets the value of the 'In bill of material' property of this occurrence.
	IsRapid	Is the part a rapid prototype? (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	IsValid	Tells you whether this object is valid or not. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	LibraryPart	Gets the related library part from which this occurrence was derived. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	MultipleSealRequired	Gets or sets the value of the 'Multiple seal' property of this occurrence.
	Name	Gets or sets the name of the occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	Parents	Gets parent occurrences of closest level in hierarchy of this occurrence. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	Pins	Get all pins (graphical and virtual), but without grouped pin.
	Position	Gets (or sets) the position of this occurrence.
	RefDes	Gets or sets the RefDes of this occurrence.
	Rotation	Gets (or sets) the rotation of this occurrence.
	Selectable	Gets or sets the value of 'Selectable' property of this occurrence.
	StrippingLength	Gets or sets the stripping length of this occurrence.
	UserDefinedProperties	Overridden. Gets or sets a list of user-defined properties of this occurrence.
	WireHarness	Gets or sets the wire harness in which this occurrence is included.
	WireHarnessSeparator	Gets or sets the value of the 'Wire harness separator' property of this occurrence.
	WireTerminalOnPinRequired	Gets or sets the value of the 'Wire terminal on pin required' property of this occurrence.
	WireTerminalRequired	Gets or sets the value of the 'Wire terminal required' property of this occurrence.

Top

Public Methods

	Name	Description
	Equals	Overloaded. Determines whether the specified object is equal to the current object. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	GetHashCode	Serves as the default hash function. (Inherited from EPLAN.Harness.API.Occurrences.BaseOccurrence)
	ToString	Returns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)

Top

Extension Methods

	Name	Description
	AddToComplexEntity	Add this occurrence to the complex entity.
	AddToWireHarness	Add this occurrence to the wire harness.
	RemoveFromComplexEntity	Remove this occurrence from complex entity.
	RemoveFromWireHarness	Remove this occurrence from any wire harness.

Top

Reference

BaseWdConnectableObject Members
EPLAN.Harness.API.Occurrences.Workdesk Namespace

Send Feedback