Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
     Glossary
   eZ Publish 4.x / legacy

 
eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add horizonal rules

This FieldType represents a block of unformatted text.

NameInternal nameExpected input type
TextBlockeztextstring

Table of contents:

Table of Contents
minLevel2

Description


The FieldType handles a block of multiple lines of unformatted text. It is capable of handling up to 16,777,216 characters.

Input expectations


Type
Example
string
"This is a block of unformatted text"

Value object


Properties

The Value class of this field type contains the following properties:

Property
Type
Description
$textstringThis property will be used for the text content.

String representation

A TextBlock's string representation is the the $text property's value, as a string.

Constructor

The constructor for this value object will initialize a new Value object with the value provided. It accepts a string as argument and will import it to the $text attribute.

Validation


This FieldType does not perform any special validation of the input value.

Settings


Settings contain only one option:

NameTypeDefault valueDescription
textRowsinteger10Number of rows for the editing control in the administration interface.