Skip To Content ArcGIS for Developers Sign In Dashboard

PopupAttachmentManager QML Type

Manages PopupAttachments for a Popup. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Methods

Detailed Description

In addition to creating a PopupAttachmentManager with the initFeature property, you can also obtain a PopupAttachmentManager from PopupManager::attachmentManager.

Property Documentation

applyChangesError : Error

Returns the Error object in the case where the applyChangesErrorChanged signal is emitted.


attachments : list<PopupAttachment>

Returns a list of all the PopupAttachments in the PopupAttachmentManager (read-only).

Use addAttachment and deleteAttachment to add or delete PopupAttachments from this list.


attachmentsModel : PopupAttachmentListModel

A model that can be used to display popup attachment information in a view.

Any changes made by the PopupAttachmentManager will be reflected immediately by the model.

This QML property was introduced in Esri.ArcGISRuntime 100.1.


fetchAttachmentsStatus : Enums.TaskStatus

Returns the status of the fetchAttachments asynchronous operation (read-only).

Check this status when the fetchAttachmentsStatusChanged signal emits, to determine if the fetchAttachments is complete, in progress, or has errored.

See also Enums.TaskStatus.


filterAttachments : list<PopupAttachment>

Returns a filtered list of popup attachments in the PopupAttachmentManager in an alphabetically ascending order by name (read-only).

This list only includes attachments with specific content types, which are:

  • "image/jpg"
  • "image/jpeg"
  • "image/pjpeg"
  • "image/png"
  • "image/gif"
  • "video/quicktime"
  • "application/pdf"
  • "application/vnd.ms-excel"
  • "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
  • "application/msword"
  • "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
  • "application/vnd.ms-powerpoint"
  • "application/vnd.openxmlformats-officedocument.presentationml.presentation"
  • "text/html"

Use addAttachment and deleteAttachment to add or delete PopupAttachments from this list.


initFeature : ArcGISFeature

The initial ArcGISFeature that will be used to create the PopupAttachmentManager.

Once this is property is set, the PopupAttachmentManager will be created with it, and the property will be immutable.


Signal Documentation

applyChangesCompleted()

Emitted when the applyChanges operation completes.

Check the applyChangesError to see if the operation completed with errors.


applyChangesErrorChanged()

Emitted when the applyChangesError property changes.


attachmentsChanged()

Emitted when the attachments property changes.

This signal will emit when PopupAttachments are fetched, added, or deleted.


attachmentsModelChanged()

Emitted when the attachmentsModel property changes.

This signal will emit when PopupAttachments are fetched, added, or deleted.

This QML signal was introduced in Esri.ArcGISRuntime 100.1.


attachmentsModelChanged()

Emitted when the attachmentsModel property changes.


fetchAttachmentsStatusChanged()

Emitted when the fetchAttachmentsStatus property changes.


filterAttachmentsChanged()

Emitted when the filterAttachments property changes.

This signal will emit when PopupAttachments are fetched, added, or deleted.


initFeatureChanged()

Emitted when the initFeature property changes.


Method Documentation

void addAttachment(url fileOrResourcePath, string contentType, string name)

Adds an attachment to the PopupAttachmentManager.

You must call applyChanges to apply the edits from the PopupAttachmentManager to the associated ArcGISFeatureTable. To undo any edits, call revertChanges.

  • fileOrResourcePath - The URL to the local data.
  • contentType - The type of data.
  • name - The name of the attachment.

void applyChanges()

Applies the current changes in the PopupAttachmentManager to the ArcGISFeature in its ArcGISFeatureTable.

The applyChangesCompleted signal emits when this asynchronous operation completes.


void deleteAttachment(PopupAttachment popupAttachment)

Deletes the given popupAttachment from the PopupAttachmentManager.

You must call applyChanges to apply the edits from the PopupAttachmentManager to the associated ArcGISFeatureTable. To undo any edits, call revertChanges.


void fetchAttachments()

Fetches the Attachments from the ArcGISFeature and creates PopupAttachments from them.


void revertChanges()

Reverts the current working changes made to the Popup's attachments (such as addAttachment and deleteAttachment).

This does not reverse a call to applyChanges.



Feedback on this topic?