Type: BCS.Sym3.IWindow

Window Remarks: Available in Operator only

Properties

BackgroundColor

  • Description: Gets or sets window color. It is not a ‘Sym3’ color, it is a .Net color
  • Type: Color
  • Access: Read and Write

BackgroundImage

  • Description: Gets or sets the background image for the window.
  • Type: IResourceImage
  • Access: Read and Write

BackgroundImageLayout

  • Description: Gets or sets the background image layout. By default it is tiled
  • Type: ImageLayout
  • Access: Read and Write

BaseProject

  • Description: Gets the project
  • Type: IBaseProject
  • Access: Read

Controls

  • Description: Gets the list of control in this container (not recursive)
  • Type: ObservableCollection`1
  • Access: Read and Write

DisplayTypeName

  • Description: Gets the display name of the type name of the object. It returns the english display name of the type name.
  • Type: String
  • Access: Read

Height

  • Description: Gets or sets the height of the control.
  • Type: Int32
  • Access: Read and Write

Id

  • Description: Gets the globally unique identifier (GUID) id of the object. This unique identifier is generated once at the object creation. This id will be kept unique for the entire life of the object, event after saving/loading the project.
  • Type: Guid
  • Access: Read and Write
  • Example:
This example shows how to get the id of an object in a string format. The following script will output a string like 'b3122ae0-dcf7-43b6-b17c-5381afaca5cb'


            strid = Project.Colors.Get("myColor").Id.ToString();
            print(strid)

Item(System.Int32)

  • Description: Indexer operator. Gets or sets a control by index (not recursive)
  • Type:
  • Access:

Item(System.String)

  • Description: Indexer operator. Gets or sets a control by name (is recursive)
  • Type:
  • Access:

Name

  • Description: Gets or sets the name of the object. All objects of the same type have a unique name.
  • Type: String
  • Access: Read and Write
  • Example:
This example shows how to get and set the name of an object.


            // get the color name
            colorname = Project.Colors.Get("myColor").Name;
            
            // set the color name
            Project.Colors.Get("myColor").Name = "myNewName";

NameSuffix

  • Description: The project explorer will display this after the Name of this object.
  • Type: String
  • Access: Read

Title

  • Description: Gets or sets window title
  • Type: String
  • Access: Read and Write

TypeName

  • Description: Gets the typename of the object. A type name doesn’t contain any space characters.
  • Type: String
  • Access: Read

UserPropertyInstances

  • Description: Gets a list of all the instances of user properties.
  • Type: ObservableCollection`1
  • Access: Read

UseWindowBorder

  • Description: Gets or sets a boolean value to show/hide Microsoft Windows border and caption
  • Type: Boolean
  • Access: Read and Write

Width

  • Description: Gets or sets the width of the control.
  • Type: Int32
  • Access: Read and Write

X

  • Description: Gets or sets the position X of the window
  • Type: Int32
  • Access: Read and Write

Y

  • Description: Gets or sets the position Y of the window
  • Type: Int32
  • Access: Read and Write

Methods

AddControl(BCS.Sym3.Controls.IControlLogic)

Adds a control

  • Parameters:
    • control: the control to add

AddControls(System.Collections.ICollection)

Adds a list of control

  • Parameters:
    • controls: list of control to add

ForceRename(System.String,System.Boolean)

Rename the object.

  • Parameters:
    • value: The new name.
    • fireChangingEvent: If false, no change event will fire. In particular, this disables the check for duplicate names, which can be costly as it has to check every equipment. The caller is responsible for ensuring that value is a unique name, or Bad Things will happen.

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

Get(System.String)

Search a control by its name (is recursive)

  • Parameters:
    • name: the name to search for
  • Returns:
    • Returns the control. Returns null if not found

GetAllControlsByTypeName(System.String)

Returns a list of control of the specified type name (is recursive)

  • Parameters:
    • typeName: type name of the control to return
  • Returns:
    • Returns a list of control of the specified type name

GetControlById(System.Guid)

Search a control by its global id (is recursive)

  • Parameters:
    • id: global id to search for
  • Returns:
    • Returns the control. Returns null if not found

GetCopyPasteXml

Converts the object into an XML string including overrides for for copy/paste functionality

  • Returns:
    • the string that contains xml version of the object for copy/paste

GetUserPropertyInstance(System.String)

Gets the user property instance of the specified name

  • Parameters:
    • userPropertyName: The user property name.
  • Returns:
    • Returns the user property instance object. If not found, the methods returns null.
  • Example:
This example shows how to set the value of a user property by using this method


            cc1 = Project.Equipment.Get("CC1");
            
            // get the value of a user property using the method
            userPropertyInstance = cc1.GetUserPropertyInstance("UserProperty1");
            if(userPropertyInstance != null) {
               userPropertyInstance.Value = 3;
            }

GetUserPropertyValue(System.String)

Gets the value of a user property. A better way to get the value of a user property is to use the indexer operator [], see example. Instead of using the method ‘GetUserPropertyInstance’ and then access the ‘Value’ property of the returned value, this method simplifies the way we get the value of a user property.

  • Parameters:
    • userPropertyName: The name of the user property to set.
  • Returns:
    • Returns null if user property is not found. Otherwise returns the value of the user property.
  • Example:
This example shows how to get the value of a user property using this method and also by using the indexer


            cc1 = Project.Equipment.Get("CC1");
            
            // get the value of a user property using the method
            val = cc1.GetUserPropertyValue("UserProperty1");
            
            // get the value of a user property using the indexer operator
            val = cc1["UserProperty1"];

IsUserProperty(System.String)

Indicates if the object contains a user property with the name you specify

  • Parameters:
    • userPropertyName: user property name
  • Returns:
    • Returns true if the object contains a user property with the name you specified in parameter.

NewControl(System.String)

Creates a new control of the specified type name

  • Parameters:
    • typeName: type name of the control to create
  • Returns:
    • Returns the created control. Returns null if not created

NewControlFromXml(System.String,System.String)

Creates a new control of the specified type name from an xml string

  • Parameters:
    • typeName: type name of the control to create
    • xml: xml string that contains values to set
  • Returns:
    • Returns the created control. Returns null if not created

RemoveControl(BCS.Sym3.Controls.IControlLogic)

Removes a control

  • Parameters:
    • control: the control to remove

RemoveControls(System.Collections.ICollection)

Remove a list of control

  • Parameters:
    • controls: list of component to remove

SetUserPropertyValue(System.String,System.Object)

Sets the value of a user property. A better way to set the value of a user property is to use the indexer operator [], see example. Instead of using the method ‘GetUserPropertyInstance’ and then access the ‘Value’ property of the returned value, this method simplifies the way we set the value of a user property.

  • Parameters:
    • userPropertyName: The name of the user property to set.
    • value: If the user property is not found, this methods does nothing.
  • Example:
This example shows how to set the value of a user property using this method and also by using the indexer


            cc1 = Project.Equipment.Get("CC1");
            
            // set the value of a user property using the method
            cc1.SetUserPropertyValue("UserProperty1", 3);
            
            // set the value of a user property using the indexer operator
            cc1["UserProperty1"] = 3;

ToCSVString(System.Char)

Returns the object in a CSV string.

  • Returns:
    • A string that contains properties of the object in a CSV format.

ToXmlString

Converts the object in an xml string

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