| Name | Description | |
|---|---|---|
 | Plug Constructor | Constructor |
The following tables list the members exposed by Plug.
| Name | Description | |
|---|---|---|
| Plug Constructor | Constructor |
| Name | Description | |
|---|---|---|
 | AllSubFunctions | Returns an array of all sub-functions of the given main function. Sub-functions are all functions having the same identifying device tag (property 20005) which are not main (a.k.a. auxiliary functions). (Inherited from Eplan.EplApi.DataModel.Function) |
| AreConnectionPointPositionsLocal | Determines if connection point data are saved locally at the part placement. (Inherited from Eplan.EplApi.DataModel.Function) |
| AreTargetsSpecifed | The value determines if target is taken from net-based routing or not. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| ArticleReference | Sets the ArticleReference at the reference position of the ArticleReference. (Inherited from Eplan.EplApi.DataModel.Function) |
| ArticleReferences | Returns Eplan.EplApi.DataModel.ArticleReferences that are referenced by Function. (Inherited from Eplan.EplApi.DataModel.Function) |
| Articles | Returns Eplan.EplApi.DataModel.Articles that are referenced by Function, and only those that are stored in project database. (Inherited from Eplan.EplApi.DataModel.Function) |
| Block | Returns a block which this SymbolReference object is part of. If this object is not a part of any block, this property returns NULL. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| BmkSearchDirection | The property gives the search direction of the full device tag, when the visible device tag name is empty. (Inherited from Eplan.EplApi.DataModel.Function) |
| CanGiveConnDesignationsToOtherFunctions | Returns flag, if this function can give connection designations to other functions (is meant for the Device-Tag-Editor, where sometimes there can be edited more connection designations than the actual function has) (Inherited from Eplan.EplApi.DataModel.Function) |
| CanHaveArticleData | Check if the Function can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.Function) |
| Category | Overridden. Returns the Eplan.EplApi.DataModel.Function.Category of the Function. |
| ConnectionPointPositions | Array of connection points data. (Inherited from Eplan.EplApi.DataModel.Function) |
| Connections | Returns Eplan.EplApi.DataModel.Connections that have the Functions as a start function or end function. (Inherited from Eplan.EplApi.DataModel.Function) |
| ContactImage | Returns contact image assign to this function or null. (Inherited from Eplan.EplApi.DataModel.Function) |
| ContactImageType | Gets or sets a value indicating where contact image is displayed for this function. (Inherited from Eplan.EplApi.DataModel.Function) |
| CrossReferencedObjectsAll | Returns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| DatabaseIdentifier | Returns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| DrawingOrder | Sets display sequence. The drawing order flag will be used to sort elements according to drawing order within a group. If elements chare the same value the drawing order will result from order of the data model. Default value is 67. (Inherited from Eplan.EplApi.DataModel.Placement) |
| FunctionDefinition | Returns the Eplan.EplApi.DataModel.FunctionDefinition of the Function. (Inherited from Eplan.EplApi.DataModel.Function) |
| FunctionTemplates | If this object is the main function of a device or a cable, this property returns an array of transient object (of Connection or Function type) that represent function templates contained by the device or the cable. (Inherited from Eplan.EplApi.DataModel.Function) |
| GraphicalConnectionPoints | An array of the symbols's connection points (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| GraphicalConnections | An array of Eplan.EplApi.DataModel.SymbolReference.GraphicalConnection objects representing all auto-connecting lines connected to the pins of the symbol. This property may be useful to check graphical layout of connections associated with the symbol (including T-nodes, corners, etc.). (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| Group | Returns a group that the Placement object belongs to. If the Placement object doesn't belong to any group, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Placement) |
| HasDefaultGraphicalTerminalsToConnectionPointsMapping | Determines if connection points to graphical terminals mapping is the default mapping, according to the symbol. Please refer to the line "Symbol connection point" in dialog "Connection point logic" in GUI. This property returns ... true, if all Symbol connection points are mapped to the respective connection point of the Function. false, if the mapping on the Function was changed in regard to the Symbol. (Inherited from Eplan.EplApi.DataModel.Function) |
| HasPolylineAsLogicalArea | Returns true if the symbol's logical area is a polyline (consisting of segments) rather than just a rectangle. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| HasPotentialSeparated | Gets/Sets, if the function separates potentials. (Inherited from Eplan.EplApi.DataModel.Function) |
| IdentifyingNameParts | Returns identifying name of the Function. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| IsCoveredTemplate | Returns true if this is a Function object that covers a function template in a device. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsFixedDevice | Set or checks if device of this function is fixed. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsLocked | Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsMainFunction | Gets/Sets a flag which indicates a main function of the device. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsNameEmpty | Returns true if the list of name's properties is empty (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| IsNetConnecting | Returns, if the function is netconnecting. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsPlaced | Returns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement) |
| IsReadOnly | Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsSetAsVisible | Gets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement) |
| IsTemplate | Returns true if this is a transient Function object repesenting an uncovered function template of a device. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsTemplateReadOnly | Determines whether changes made on this template will be stored after UpdateLocalTemplate is called. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsTransient | Determines if the the StorableObject is transient. The StorableObject is transient when it was created by default constructor and: it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project, it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsValid | Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Location | Get or set the placement's location. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| LogicalAreaSegments | Gets/Sets an array of segments that the symbol's logical area may consist of. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| ManualPlacementType | Gets custom placement type. Placement type express how function will be shown on schema. (Inherited from Eplan.EplApi.DataModel.Function) |
| Name | Returns the name of the FunctionBase. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| NameParts | Name of the Function. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| NestedFunctions | Returns an array of nested functions of the given main function. Nested-functions property returns functions whose identifying device tag contains the device tag of the parent + nested part of device tag. (Inherited from Eplan.EplApi.DataModel.Function) |
| ObjectIdentifier | Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Page | Returns the page the Placement is on, or assigns a Page object to the placement. If the placement was previously assigned to another page, it is removed from old one and assigned to the page given as an argument. (Inherited from Eplan.EplApi.DataModel.Placement) |
| ParentFunction | Gets parent function (a main function having the same identifying name or, in case of sub-terminals, the main terminal of a multi-level terminal). For main functions it returns NULL. (Inherited from Eplan.EplApi.DataModel.Function) |
| Pins | Gets/Sets an array of the function's connection points. (Inherited from Eplan.EplApi.DataModel.Function) |
| PlanningSegment | Eplan.EplApi.DataModel.Planning.PlanningSegment assigned to this function. (Inherited from Eplan.EplApi.DataModel.Function) |
| PLC | Returns PLC object related to PLC. |
| PlugStrip | Returns PlugStrip the Plug belongs to. |
| Project | Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Properties | .NET Property enabling access to P8 properties of the Plug object. |
| PropertyPlacements | Returns Eplan.EplApi.DataModel.Graphics.PropertyPlacements assigned to the SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| PropertyPlacementsSchemas | Returns Eplan.EplApi.DataModel.SymbolReference.PropertyPlacementsSchemas assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| SubFunctions | Returns an array of sub-functions of the given main function. Sub-functions are all functions having the same identifying device tag (property 20005) which are not main (a.k.a. auxiliary functions). (Inherited from Eplan.EplApi.DataModel.Function) |
| SymbolVariant | Specifies Eplan.EplApi.DataModel.MasterData.SymbolVariant assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.Function) |
| SymbolWiringType | Set configuration type to select different variants for point or destination wiring (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| TypeIdentifier | Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| UseLocalPropertyPlacements | Return true if the instance uses the local property instances, otherwise it uses the ones of the variant. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| VisibleName | Returns the visible name of the FunctionBase. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| VisibleNameParts | Returns visible name of the Function. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| WriteProtected | Check if object is currently write protected or sets Manual write protection (Inherited from Eplan.EplApi.DataModel.Function) |
| Name | Description | |
|---|---|---|
 | AddArticleReference | Overloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the Function. (Inherited from Eplan.EplApi.DataModel.Function) |
| AddConnectionPointPosition | Creates new connection point position. (Inherited from Eplan.EplApi.DataModel.Function) |
| Assign | Assigns this function to another, which means that values of this function's properties are copied to the target object and the function itself is removed from the project. (Inherited from Eplan.EplApi.DataModel.Function) |
| ConvertToGraphics | Converts the symbol representing this object into a group of graphical placements. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| CopyTo | Overloaded. Copy Placement and insert the Copy into destination group. Copied placement will be inserted into desired project of destination group. If this placement is temporary, the copy will be persistent, if the destination group is also persistent. Group or Page, where the placement will be inserted. Defines whether a layer should be matched by name. (Inherited from Eplan.EplApi.DataModel.Placement) |
| Create | Overloaded. Creates a Plug object related to a PlugStrip given as a parameter. The created plug will get its symbol and function definition from the Eplan.EplApi.DataModel.MasterData.SymbolVariant parameter. |
| CreateTransient | Creates a Function. It is not placed on any Eplan.EplApi.DataModel.Page. Its category is taken from Eplan.EplApi.DataModel.MasterData.SymbolVariant. (Inherited from Eplan.EplApi.DataModel.Function) |
| Dispose() | Destructor (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Equals | Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetBoundingBox | Placement bounding box. Bounding box is a rectangle which contain this placement. It can be also used to determine placement size. (Inherited from Eplan.EplApi.DataModel.Placement) |
| GetGraphics | Gets graphical representation of the Function. (Inherited from Eplan.EplApi.DataModel.Function) |
| GetHashCode | Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetLogicalArea | Returns a rectangle which is the logical area of the object derived from SymbolReference. For objects having symbols consisting of segments, this method returns the bounding box of the polyline created by those segments. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| GetNamePropertyIdsWithSeparators | Gets name prototype properties id with separators. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| GetNamePrototype | Sets properties which are used for building name of object. (Inherited from Eplan.EplApi.DataModel.FunctionBase) |
| GetPropertyPlacements | Gets list of property placements of given type. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetWriteProtectionFlagSet | Checks if a specific write protection kind was set. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsDeviceLocked | Determines if the the Device (which can refer to several objects, such as all function's representations) is locked. The LockDevice is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.Function) |
| IsPointInsideLogicalArea | Checks, if the point is inside logical area of the symbol. Returns true, if the symbol has a logical area and the point is inside. The logical area may be a rectangle or a polyline without arcs. (Inherited from Eplan.EplApi.DataModel.Function) |
| LockDevice | Tries to lock current device (which can refer to several objects, such as all function's representations) in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. If locked device in placed, corresponding page(s) will be locked as well. (Inherited from Eplan.EplApi.DataModel.Function) |
| LockObject | Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| MakePersistent | Instantiates the function represented by this object. Primarily used for instantiating an uncovered function template. (Inherited from Eplan.EplApi.DataModel.Function) |
| PauseWriteProtection | Temporarily disables write protection. Note that current write protection (Inherited from Eplan.EplApi.DataModel.Function) |
| PlaceAt | Places the function onto the given page, in the given location and with the symbol specified by the placementType and the pSymbolVariant parameters. (Inherited from Eplan.EplApi.DataModel.Function) |
| PlaceFunctionalMacro | Places a macro assigned to this function together with a special symbol configured in settings. The symbol placed has 'Functional' representation type and the macro is converted to graphics after insertion. If no macro is assigned to the function in its article data (ARTICLE_GROUPSYMBOLMACRO property), the macro specified by the third parameter ('strMacroFileName') will be inserted. (Inherited from Eplan.EplApi.DataModel.Function) |
| Remove | Removes placement. (Inherited from Eplan.EplApi.DataModel.Placement) |
| RemoveArticleReference | Removes the ArticleReference from the Function (Inherited from Eplan.EplApi.DataModel.Function) |
| RemoveConnectionPointPosition | Removes connection point data stored under given index. (Inherited from Eplan.EplApi.DataModel.Function) |
| RemoveFromPage | Removes placement from the page. Object becomes not-placed. (Inherited from Eplan.EplApi.DataModel.Function) |
| ReorderPropertyPlacements | Reorders property placements of one type, which are assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| ResetGraphicalTerminalsToConnectionPointsMapping | Resets connection points to graphical terminals mapping. (Inherited from Eplan.EplApi.DataModel.Function) |
| Scale | Overloaded. Scales the placement (or group of placements) by the specified factors in X and Y axis with scaling origin point specified by the ptOrigin parameter X axis factor. E.g. value of 2 makes the width two times bigger.Y axis factor. E.g. value of 0.5 makes the height two times smaller.Scaling origin point. (Inherited from Eplan.EplApi.DataModel.Placement) |
| SetLogicalArea | Sets rectangular logical area for objects derived from SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| SetPlanningSegment | Assigns Eplan.EplApi.DataModel.Planning.PlanningSegment to this function. (Inherited from Eplan.EplApi.DataModel.Function) |
| SetSymbolVariant | Sets symbol variant for Function. (Inherited from Eplan.EplApi.DataModel.Function) |
| SmartLock | Tries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| StoreConnectionPointPosition | Stores data from connection point position in function under given index. (Inherited from Eplan.EplApi.DataModel.Function) |
| SwitchLocalPropertyPlacements | Copies or removes all local ProperyPlacemnets and sets flag (Inherited from Eplan.EplApi.DataModel.SymbolReference) |
| ToStringIdentifier | Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| UpdateLocalTemplate | Stores changes into object from which template has been taken. (Inherited from Eplan.EplApi.DataModel.Function) |