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