EntrySummaryTextType Property

This property contains the text type of the summary of the entry.

Syntax

 atom.getEntrySummaryTextType(index, [callback])
 atom.setEntrySummaryTextType(index,  entrySummaryTextType, [callback])

Possible Values

  0 (ttText), 
  1 (ttHTML), 
  2 (ttXHTML)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getEntrySummaryTextType([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setEntrySummaryTextType([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property contains the text type of the summary of the entry. Atom textual content can either be html, xhtml or text.

The size of the array is controlled by the EntryCount property.

This property is not available at design time.

Data Type

Integer