AttachmentsPopupElement Class

  • AttachmentsPopupElement
  • class Esri::ArcGISRuntime::AttachmentsPopupElement

    Represents a pop-up element of type attachments that is displayed in a pop-up for a geoelement. More...

    Header: #include <AttachmentsPopupElement>
    Since: Esri::ArcGISRuntime 100.14
    Inherits: Esri::ArcGISRuntime::PopupElement

    Public Functions

    AttachmentsPopupElement(Esri::ArcGISRuntime::PopupAttachmentsDisplayType displayType, QObject *parent = nullptr)
    virtual ~AttachmentsPopupElement() override
    QList<Esri::ArcGISRuntime::PopupAttachment *> attachments() const
    QString description() const
    Esri::ArcGISRuntime::PopupAttachmentsDisplayType displayType() const
    QFuture<void> fetchAttachmentsAsync()
    void setDescription(const QString &description)
    void setDisplayType(Esri::ArcGISRuntime::PopupAttachmentsDisplayType displayType)
    void setTitle(const QString &title)
    QString title() const

    Detailed Description

    See also PopupElementType.

    Member Function Documentation

    [explicit] AttachmentsPopupElement::AttachmentsPopupElement(Esri::ArcGISRuntime::PopupAttachmentsDisplayType displayType, QObject *parent = nullptr)

    Creates a new attachments pop-up element with the given PopupAttachmentsDisplayType.

    • displayType - Indicates how to display the attachments.
    • parent - The optional parent QObject.

    [override virtual] AttachmentsPopupElement::~AttachmentsPopupElement()


    [since Esri::ArcGISRuntime 200.3] QList<Esri::ArcGISRuntime::PopupAttachment *> AttachmentsPopupElement::attachments() const

    Returns all the current attachments.

    Will be empty if attachments haven't yet been fetched or if PopupElement::isEvaluated is false.

    This function was introduced in Esri::ArcGISRuntime 200.3.

    See also fetchAttachmentsAsync.

    QString AttachmentsPopupElement::description() const

    Returns a string value describing the element in detail. Can be an empty string.

    See also setDescription().

    Esri::ArcGISRuntime::PopupAttachmentsDisplayType AttachmentsPopupElement::displayType() const

    Returns how to display the attachments. If `list` is specified, attachments show as links.

    If `preview` is specified, attachments expand to the width of the pop-up. Setting the value to `auto` allows applications to choose the most suitable default experience for their application.

    See also setDisplayType().

    [since Esri::ArcGISRuntime 200.3] QFuture<void> AttachmentsPopupElement::fetchAttachmentsAsync()

    Returns the Attachments from the Feature, creates PopupAttachments from them, and populates attachments.

    Once the future is completed, all new PopupAttachment results will be available in the attachments immediately.

    If PopupElement::isEvaluated is false, this method will have no effect.

    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.

    This function was introduced in Esri::ArcGISRuntime 200.3.

    void AttachmentsPopupElement::setDescription(const QString &description)

    Sets the description to description.

    See also description.

    void AttachmentsPopupElement::setDisplayType(Esri::ArcGISRuntime::PopupAttachmentsDisplayType displayType)

    Sets the displayType to displayType.

    See also displayType.

    void AttachmentsPopupElement::setTitle(const QString &title)

    Sets the title to title.

    See also title.

    QString AttachmentsPopupElement::title() const

    Returns a string value indicating what the element represents. Can be an empty string.

    See also setTitle().

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