TextBasePropertyList Class

In This Topic

This class represents collection of properties of TextBase class. Please check also base classes for other properties which are available for TextBase objects: GraphicalPlacementPropertyList, 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.Graphics.GraphicalPlacementPropertyList
               Eplan.EplApi.DataModel.Graphics.TextBasePropertyList
                  Eplan.EplApi.DataModel.Graphics.HyperLinkPropertyList
                  Eplan.EplApi.DataModel.Graphics.PropertyPlacementPropertyList
                  Eplan.EplApi.DataModel.Graphics.TextPropertyList

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class TextBasePropertyList : GraphicalPlacementPropertyList

[DefaultMember("Property")]
public ref class TextBasePropertyList : public GraphicalPlacementPropertyList

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
	TextBasePropertyList 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_COLOR	Overloaded. Color # 19010. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_FULLPLACEMENTLOCATION	Overloaded. Placement # 19007. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_INVISIBLE	Overloaded. Invisible # 19101. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGEFULLNAME	Overloaded. Page name (full) # 19023. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGENAME	Overloaded. Page name # 19022. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGENOMINATION	Overloaded. Page description # 19024. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGETYPE	Overloaded. Page type # 19020. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PARAMETRICRULE	Overloaded. Parametric rules # 19100. This property isn't indexed. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PATHID	Overloaded. Column number # 19005. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_POSID	Overloaded. Row number # 19006. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	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)
	INSTANCE_SIZE	Overloaded. Font size # 19017. This property isn't indexed.
	INSTANCE_XCOORD	Overloaded. X coordinate # 19002. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_YCOORD	Overloaded. Y coordinate # 19003. This property isn't indexed, and is read-only. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	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 TextBasePropertyList 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

TextBasePropertyList Members
Eplan.EplApi.DataModel.Graphics Namespace
TextBase Class
GraphicalPlacementPropertyList Class

Send Feedback