Eplan Platform API
Eplan.EplApi.DataModel.EObjects Namespace / PlugStrip Class

In This Topic
    PlugStrip Class Properties
    In This Topic

    For a list of all members of this type, see PlugStrip members.

    Public Properties
     NameDescription
    Public PropertyReturns 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)
    Public PropertyDetermines if connection point data are saved locally at the part placement. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyThe value determines if target is taken from net-based routing or not. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertySets the ArticleReference at the reference position of the ArticleReference. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns Eplan.EplApi.DataModel.ArticleReferences that are referenced by Function. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns Eplan.EplApi.DataModel.Articles that are referenced by Function, and only those that are stored in project database. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns 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)
    Public PropertyThe property gives the search direction of the full device tag, when the visible device tag name is empty. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns 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)
    Public PropertyCheck if the Function can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyArray of connection points data. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns Eplan.EplApi.DataModel.Connections that have the Functions as a start function or end function. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns contact image assign to this function or null. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyGets or sets a value indicating where contact image is displayed for this function. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns 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)
    Public PropertyReturns 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)
    Public PropertySets 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)
    Public PropertyOverridden. Returns the category of a Function.  
    Public PropertyReturns the Eplan.EplApi.DataModel.FunctionDefinition of the Function. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyIf 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)
    Public PropertyAn array of the symbols's connection points (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyAn 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)
    Public PropertyReturns 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)
    Public PropertyDetermines 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)
    Public PropertyReturns true if the symbol's logical area is a polyline (consisting of segments) rather than just a rectangle. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyGets/Sets, if the function separates potentials. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns identifying name of the Function. (Inherited from Eplan.EplApi.DataModel.FunctionBase)
    Public PropertyReturns true if this is a Function object that covers a function template in a device. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertySet or checks if device of this function is fixed. (Inherited from Eplan.EplApi.DataModel.Function)
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets a flag which indicates a main function of the device. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns true if the list of name's properties is empty (Inherited from Eplan.EplApi.DataModel.FunctionBase)
    Public PropertyReturns, if the function is netconnecting. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets/Sets visibility of the object as set in its properties dialog. (Inherited from Eplan.EplApi.DataModel.Placement)
    Public PropertyReturns true if this is a transient Function object repesenting an uncovered function template of a device. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyDetermines whether changes made on this template will be stored after UpdateLocalTemplate is called. (Inherited from Eplan.EplApi.DataModel.Function)
    Public Property

    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)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGet or set the placement's location. (Inherited from Eplan.EplApi.DataModel.FunctionBase)
    Public PropertyGets/Sets an array of segments that the symbol's logical area may consist of. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyGets custom placement type. Placement type express how function will be shown on schema. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns the name of the FunctionBase. (Inherited from Eplan.EplApi.DataModel.FunctionBase)
    Public PropertyName of the Function. (Inherited from Eplan.EplApi.DataModel.FunctionBase)
    Public PropertyReturns 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)
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns 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)
    Public PropertyGets 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)
    Public PropertyGets/Sets an array of the function's connection points. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyEplan.EplApi.DataModel.Planning.PlanningSegment assigned to this function. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertyReturns all Plug objects of the plug strip.  
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to P8 properties of the PlugStrip object.  
    Public PropertyReturns Eplan.EplApi.DataModel.Graphics.PropertyPlacements assigned to the SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyReturns Eplan.EplApi.DataModel.SymbolReference.PropertyPlacementsSchemas assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyReturns 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)
    Public PropertySpecifies Eplan.EplApi.DataModel.MasterData.SymbolVariant assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.Function)
    Public PropertySet configuration type to select different variants for point or destination wiring (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturn true if the instance uses the local property instances, otherwise it uses the ones of the variant. (Inherited from Eplan.EplApi.DataModel.SymbolReference)
    Public PropertyReturns the visible name of the FunctionBase. (Inherited from Eplan.EplApi.DataModel.FunctionBase)
    Public PropertyReturns visible name of the Function. (Inherited from Eplan.EplApi.DataModel.FunctionBase)
    Public PropertyCheck if object is currently write protected or sets Manual write protection (Inherited from Eplan.EplApi.DataModel.Function)
    Top
    See Also