PlotFramePropertyList Class

In This Topic

Inheritance Hierarchy
Syntax
Remarks
Example
Public Constructors
Public Properties
Public Methods
See Also

This class represents collection of properties of PlotFrame class. Please check also base classes for other properties which are available for PlotFrame objects: Eplan.EplApi.DataModel.PlacementPropertyList, Eplan.EplApi.DataModel.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

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class PlotFramePropertyList : Eplan.EplApi.DataModel.DocumentBasePropertyList

[DefaultMember("Property")]
public ref class PlotFramePropertyList : public Eplan.EplApi.DataModel.DocumentBasePropertyList

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
	PlotFramePropertyList 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)
	FORM_BEHAVIOUR_PROPERTY_VAL_GRAPHIC	Overloaded. Assignment: Property / value to graphic # 13026.
	FRAME_ADD_PAGENAME	Overloaded. Add page names # 12030. This property isn't indexed.
	FRAME_AREA_X	Overloaded. Plot frame dimensions: X axis # 12033. This property isn't indexed.
	FRAME_AREA_Y	Overloaded. Plot frame dimensions: Y axis # 12034. This property isn't indexed.
	FRAME_ASYNCHRON_POS	Overloaded. Asynchronous rows # 12013. This property isn't indexed.
	FRAME_ASYNCHRON_ROWS	Overloaded. Asynchronous columns # 12012. This property isn't indexed.
	FRAME_AUTOX_OFFSET	Overloaded. Property arrangement: Automatic X coordinate (path) # 12063. This property isn't indexed.
	FRAME_AUTOY_OFFSET	Overloaded. Property arrangement: Automatic Y coordinate (path) # 12062. This property isn't indexed.
	FRAME_CONT_LADDER_DESCR	Overloaded. Continuous row / column designation # 12031. This property isn't indexed.
	FRAME_CONTACTIMAGE_OFFSET	Overloaded. Contact image margin (in path) # 12060. This property isn't indexed.
	FRAME_CONTACTIMAGE_POSTPONEMENT	Overloaded. Contact image offset # 12061. This property isn't indexed.
	FRAME_DEFAULT_ALPHASET	Overloaded. String for alphanumeric # 12032. This property isn't indexed.
	FRAME_DEVTAGSEARCHDIR_BOXESONLY	Overloaded. DT adoption: Only from boxes # 12105. This property isn't indexed.
	FRAME_DEVTAGSEARCHDIR_FOR_GOST	Overloaded. DT adoption: Search direction conforming to GOST standard # 12104. This property isn't indexed.
	FRAME_DXF_BLOCKNAME	Overloaded. DXF export: Name of block # 12050. This property isn't indexed.
	FRAME_DXF_INSERTXCOORD	Overloaded. DXF export: Insertion point (X) # 12051. This property isn't indexed.
	FRAME_DXF_INSERTYCOORD	Overloaded. DXF export: Insertion point (Y) # 12052. This property isn't indexed.
	FRAME_ERRORCOUNT	Overloaded. Number of messages # 12099. This property isn't indexed.
	FRAME_EVALUATION_AREA_START_POINT_X	Overloaded. Grid offset X # 12003. This property isn't indexed.
	FRAME_EVALUATION_AREA_START_POINT_Y	Overloaded. Grid offset Y # 12004. This property isn't indexed.
	FRAME_EVALUATION_DIRECTION	Overloaded. Reporting direction # 12103. This property isn't indexed.
	FRAME_FORMAT_OF_NUMBERING_POSITION	Overloaded. Row numbering format # 12009. This property isn't indexed.
	FRAME_FORMAT_OF_ROW_NUMBERS	Overloaded. Column numbering format # 12011. This property isn't indexed.
	FRAME_GRAPHICERROR	Overloaded. Error: Graphic # 12100.
	FRAME_IMPORTERROR	Overloaded. Error (import) # 12200.
	FRAME_MOTORSWITCH_OFFSET	Overloaded. Contact image margin (on component) # 12059. This property isn't indexed.
	FRAME_NUMBER_OF_COLUMS	Overloaded. Number of rows # 12006. This property isn't indexed.
	FRAME_NUMBER_OF_LADDERS	Overloaded. Number of ladders # 12007. This property isn't indexed.
	FRAME_NUMBER_OF_ROWS	Overloaded. Number of columns # 12005. This property isn't indexed.
	FRAME_PAGE_ORIENTATION	Overloaded. Page orientation / paper format # 12016. This property isn't indexed.
	FRAME_PATH_ALPHASET	Overloaded. String for column designation # 12027.
	FRAME_PATH_REVERSE_NUMBERING	Overloaded. Inverse column numbering # 12035. This property isn't indexed.
	FRAME_PATH_STARTID	Overloaded. Start value (column) # 12025. This property isn't indexed.
	FRAME_PATHPOS_MINDIGITS	Overloaded. Number of characters for column / row # 12029. This property isn't indexed.
	FRAME_PATHSIZE	Overloaded. Column width # 12102.
	FRAME_PLACEDPROPERROR	Overloaded. Error: Property placement # 12101.
	FRAME_POS_ALPHASET	Overloaded. String for row designation # 12028.
	FRAME_POS_REVERSE_NUMBERING	Overloaded. Inverse row numbering # 12036. This property isn't indexed.
	FRAME_POS_STARTID	Overloaded. Start value (row) # 12026. This property isn't indexed.
	FRAME_POSITIONSIZE	Overloaded. Row height # 12002.
	FRAME_ROW_AND_POS_ALPHABETIC_ALLOCATION	Overloaded. Alphabetical column / row distribution # 12010. This property isn't indexed.
	FRAME_ROW_DESC_OF_NON_LOGICAL_PAGES	Overloaded. Show column designation on non-logical pages # 12014. This property isn't indexed.
	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)
	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)
	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 PlotFramePropertyList 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

PlotFramePropertyList Members
Eplan.EplApi.DataModel.MasterData Namespace
PlotFrame Class
DocumentBasePropertyList Class

Send Feedback