setReturnBodyOnly Property

Description

This property stipulates what content to retrieve from Ephox EditLive! for Java.  When set to true EditLive! for Java returns all content between the <BODY> and </BODY> tags.  When set to false EditLive! for Java returns all content between the <HTML> and </HTML> tags.  When set to auto EditLive! for Java automatically predicts what content to return. 

Syntax

JavaScript object.setReturnBodyOnly(strReturnBodyOnly)

Parameters

strReturnBodyOnly Required.  A string which specifies if only the body, the entire document is to be returned or if EditLive! for Java is to automatically what is to be returned.  If strReturnBodyOnly is true, then only the body is returned.  If strReturnBodyOnly is false then the entire document is to be returned.  If strReturnBodyOnly is auto, then EditLive! for Java is to automatically detect what is to be returned.

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

Example

The following code creates an instance of EditLive! for Java and sets it to return only content between the <BODY> and </BODY> tags. 

var editlivejava1;
editlivejava1 = new EditLiveJava("ELJApplet1","600","400");
editlivejava1.setReturnBodyOnly("true");

Remarks

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

If this property is set to true only the body will be returned.  The body consists of everything between, but not including, the <BODY> tags.

If set to false then everything between the <HTML> tags, including the <HTML> tags will be returned.

See Also