Utility
A form element that represents the utility network associations within the form.
Since
200.7.0
Properties
A collection of filters that define which associations are displayed.
The collection of results from the UtilityAssociationsFormElement.fetchAssociationsFilterResults method. The collection of UtilityAssociationsFilterResult objects groups the fetch results first by their UtilityAssociationsFilter and then groups the UtilityAssociation objects by the layer or table that contains them within the ArcGISMap.
True if the utility associations form element is editable, false otherwise. This property can be modified by the editable expression, which can be set during Feature Form authoring.
Inherited properties
A detailed description of the element.
A descriptive label that appears with the element. If not supplied, a FieldFormElement is labeled with the alias property of the associated field.
Functions
Adds an association between the provided feature and the FeatureForm.feature that this element is part of. This method can be used to create an association of any type. Default values will be used for any properties of the association such as UtilityAssociation.isContainmentVisible, UtilityAssociation.fractionAlongEdge.
Adds an association between the provided feature and the FeatureForm.feature that this element is part of, along with the UtilityAssociation.isContainmentVisible value. This method is typically used when creating an UtilityAssociationType.Containment association.
Adds an association between the provided feature and the FeatureForm.feature that this element is part of, along with the fractionAlongEdge and terminal value, if provided. This method is typically used when creating an UtilityAssociationType.Connectivity association between a junction and an edge and the junction feature may have an associated UtilityTerminal value.
Adds an association between the provided feature and the FeatureForm.feature that this element is part of, along with the UtilityTerminal values. This method is typically used when creating an UtilityAssociationType.Connectivity association between two junction features in the UtilityNetwork.
Checks if an UtilityAssociation can be added between the provided ArcGISFeature and the FeatureForm.feature this element is part of. Checks that all of the following conditions are met:
Deletes an association from the UtilityNetwork. UtilityAssociationsFormElement.fetchAssociationsFilterResults should be called after a successful deletion to refresh the list of filter results.
Fetches UtilityAssociation objects from an ArcGISFeature based on the UtilityAssociationsFormElement.associationFilters. The results are provided in UtilityAssociationsFormElement.associationsFilterResults.
Gets the UtilityAssociationFeatureSource objects from the UtilityNetwork. Checks the utility rules and the filter definition to find all UtilityAssociationFeatureSource objects that can be used to create an association. Use UtilityAssociationFeatureSource.queryFeatures to get the actual features from an UtilityAssociationFeatureSource.
Retrieves options for creating an association with a specified feature in the utility network. This method evaluates the provided feature and returns a set of options that can be used to define an association. The options include details about valid configurations and constraints for the association.