package snipe.edit

typedef _ExportBlock

Module export page block. All of these parameters are optional, except for the block type.

Properties

optional action:Null<String>

Link action. Used with BLOCK_LINK block type.

optional actionPost:Null<String>

List action postfix. Used with BLOCK_LIST block type.

optional actionPre:Null<String>

List action prefix. Used with BLOCK_LIST block type.

optional actions:Null<Array<String>>

List actions list. Used with BLOCK_LIST block type.

optional actionsConfirm:Null<Array<Bool>>

Confirm actions flags list. Used with BLOCK_LIST block type.

optional enctype:Null<String>

Form encoding. Used with BLOCK_FORM block type.

optional fields:Null<Array<String>>

List columns. Used with BLOCK_LIST block type.

optional fieldsExt:Null<Array<{param:Null<String>, name:String, func:Null<Dynamic ‑> Vars ‑> String ‑> Void>}>>

Extended list columns. Used with BLOCK_LIST block type.

Parameters:

name

Column name.

param

Parameter to get from "params" row field.

func

Function to process and display that column. Its arguments are: database row, request variables, user permissions string.

optional file:Null<String>

Local file name. Used with BLOCK_SWF block type.

optional func:Null<Vars ‑> Void>

Module method to call. Used with BLOCK_FUNC block type.

optional height:Null<Int>

SWF object height. Used with BLOCK_SWF block type.

optional htmlPost:Null<String>

HTML code to output after the block.

optional htmlPre:Null<String>

HTML code to output before the block.

optional inputs:Null<Array<_BlockFormInput>>

Block types list. Used with BLOCK_FORM block type.

optional isDisabledInProduction:Null<Bool>

If enabled, this block is disabled in production. Production status is controlled by server.isProduction configuration variable.

optional pageAction:Null<String>

Action postfix for next list page link. Used with BLOCK_LIST block type.

optional pageCount:Null<String>

List page count query. Used with BLOCK_LIST block type.

optional pageRows:Null<Int>

Maximum rows count for list page. Used with BLOCK_LIST block type.

optional position:Null<Int>

Page block position in page.

Note: You should not set this in module exports, this value is assigned automatically. However, if you inject a block into the page, you can set its position here.

optional query:Null<String>

List or form SQL query. Used with BLOCK_LIST, BLOCK_FORM block types.

optional queryTrace:Null<Bool>

If enabled, display query string on page. Used with BLOCK_LIST, BLOCK_FORM block types.

optional rawValues:Null<Bool>

When enabled, will display list values as raw HTML without HTML.quote(). Used with BLOCK_LIST block type.

optional sortDir:Null<Bool>

List sort direction. False - ascending, true - descending. Used with BLOCK_LIST block type.

optional sortField:Null<String>

List sort column ID. Used with BLOCK_LIST block type.

optional title:Null<String>

Page block title.

type:_BlockType

Page block type.

optional values:Null<List<Dynamic>>

List of list values. Used with BLOCK_LIST block type. "values" and "query" parameters are mutually exclusive.

optional width:Null<Int>

Form or SWF object width. Used with BLOCK_FORM, BLOCK_SWF block types.