arcgis-maps-kotlin/com.arcgismaps.mapping.featureforms/AttachmentsFormElement

AttachmentsFormElement

class AttachmentsFormElement : FormElement

A form element that holds one or more attachments on a feature. The AttachmentsFormElement specifies how one or more attachments can participate in the form. When present in the form, the user has the ability to edit the list of attachments specific to the form element.

Since

200.5.0

Properties

attachments

val attachments: List<FormAttachment>

Returns all the current attachments. This is empty if attachments haven't yet been fetched.

isEditable

val isEditable: StateFlow<Boolean>

True if the element is editable, False otherwise. This property can be modified by the editable expression, which can be set during Feature Form authoring.

keyword

val keyword: String

A string to identify the attachment(s). When a file is attached using the form, this property sets the value of the keywords field for the attachment. When a form displays existing attachments, this property is used to query attachments with an exact match on the keywords field.

Inherited properties

description

val description: String

A detailed description of the element.

isVisible

val isVisible: StateFlow<Boolean>

The form element's visibility. This property can be modified by the visibility expression.

label

val label: String

A descriptive label that appears with the element. If not supplied, a FieldFormElement is labeled with the alias property of the associated field.

Functions

addAttachment

fun addAttachment(name: String, contentType: String, data: ByteArray): FormAttachment

Adds a new attachment to this AttachmentsFormElement.

suspend fun addAttachment(name: String, contentType: String, filePath: String): Result<FormAttachment>

Adds a new attachment to this AttachmentsFormElement from the specified file.

addAttachmentOrNull

fun addAttachmentOrNull(name: String, contentType: String, data: ByteArray): FormAttachment?

Adds a new attachment to this AttachmentsFormElement.

deleteAttachment

fun deleteAttachment(attachment: FormAttachment)

Deletes an attachment from the Feature.

fetchAttachments

suspend fun fetchAttachments(): Result<Unit>

Fetches the attachments from the Feature and populates AttachmentsFormElement.attachments. Attachments are not re-fetched if they have already been fetched.

Inherited functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toJson

fun toJson(): String

Convert an object to JSON string.