Method AddAssociationAsync
AddAssociationAsync(ArcGISFeature, UtilityAssociationsFilter, CancellationToken)
Adds an association between the provided feature and the Feature that this element is part of.
Declaration
public Task<UtilityAssociationResult> AddAssociationAsync(ArcGISFeature feature, UtilityAssociationsFilter filter, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| ArcGISFeature | feature | The ArcGISFeature on the other side of the association. |
| UtilityAssociationsFilter | filter | The UtilityAssociationsFilter that the association will be part of. |
| CancellationToken | cancellationToken | A cancellation token that can be used to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task<UtilityAssociationResult> | The UtilityAssociationResult that contains information about the added association. |
Remarks
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 IsContainmentVisible, FractionAlongEdge.
FetchAssociationsFilterResultsAsync() should be called after a successful addition to refresh the list of filter results.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the filter definition does not support adding an association with the specified feature. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET | 300 |
| .NET Windows | 300 |
| .NET Android | 300 |
| .NET iOS | 300 |
AddAssociationAsync(ArcGISFeature, UtilityAssociationsFilter, bool, CancellationToken)
Adds an association between the provided feature and the Feature that this element is part of, along with the IsContainmentVisible value.
Declaration
public Task<UtilityAssociationResult> AddAssociationAsync(ArcGISFeature feature, UtilityAssociationsFilter filter, bool isContainmentVisible, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| ArcGISFeature | feature | The ArcGISFeature on the other side of the association. |
| UtilityAssociationsFilter | filter | The UtilityAssociationsFilter that the association will be part of. |
| bool | isContainmentVisible | Indicates whether the content in the containment association is visible. |
| CancellationToken | cancellationToken | A cancellation token that can be used to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task<UtilityAssociationResult> | The UtilityAssociationResult that contains information about the added association. |
Remarks
This method is typically used when creating a Containment association.
FetchAssociationsFilterResultsAsync() should be called after a successful addition to refresh the list of filter results.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the filter definition does not support adding an association with the specified feature. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET | 300 |
| .NET Windows | 300 |
| .NET Android | 300 |
| .NET iOS | 300 |
AddAssociationAsync(ArcGISFeature, UtilityAssociationsFilter, double, CancellationToken)
Adds an association between the provided feature and the Feature that this element is part of, along with the FractionAlongEdge value.
Declaration
public Task<UtilityAssociationResult> AddAssociationAsync(ArcGISFeature feature, UtilityAssociationsFilter filter, double fractionAlongEdge, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| ArcGISFeature | feature | The ArcGISFeature on the other side of the association. |
| UtilityAssociationsFilter | filter | The UtilityAssociationsFilter that the association will be part of. |
| double | fractionAlongEdge | Represents how far the starting point or barrier is located along an edge in the utility network feature. |
| CancellationToken | cancellationToken | A cancellation token that can be used to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task<UtilityAssociationResult> | The UtilityAssociationResult that contains information about the added association. |
Remarks
This method is typically used when creating a Connectivity association between a junction and an edge.
FetchAssociationsFilterResultsAsync() should be called after a successful addition to refresh the list of filter results.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the filter definition does not support adding an association with the specified feature. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET | 300 |
| .NET Windows | 300 |
| .NET Android | 300 |
| .NET iOS | 300 |
AddAssociationAsync(ArcGISFeature, UtilityAssociationsFilter, double, UtilityTerminal, CancellationToken)
Adds an association between the provided feature and the Feature that this element is part of, along with the FractionAlongEdge and terminal value.
Declaration
public Task<UtilityAssociationResult> AddAssociationAsync(ArcGISFeature feature, UtilityAssociationsFilter filter, double fractionAlongEdge, UtilityTerminal terminal, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| ArcGISFeature | feature | The ArcGISFeature on the other side of the association. |
| UtilityAssociationsFilter | filter | The UtilityAssociationsFilter that the association will be part of. |
| double | fractionAlongEdge | Represents how far the junction is located along an edge in the utility network feature. |
| UtilityTerminal | terminal | The UtilityTerminal of the junction. |
| CancellationToken | cancellationToken | A cancellation token that can be used to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task<UtilityAssociationResult> | The UtilityAssociationResult that contains information about the added association. |
Remarks
This method is typically used when creating a Connectivity association between a junction and an edge and the junction feature has an associated UtilityTerminal value.
FetchAssociationsFilterResultsAsync() should be called after a successful addition to refresh the list of filter results.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the filter definition does not support adding an association with the specified feature, or the provided UtilityTerminal value is not a valid selection. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET | 300 |
| .NET Windows | 300 |
| .NET Android | 300 |
| .NET iOS | 300 |
AddAssociationAsync(ArcGISFeature, UtilityAssociationsFilter, UtilityTerminal?, UtilityTerminal?, CancellationToken)
Adds an association between the provided feature and the Feature that this element is part of, along with the UtilityTerminal values.
Declaration
public Task<UtilityAssociationResult> AddAssociationAsync(ArcGISFeature feature, UtilityAssociationsFilter filter, UtilityTerminal? featureTerminal, UtilityTerminal? currentFeatureTerminal, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| ArcGISFeature | feature | The ArcGISFeature on the other side of the association. |
| UtilityAssociationsFilter | filter | The UtilityAssociationsFilter that the association will be part of. |
| UtilityTerminal | featureTerminal | The UtilityTerminal of the feature being associated. |
| UtilityTerminal | currentFeatureTerminal | The UtilityTerminal of the feature currently being edited in the FeatureForm. |
| CancellationToken | cancellationToken | A cancellation token that can be used to cancel the operation. |
Returns
| Type | Description |
|---|---|
| Task<UtilityAssociationResult> | The UtilityAssociationResult that contains information about the added association. |
Remarks
This method is typically used when creating a Connectivity association between two junction features in the UtilityNetwork.
FetchAssociationsFilterResultsAsync() should be called after a successful addition to refresh the list of filter results.
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the filter definition does not support adding an association with the specified feature, or the provided UtilityTerminal values are not a valid selection. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET | 300 |
| .NET Windows | 300 |
| .NET Android | 300 |
| .NET iOS | 300 |