Description
Use the PropertyByName property to obtain a StoredObjectProperty object that provides a scripting interface to a property value that is stored in the property collection, to which StoredObject provides access to.
Declaration
StoredObjectObj.PropertyByName(Name)
| Read-Only Property | A StoredObjectProperty object |
| StoredObjectObj | An expression, variable or parameter that specifies a reference to a StoredObject object | |||
| Name | [in] | Required | String | |
Applies To
The property is applied to the following object:
Parameters
The property has the following parameter:
Name
Specifies the name of the stored property.
Property Value
A StoredObjectProperty object that provides a scripting interface to the desired stored property.
Remarks
If you use Python or DelphiScript, you should enclose the parameter of the StoredObjectObj.PropertyByName property in square brackets: StoredObjectObj.PropertyByName[Name].
If the specified property does not exist, the PropertyByName property returns an empty value (Nothing in VBScript, None in Python, null in JavaScript, JScript, C++Script and C#Script, and nil in DelphiScript).
Example
The following code demonstrates how you can access the desired item of the Objects collection and the properties stored in this item.
JavaScript, JScript
{
// Obtains the specified property collection
StoredObject = Objects.Items("MyCollection");
Log.Message("The total number of property values stored by the collection: " + StoredObject.PropertyCount);
// Access the specified stored property
StoredObjectProperty = StoredObject.Properties(0);
// --or--
// StoredObjectProperty = StoredObject.PropertyByName("Caption");
PropertyName = StoredObjectProperty.Name;
PropertyValue = StoredObjectProperty.Value;
Log.Message(PropertyName + " = " + PropertyValue);
}
Python
def Test1():
# Obtains the specified property collection
StoredObject = Objects.Items("MyCollection")
Log.Message("The total number of property values stored by the collection: " + str(StoredObject.PropertyCount))
# Access the specified stored property
StoredObjectProperty = StoredObject.Properties[0]
# --or--
# StoredObjectProperty = StoredObject.PropertyByName["Caption"]
PropertyName = StoredObjectProperty.Name
PropertyValue = StoredObjectProperty.Value
Log.Message(PropertyName + " = " + str(PropertyValue))VBScript
' Obtains the specified property collection
Set StoredObject = Objects.Items("MyCollection")
Log.Message("The total number of property values stored by the collection: " & StoredObject.PropertyCount)
' Access the specified stored property
Set StoredObjectProperty = StoredObject.Properties(0)
' --or--
' Set StoredObjectProperty = StoredObject.PropertyByName("Caption")
PropertyName = StoredObjectProperty.Name
PropertyValue = StoredObjectProperty.Value
Log.Message(PropertyName & " = " & PropertyValue)
End Sub
DelphiScript
begin
// Obtains the specified property collection
StoredObject := Objects.Items('MyCollection');
Log.Message('The total number of property values stored by the collection: ' + StoredObject.PropertyCount);
// Access the specified stored property
StoredObjectProperty := StoredObject.Properties(0);
// --or--
// StoredObjectProperty := StoredObject.PropertyByName('Caption');
PropertyName := StoredObjectProperty.Name;
PropertyValue := StoredObjectProperty.Value;
Log.Message(PropertyName + ' = ' + PropertyValue);
end;
C++Script, C#Script
{
// Obtains the specified property collection
StoredObject = Objects["Items"]("MyCollection");
Log["Message"]("The total number of property values stored by the collection: " + StoredObject["PropertyCount"]);
// Access the specified stored property
StoredObjectProperty = StoredObject["Properties"](0);
// --or--
// StoredObjectProperty = StoredObject["PropertyByName"]("Caption");
PropertyName = StoredObjectProperty["Name"];
PropertyValue = StoredObjectProperty["Value"];
Log["Message"](PropertyName + " = " + PropertyValue);
}
See Also
PropertyCount Property
Properties Property
StoredObjectProperty Object
Name Property