API Help
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. Property arrangement # 19307. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Placement # 19007. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name (full) # 19023. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page name # 19022. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Page type # 19020. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Column number # 19005. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Row number # 19006. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Modification date (change tracking) # 19032. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (change tracking) # 19030. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker format (change tracking) # 19031. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Modification time (change tracking) # 19034. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Creator (change tracking) # 19033. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision change marker (from property comparison) # 10153. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Revision marker (from property comparison) # 10152. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
    Public PropertyOverloaded. Representation type / report type # 19021. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. User-defined property arrangement: Name # 19008. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. X coordinate # 19002. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Y coordinate # 19003. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
    Public PropertyOverloaded. Macro: Inserted by # 23006. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Also insert macro box # 23013. This property isn't indexed.  
    Public PropertyOverloaded. Macro: File name # 23001. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Description # 23004. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Source / reference # 23003. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Version # 23002. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Name # 23009. This property isn't indexed, and is read-only.  
    Public PropertyOverloaded. Macro: Representation type # 23007. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Source project # 23005. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Type of usage # 23011. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Take connection point designations into account # 23014. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Protected group # 23012. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Variant # 23008. This property isn't indexed.  
    Public PropertyOverloaded. Macro: Description # 11014.  
    Public PropertyOverloaded. Macro: 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. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertyOverloaded. Height # 20222. This property isn't indexed.  
    Public PropertyOverloaded. X coordinate starting point # 19340. This property isn't indexed.  
    Public PropertyOverloaded. Y coordinate starting point # 19341. This property isn't indexed.  
    Public PropertyOverloaded. Width # 20221. This property isn't indexed.  
    Public PropertyOverloaded. Change protection (hierarchical) # 3015. This property isn't indexed, and is read-only. (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