DocumentBasePropertyList Class

In This Topic

This class represents collection of properties of DocumentBase class. Please check also base classes for other properties which are available for DocumentBase objects: PlacementPropertyList, StorableObjectPropertyList

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.PlacementPropertyList
            Eplan.EplApi.DataModel.GroupPropertyList
               Eplan.EplApi.DataModel.DocumentBasePropertyList
                  Eplan.EplApi.DataModel.MasterData.PlotFramePropertyList
                  Eplan.EplApi.DataModel.PagePropertyList

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class DocumentBasePropertyList : GroupPropertyList

[DefaultMember("Property")]
public ref class DocumentBasePropertyList : public GroupPropertyList

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
	DocumentBasePropertyList 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_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)
	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 by AnyPropertyId.
	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 DocumentBasePropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
	Exists	Overloaded. Checks property existence for used obiect. (Inherited from Eplan.EplApi.DataModel.PlacementPropertyList)
	getPropList	Internal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)

Top

Reference

DocumentBasePropertyList Members
Eplan.EplApi.DataModel Namespace
DocumentBase Class
GroupPropertyList Class

Send Feedback