Migration Guide : E. Features Introduced in OpenROAD 6.2 : Changes to Existing Features : CompositeField Class Gets New FieldsByProperty Method
 
Share this page          
CompositeField Class Gets New FieldsByProperty Method
OpenROAD applications involve much field manipulation that would be easier if fields could be managed in related sets. Previously, the only way to interrelate fields was through naming or shared parenting. This version of OpenROAD enables the finding of fields by field properties or tagged values and collecting them into a FormField array. The implementation:
Allows fields to be manipulated as sets more easily.
Enables field tags to be searched for as easily as other field properties.
Consolidates such set functionality at a single point in the product.
The FieldsByProperty method of the CompositeField class searches all of a composite field's descendants and returns an array of fields that match the specified field property or tagged value.
You can use this method to return all of the frame’s fields (by specifying no parameters), to find all fields with a particular attribute or tag value, or to manipulate a group of fields that are linked by tagged values. A group could be a multifield field template or a number of fields that are hidden or displayed together. An example of a field group is a business construct such as a shipping address, which comprises several fields such as street number, street name, city, state, and postal code that may not be formally linked together as an Address userclass object but can be bound together by a particular tagged value.
For more information, see the CompositeField class FieldsByProperty Method in the Language Reference Guide.