In This Topic
Class for managing the Function names (device tags) on the specified Page
Inheritance Hierarchy
System.Object
Eplan.EplApi.HEServices.NameService
Syntax
public ref class NameService
Public Constructors
Public Properties
| | Name | Description |
|---|
 | AdjustmentOfDeviceTagSeparatorIsEnabled | Determines if adjustment of the visible device tag separator should be forced |
| Page | Gets/Sets the page. Page must be set, because most of the NameService class's methods work on page only (except for e.g. CorrectDeviceTagProperties, EvaluateAndSetAllNamesTXN methods). |
| RemovalOfUnnecessaryDeviceTagNamePartsIsEnabled | Determines if removal of unnecessary main and nested device tag in the visible name should be forced. The property is need to be set, if you have a function with a device tag in the visible name, you want to evaluate a new visible name and the device tag should be removed from the visible name if it matches the device tag of a surrounding device box or of a function laying in search direction (which normally is "left"). By default or if this parameter is set to false, the device tag is kept in the visible name even if it is not necessary. |
| RemovalOfUnnecessaryProjectStructuresIsEnabled | Determines if removal of unnecessary project structures in the visible device tag should be forced. This property is need to be set, if you have a function with a visible name that contains project structures, you want to evaluate a new visible name and the project structures should be removed from the visible name if they matches the project structures of a surrounding location box or the page. By default or if this parameter is set to false, the project structures are kept in the visible name even if they are not necessary. |
TopPublic Methods
| | Name | Description |
|---|
 | AdjustFullName | Overloaded. Sets the page and evaluates for a given functionbase the full name from the visible name of the functionbase and sets that evaluated value at the functionbase-object |
| AdjustVisibleName | Overloaded. Sets the page and evaluates for a given functionbase the visible name and visible name format from the fullname of the functionbase and sets these evaluated values at the functionbase-object |
| CanDeviceTagBeNested | Overloaded. Sets the page and returns, if the device tag of a given function can be nested |
| CorrectDeviceTagProperties | Do a correction on the namelist, if properties for main and nested devicetags are incorrect. In detail the nested devicetags are moved to the main devicetags if these have been empty. |
| Dispose | Destructor |
| EvaluateAndSetAllNames | Overloaded. Sets the page and evaluates the full name for all placed functions and interruption points on page by calling EvaluateName for all those objects. |
| EvaluateAndSetAllNamesTXN | Evaluate all names for all FunctionBase objects in the project by calling EvaluateName for all those objects. This methods does own transactions, so no transactions around the method are allowed. |
| EvaluateAndSetAllVisibleNames | Overloaded. Sets the page and evaluate the visible names from the full names for all placed functions and interruption points on page. |
| EvaluateName | Overloaded. Sets the page and evaluates the full name for a FunctionBase (which is either a Function or a Location box or an Interruption-point) by using the visible device tag of that FunctionBase and building the full name by graphical search on the page where the FunctionBase is placed. In the visible name missing project structures, which for example are supplemented from surrounding LocationBoxes or from the Page-Object itself. For an empty visible name the full name is taken from a function in search direction or from a surrounding device box. Nesting of device tags is made by using an surrounding device box, if nesting is enabled. The parameters used for evaluation are defined in the dialog with the project properties. |
| FindNameGivingFunction | Overloaded. Sets the page and finds the function, that would give hActual the function name, if hActual has no instance name parts (has no visible device tag). Returns NULL, if no such function exists or hActual don't take over a name. |
| FindNameGivingObject | Overloaded. Finds an object, that would give the f function its name, if f has no its instance name parts assigned (has no visible device tag). Returns NULL, if no such object exists or f don't take over a name. |
| GetSortedListOfLogicals | Overloaded. Sets the page and returns a sorted list of logicals (that is everything derived from functionbase). The logicals are sorted in that way, so that objects which are dependent on the name of other logicals are sorted behind them. |
| RenameDevice | Overloaded. Rename all functions of device. |
| SetFullNameAndAdjustVisibleName | Overloaded. Sets the page and sets the given full name as the new full name to the given function and adjusts the visible name of that function. Returns false, if a problem occured (if a visible name cannot be evaluated) - no changes to the function-object have been made then. |
| SetName | Sets a default device tag to the function. (I.e. a device tag which is automatically assigned when manually inserting a symbol on a page) |
| SetVisibleNameAndAdjustFullName | Overloaded. Sets the page and sets the given visible name as the new visible name to the given function and adjusts the full name of that function accordingly (by calling "EvaluateName"). |
| UpdateConnectionDefinitionPointsParent | Overloaded. Sets the page and updates the graphical parent of a connection definition point |
TopSee Also
