Skip to main content
CYPEX Documentation
Support
v2.0.0 Latest stable release View changelog ->
Various Referencegenerated

Delete Button

Delete the current record

Technical id
default_delete_button
Translation keys
labeliconRighticonLefttitlewarningsubmitTitlecancelTitle

A button that deletes the record it is bound to, optionally behind a confirmation dialog.

When to use

  • Removing the record shown by the surrounding form, or the row it sits in inside a table body.

What you need

Needs a record to act on: either the parent form’s record, or the row it is placed in when used as a table body element.

Examples

  • A row action that removes the record from a table.
  • A Delete control beside Save on a detail form.

Avoid

  • Leaving the confirmation off for destructive deletes — there is no undo.
  • Placing it in a table body without checking the row’s permissions, which offers an action that will fail.

Editor properties

Configure these in the Application Designer property panel. Group headings mirror the editor where possible. Data Source is where the element gets its rows or field binding (a view/query, a connector operation, or a parent form field). References appear only for view-backed sources and map foreign-key ID columns to readable labels from another view.

Required
Data SourcerequiredSettings group
Where this element loads its data (view, query, connector, or element).
Default: none
Optional
ColoroptionalOne of: primary, secondary, default
Configuration for color.
Choices
  • primary
  • secondary
  • default
Default: none
DisabledoptionalYes / no or Custom expression (yes/no)
When true, the control cannot be edited.
Default: none
IconoptionalText
Configuration for icon.
Default: none
PlacementoptionalOne of: top, bottom, left, right
Label position relative to the input control.
Choices
  • top
  • bottom
  • left
  • right
Default: none
Show WarningoptionalYes / no
Configuration for show Warning.
Default: none
SizeoptionalOne of: small, medium
Configuration for size.
Choices
  • small
  • medium
Default: none

Inside dataSource: (dataSource)

Element IDrequiredNumber or Text
Another element on the page whose data backs this field.
Default: none

Sizing

  • No size of its own: dropped at the platform default of 1 × 1 grid cells and resized on the page.

Where you can place it

Drag this element into one of these containers:

Placement notes

  • Table (body slot) — As a row action it deletes that row’s record. Pair it with a table reload so the list reflects the deletion.
1
2
3
4
5
6
7
{
  "config": {
    "dataSource": {
      "elementId": "myElement"
    }
  }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "config": {
    "dataSource": {
      "elementId": "myElement"
    },
    "showWarning": false,
    "icon": "icon",
    "disabled": false,
    "color": "primary",
    "size": "small",
    "placement": "top"
  }
}