Attribute settings: Text

From CollectiveAccess Documentation
Jump to: navigation, search

[Valid for v1.6]

Represents a free-text value. This attribute supports plain text:

PlainText.png


rich text:

RichText.png

and many other specifications.

The list (array) of attribute settings can be viewed in the application code at https://github.com/collectiveaccess/providence/blob/master/app/lib/ca/Attributes/Values/TextAttributeValue.php.

Settings Description Default Values
minChars The minimum number of characters to allow. Input shorter than required will be rejected. 0 (no minimum) Integers zero or greater
maxChars The maximum number of characters to allow. Input longer than required will be rejected. 65535 Integers greater than zero
regex A Perl-format regular expression with which to validate the input. Input not matching the expression will be rejected. Do not include the leading and trailling delimiter characters (typically "/") in your expression. Leave blank if you don't want to use regular expression-based validation. Expression-based validation value
fieldWidth Width, in characters, of the field when displayed in a user interface. 40 Integers greater than zero
fieldHeight Height, in characters, of the field when displayed in a user interface. 1 Integers greater than zero
usewysiwygeditor Check this option if you want to use a word-processor like editor with this text field. If you expect users to enter rich text (italic, bold, underline) then you might want to enable this. 0 (not enabled) 0 or 1
default_text Text to pre-populate a newly created attribute with Text
suggestExistingValues Use this option if you want the attribute to suggest previously saved values as text. This option is only effective if the display height of the text entry is equal to 1. 0 (does not suggest text) 0 or 1
suggestExistingValueSort If suggestion of existing values is enabled this option determines how returned values are sorted. Choose value to sort alphabetically. Choose most recently added to sort with most recently entered values first. value value or most recently added
doesNotTakeLocale Defines whether element take locale specification 0 (takes locale) 0 or 1
canBeUsedInSort Use this option if this attribute value can be used for sorting of search results. 1 (used in sort) 0 or 1
canBeUsedInSearchForm Use this option if the attribute value can be used in search forms 1 (used in search forms) 0 or 1
canBeUsedInDisplay Use this option if the attribute value can be used for display in search results 1 (used for display) 0 or 1
displayTemplate Layout for value when used in a display. Element code tags prefixed with the ^ character, used to represent the value in the template. For example: <i>^my_element_code</i>. HTML
displayDelimiter Delimiter to use between multiple values ; (semicolon) Text
canMakePDF Check this option if this metadata element can be output as a printable PDF. (The default is not to be.) 0 0 or 1
CanMakePDFForValue Check this option if individual values for this metadata element can be output as a printable PDF. (The default is not to be.) 0 0 or 1
isDependentValue If set then this element is set using values in other fields in the same container. This is only relevant when the element is in a container and is ignored otherwise. 0 0 or 1
dependentValueTemplate Template to be used to format content for dependent values. Template should reference container values using their bare element code prefixed with a caret (^). Do not include the table or container codes. ? (HTML?)

i_sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools