Documentation for class text_document (inherits from file):


Properties:

name type default params representant foreign foreign_prop position
id CO_INTEGER SEQUENCE READONLY=1;HIDDEN=1 0 0
version CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
deleted CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
name CO_STRING '' 0 44
file_version CO_INTEGER 0 0 100

Methods:


method getContentType
description: returns content-type which will be put into http header
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method getPath
description: returns partial path to text object data file
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method create
description: creates new object
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

create_params
description: this is array of additional parameters that we can pass to target class to create object
type CO_ARRAY_OF_STRINGS

dont_set_acl
description: If this param is set to 1 we do not set ACL for __PERMISSION_CHANGE_ACL for created object
type CO_INTEGER


method viewTextDocument
description: generate client view interface
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method writeTextAndEvalAsASP
description: write text of document and treat text_document as asp file and evaluate it
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

text
description: this is new text to be written for curent text_document
type CO_STRING


method evalTextDocumentAsASP
description: treat text_document as asp file and evaluate it
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

args
description: replacement parameters for the ASP page
type CO_STRING


method getTextDocument
description: get a copy of text_document content
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method browseTextDocumentVersions
description: generates HTML version-browser
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

version_number
type CO_INTEGER


method showTextDocumentVersion
description: show particular version of text_document as HTML
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

version_number
type CO_INTEGER


method editTextDocument
description: generates client interface to edit document
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method saveFormToTextDocument
description: saves HTML form to text_document file
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

text_document_data
type CO_STRING

text_document_action_param
type CO_STRING

active_path
type CO_STRING