Type: BCS.Sym3.Controls.ITextDisplayMappingItem

Text Display Mapping Item

Properties

Text

  • Description: Gets or sets the Text
  • Type: String
  • Access: Read and Write
  • Example:
This example shows you how to add/remove and edit mapping items


            var textdisplay = ...;
            
            // add maping items:
            textdisplay.AddMapping("0", "Zero")
            textdisplay.AddMapping("1", "One")
            textdisplay.AddMapping("2", "Two")
            
            // loop existing mapping items
            for(i=0; i<textdisplay.Mapping.Count; i++) {
            
              var item = textdisplay.Mapping[i];
              print("Text = " + item.Text);
              print("Value = " + item.Value);
            }
            
            // remove mapping items
            var item = textdisplay.Mapping[0];
            textdisplay.Mapping.Remove(item);

Value

  • Description: Gets or sets the Value.
  • Type: String
  • Access: Read and Write
  • Example:
This example shows you how to add/remove and edit mapping items


            var textdisplay = ...;
            
            // add maping items:
            textdisplay.AddMapping("0", "Zero")
            textdisplay.AddMapping("1", "One")
            textdisplay.AddMapping("2", "Two")
            
            // loop existing mapping items
            for(i=0; i<textdisplay.Mapping.Count; i++) {
            
              var item = textdisplay.Mapping[i];
              print("Text = " + item.Text);
              print("Value = " + item.Value);
            }
            
            // remove mapping items
            var item = textdisplay.Mapping[0];
            textdisplay.Mapping.Remove(item);

Methods

FromXmlString(BCS.IToolXmlToObjectHelper)

Init object from IToolXmlToObjectHelper. All properties found in the RootElement of IToolXmlToObjectHelper will be set with the value in the rootElement

  • Parameters:
    • xmlHelperObj: xmlHelperObj IToolXmlToObjectHelper

FromXmlString(System.String)

Init object from xml. All properties found in the xml will be set with the value in the xml file

  • Parameters:
    • xmlText: Xml string

FromXmlString(System.Xml.Linq.XElement)

Init object from root element. All properties found in the XElement will be set with the value in the XElement

  • Parameters:
    • objXml: objXml XElement

ToXmlString

Converts the object in an xml string

  • Returns:
    • the string that contains xml version of the object