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)
	FUNC_SYMB_DESC	Overloaded. Symbol description (function) # 20114. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMB_NAME	Overloaded. Symbol name # 20112. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMB_NUMBER	Overloaded. Symbol number # 20168. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMB_VARIANT	Overloaded. Symbol variant # 20113. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMBLIB_NAME	Overloaded. Symbol library # 20111. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	FUNC_SYMBOL	Overloaded. Symbol # 20575. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_ACTIVE_PROPERTYSET	Overloaded. Property arrangement # 19307. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_FULLPLACEMENTLOCATION	Overloaded. Placement # 19007. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGEFULLNAME	Overloaded. Page name (full) # 19023. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGENAME	Overloaded. Page name # 19022. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PAGETYPE	Overloaded. Page type # 19020. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_PATHID	Overloaded. Column number # 19005. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_POSID	Overloaded. Row number # 19006. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_REVISION_LOG_DATE	Overloaded. Modification date (change tracking) # 19032. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_MARKER	Overloaded. Revision marker (change tracking) # 19030. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_MARKER_FORMAT	Overloaded. Revision marker format (change tracking) # 19031. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_TIME	Overloaded. Modification time (change tracking) # 19034. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISION_LOG_USER	Overloaded. Creator (change tracking) # 19033. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISIONID	Overloaded. Revision change marker (from property comparison) # 10153. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_REVISIONMARKER	Overloaded. Revision marker (from property comparison) # 10152. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	INSTANCE_TYPE	Overloaded. Representation type / report type # 19021. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_USER_DEFINED_PROPERTYSET	Overloaded. User-defined property arrangement: Name # 19008. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_XCOORD	Overloaded. X coordinate # 19002. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	INSTANCE_YCOORD	Overloaded. Y coordinate # 19003. (Inherited from Eplan.EplApi.DataModel.SymbolReferencePropertyList)
	MACROBOX_DIRECTORY	Macro: Directory # 23015.
	MACROBOX_INSERTED_BY	Macro: Inserted by # 23006.
	MACROBOX_INSERTMODE	Macro: Also insert macro box # 23013.
	MACROBOX_MACRO	Macro: File name # 23001.
	MACROBOX_MACRO_DESCRIPTION	Macro: Description # 23004.
	MACROBOX_MACRO_SOURCE	Macro: Source / reference # 23003.
	MACROBOX_MACRO_VERSION	Macro: Version # 23002.
	MACROBOX_NAME	Macro: Name # 23009.
	MACROBOX_REPRESENTATION_TYPE	Macro: Representation type # 23007.
	MACROBOX_SOURCEPROJECT	Macro: Source project # 23005.
	MACROBOX_USAGE	Macro: Type of usage # 23011.
	MACROBOX_USECONNECTIONPOINTDESIGNATION	Macro: Take connection point designations into account # 23014.
	MACROBOX_USEPROTECTEDGROUP	Macro: Protected group # 23012.
	MACROBOX_VARIANT	Macro: Variant # 23008.
	PAGE_MACRO_DESCRIPTION	Macro: Description # 11014.
	PAGE_MACRO_NAME	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. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
	RECTANGLE_HEIGHT	Height # 20222.
	RECTANGLE_START_X	X coordinate starting point # 19340.
	RECTANGLE_START_Y	Y coordinate starting point # 19341.
	RECTANGLE_WIDTH	Width # 20221.
	WRITEPROTECTED_AUTOMATIC	Overloaded. Change protection (hierarchical) # 3015. (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