| Name | Description | |
|---|---|---|
 | AddArticleReference | Overloaded. Adds a new ArticleReference to the Function. |
| AddConnectionPointPosition | Creates new connection point position. |
| 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. |
| 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. This method has been deprecated. Function definition may be invalid after using this method. Creates a Function object placed on a Page given as the first parameter and having a Category given as the second parameter. |
| CreateTransient | Overloaded. Creates a Function. It is not placed on any Page. Its category is taken from Eplan.EplApi.DataModel.MasterData.SymbolVariant. |
| Dispose() | Destructor for deterministic finalization of Function object. (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. |
| 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. |
| 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. |
| IsPointInsideLogicalArea | Overridden. Tells if the point is inside Functions logical area. |
| 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. |
| 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. |
| PauseWriteProtection | Temporarily disables write protection. Note that current write protection |
| Place | Places the function onto the given page, in the given location |
| PlaceAt | Places the function onto the given page, in the given location and with the symbol specified by the placementType and the pSymbolVariant parameters. |
| 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. |
| Remove | Removes placement. (Inherited from Eplan.EplApi.DataModel.Placement) |
| RemoveArticleReference | Removes the ArticleReference from the Function |
| RemoveConnectionPointPosition | Removes connection point data stored under given index. |
| RemoveFromPage | Removes placement from the page. Object becomes not-placed. |
| 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. |
| 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. |
| SetSymbolVariant | Sets symbol variant for Function. |
| SmartLock | Tries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; 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. |
| 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. |