Skip to content

UtilityAssociationsFormElement Class

  • UtilityAssociationsFormElement
  • class Esri::ArcGISRuntime::UtilityAssociationsFormElement

    A form element that represents the utility network associations within the form. More...

    Header: #include <UtilityAssociationsFormElement.h>
    Since: Esri::ArcGISRuntime 200.8
    Inherits: Esri::ArcGISRuntime::FormElement

    Public Functions

    virtual ~UtilityAssociationsFormElement() override
    QList<Esri::ArcGISRuntime::UtilityAssociationsFilter *> associationFilters() const
    QList<Esri::ArcGISRuntime::UtilityAssociationsFilterResult *> associationsFilterResults() const
    QFuture<void> fetchAssociationsFilterResultsAsync()
    bool isEditable() const

    Signals

    void editableChanged(bool isEditable)

    Detailed Description

    Member Function Documentation

    [override virtual noexcept] UtilityAssociationsFormElement::~UtilityAssociationsFormElement()

    Destructor.

    QList<Esri::ArcGISRuntime::UtilityAssociationsFilter *> UtilityAssociationsFormElement::associationFilters() const

    Returns a collection of filters that define which associations are displayed.

    QList<Esri::ArcGISRuntime::UtilityAssociationsFilterResult *> UtilityAssociationsFormElement::associationsFilterResults() const

    Returns the collection of results from the fetchAssociationsFilterResultsAsync 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 Map.

    This collection is empty if associations haven't been fetched.

    [signal] void UtilityAssociationsFormElement::editableChanged(bool isEditable)

    Signal emitted when the editable status changes for this form element.

    QFuture<void> UtilityAssociationsFormElement::fetchAssociationsFilterResultsAsync()

    Fetches UtilityAssociation objects from an ArcGISFeature based on the associationFilters. The results are provided in associationsFilterResults.

    This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

    See Working with QFuture for further details.

    bool UtilityAssociationsFormElement::isEditable() const

    Returns 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.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.