AnnotatedViews (Object)

A collection of AnnotatedView objects.

The method ("AnnotatedViews") on the root product retrieves this collection.


Methods


Func Add() As
Creates an annotated view using the current viewpoint and adds it to the AnnotatedView collection.
Returns:
The created AnnotatedView
Example:
    This example creates a new AnnotatedView in the TheAnnotatedViews collection.
    
    Dim NewAnnotatedView As AnnotatedView
    Set NewAnnotatedView = TheAnnotatedViews.Add
    
Func AddFromViewpoint( iViewpoint) As
Creates an annotated view using a given viewpoint and adds it to the AnnotatedView collection.
Parameters:
iViewpoint
The viewpoint.
Returns:
The created AnnotatedView
Example:
    This example creates a new AnnotatedView in the TheAnnotatedViews collection using a 
    AViewpoint viewpoint object.
    
    Dim NewAnnotatedView As AnnotatedView
    Set NewAnnotatedView = TheAnnotatedViews.AddFromViewpoint(AViewpoint)
    
Func Item( iIndex) As
Returns an annotated view using its index or its name from the AnnotatedViews collection.
Parameters:
iIndex
The index or the name of the AnnotatedView to retrieve from the collection of AnnotatedViews. As a numerics, this index is the rank of the AnnotatedView in the collection. The index of the first AnnotatedView in the collection is 1, and the index of the last AnnotatedView is Count. As a string, it is the name you assigned to the AnnotatedView.
Returns:
The retrieved AnnotatedView
Example:
    This example retrieves in ThisAnnotatedView the ninth AnnotatedView,
    and in ThatAnnotatedView the AnnotatedView named
    AnnotatedView3 from the TheAnnotatedViews collection. 
    
    Dim ThisAnnotatedView As AnnotatedView
    Set ThisAnnotatedView = TheAnnotatedViews.Item(9)
    Dim ThatAnnotatedView As AnnotatedView
    Set ThatAnnotatedView = TheAnnotatedViews.Item("AnnotatedView3")
    
Sub Remove( iIndex)
Removes an annotated view from the AnnotatedViews collection.
Parameters:
iIndex
The index or the name of the AnnotatedView to retrieve from he collection of AnnotatedViews. As a numerics, this index is the rank of the AnnotatedView in the collection. The index of the first AnnotatedView in the collection is 1, and the index of the last AnnotatedView is Count. As a string, it is the name you assigned to the AnnotatedView.
Example:
    The following example removes the tenth AnnotatedView and the AnnotatedView named
    AnnotatedView2 from the TheAnnotatedViews collection.
    
    TheAnnotatedViews.Remove(10)
    TheAnnotatedViews.Remove("AnnotatedView2")