TreeAge Pro


TreeObj Overview
TreeObj Overview

TreeAge Pro - Table of Contents

TreeAge Pro Interactive - Table of Contents
TreeAge Pro Interactive - TreeObj Object

Documentation Home
TreeAge Website Home
 Notes
  
 Many methods and properties of TreeObj objects in TreeAge Pro 2007/8 are also available in TreeAge Pro Interactive (a.k.a. the 'Interactive/ActiveX version').

A key difference between the TreeObj implementations in TreeAge Pro vs. the Interactive version is that you do not create TreeObj instances in TreeAge Pro (e.g. using "New"). Instead, you "Get()" them from the ApplicationObj.

Methods and properties shown in gray have not been implemented in TreeAge Pro. Some may be added eventually.


 
 Methods
  
 
File operations
OpenFile [Use ApplicationObj.getTreeObj method instead.]
OpenPackage [Use ApplicationObj.getTreeObj method instead.]
SaveFile [Use ApplicationObj.topDocSaveAs method instead.
First ensure that the tree document is the top document in the
application window via ApplicationObj.getTreeObj].
Associate [Not used in TreeAge Pro, only TreeAge Pro Interactive.]
IsValid Ensures that the tree is usable
SaveGraphic Saves a pictorial representation of the tree
GetImageBinary Returns an image (GIF only currently) in binary format for display in a browser
Node operations
SelectRoot Selects the root node of the tree
SelectRelativeNode Selects a node related to the current selection
SelectNodeObj Selects the node from a previously-created NodeObj object
GetNodeObj Retrieves a NodeObj at the selected node
Analysis methods
RollBack Turns roll-back on or off
Sensitivity Runs a 1-way sensitivity analysis
SensitivityTwo Runs a 2-way sensitivity analysis
Tornado Runs a tornado sensitivity analysis
Markov Runs a Markov analysis
MonteCarlo Runs a Monte Carlo simulation
CostEff Runs a baseline cost-effectiveness analysis
ProbDist Calculates the risk profile
OverUnder Calculates the probability of being over a given target
Miscellaneous methods
SetCalcMethod Sets the active calculation method
GetNumForm Retrieves a NumFormObj which describes the numeric formatting for the tree
SetNumForm Sets the numeric formatting for the tree from a NumFormObj
GetTable Retrieves a TableObj to enable manipulations of table values
SetDatabasePassword Set password for given database [v1.15, Jan-06]
GetLastTimes Get time spent on the last operation
SetPreferencesFromXML Reserved for future use
Methods moved from CurrentTree... [v2.0; Feb-2007]
isReady Is tree busy
Variable methods - Create/define variables
defineNewVariable Create a new variable with basic properties and no definition
defineUpdateVariable2 Create or update a variable and set all properties including the default definition (v2007)
defineUpdateVariable Obsolete -- Use defineUpdateVariable2 instead with v2007 or higher
setVariableValue Define a variable at the root or at a specific node
Variable methods - Get variable values/properties
getVariableProperties Get a variable's properties via the variable name
getVariableValue Get a definition of a variable
isVariableDefined Determine if a variable exists
Variable methods - Cycle through all variables
getVariablesCount Count definitions at a node
getVariableName Get the name of the i-th defined variable at a node
Table methods
getTable Get a table object from the tree
getTableProperties Get properties of a defined table
defineTableProperties Define or update properties of a table
defineTableData Overwrite current contents of a table
Distribution methods
getDistributionProperties2 Output the properties of a distribution (v2008)
defineDistribution2 Create or update properties of a distribution (v2008)
getDistributionProperties Obsolete -- Use getDistributionProperties2 instead with v2008 or higher
defineDistribution Obsolete -- Use defineDistribution2 instead with v2008 or higher
Bilink methods
getBilinkProperties Get dynamic link properties
defineBilink Dynamically link current tree document to a specified spreadsheet cell/range
defineInputVariableLink Dynamically link a specified spreadsheet cell to a TreeAge variable
getBilinkCount Get number of links to spreadsheet cells
getBilinkIndex Get index of a link to a specified cell
selectNodeUsingBilink Select a node with a variable defined equal to a linked cell

 
 Properties
  
 
Calculation properties
calcMethod Retrieves the current calculation method
isCE Flag indicating if the tree is a cost-effectiveness tree
currentPayoff Retrieves the current payoff (for simple trees)
costPayoff Retrieves the payoff being used for costs
effPayoff Retrieves the payoff being used for effectiveness values
benefitPayoff Retrieves the payoff being used for benefits
rollBackOn Flag indicating if roll-back has been turned on
calcTime Retrieves the time required for the last analysis operation
Graphic properties
graphicFileWidth Gets the width of the last file saved in SaveGraphic
graphicFileHeight Gets the height of the last file saved in SaveGraphic
imageBinarySize Gets the size of the buffered image in bytes
Miscellaneous properties
selection Retrieves the name of the currently-selected node
fileName The full path of the tree, as passed in to OpenFile
eventFlags Indicates which callback events are requested
lastError The error code of the last analysis
errorMsg Retrieves the last error message (for debugging)
message Retrieves a status message (for debugging)