Type: BCS.Sym3.Operator.Runtime.IProduct

Represents a product in the system

Properties

Color

  • Description: Set product color
  • Type: IResourceColor
  • Access: Read and Write
  • Example:
This example shows you how to change the color of a product


            //---- JAVASCRIPT
            var product; // this is a valid product
            product.Color = Client.Project.Colors["Sym3 Yellow"];

DestinationData

  • Description: Gets destination data list. Please note that you cannot subscribe to this property to get notifications (from ProductChanged) but you can call it to get the value.
  • Type: List`1
  • Access: Read
  • Example:
This example shows you how to ge tdestinatin data


            //---- JAVASCRIPT
            var product; // this is a valid product
            if(product.DestinationData.Count > 0)
                print(product.DestinationData[0]);

HeightOffset

  • Description: Gets the height offset
  • Type: Double
  • Access: Read
  • Example:
This example shows you how to get the height offset


            //---- JAVASCRIPT
            var product; // this is a valid product
            print(product.HeightOffset);

Id

  • Description: Unique internal id of the product
  • Type: Int64
  • Access: Read

Identified

  • Description: Gets if the product is identified
  • Type: Boolean
  • Access: Read
  • Example:
This example shows you how to get the value of Identified


            //---- JAVASCRIPT
            var product; // this is a valid product
            print(product.Identified);

Identifier

  • Description: Gets the identifier of a product
  • Type: String
  • Access: Read
  • Example:
This example shows you how to get the identifier


            //---- JAVASCRIPT
            var product; // this is a valid product
            print(product.Identifier);

Label

  • Description: Get label attached to the product. Please read IAttachedLabel properties to customize the label.
  • Type: IAttachedLabel
  • Access: Read
  • Example:
This example shows you how to change the billboard text of a product.


            //---- JAVASCRIPT
            var product; // this is a valid product
            product.Label.Text = "Hello World";

Name

  • Description: Gets the name of a product
  • Type: String
  • Access: Read
  • Example:
This example shows you how to get the name


            //---- JAVASCRIPT
            var product; // this is a valid product
            print(product.Name);

ScreeningData

  • Description: Gets screening data list. Please note that you cannot subscribe to this property to get notifications (from ProductChanged) but you can call it to get the value.
  • Type: List`1
  • Access: Read
  • Example:
This example shows you how to get the screening data


            //---- JAVASCRIPT
            var product; // this is a valid product
            if(product.ScreeningData.Count > 0)
                print(product.ScreeningData[0]);

Methods

GetPropertyValue(System.String)

Get property value including standard properties and UDP

  • Parameters:
    • propertyName: Property name
  • Returns:
    • Value or null if not found

GetUserPropertyValue(System.String)

Gets a user property value

  • Parameters:
    • propertyName: Name of the property to get the value from
  • Example:
This example shows you how to get the value of a user defined property


            //---- JAVASCRIPT
            var product; // this is a valid product
            print(product.GetUserPropertyValue("MyUDP"));