Add Method

Adds a new:

  • Document in the WorkSpace.
  • Event handler to the Procedures collection.
  • Line to the Lines collection of the Procedures collection.
  • DataItem to the DataItems collection.
  • Group (DataSystem) to the Groups collection.
  • Key macro to the collection, copying the definition from the passed Key macro object.

Documents Collection Syntax

object.Add([Filename], [DisplayOption])

Properties

The Add method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

Filename

String. (Optional) The ProgID for the document type. The default is “FIX.Picture”.

DisplayOption

Long. (Optional) Specifies how the document is displayed.
 

Valid entries:
1 – Load only.
2 – Load and activate the document in a hidden window.
3 – Load and display the document normally. (default)

 

Document Type

ProgID

Fix Picture

Fix.Picture

Fix Dynamo Set

FixDynamoSetServer.FixDynamoSetServer

Fix Schedule

FixSchedule.FixSchedulerServer

Microsoft Word Document

Word.Document

Microsoft Excel Worksheet

Excel.Sheet

Microsoft Excel Chart

Excel.Chart

Return Value

Object. The dispatch pointer to the added document.

Remarks

Add adds new document to the WorkSpace's application object's documents collection. It is equivalent to selecting New from the File menu.

Procedures Collection Syntax

object.Add lType, bstrProcDecl

Properties

The Add method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

lType

Long. Reserved.

bstrProcDecl

String. The header string for the procedure.

Lines Collection Syntax

object.Add bstrNewLine, lLineNumber

Properties

The Add method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

bstrNewLine

String. The new line of code to be added.

lLineNumber

Long. The line number to place the code within the event handler.

DataItems and Groups Collection Syntax

object.Add (bstrName)

Properties

The Add method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

bstrName

String. The name of the member to add.

Return Value

Object. The dispatch pointer of the item added to the collection.

 

Example

Applies To