MacroEntryPropertyList Class

In This Topic

This class represents a collection of properties of MacroEntry class. Please also check the base classes for other properties that are available for MacroEntry objects: PlacementPropertyList, StorableObjectPropertyList

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.PlacementPropertyList
            Eplan.EplApi.DataModel.MacroEntryPropertyList

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class MacroEntryPropertyList : PlacementPropertyList

[DefaultMember("Property")]
public ref class MacroEntryPropertyList : public PlacementPropertyList

Remarks

It uses the [] operator in order to access its elements (stored properties).

Property list is a container for property values and just like them can be persistent (also called online) or transient (also called offline). If a property list is persistent, this means that it is associated with the properties of some StorableObject or other property list. If any property is added, changed or removed from the property list in this case, the result is also visible in the related objects. Whether a property list is persistent or transient is determined at the time of its creation and cannot be changed.

Example

This example shows the different usage of persistent property lists and transient property lists:

// Creation of a persistent property list
FunctionPropertyList oPersistentPropertyList1 = oFunction.Properties;
oPersistentPropertyList1.FUNC_COMMENT = "Comment";
// Now, oFunction.Properties.FUNC_COMMENT is equals "Comment"

FunctionPropertyList oPersistentPropertyList2 = new FunctionPropertyList(oFunction);
oPersistentPropertyList2.FUNC_COMMENT = "Test";
// Now, oFunction.Properties.FUNC_COMMENT equals "Test"

// Creation of a transient property list
FunctionPropertyList oTransientPropertyList = new FunctionPropertyList();
oTransientPropertyList.FUNC_COMMENT = "Test comment";
oFunction.Properties.FUNC_COMMENT = oTransientPropertyList.FUNC_COMMENT;
oTransientPropertyList.FUNC_COMMENT = "Transient comment";
// Now, oTransientPropertyList.FUNC_COMMENT equals "Test comment"

Public Constructors

	Name	Description
	MacroEntryPropertyList Constructor	Constructor

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_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)
	MACROBOX_COMPANYSTANDARD	Macro: Company standard # 23017.
	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_NORM	Macro: Standard # 23016.
	MACROBOX_REPRESENTATION_TYPE	Macro: Representation type # 23007.
	MACROBOX_SOURCEPROJECT	Macro: Source project # 23005.
	MACROBOX_TYPE	Macro: Type # 23010.
	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.
	MACROFILE_CHANGEDATE	Macro: Modification date # 23019.
	MACROFILE_EPLANVERSION	Macro: Eplan version # 23018.
	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)
	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 MacroEntryPropertyList 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

MacroEntryPropertyList Members
Eplan.EplApi.DataModel Namespace
MacroEntry Class
PlacementPropertyList Class

Use the Eplan Global Support Portal for feedback and support