NodeTypeProperty

Metropolis SDK ›› Classes ››
Parent Previous Next

namespace Dysr.Metropolis.SDK

{

   /// <summary>

   /// The data types a node type property can be.

   /// </summary>

   public enum NodeTypePropertyType { Boolean, Number, Decimal, Character, String, Date, DateTime }


   [DataContract]

   public class NodeTypeProperty

   {

       /// <summary>

       /// The Id of the NodeTypeProperty

       /// </summary>

       [DataMember]

       public int Id { get; set; }

       /// <summary>

       /// The Id of the parent NodeType

       /// </summary>

       [DataMember]

       public int NodeTypeId { get; set; }

       /// <summary>

       /// The KeyName of the NodeTypeProperty. This is referenced by the

       /// ActionNodeProperty GetActionNodePropertyByKey(string keyName)

       /// method in ActionNode.

       /// </summary>

       [DataMember]

       public string KeyName { get; set; }

       /// <summary>

       /// The default value of the NodeTypeProperty. This will auto-populate

       /// ActionNodeProperty objects of newly created ActionNodes.

       /// </summary>

       [DataMember]

       public string DefaultValue { get; set; }

       /// <summary>

       /// The datatype of the property.

       /// </summary>

       [DataMember]

       public NodeTypePropertyType PropertyType { get; set; }

       /// <summary>

       /// The display name of the property for the user. For example,

       /// "Clear Working Files?"

       /// </summary>

       [DataMember]

       public string DisplayName { get; set; }

       /// <summary>

       /// The order the property will appear to the user in a property list.

       /// </summary>

       [DataMember]

       public int DisplayOrder { get; set; }

       /// <summary>

       /// If true, forces the user to enter a value for this NodeTypeProperty when

       /// defining a new ActionNode

       /// </summary>

       [DataMember]

       public bool IsRequired { get; set; }

   }

}

Created with the Personal Edition of HelpNDoc: Easy CHM and documentation editor