Search

Module: Editor

Version: 2.2.1 +

User: Developer

Object Type: Document Object

Parent of:

no children

Child of:

- Document

 

Description

A SubDocument is an object which is used to make a reference to another Futurama Document. By doing this you gain access to all objects that are located in this other Document.

Properties

DebugLogMode (from version 4.1)

Indicates the level of detail of debug information that is logged when running a Futurama application (website, webservice, console application) to the trace, a logfile, a database etc. The possible values are:

  • None: no debug information is logged
  • Simple: only basic information is given
  • Extended: in addition to the information in the Simple mode the values of all the properties of the object are shown

IsPublic

Possible values are True or False. If the value is False, then the object can only be used within the document where it is created. If the value is True, then also from other Futurama documents can be referred to this object. This means that changes in the object also affect the document in which is referred to this object. If the value is True and you attempt to move or delete the object, a warning will be given. To limit these warnings to a minimum it is recommended to set IsPublic to True only when necessary.

LateBinding

This property regulates the moment of loading of the SubDocument during runtime. It can be set to True or False. If the value is True then the SubDocument is not loaded into memory until a reference is made to an object in the SubDocument. If the value is False then the SubDocument is loaded together with the Document containing the SubDocument. Especially in situations in which a SubDocument is large and rarely used by the document, it is advised to set LateBinding to True in order to improve performance.

XmlName

The name of the object as it is shown in the source of the website. By default the XmlName is equal to the name given in the property (Name) with spaces replaced by underscores, but you are free to change it.

(Name)

The name of the object.

Comment

Here a comment can be entered. For example a short description of the object.

FileName

The Futurama document which is to be included as subdocument.

ID

The unique identification number of the object. This number is automatically generated by Futurama on the moment of creation. This number can be used when searching for a certain object in the Find Window.

Use of SubDocuments

SubDocuments offer you the opportunity to model your application in several distinct 'modules' each represented by a Document. These 'modules' can then be connected. For example if you have multiple websites that use the same calculations, you only need to make one Futurama Document containing the calculations. This Document is then used (as a SubDocument) by all Documents that contain the websites.

Related Topics

- Document

Updated: 2012-08-22