rk.XML.optioncolumn: Create XML node "optioncolumn" for RKWard plugins

In rkward-community/rkwarddev: A Collection of Tools for RKWard Plugin Development

Create XML node "optioncolumn" for RKWard plugins

Description

These nodes are valid only inside <optionset> nodes.

Usage

rk.XML.optioncolumn(
  connect,
  modifier = NULL,
  label = TRUE,
  external = FALSE,
  default = NULL,
  id.name = "auto",
  i18n = NULL
)

Arguments

connect	Either a character string (the id of the property to connect this optioncolumn to), or an object of class XiMpLe.node (whose id will be extracted and used). For external <optioncolumn>s, the corresponding value will be set to the externally set value. For regular (non-external) <optioncolumn>s, the corresponding row of the <optioncolumn> property, will be set when the property changes inside the content-area.
modifier	Character string, the modifier of the property to connect to, will be appended to the id of connect.
label	Either logical or a character string. If given, the optioncolumn will be displayed in the <optiondisplay> in a column by that label. If set to TRUE and you provide a XiMpLe node object to connect, the label will be extracted from that node.
external	Logical, set to TRUE if the optioncolumn is controlled from outside the optionset.
default	Character string, only for external columns: The value to assume for this column, if no value is known for an entry. Rarely useful.
id.name	Character string, a unique ID for this plugin element. If "auto", an ID will be generated automatically from the connect object.
i18n	Either a character string or a named list with the optional elements context or comment, to give some i18n_context information for this node. If set to FALSE, the attribute label will be renamed into noi18n_label.

Value

An object of class XiMpLe.node.

Note

The <optionset> node was introduced with RKWard 0.6.1, please set the dependencies of your component/plugin accordingly.

See Also

rk.XML.optionset, rk.XML.optiondisplay, and the Introduction to Writing Plugins for RKWard

Examples

myInput <- rk.XML.input(label="Given name(s)", size="small")
myOptCol <- rk.XML.optioncolumn(myInput, modifier="text")

rkward-community/rkwarddev documentation built on May 9, 2022, 3:02 p.m.