Search

Module: Editor

Version: 2.2.1 +

User: Developer

Object Type: Document Object

Description

A Document is the starting point of modelling a project in Futurama. In that sense it can be compared to a Word Document, an Excel Workbook etc. It contains all objects and their properties. The Document is the item that is in fact saved to disc as an XML-file.

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

DocType (from version 3.0)

The DocType is stated at the top of every (X)HTML page. It tells the Browser what kind of code is used in the page so that the Browser knows how to interpret the code. The possible values for this property are "HTML4_Transitional" and "XHTML_1_0". Since version 17.02 DocType HTML4_Transitonal is no longer supported; an error will disappear when rendering the web pages. If DocType "XHTML_1_0" is chosen, the layout of objects that are rendered on a website will have to be set within a CSS stylesheet. More information about how objects are rendered on a website is given on the help page of the individual object.

ErrorWebPage

This property contains the WebPage that is to be shown when an error occurs in the execution of the website.

LanguageID (from version 18.02)

This property is used when the text is generated using a ResourceDocument. This property has to be a reference to a value of type long and is used to set the language for the texts. How the LanguageID is used within a Futurama application can be found on the page Text management and Multi-language.

LoginPage

This property is obligatory when the authentication mode is set to Forms. It contains the webpage which is shown initially. It is used when the user first has to login on the website before gaining access to the website itself. If the authentication mode is set to Windows Integrated or None, the webpage indicated in the property "StartWebPage" is the first webpage that is shown. Note that in order for a user to leave the LoginPage a button of type Login has to be used.

LogoffPage

De LogoffPage is the webpage to which the user is referred to when the authentication mode is set to Forms and the user clicks on a Button of type LogOff.

PageTitle

This property contains the title of the website as it appears in the browser.

ResourceDocument (from version 18.02)

This property is used when the text is defined in an external ResourceDocument. This property is a reference to a xml-file where the different resources are defined. How this property is used, can be found on the page Text management and Multi-language.

SmartNavigation (from version 3.0.0)

This property determines what happens after a postback. The value can be True or False. If the property is set to True the page will stay at exact the same spot after a postback. If the property is set to False the page will navigate back to the top after a postback.

StartWebPage

This is an obligatory property when the authentication mode is set to None or Windows. The StartWebPage is the webpage that is shown first. If the authentication mode is set to Forms the webpage defined in the property LoginPage is shown first.

TimeOutPage

The TimeOutPage is the WebPage which is shown when either a session timeout or an authentication timeout occurs. Because of a limitation in .Net a TimeOutPage works only in a session that also uses cookies. Whether or not cookies should be used has to be set in the SessionState setting in the web.config.

VersionNumber

In this property the version number of the Futurama document can be set. Version numbers of any Futurama document can be retrieved by the Formula ReadVersionNumber. A complete overview of the version numbers and other information of the Futurama document as well as it's subdocuments can be generated using the file version.aspx. The URL that has to be entered in the browser to get this information is of the form

http://

/version.aspx?Folder=

It is not required to have set a version number but it is recommended to do so. If a Futurama document is validated a message will appear when this property is empty.

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.

CalculationType

This property has two values: "Compatibility" and "Standard". It is recommended to use the CalculationType "Standard" for it assures that calculations are not executed when (part of) its input is invalid. This prevents the creation of erroneous results. The CalculationType "Compatibility" is only used when older Futurama Documents (version 3.2 and earlier) are converted to a newer version of Futurama while retaining the more 'tolerant' calculation style of the old Futurama. When validating a document Futurama will display a warning when the CalculatonType "Compatibility" is used. To prevent erroneous results it is therefore recommended to switch to CalculationType "Standard" and resolve any errors that might occur as a result.

CompatibilityMode

This setting controls the behavior of Futurama. In some occasions we change the behavior of formulas or other objects between Futurama versions. That happens only when undesired behavior is found in old versions. The compatibility mode ensures that Futurama will keep behaving in the old way. This guarantees that the results of your calculations remain the same.

The default value for Compatibility is 'Futurama_Current'. With this settings you get the most recent and correct behavior.

When you convert a document to a new version, Futurama checks if your document contains items that are affected by the compatibility setting. If that is the case, your document will get a different value for the Compatibility setting. For example ‘Futurama_5_1_4’ which ensures behavior that is compatible with Futurama 5.1.4. See here for more details.

ThrowErrorOnInfinity

This property is only visible when the CalculationType is Standard. If this property is set to 'True' Futurama will generate an error when a calculation in Futurama results in an Infinity, for example when dividing by 0. This error can be logged when desired. If this property is set to 'False' no error is generated and the string 'Infinity' is returned.

ThrowErrorOnNaN

This property is only visible when the CalculationType is Standard. If this property is set to 'True' Futurama will generate an error when a calculation in Futurama results in a NaN (Not a Number), for example when taking the square root of a negative number. This error can be logged when desired. If this property is set to 'False' no error is generated and the string 'NaN' is returned.

(Name)

The name of the object.

Comment

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

FileName

This is a read-only property that states the location and name of the Futurama document on file.

FileVersion

This is a read-only property that states the fileversion of Futurama. If the fileversion of a Futurama document does not match the fileversion of the Futurama Editor in which it is opened it will either convert the Futurama document (when its fileversion is lower than the Editor's fileversion) or give a message that the document can't be opened (when it's fileversion is higher than the Editor's fileversion).

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.

PathToDataFiles

This is a read-only property that states the path to the location of the Futurama document on file.

ValidationMessagesToIgnore

This property displays a list of all ignored validation messages. You can manually add an ignore-all, or remove previously ignored messages.

VersionInfo

This property states the most recent date and time on which the document has been saved, by which user, in which Futurama Version and on which computer.

Related Topics

- SubDocument

- ThrowErrorOnInfinity and ThrowErrorOnNaN : More information about these two properties.

- Converting Futurama documents: More information about conversion of Futurama documents.

Relevant Tutorials

- Creating a Website Application: Example of creating a Document and setting some of it's properties.

External Topics

On http://www.w3schools.com/tags/tag_DOCTYPE.asp more information can be found about DocTypes.

Updated: 2018-09-24