Free-Conversant Support / Message Macro: msgCustomField
 Home   About Conversant   Free Sites   Hosting   Support   XML-RPC 

Search



Documentation >> Macros >> Message Macros >> msgCustomField

Message Macro: msgCustomField

Usage:

<!--#msgCustomField fieldName="A_Field_Name"-->

Overview:

If edit mode, returns a widget to editing the custom field. In view mode, returns the field's value as a string.

Required Attributes:

  • fieldname="[string]" : Name of the custom field to be displayed.

Optional Attributes:

  • msgNum="[number/special value]" : Used to override the context's default message number. Values can be the number of a message, or relative to the context's message. Acceptable relative values are: "next" (next valid message), "prev" (previous valid message), "nextThread" (top of next thread), "prevThread" (top of previous thread), "top" (first message in current thread), "inresponseto" (the message the current message is a reply to).
  • noValueText="[string]" : Text to be displayed if no value is currently assigned to the field.
  • editing="[true/false]" : Used to override the context's default editing mode. Edit mode is typically determined by context, ie, when on a new thread page, reply page, or editing a message, editing is true and an editing widget will be returned by the macro. By overriding this value, in combination with conditional macros, you might choose to make a particular custom field visible but not editable by members of certain groups, etc.
  • valueOnly="[true/false]": Return the raw value(s) for the specified field, rather than the text version of the value(s). For example, a popup menu stores its values in the database as numbers, but normally displays the names associated with those values. Setting the valueOnly attribute to true overrides that default behavior.
  • Many other attributes are available, but are specific to the datatype of the custom field. For example, a date custom field will support all the attributes supported by the #msgCreationDate macro for controlling the format of the output. In edit mode, widget "size", "maxlength" attributes will be supported for short text custom fields, etc.
View in DG


This site managed with Conversant, © Copyright 2008 Macrobyte Resources