Element Types

Table of Contents

Previous | Top | Next

Element

All elements derive from Element and have access to its various properties. They can be accessed with the following syntax: [ELEMENT.<property-name>].

 

Name - The name of the element.
Code - The element's code as raw text.
Formatted_Code - The element's code as formatted HTML with syntax highlighting.
Notes - The element's notes text.
Link - The relative link to the element's HTML page.
Parent_Link - The link the the parent element's HTML page.
Previous_Link - The relative link to the previous element's HTML page if the element is not the first.
Next_Link - The relative link to the next element's HTML page if the element is not the last.
Icon - The icon associated with the element type (not applicable for Code Element and Parameter elements).
Element_Name - The name of the element for use in alt tags for example.

 

Element has various properties that can be used as conditions in IF statements.

 

Has_Code - Whether or not the element has code attached to it.
Has_Notes - Whether or not the element has notes attached to it.
Has_Child_Notes - Whether or not any of the element's descendants have notes associated with them.
Has_Parent - Whether or not the element has a parent element.
Has_Children - Whether or not the element has children.
Is_Included - Whether or not the element is included based on the Include and Exclude rules.
Are_Children_Included - Whether or not at least one of the element's children are included based on the Include and Exclude rules.

 

Solution

Solution elements have no specific properties but can access the Element properties with the following syntax: [SOLUTION.<property-name>].

 

Project

Project elements have no specific properties but can access the Element properties with the following syntax: [PROJECT.<property-name>].

 

Code File

Code File elements have no specific properties but can access the Element properties with the following syntax: [CODEFILE.<property-name>].

 

Attribute

Attribute elements have no specific properties but can access the Element properties with the following syntax: [ATTRIBUTE.<property-name>].

 

Code Line

Code Line elements have no specific properties but can access the Element properties with the following syntax: [CODELINE.<property-name>].

 

Comment Line

Comment Line elements have no specific properties but can access the Element properties with the following syntax: [COMMENTLINE.<property-name>].

 

Class

Class elements have no specific properties but can access the Element properties with the following syntax: [CLASS.<property-name>].

 

Enum

Enum elements have no specific properties but can access the Element properties with the following syntax: [ENUM.<property-name>].

 

Interface

Interface elements have no specific properties but can access the Element properties with the following syntax: [INTERFACE.<property-name>].

 

Namespace

Namespace elements have no specific properties but can access the Element properties with the following syntax: [NAMESPACE.<property-name>].

 

Procedure

Procedure elements have access to the following properties:

 

Return_Type - The procedure's return type.
Pseudocode - The procedure's pseudocode as formatted HTML with syntax highlighting.
Flowchart - The relative link to the flowchart image.
Flowchart_Small - The relative link to a 700 pixel wide version of the flowchart image,
Flowchart_Thumbnail - The relative link to a 250 pixel wide version of the flowchart image,

 

Procedure elements have access to the following conditional properties:

 

Has_Return_Type - Whether or not the procedure has a return type.
Has_Parameters - Whether or not the procedure has at least one parameter.

 

Constructor

Constructor elements have access to the following properties:

 

Pseudocode - The procedure's pseudocode as formatted HTML with syntax highlighting.
Flowchart - The relative link to the flowchart image.
Flowchart_Small - The relative link to a 700 pixel wide version of the flowchart image,
Flowchart_Thumbnail - The relative link to a 250 pixel wide version of the flowchart image,

 

Constructor elements have a Has_Parameters property that can be used in conditions to check if the constructor has at least one parameter.

 

Destructor

Destructor elements have access to the following properties:

 

Pseudocode - The procedure's pseudocode as formatted HTML with syntax highlighting.
Flowchart - The relative link to the flowchart image.
Flowchart_Small - The relative link to a 700 pixel wide version of the flowchart image,
Flowchart_Thumbnail - The relative link to a 250 pixel wide version of the flowchart image,

 

Code Element

Code elements have access to the following properties:

 

Type - The type of code element.
Text - The text of the code element.

 

Property

Property elements have no specific properties but can access the Element properties with the following syntax: [PROPERTY.<property-name>].

 

Structure

Structure elements have no specific properties but can access the Element properties with the following syntax: [STRUCTURE.<property-name>].