HyperLinkPropertyList Class

In This Topic

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

Syntax

C#
C++/CLI

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

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

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
	HyperLinkPropertyList Constructor	Overloaded.

Top

Public Properties

	Name	Description
	DESCRIPTION	Description (Hyperlink) # 19305.
	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)
	FILE	File / Document # 19304.
	INSTANCE_COLOR	Overloaded. Color # 19010. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_DIRECTION	Overloaded. Alignment # 19016. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBasePropertyList)
	INSTANCE_FONT	Overloaded. Font # 19015. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBasePropertyList)
	INSTANCE_FULLPLACEMENTLOCATION	Overloaded. Placement # 19007. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_GEDLOCATION	Overloaded. Graphical placement # 19103. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_INVISIBLE	Overloaded. Invisible # 19101. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_LAYER	Overloaded. Layer # 19019. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGEFULLNAME	Overloaded. Page name (full) # 19023. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGENAME	Overloaded. Page name # 19022. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGENOMINATION	Overloaded. Page description # 19024. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PAGETYPE	Overloaded. Page type # 19020. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PARAMETRICRULE	Overloaded. Parametric rules # 19100. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_PATHID	Overloaded. Column number # 19005. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_POSID	Overloaded. Row number # 19006. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	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)
	INSTANCE_SIZE	Overloaded. Font size # 19017. (Inherited from Eplan.EplApi.DataModel.Graphics.TextBasePropertyList)
	INSTANCE_XCOORD	Overloaded. X coordinate # 19002. (Inherited from Eplan.EplApi.DataModel.Graphics.GraphicalPlacementPropertyList)
	INSTANCE_YCOORD	Overloaded. Y coordinate # 19003. (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. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
	TEXT_CONTENTS	Text contents # 19201.
	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 HyperLinkPropertyList 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

HyperLinkPropertyList Members
Eplan.EplApi.DataModel.Graphics Namespace
HyperLink Class
TextBasePropertyList Class

Send Feedback