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

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.PlacementPropertyList
            Eplan.EplApi.DataModel.SymbolReferencePropertyList
               Eplan.EplApi.DataModel.MacroBoxPropertyList

Syntax

C#
C++/CLI

[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

	Name	Description
	MacroBoxPropertyList Constructor	Overloaded.

Top

Public Properties

	Name	Description
	ExistingIds	Returns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	ExistingValues	Returns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	INSTANCE_ACTIVE_PROPERTYSET	Overloaded. Property arrangement # 19307. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_FULLPLACEMENTLOCATION	Overloaded. Placement # 19007. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGEFULLNAME	Overloaded. Page name (full) # 19023. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGENAME	Overloaded. Page name # 19022. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGETYPE	Overloaded. Page type # 19020. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PATHID	Overloaded. Column number # 19005. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_POSID	Overloaded. Row number # 19006. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_REVISION_LOG_DATE	Overloaded. Modification date (change tracking) # 19032. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_MARKER	Overloaded. Revision marker (change tracking) # 19030. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_MARKER_FORMAT	Overloaded. Revision marker format (change tracking) # 19031. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_TIME	Overloaded. Modification time (change tracking) # 19034. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_USER	Overloaded. Creator (change tracking) # 19033. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISIONID	Overloaded. Revision change marker (from property comparison) # 10153. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISIONMARKER	Overloaded. Revision marker (from property comparison) # 10152. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_TYPE	Overloaded. Representation type / report type # 19021. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_USER_DEFINED_PROPERTYSET	Overloaded. User-defined property arrangement: Name # 19008. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_XCOORD	Overloaded. X coordinate # 19002. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_YCOORD	Overloaded. Y coordinate # 19003. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	MACROBOX_INSERTED_BY	Overloaded. Macro: Inserted by # 23006. This property isn't indexed.
	MACROBOX_INSERTMODE	Overloaded. Macro: Also insert macro box # 23013. This property isn't indexed.
	MACROBOX_MACRO	Overloaded. Macro: File name # 23001. This property isn't indexed.
	MACROBOX_MACRO_DESCRIPTION	Overloaded. Macro: Description # 23004. This property isn't indexed.
	MACROBOX_MACRO_SOURCE	Overloaded. Macro: Source / reference # 23003. This property isn't indexed.
	MACROBOX_MACRO_VERSION	Overloaded. Macro: Version # 23002. This property isn't indexed.
	MACROBOX_NAME	Overloaded. Macro: Name # 23009. This property isn't indexed, and is read-only.
	MACROBOX_REPRESENTATION_TYPE	Overloaded. Macro: Representation type # 23007. This property isn't indexed.
	MACROBOX_SOURCEPROJECT	Overloaded. Macro: Source project # 23005. This property isn't indexed.
	MACROBOX_USAGE	Overloaded. Macro: Type of usage # 23011. This property isn't indexed.
	MACROBOX_USECONNECTIONPOINTDESIGNATION	Overloaded. Macro: Take connection point designations into account # 23014. This property isn't indexed.
	MACROBOX_USEPROTECTEDGROUP	Overloaded. Macro: Protected group # 23012. This property isn't indexed.
	MACROBOX_VARIANT	Overloaded. Macro: Variant # 23008. This property isn't indexed.
	PAGE_MACRO_DESCRIPTION	Overloaded. Macro: Description # 11014.
	PAGE_MACRO_NAME	Overloaded. Macro: Name # 11008.
	Parent	StorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	Property	Overloaded. Method used by operator[] in order to access indexed properties.
	PROPUSER_DBOBJECTID	Overloaded. Object identification # 2000. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
	RECTANGLE_HEIGHT	Overloaded. Height # 20222. This property isn't indexed.
	RECTANGLE_START_X	Overloaded. X coordinate starting point # 19340. This property isn't indexed.
	RECTANGLE_START_Y	Overloaded. Y coordinate starting point # 19341. This property isn't indexed.
	RECTANGLE_WIDTH	Overloaded. Width # 20221. This property isn't indexed.
	WRITEPROTECTED_AUTOMATIC	Overloaded. Change protection (hierarchical) # 3015. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)

Top

Public Methods

	Name	Description
	CopyTo	Overloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	Dispose()	Destructor for deterministic finalization of MacroBoxPropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	Exists	Overloaded. Checks property existence for used obiect.
	getPropList	Internal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)

Top

Reference

MacroBoxPropertyList Members
Eplan.EplApi.DataModel Namespace
MacroBox Class
SymbolReferencePropertyList Class

Send Feedback