Type: BCS.Sym3.ISystemPropertyManager

System Property Manager

Methods

GetSystemProperties

Returns a list of the properties

  • Returns:
    • Requested list

GetSystemProperty(System.String)

Returns a requested property or null, based on the input name

  • Parameters:
    • Name: Name of the property to return
  • Returns:
    • Null or the requested property

NewProperty

Creates a user defined system property and stores within the manager instance

  • Returns:
    • Newly created object

Examples:

//******************************************************************************
// HOW TO : System Properties
//******************************************************************************


//------------------------------------------------------------------------------
// How to create
//------------------------------------------------------------------------------

// create a new entity
var newEntity = Project.SystemProperties.NewProperty()
print("A new entity has been created with default name: " + newEntity.Name)


//------------------------------------------------------------------------------
// How to access entity
//------------------------------------------------------------------------------

// get by name using method 'Get'
var entity1 = Project.SystemProperties.GetSystemProperty("SystemUserProperty1")
print("Get entity by name: " + entity1.Name)


//------------------------------------------------------------------------------
// How to loop
//------------------------------------------------------------------------------

var entities = Project.SystemProperties.GetSystemProperties();
for (var i = 0; i < entities.Count; i++) {
    
    print(entities[i].Name);
}


//------------------------------------------------------------------------------
// How to delete
//------------------------------------------------------------------------------

// remove entity
var newEntity = Project.SystemProperties.NewProperty()
print(Project.SystemProperties.Count)
Project.SystemProperties.Remove(newEntity)
print(Project.SystemProperties.Count)


//------------------------------------------------------------------------------
// How to edit
//------------------------------------------------------------------------------

var myProperty = Project.SystemProperties.NewProperty()

// change properties:
myProperty.Name = "my new name";


// set the Value of the property
myProperty.Value = 8;

// set Property type to string:
myProperty.Type = System.Type.GetType("System.String");

// set Property type to Double:
myProperty.Type = System.Type.GetType("System.Double");

// set Property type to Boolean:
myProperty.Type = System.Type.GetType("System.Boolean");

// set Property type to Integer 32bits:
myProperty.Type = System.Type.GetType("System.Int32");

// Provides a description of the property
myProperty.Description = "my descrition";

// Sets a flag that suspends the notification of property change
myProperty.SuspendUpdateNotifcation = true;