Configuring Siebel Open UI > Application Programming Interface > Methods for Pop-Up Objects, Google Maps, and Property Sets >
Methods That Manipulate Property Sets
This topic describes the methods you can use that manipulate property sets. It includes the following information:
Structure of the Property Set
Table 46 describes the structure of the property set that Siebel Open UI uses in the client.
Table 46. Structure of the Property Set
|
|
childArray |
Array of all child property sets that the parent property set contains. |
childEnum |
Counter that contains the number of children enumerated in the property set. |
propArray |
Object that contains the values for all properties that the property set contains. |
propArrayLen |
Length of the propArray property. |
type |
Type of the property set. |
value |
Value of the property set. |
The AddChild method creates a new child property in the property set. It returns one of the following values:
- true. Siebel Open UI created a child property.
- false. Siebel Open UI did not create a child property.
It uses the following format: AddChild (child)
For example: outputPS.AddChild (inputPS);
where:
inputPS is an argument that identifies the input property set that Siebel Open UI adds to the childArray of the called on property set object outputPS.
The Clone method creates a new property set and does a full copy of the following property set: this
It returns a new property set object. It uses the following format: Clone()
For example: outputPS = inputPS.Clone();
It includes no arguments.
The Copy method copies the following property set: this
It returns one of the following values:
- true. Siebel Open UI made a copy of the property set.
- false. Siebel Open UI did not make a copy of the property set.
It adds every child and subchild in the childArray of the input property set to the childArray of the following property set: this
It uses the following format: Copy(old)
For example: outputPS.Copy(inputPS);
It uses the following arguments:
- inputPS. Identifies the input property set that Siebel Open UI copies.
The DeepCopy method makes a full copy of the inputPS property set, and then parses this copy into the following property set: this
It returns one of the following values:
- true. Siebel Open UI made a full copy of the inputPS property set, and then parsed it.
- false. Siebel Open UI did not make a full copy of the inputPS property set, and then parse it.
It uses the following format: DeepCopy(inputPS)
For example: outputPS.DeepCopy (inputPS)
It uses the following arguments:
- inputPS. An input property set that contains the values that Siebel Open UI copies to the outputPS property set.
The GetChild method returns a child of the property set that resides at an index location that you specify. It returns a property set object. It uses the following format: GetChild (index)
For example: childPS = inputPS.GetChild (index);
It uses the following arguments:
- index. Specifies the index of the child that Siebel Open UI gets from the inputPS property set.
The GetChildByType method returns a child of the property set according to the type that you specify. It returns a property set object. It uses the following format: GetChildByType (type)
For example: childPS = inputPS.GetChildByType("vi")
It uses the following arguments:
- type. Specifies the type of the property set that Siebel Open UI gets from the childArray of the inputPS property set.
The InsertChildAt method inserts a new property set in the child array at the location that the index specifies. It returns one of the following values:
- true. Siebel Open UI inserted a new property set.
- false. Siebel Open UI did not insert a new property set.
It uses the following format: InsertChildAt (child, index)
For example: outputPS.InsertChildAt(inputPS, 2);
It uses the following arguments:
- inputPS. Specifies the input property set that Siebel Open UI adds in the childArray of the outputPS property set.
- index. Specifies the index where Siebel Open UI adds the inputPS property set to childArray.
The RemoveChild method removes a child from the child array of the property set at the location that the index specifies. It returns one of the following values:
- true. Siebel Open UI removed a child from the child array.
- false. Siebel Open UI did not remove a child from the child array.
It uses the following format: RemoveChild (index)
where:
index specifies the index of the child property set that Siebel Open UI removes from the childArray of the outputPS property set.
For example: outputPS.RemoveChild(2);
The RemoveProperty method removes a property from the propArray of the property set. It returns one of the following values:
- true. Siebel Open UI removed a property from the propArray.
- false. Siebel Open UI did not remove a property from the propArray.
It uses the following format: RemoveProperty (name)
where:
name specifies the name of the property that Siebel Open UI removes from propArray.
For example: outputPS.RemoveProperty("prop");
The SetProperty method sets a property of the property set. It returns one of the following values:
- true. Siebel Open UI set a property of the property set.
- false. Siebel Open UI did not set a property of the property set.
It uses the following format: SetProperty (name, value)
For example: inputPS.SetProperty("SelectedItem", val);
It uses the following arguments:
- name. Specifies the new property name.
- value. Specifies the new property value.
|