Eplan Platform API
Eplan.EplApi.DataModel Namespace / MacroBoxPropertyList Class
Members Example

In This Topic
    MacroBoxPropertyList Class
    In This Topic
    This class represents collection of properties of MacroBox class. Please check also base classes for other properties which are available for MacroBox objects: SymbolReferencePropertyList, PlacementPropertyList, StorableObjectPropertyList
    Inheritance Hierarchy
    Syntax
    [DefaultMember("Property")]
    public class MacroBoxPropertyList : SymbolReferencePropertyList 
    [DefaultMember("Property")]
    public ref class MacroBoxPropertyList : public SymbolReferencePropertyList 
    Remarks
    It uses operator[] in order to access its elements (stored properties).

    Property list is a container for property values and just like them can be online or offline. If property list is online it means that is associated with properties of some StorableObject or other property list. In this case if any property is added, changed or removed from property list the result is also visible in related objects. Whether property list is online or offline is being determine in time of it's creation and can not be changed.

    Example
    Example shows usage of online an offline property list:
    //creation of online property list
    FunctionPropertyList oPropertyListOnline1 = oFunction.Properties;
    oPropertyListOnline1.FUNC_COMMENT = "Comment";
    //now oFunction.Properties.FUNC_COMMENT is equal "Comment"
    
    FunctionPropertyList oPropertyLineOnline2 = new FunctionPropertyList(oFunction);
    oPropertyLineOnline2.FUNC_COMMENT = "Test";
    //now oFunction.Properties.FUNC_COMMENT is equal "Test"
    
    //creation of offline property list
    FunctionPropertyList oPropertyLineOffline = new FunctionPropertyList();
    oPropertyLineOffline.FUNC_COMMENT = "Test comment";
    oFunction.Properties.FUNC_COMMENT = oPropertyLineOffline.FUNC_COMMENT;
    oPropertyLineOffline.FUNC_COMMENT = "Offline comment";
    //now oPropertyLineOffline.FUNC_COMMENT is equal "Test comment"
    
    
    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyReturns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyReturns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyOverloaded. Symbol description (function) # 20114. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol name # 20112. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol number # 20168. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol variant # 20113. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol library # 20111. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Symbol # 20575. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Property arrangement # 19307. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Placement # 19007. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name (full) # 19023. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name # 19022. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page type # 19020. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Column number # 19005. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Row number # 19006. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Modification date (change tracking) # 19032. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (change tracking) # 19030. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker format (change tracking) # 19031. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Modification time (change tracking) # 19034. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Creator (change tracking) # 19033. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision change marker (from property comparison) # 10153. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (from property comparison) # 10152. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Representation type / report type # 19021. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. User-defined property arrangement: Name # 19008. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. X coordinate # 19002. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Y coordinate # 19003. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyMacro: Directory # 23015.  
    Public PropertyMacro: Inserted by # 23006.  
    Public PropertyMacro: Also insert macro box # 23013.  
    Public PropertyMacro: File name # 23001.  
    Public PropertyMacro: Description # 23004.  
    Public PropertyMacro: Source / reference # 23003.  
    Public PropertyMacro: Version # 23002.  
    Public PropertyMacro: Name # 23009.  
    Public PropertyMacro: Representation type # 23007.  
    Public PropertyMacro: Source project # 23005.  
    Public PropertyMacro: Type of usage # 23011.  
    Public PropertyMacro: Take connection point designations into account # 23014.  
    Public PropertyMacro: Protected group # 23012.  
    Public PropertyMacro: Variant # 23008.  
    Public PropertyMacro: Description # 11014.  
    Public PropertyMacro: Name # 11008.  
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyHeight # 20222.  
    Public PropertyX coordinate starting point # 19340.  
    Public PropertyY coordinate starting point # 19341.  
    Public PropertyWidth # 20221.  
    Public PropertyOverloaded. Change protection (hierarchical) # 3015. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDestructor for deterministic finalization of MacroBoxPropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodOverloaded. Checks property existence for used obiect.  
    Public MethodInternal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Top
    See Also