Task
This property stipulates what content to retrieve from Ephox EditLive! if the editor is set to attach it's contents to a form submission. For more information on how EditLive! instances can attach their content to a form submission see the Retrieving Content From EditLive! and AutoSubmit Property 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
JSP Tag
ASP.NET
JavaScript
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.
 | There are only three possible values for this attribute: true, false, and auto. |
Examples
The following code would specify that only the body is to be returned.
VBScript
JSP Tag
ASP.NET Server Control
JavaScript
Remarks
When setting this property to auto, EditLive! will perform in the following way:
- If the document initially included <HTML> tags but the <HTML> tag is deleted by the user during their editing session in EditLive!, then only the content between the <BODY> tags (not including the <BODY> tags) will be retrieved.
- If the document did not initially include <HTML> tags (i.e. the document included only content from the document body) but the user adds <HTML> tags during their editing session in EditLive!, then the content between the <HTML> tags (including the <HTML> tags) will be retrieved.
- If the document initially included <HTML> tags and they are not edited by the user during their editing session in EditLive!, then the content between the <HTML> tags (including the <HTML> tags) will be retrieved.
- If the document does not initially include <HTML> tags (i.e. the document included only content from the document body) and the user does not add <HTML> tags during their EditLive! editing session, then the content between the <BODY> tags (not including the <BODY> tags) will be retrieved.
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.
If set to false then everything between the <HTML> tags, including the <HTML> tags, will be returned.