Page tree
Skip to end of metadata
Go to start of metadata

This property stipulates what content to retrieve from Tiny EditLive!. It affects the following:

For more information on how EditLive! instances can attach their content to a form submission see the Retrieving Content From EditLive! and setAutoSubmit Method articles.

When set to true, EditLive! returns all content between the <body> and </body> tags, not including the <body> and </body> tags. When set to false, EditLive! returns all content between the <HTML> and </HTML> tags. When set to auto, EditLive! automatically predicts what content to return.

Syntax

Visual Basic Script
object.ReturnBodyOnly = strReturn
ASP.NET
prefix:EditLiveJava ReturnBodyOnly = strReturn
JavaScript
editliveInstance.setReturnBodyOnly(strReturn);

Parameters

strReturn

A string which specifies if only the body, or if the entire document is to be returned, or if EditLive! is to automatically detect what is to be returned. If strReturn is true, then only the body is returned. If strReturn is false, then the entire document is to be returned. If strReturn is auto, then EditLive! is to automatically detect what is to be returned (see below).

There are only three possible values for this attribute: true, false, and auto.

The default value is true.

Examples

The following code would specify that only the body is to be returned.

VBScript
editlive1.ReturnBodyOnly = "true"
ASP.NET Server Control
<elj:EditLiveJava
  ...
  ReturnBodyOnly = "true" 
  ... 
/>
JavaScript
editlive_js.setReturnBodyOnly("true");

Remarks

The default of this property is true. Hence, if this attribute is not included in your code, by default only the body will be returned. The body consists of everything between, but not including, the <body> tags.

When setting this property to auto, EditLive! will perform in the following way:

  • If the content is set using the setDocument Method, a whole document is returned
  • If the content is set using the setBody Method, only the content within the <body></body> tag is returned
  • If the content is set for an Inline Editing section using the setContentForEditableSection Method, the content returned depends on the content set - if a whole document is set, a whole document is returned; if a fragment is set, a fragment is returned
  • If the content is set for an Inline Editing section using the related textarea, the content returned depends on the content set.
  • If the content is set for an Inline Editing section by populating the Inline Editing element (not recommended), the content returned depends on the content set. 

 

  • No labels