ActiveField - QuickField API help

QuickField Student Edition free download     Contacts

ActiveField Technology

Objects Overview

Hierarchy Chart

How to Start: Application Object

How to work with Problems

How to work with Model

How to work with Data

How to Analyze Results

Objects

Properties

Methods

Add Method

Applies to

Summary

Adds a new empty document to the collection

Syntax

Documents.Add As IDocument
Attributes.Add As Attribute
Labels.Add As Label
FieldQuantities.Add (
   Quantity As QfQuantity )
Columns.Add (
   Quantity As QfQuantity
) As TableColumn
Rows.Add (
   Distance As Long
) As TableRow
TimePlotPoints.Add (
   p As Point
) As TimePlotPoint
Links.Add (
   LinkType As QfLinkTypes,
   TargetName As String
) As Link
Spline.Add (
   pVal As Point
) As Long

Parameters

Quantity
[in, optional] QfQuantity
Distance
[in, optional] Long
p
[in, optional] Point
LinkType
[in, optional] QfLinkTypes
TargetName
[in, optional] String
pVal
[in, optional] Point

Remarks

Generally you use the Add method to create a new element and include it to a collection. Exact type of the object created depends upon the nature of the collection that the Add method belongs to.

If the collection is of Documents type, the Add method requires no input parameters and creates a new empty document. Then you use its properties and methods to give it the contents and the SaveAs method to store the document to the file.

When adding a new column to the TableWindow you specify the Quantity parameter that defines which column you want to create.

When adding a new row to the Rows collection of the TableWindow, you give a distance from the contour starting point to the point you want to add to the table.

With a Spline object you use the Add method to create a new spline node. The coordinates of the point parameter give the node’s abscissa and ordinate.

When adding a new link to the Links collection, you specify the type of the new link, and the name of the problem file that the link refers to. Unlike the type, targetName can be changed later. Use the fully qualified file path name until you file located in the default folder.