SymbolLibraryPropertyList Class

In This Topic

This class represents collection of properties of SymbolLibrary class. Please check also base classes for other properties which are available for SymbolLibrary objects: Eplan.EplApi.DataModel.StorableObjectPropertyList

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.UniversalPropertyList
      Eplan.EplApi.DataModel.StorableObjectPropertyList
         Eplan.EplApi.DataModel.MasterData.SymbolLibraryPropertyList

Syntax

C#
C++/CLI

[DefaultMember("Property")]
public class SymbolLibraryPropertyList : Eplan.EplApi.DataModel.StorableObjectPropertyList

[DefaultMember("Property")]
public ref class SymbolLibraryPropertyList : public Eplan.EplApi.DataModel.StorableObjectPropertyList

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
	SymbolLibraryPropertyList 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_SIZE	Font size # 19017.
	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)
	PROPUSER_LAST_USERCODE	Last editor: ID # 3010.
	PROPUSER_LAST_USEREMAIL	Last editor: E-mail # 3013.
	PROPUSER_LAST_USERNAME	Last editor: Name # 3011.
	PROPUSER_LAST_USERPHONE	Last editor: Phone # 3012.
	SYMBLIB_COMPANY	Company code # 15019.
	SYMBLIB_CONNECTIONERROR	Error: Connection point # 15101.
	SYMBLIB_CREATIONDATE	Creation date # 15021.
	SYMBLIB_CREATOR	Creator # 15020.
	SYMBLIB_DESC	Symbol library description # 15011.
	SYMBLIB_ERRORCOUNT	Number of messages # 15099.
	SYMBLIB_ERRORSYMBOLED	Error (symbol editor) # 15201.
	SYMBLIB_FRAME	Plot frame to edit symbol # 15030.
	SYMBLIB_FUNCDEFERROR	Error: Function definition # 15100.
	SYMBLIB_FUNCTYPEERROR	Error: Representation type # 15103.
	SYMBLIB_GRAPHICERROR	Error: Symbol graphic # 15105.
	SYMBLIB_IMPORTERROR	Error (import) # 15200.
	SYMBLIB_LASTMODIFICATIONDATE	Modification date (automatic) # 15023.
	SYMBLIB_LASTMODIFICATOR	Last editor: Logon name # 15022.
	SYMBLIB_LOCKEDSYMBOLCOUNT	Number of locked symbols # 15016.
	SYMBLIB_LOGICERROR	Error: Connection point logic # 15104.
	SYMBLIB_LOGICGRID	Grid # 15013.
	SYMBLIB_MANUALDATE	Modification date (manual) # 15024.
	SYMBLIB_NAME	Symbol library # 15000.
	SYMBLIB_OLDNAME	Name of original symbol library # 15098.
	SYMBLIB_PLACEDPROPERROR	Error: Property placement # 15106.
	SYMBLIB_SUPPLEMENTARYFIELD	Supplementary field # 15901.
	SYMBLIB_SYMBOLCOUNT	Number of symbols # 15015.
	SYMBLIB_VARIANTCOUNT	Number of symbol variants # 15017.
	SYMBLIB_VARIANTERROR	Error: Symbol variant # 15102.
	SYMBLIB_VERSION	Version # 15012.
	SYMBOLLIBRARY_REMOVED_VARIANT	Compressed symbol library # 15031.

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 SymbolLibraryPropertyList 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

SymbolLibraryPropertyList Members
Eplan.EplApi.DataModel.MasterData Namespace
SymbolLibrary Class
StorableObjectPropertyList Class

Send Feedback