Eplan Platform API
Eplan.EplApi.DataModel.MasterData Namespace / SymbolPropertyList Class
Members Example

In This Topic
SymbolPropertyList Class
In This Topic
This class represents collection of properties of Symbol class. Please check also base classes for other properties which are available for Symbol objects: Eplan.EplApi.DataModel.StorableObjectPropertyList
Inheritance Hierarchy

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

Syntax
[DefaultMember("Property")]
public class SymbolPropertyList : 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
 NameDescription
Public ConstructorSymbolPropertyList ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyCABLINGSEGMENT_DIRECTION_OF_HEIGHT_DIFFTopology: Direction for height difference # 20348.  
Public PropertyCONNECTION_ACL_COLORAutoconnecting line: Color # 31005.  
Public PropertyCONNECTION_ACL_FACTORAutoconnecting line: Pattern length # 31018.  
Public PropertyCONNECTION_ACL_LAYERAutoconnecting line: Layer # 31017.  
Public PropertyCONNECTION_ACL_STYLEAutoconnecting line: Line type # 31015.  
Public PropertyCONNECTION_ACL_WIDTHAutoconnecting line: Line thickness # 31016.  
Public PropertyCONNECTION_DESIGNATIONConnection designation # 31011.  
Public PropertyExistingIdsReturns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Public PropertyExistingValuesReturns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Public PropertyFUNC_BLOCK_FORMATBlock property: Format # 20202.  
Public PropertyFUNC_CATEGORYFunction definition: Category # 20115.  
Public PropertyFUNC_CATEGORY_GROUP_IDFunction definition: Category / Group / Definition # 20188.  
Public PropertyFUNC_CATEGORY_REGIONFunction definition: Area # 20088.  
Public PropertyFUNC_COMPONENTTYPEFunction definition # 20026.  
Public PropertyFUNC_DESCFunction definition: Description # 20117.  
Public PropertyFUNC_GROUPFunction definition: Group # 20116.  
Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
Public PropertyPROPUSER_LAST_USERCODELast editor: ID # 3010.  
Public PropertyPROPUSER_LAST_USEREMAILLast editor: E-mail # 3013.  
Public PropertyPROPUSER_LAST_USERNAMELast editor: Name # 3011.  
Public PropertyPROPUSER_LAST_USERPHONELast editor: Phone # 3012.  
Public PropertySYMB_CABLE_RELATED_VDP_SYMBOL_ID_USE_1ST_VARIANT_ONLYUse first variant of connection definition point symbol # 16030.  
Public PropertySYMB_CONNECTIONNUMBERConnection point number # 16001.  
Public PropertySYMB_CRAFTTrade (function definition) # 16017.  
Public PropertySYMB_CREATIONDATECreation date # 16021.  
Public PropertySYMB_CREATORCreator # 16020.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_ADefault property arrangement for variant A (alternative) # 16033.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_BDefault property arrangement for variant B (alternative) # 16034.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_CDefault property arrangement for variant C (alternative) # 16035.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_DDefault property arrangement for variant D (alternative) # 16036.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_EDefault property arrangement for variant E (alternative) # 16037.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_FDefault property arrangement for variant F (alternative) # 16038.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_GDefault property arrangement for variant G (alternative) # 16039.  
Public PropertySYMB_DEFAULT_ALTERNATIVE_PROPERTYSET_HDefault property arrangement for variant H (alternative) # 16041.  
Public PropertySYMB_DEFAULT_PROPERTYSET_ADefault property arrangement for variant A # 16004.  
Public PropertySYMB_DEFAULT_PROPERTYSET_BDefault property arrangement for variant B # 16005.  
Public PropertySYMB_DEFAULT_PROPERTYSET_CDefault property arrangement for variant C # 16006.  
Public PropertySYMB_DEFAULT_PROPERTYSET_DDefault property arrangement for variant D # 16007.  
Public PropertySYMB_DEFAULT_PROPERTYSET_EDefault property arrangement for variant E # 16008.  
Public PropertySYMB_DEFAULT_PROPERTYSET_FDefault property arrangement for variant F # 16009.  
Public PropertySYMB_DEFAULT_PROPERTYSET_GDefault property arrangement for variant G # 16014.  
Public PropertySYMB_DEFAULT_PROPERTYSET_HDefault property arrangement for variant H # 16015.  
Public PropertySYMB_DEFAULT_VARIANTDefault variant # 16003.  
Public PropertySYMB_DESCSymbol description # 16011.  
Public PropertySYMB_DXF_BLOCKNAMEDXF export: Name of block # 16040.  
Public PropertySYMB_IMPORTEDVARIANTMAPPINGSymbol variant assignment (internal) # 16031.  
Public PropertySYMB_INTRINSICALLYSAFEIntrinsically safe # 16019.  
Public PropertySYMB_LASTAUTOMODIFICATIONDATEModification date (automatic) # 16023.  
Public PropertySYMB_LASTMANUMODIFICATIONDATEModification date (manual) # 16025.  
Public PropertySYMB_LASTMODIFICATORLast editor: Sign-in name # 16022.  
Public PropertySYMB_LOGICMODELTarget tracking # 16010.  
Public PropertySYMB_MAINFUNCTIONMain function # 16018.  
Public PropertySYMB_MODIFICATIONCOMMENTModification note # 16024.  
Public PropertySYMB_MOTOR_CONTACT_IMAGESymbol for contact image of motor overload switch # 16032.  
Public PropertySYMB_NAMEName # 16000.  
Public PropertySYMB_NETCONNECTINGNet-connecting # 16043.  
Public PropertySYMB_NRNumber # 16002.  
Public PropertySYMB_PLTTYPEPCT type # 16016.  
Public PropertySYMB_POTENTIALSEPARATEDWith signal isolation # 16042.  
Public PropertySYMB_PREVENTPLACEMENTPrevent new placement # 16012.  
Public PropertySYMB_PROPERTYINSTANCESETProperty arrangements # 16050.  
Public PropertySYMB_SAFETYRELEVANTSafety function # 16044.  
Public PropertySYMB_SUPPLEMENTARYFIELDSupplementary field # 16013.  
Public PropertySYMB_SYBMOLFUNCTIONTYPESymbol representation type (encoded) # 16027.  
Public PropertySYMB_SYBMOLFUNCTIONTYPE_NAMESymbol representation type # 16028.  
Public PropertySYMB_VERSIONVersion # 16026.  
Public PropertySYMBLIB_NAMESymbol library # 15000.  
Public PropertySYMBOL_TRANSFORMATION_POINTTransformation point # 16045.  
Top
Public Methods
 NameDescription
Public MethodCopyToOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Public MethodDispose()Destructor for deterministic finalization of SymbolPropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Public MethodExistsOverloaded. Checks property existence for used obiect.  
Public MethodgetPropListInternal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
Top
See Also

Reference

SymbolPropertyList Members
Eplan.EplApi.DataModel.MasterData Namespace
Symbol Class
StorableObjectPropertyList Class

 

 

EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

Send Feedback