Range

Objects > Range

Module: Editor

Version: 2.2.1 - 20.08

User: Developer

Object Type: Calculation Object

Parent of:

no children

Child of:

- Node

- Document

- DatabaseView

Description

Note: The Range object does not exist anymore from version 20.09 onwards; it is replaced by the Range-formulas. Range objects from previous versions are automatically converted to the new Range formula.

A Range is a series of numbers or dates starting at a given startnumber (or startdate) and ending at a given endnumber (or enddate) using a given stepsize.

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.

ReturnsTable (until version 5.0)

This is an automatic property indicating whether the result of the Calculation object is a table. For a Range it is always True. From version 5.1.0 the ReturnsTable property is replaced by the Rank property (see property below).

Rank (from version 5.1)

The Rank property is an automatic property indicating the rank of the Calculation Object. Rank=0 implies a scalar. Rank=1 a vector and Rank=2 a matrix. For a Range the Rank=1.

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.

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.

Text

Here the start number/date and end number/date can be defined between which the Range will be created. Also the stepsize and the sign be stated. After the Range has been defined the property shows in x*1 format the number of rows (x) of the Range.

Type

The value of this property determines what kind of values can be entered at the property Text. The following types are available:

Long (an integer)
Double (a broken number)
Date

Editing

Before a Range can be defined the type of the values that will be entered in the Range has to be denoted in the property 'Type'. Next the Range can be edited by either a a doubleclick on the Range in the Design Window or by first clicking on the property Text in the Properties Window of the Range and then on the editing box on the right of the property. Both methods will open up a window where the Range can be defined.

For a Range three things have to be defined: the first element of the Range (the 'From'-field), the last element of the Range (the 'To'-field) and the stepsize of the elements that are in between the first and last element. All can be either Fixeds, References or Formulas. If the chosen Type is a date, then the stepsize has to be specified for the day, the month and the year. If the last element specified in the 'To'-field can't be reached exactly the stepsize, the Range will stop at the last element before exceeding the value in the 'To'-field. If an impossible Range has been defined such as from 1 to 5 with stepsize -1, the Range will produce a error.

Relevant Tutorials

- Working with Tables: Select part 4 of this tutorial to see how a Range is created and used.

Updated: 2012-07-24