ExternalID Property

Description

Represents the external ID.

For objects of type SAVE_ALIGN, it should be the name of the alignment being saved to a file. For example, if you are saving alignment ‘A2’ to a file, set ExternalID to “A2”.
For objects of type RECALL_ALIGN set to recall an external alignment file, ExternalID should be set to “External”.

Note: for releases prior to 2012, the required value is whatever the corresponding SAVE_ALIGN object ExternalID was set to, for example “A2”.

For objects of type RECALL_ALIGN set to recall an internal alignment, this property should be set to the name of the internal alignment being recalled.

Property type

Read-write property

Syntax

Visual Basic
Public Property ExternalID As String

Return Type

Read/write String.

Remarks

This function only works for objects of type RECALL_ALIGN and SAVE_ALIGN. If used on an object other than a RECALL_ALIGN or SAVE_ALIGN, setting this variable will do nothing, and getting this variable will return the empty string.

For SAVE_ALIGN objects and external file RECALL_ALIGN objects, PC-DMIS version 2012 and newer will attempt to repair invalid ExternalID values. For example, if a 2011 MR1 version of ExternalID is used, it will be automatically converted to the correct 2012 format.