navigator_interfaces¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property BehaviorMode() As CatAnnotatedViewBehavior

Returns or sets the behavior mode of the annotated view. This behavior mode

enables the annotated view to be independant from the

viewpoint.

Example:

This example retrieves the behavior mode of the NewAnnotatedView

annotated view.

Dim Mode

Mode = NewAnnotatedView.BehaviorMode

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Comment() As CATBSTR

Returns or sets the comment associated with the annotated

view.

Example:

This example retrieves the comment of NewAnnotatedView annotated

view.

Dim text As String

text = NewAnnotatedView.Comment

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FieldOfView() As double (Read Only)

Returns the field of view associated with the annotated view. The field of

view is half of the vertical angle of the viewpoint, expressed in degrees. This

property exists with the perspective (conic) projection mode

only.

Example:

This example retrieves the field of view of the NewAnnotatedView

annotated view.

Dim Field As Double

Field = NewAnnotatedView.FieldOfView

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetOrigin(CATSafeArrayVariant oOrigin)

Retrieves the coordinates of the origin of the 3D viewpoint of the

annotated view.

Parameters:

oOrigin

The coordinates of the view point origin expressed as an array of 3

variants are:

oOrigin(0) is the X coordinate of the origin

oOrigin(1) is the Y coordinate of the origin

oOrigin(2) is the Z coordinate of the origin

Example:

This example retrieves the origin of the 3D viewpoint of the

NewAnnotatedView annotated view.

Dim origin(2)

NewAnnotatedView.GetOrigin origin

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetSightDirection(CATSafeArrayVariant oSight)

Retrieves the components of the sight direction of the 3D viewpoint of the

annotated view. The sight direction is the line that passes by the origin of

the viewpoint and by the target.

Parameters:

oSight

The components of the viewpoint sight direction expressed as an

array of 3 variants are:

oSight(0) is the X component of the sight

direction

oSight(1) is the Y component of the sight

direction

oSight(2) is the Z component of the sight direction

Example:

This example retrieves the sight direction of the NewAnnotatedView

annotated view.

Dim sight(2)

NewAnnotatedView.GetSightDirection sight

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetUpDirection(CATSafeArrayVariant oUp)

Retrieves the components of the up direction of the 3D viewpoint of the

annotated view.

Parameters:

oUp

The components of the viewpoint up direction expressed as an array

of 3 variants are:

oUp(0) is the X component of the up direction

oUp(1) is the Y component of the up direction

oUp(2) is the Z component of the up direction

Example:

This example retrieves the up direction of the NewAnnotatedView

annotated view.

Dim up(2)

NewAnnotatedView.GetUpDirection up

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Marker2Ds() As Marker2Ds (Read Only)

Returns the Marker2D Collection associated with the annotated

view.

Example:

This example retrieves the TheMarker2Ds

collection

from the NewAnnotatedView annotated view.

Dim TheMarker2Ds As AnnotatedView

Set TheMarker2Ds = NewAnnotatedView.Marker2Ds(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ProjectionMode() As CatProjectionMode (Read Only)

Returns the projection mode of the annotated view. This projection mode is

the one of the associated 3D View point.

Example:

This example retrieves the projection mode of the NewAnnotatedView

annotated view.

Dim Mode

Mode = NewAnnotatedView.ProjectionMode

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Sound() As CATBSTR

Returns or sets the path of the sound file associated with the annotated

view.

Parameters:

iPath

The path of the sound file. If this path is not empty, the sound

replaces the old associated one (if it exists) or creates a new association (if

not). If this path is empty, the sound is removed.

Returns:

The path of the sound file. If this path is empty, the annotated view

has no associated sound.

Example:

This example retrieves the path of the sound file associated with

the NewAnnotatedView annotated view.

Dim path As String

path = NewAnnotatedView.Sound

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Update()

Updates the annotated view: that is to take into account all modifications

which occur since last update.

Example:

This example updates the NewAnnotatedView annotated

view.

NewAnnotatedView.Update

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Zoom() As double (Read Only)

Returns the zoom factor associated with the annotated view. This property

exists with the parallel (cylindric) projection mode only. This zoom factor is

the one of the associated 3D View point.

Example:

This example retrieves in ZoomFactor the zoom of the

NewAnnotatedView annotated view.

Dim ZoomFactor As Double

ZoomFactor = NewAnnotatedView.Zoom

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add() As AnnotatedView

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func AddFromViewpoint(Viewpoint3D iViewpoint) As

AnnotatedView

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As AnnotatedView

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”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant 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”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub CacheExport(CATBSTR iDirectory,

CATBSTR iPrefix,

long iData)

Exports all documents related to the product in a

directory.

Parameters:

iDirectory

The directory that will contain documents.

iPrefix

The prefix used to save product documents.

iData

To save geometries.

0: no save.

1: save.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub CacheImport(CATBSTR iDirectory)

Imports in the cache of marked documents in a directory.

Parameters:

iDirectory

The directory that contains marked documents.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Collapse()

Collapse the product by replacing all sub-product by corresponding

components.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ReplaceByCGR(CATBSTR iDirectory,

CATBSTR iPrefix)

Replaces all components of the product by the corresponding CGR located in

a directory.

Parameters:

iDirectory

The directory that will contain documents.

iPrefix

The prefix used to save product documents.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SaveAsFrozen(CATBSTR iDirectory,

CATBSTR iPrefix,

long iData,

long iCache)

Saves all documents related to the product in a directory.

Parameters:

iDirectory

The directory that will contain documents.

iPrefix

The prefix used to save product documents.

iData

To save geometries.

0: no save.

1: save.

iCache

To cache data.

0: no save.

1: save.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Activation() As long

Returns or sets the activation.

Returns:

The activation

0: the DMU Review is inactivated.

1: the DMU Review is activated.

Example:

This example retrieves the activation of the oDMUReview DMU Review

and activates it.

Activation = oDMUReview.Activation

oDMUReview.Activation = 1

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DMUReviews() As DMUReviews (Read Only)

Returns the DMUReviews Collection associated with the DMUReview

(children).

Example:

This example retrieves the cDMUReviews collection

from the oDMUReview DMU Review.

Set cDMUReviews = oDMUReview.DMUReviews(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add() As DMUReview

Creates a DMUReview and adds it to the DMUReviews

Collection.

Returns:

The created DMUReview

Example:

This example creates a new DMUReview in the cDMUReviews

collection.

Set oDMUReview = cDMUReviews.Add

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Current() As CATBaseDispatch (Read Only)

Returns the current DMUReview.

Returns:

The current DMUReview (the collection is returned if there is no

current review)

Example:

This example retrieves the current oDMUReview DMU

Review

from the cDMUReviews collection.

Set oDMUReview = cDMUReviews.Current

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ImportFrom(Product iProduct) As DMUReview

Imports Applicative data froma given product in a new DMU

Review

Parameters:

iProduct

The product to import applicative data from

Returns:

The created DMUReview

Example:

This example imports a new DMUReview from a product in the

cDMUReviews collection.

Set oDMUReview = cDMUReviews.ImportFrom(iExistingProduct)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As DMUReview

Returns a DMUReview using its index or its name from the DMUReviews

collection.

Parameters:

iIndex

The index or the name of the DMUReview to retrieve from the

collection of DMUReviews. As a numerics, this index is the rank of the

DMUReview in the collection. The index of the first DMUReview in the collection

is 1, and the index of the last DMUReview is Count. As a string, it is the name

you assigned to the DMUReview.

Returns:

The retrieved DMUReview

Example:

This example retrieves in oThisDMUReview the ninth

DMUReview,

and in oThatDMUReview the DMUReview named

DMUReview3 from the cDMUReviews collection.

Set oThisDMUReview = cDMUReviews.Item(9)

Set oThatDMUReview = cDMUReviews.Item(“DMUReview3”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant iIndex)

Removes a DMUReview from the DMUReviews collection.

Parameters:

iIndex

The index or the name of the DMUReview to retrieve from the

collection of DMUReviews. As a numerics, this index is the rank of the

DMUReview in the collection. The index of the first DMUReview in the collection

is 1, and the index of the last DMUReview is Count. As a string, it is the name

you assigned to the DMUReview.

Example:

The following example removes the tenth DMUReview and the

DMUReview named

DMUReview2 from the cDMUReviews collection.

cDMUReviews.Remove(10)

cDMUReviews.Remove(“DMUReview2”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddExplicit(CATBaseDispatch iProduct)

Adds a product to the group.

Parameters:

iProduct

The product to add

Example:

This example adds the product MyProduct to the group

NewGroup.

NewGroup.AddExplicit MyProduct

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CountExplicit() As long

Returns the number of products in the group.

Example:

This example retrieves the number of products in the group

NewGroup.

Dim number As Integer

number = NewGroup.CountExplicit

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CountExtract() As long

Returns the number of products which can be extracted from the

group.

Depending on the extraction mode, the extracted products can

be:

Mode = 0: the products from the group (intermediate or terminal nodes).

Mode = 1: the terminal nodes of the products from the group.

Returns:

The number of products

Example:

This example reads the number of products in the group

NewGroup.

Dim number As Integer

number = NewGroup.CountExtract

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CountInvert() As long

Returns the number of terminal node products which cannot be extracted from

the group.

Example:

This example retrieves the number of terminal node products which

cannot be extracted from the group NewGroup.

Dim number As Integer

number = NewGroup.CountInvert

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ExtractMode() As long

Returns or sets the mode for the extraction methods.

Returns:

The extraction mode

0: the extraction provides the products from the group

(intermediate of terminal nodes).

1: the extraction provides terminal nodes of the products from the

group.

Example:

This example retrieves the extraction mode of the NewGroup Group

and sets it to 1.

Dim Mode As Integer

Mode = NewGroup.ExtractMode

NewGroup.ExtractMode = 1

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub FillSelWithExtract()

Fills the selection with all products which can be extracted from the

group.

Example:

This example fills the selection with products which can be

extracted

from the NewGroup group.

NewGroup.FillSelWithExtract

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub FillSelWithInvert()

Fills the selection with all terminal node products which cannot be

extracted from the group.

Example:

This example fills the selection with all products which cannnot

be extracted

from the NewGroup group.

NewGroup.FillSelWithInvert

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ItemExplicit(CATVariant iIndex) As CATBaseDispatch

Returns a product using its index in the group.

Parameters:

iIndex

The index of the product in the group. The index of the first

product is 1, and the index of the last product is CountExplicit.

Returns:

The retrieved product

Example:

This example retrieves in ThisProduct the ninth

product

from the NewGroup group.

Dim ThisProduct As Product

Set ThisProduct = NewGroup.ItemExplicit(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ItemExtract(CATVariant iIndex) As Product

Returns a product which can be extracted from the group using its

index.

Parameters:

iIndex

The index of the product in the group. The index of the first

product is 1, and the index of the last product is CountExtract.

Returns:

The retrieved product

Example:

This example retrieves in ThisProduct the ninth

product

from the NewGroup group.

Dim ThisProduct As Group

Set ThisProduct = NewGroup.ItemExtract(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ItemInvert(CATVariant iIndex) As Product

Returns a terminal node product which cannot be extracted from the group

using its index.

Parameters:

iIndex

The index of the product in the group. The index of the first

product is 1, and the index of the last product is CountExtract.

Returns:

The retrieved product

Example:

This example retrieves in ThisProduct the ninth product which

cannot be extracted from

the NewGroup group.

Dim ThisProduct As Group

Set ThisProduct = NewGroup.ItemInvert(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveExplicit(CATVariant iIndex)

Removes a product from the group using its index.

Parameters:

iIndex

The index of the product in the group. The index of the first

product is 1, and the index of the last product is CountExplicit.

Example:

The following example removes the tenth product from the NewGroup

group.

NewGroup.RemoveExplicit 10

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add() As Group

Creates an empty Group and adds it to the Groups

Collection.

Returns:

The created group

Example:

This example creates a new group in the TheGroups

collection.

Dim NewGroup As Group

Set NewGroup = TheGroups.Add

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func AddFromSel() As Group

Creates a Group containing all products in the selection and adds it to the

Groups Collection.

Returns:

The created group

Example:

This example creates a new group containing all products in the

selection

in the TheGroups collection.

Dim NewGroup As Group

Set NewGroup = TheGroups.AddFromSel

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func AllLeaves() As Group

Returns a group which contains all the terminal nodes of the current root

product.

Example:

This example retrieves the group in the TheGroups

collection.

Dim AllLeavesGroup As Group

Set AllLeavesGroup = TheGroups.AllLeaves

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As Group

Returns a group using its index or its name from the Groups

collection.

Parameters:

iIndex

The index or the name of the Group to retrieve from the collection

of groups. As a numerics, this index is the rank of the Group in the

collection. The index of the first Group in the collection is 1, and the index

of the last Group is Count. As a string, it is the name you assigned to the

Group.

Returns:

The retrieved Group

Example:

This example retrieves in ThisGroup the ninth

Group,

and in ThatGroup the Group named

Group3 from the TheGroups collection.

Dim ThisGroup As Group

Set ThisGroup = TheGroups.Item(9)

Dim ThatGroup As Group

Set ThatGroup = TheGroups.Item(“Group3”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant iIndex)

Removes a group from the Groups collection.

Parameters:

iIndex

The index or the name of the Group to retrieve from he collection

of groups. As a numerics, this index is the rank of the Group in the

collection. The index of the first Group in the collection is 1, and the index

of the last Group is Count. As a string, it is the name you assigned to the

Group.

Example:

The following example removes the tenth Group and the Group

named

Group2 from the TheGroups collection.

TheGroups.Remove(10)

TheGroups.Remove(“Group2”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddUrl(CATBSTR iUrl)

Adds a url to an Hyperlink.

Parameters:

iUrl

The URL to be added to the Hyperlink.

Example:

This example links TheUrl to the NewHyperlink

Hyperlink.

NewHyperlink.AddUrl(TheUrl)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CountObject() As long

Returns the number of Url which are linked to the

Hyperlink.

Example:

This example reads the number of Url in the Hyperlink NewHyperlink

.

Dim number As Integer

number = NewHyperlink.CountObject

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ItemObject(CATVariant iIndex) As CATBSTR

Returns an Url which is linked to the Hyperlink using its

index.

Parameters:

iIndex

The index of the Url in the Hyperlink. The index of the first

object is 1, and the index of the last object is CountObject.

Returns:

The retrieved Url

Example:

This example retrieves in ThisUrl the ninth

object

from the NewHyperlink Hyperlink.

Dim ThisUrl As String

Set ThisUrl = NewHyperlink.ItemObject(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveObject(CATVariant iIndex)

Removes an Url which is linked to the Hyperlink using its

index.

Parameters:

iIndex

The index of the object in the Hyperlink. The index of the first

object is 1, and the index of the last object is CountObject.

Example:

This example removes the ninth Url

from the NewHyperlink Hyperlink.

NewHyperlink.RemoveObject(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add(AnyObject iObject) As Hyperlink

Adds a Hyperlink to the Hyperlinks collection. Be careful: only one

Hyperlink instance is allowed per object which supports the hyperlink. If one

adds a Hyperlink on an object which already has a Hyperlink, the call fails.

The Hyperlink name is internally generated. If one wants to manage Hyperlink

using its name, he has to set it manually.

Parameters:

iObject

The object which supports the hyperlink.

Example:

The following example adds a Hyperlink

Dim NewHyperlink As Hyperlink

Set NewHyperlink = TheHyperlinks.Add(iObject)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetHyperlink(AnyObject iObject) As Hyperlink

Retrieve an Hyperlink associated to an object

Parameters:

iObject

The object which supports the hyperlink. The call fails otherwise.

Returns:

The retrieved Hyperlink if it exists

Example:

This example retrieves an existing one in the TheHyperlinks

collection.

Dim NewHyperlink As Hyperlink

Set NewHyperlink = TheHyperlinks.GetHyperlink(iObject)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As Hyperlink

Returns an Hyperlink using its index from the Hyperlinks

collection.

Parameters:

iIndex

The index or the name of the hyperlink to retrieve from the

collection of Hyperlinks. As a numerics, this index is the rank of the

Hyperlink in the collection. The index of the first Hyperlink in the collection

is 1, and the index of the last Hyperlink is Count. As a string, it is the name

you assigned to the Hyperlink.

Returns:

The retrieved Hyperlink

Example:

This example retrieves in ThisHyperlink the ninth Hyperlink

,

and in ThatHyperlink the Hyperlink named

Hyperlink3 from the TheHyperlinks collection.

Dim ThisHyperlink As Hyperlink

Set ThisHyperlink = TheHyperlinks.Item(9)

Dim ThatHyperlink As Hyperlink

Set ThatHyperlink = TheHyperlinks.Item(“Hyperlink3”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant iIndex)

Removes a Hyperlink from the Hyperlinks collection.

Parameters:

iIndex

The index or the name of the Hyperlink to retrieve from the

collection of Hyperlinks. As a numerics, this index is the rank of the

Hyperlink in the collection. The index of the first Hyperlink in the collection

is 1, and the index of the last Hyperlink is Count. As a string, it is the name

you assigned to the Hyperlink.

Example:

The following example removes the tenth Hyperlink and the

Hyperlink named

Hyperlink 2 from the TheHyperlinks collection.

TheHyperlinks.Remove(10)

TheHyperlinks.Remove(“Hyperlink2”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Fill() As long

Returns or sets the Marker2D’s filling status (1 the figure is filled, 0

the figure is not filled).

Example:

This example retrieves the filling status of the NewMarker2D

Marker2D.

Dim status As Integer

status = NewMarker2D.Fill

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Frame() As long

Returns or sets the Marker2D’s framing status (1 the figure is framed, 0

the figure is not framed).

Example:

This example retrieves the framing status of the NewMarker2D

Marker2D.

Dim status As Integer

status = NewMarker2D.Frame

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetPositions(CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the positions of the

Marker2D.

These positions depend on the type of the Marker2D :

Line: 2 positions.

Arrow: 2 positions, the first being the head and the second being the

tail.

Rectangle: 2 positions, the first being the bottom-left corner and the

second being the top-right corner.

Circle: 2 positions, the first being the center and the second being a

point on the circle.

FreeHand: as many positions as points.

Text: 1 position, the bottom-left corner.

Picture: 2 positions, the first being the bottom-left corner and the

second being the top-right corner.

Parameters:

oCoordinates

The coordinates of the positions expressed as an array of variants

are:

oCoordinates(0) is the X coordinate of the first

point

oCoordinates(1) is the Y coordinate of the first

point

oCoordinates(2) is the X coordinate of the second

point

oCoordinates(3) is the Y coordinate of the second

point

oCoordinates(n*2-2) is the X coordinate of the n-th

point

oCoordinates(n*2-1) is the Y coordinate of the n-th point

Example:

This example retrieves the coordinates of the positions of the

NewMarker2D Marker2D.

Dim Coordinates (3)

NewMarker2D.GetPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Picture() As CATBSTR

Returns or sets the path to a picture file for a picture

Marker2D.

Example:

This example retrieves the path to a picture file of the

NewMarker2D Marker2D.

Dim path As String

path = NewMarker2D.Picture

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPositions(CATSafeArrayVariant iCoordinates)

Sets the coordinates of the positions of the Marker2D.

These positions depend on the type of the Marker2D :

Line: 2 positions.

Arrow: 2 positions, the first being the head and the second being the

tail.

Rectangle: 2 positions, the first being the bottom-left corner and the

second being the top-right corner.

Circle: 2 positions, the first being the center and the second being a

point on the circle.

FreeHand: as many positions as points.

Text: 1 position, the bottom-left corner.

Picture: 2 positions, the first being the bottom-left corner and the

second being the top-right corner.

Parameters:

iCoordinates

The coordinates of the positions expressed as an array of variants

are:

iCoordinates(0) is the X coordinate of the first

point

iCoordinates(1) is the Y coordinate of the first

point

iCoordinates(2) is the X coordinate of the second

point

iCoordinates(3) is the Y coordinate of the second

point

oCoordinates(n*2-2) is the X coordinate of the n-th

point

oCoordinates(n*2-1) is the Y coordinate of the n-th point

Example:

This example sets the coordinates of the positions of the

NewMarker2D Marker2D.

Dim Coordinates (3) ‘To be valuated

NewMarker2D.SetPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Text() As CATBSTR

Returns or sets the text for a text Marker2D.

Example:

This example retrieves the text of the NewMarker2D

Marker2D.

Dim text As String

text = NewMarker2D.Text

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextAngle() As double

Returns or sets the text’s angle for a text Marker2D.

Example:

This example retrieves the text’s angle of the NewMarker2D

Marker2D.

Dim angle As Double

size = NewMarker2D.TextAngle

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextFont() As CATBSTR

Returns or sets the text’s font for a text Marker2D.

Example:

This example retrieves the text’s font of the NewMarker2D

Marker2D.

Dim font As String

font = NewMarker2D.TextFont

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextOrientation() As CatMarkerTextOrientation

Return or set the orientation of text.

Example:

This example retrieves the orientation of the NewMarker2D

Marker2D.

Dim orientation As CatMarkerTextOrientation

orientation = NewMarker2D.TextOrientation

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextSize() As double

Returns or sets the text’s size for a text Marker2D.

Example:

This example retrieves the text’s size of the NewMarker2D

Marker2D.

Dim size As Double

size = NewMarker2D.TextSize

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Type() As CatMarker2DType (Read Only)

Returns the type of the marker 2D.

Example:

This example retrieves the type of the NewMarker2D

Marker2D.

Dim type As CatMarker2DType

type = NewMarker2D.Type

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add2DArrow(CATSafeArrayVariant iCoordinates) As

Marker2D

Creates an arrow marker 2D and adds it to the marker 2D collection. The

arrow is defined using the coordinates of its head and tail

points.

Parameters:

iCoordinates

The coordinates

iCoordinates(0) is the X coordinate of the head

point

iCoordinates(1) is the Y coordinate of the head

point

iCoordinates(2) is the X coordinate of the tail

point

iCoordinates(3) is the Y coordinate of the tail point

Returns:

The created marker 2D

Example:

This example creates a new marker 2D in the TheMarker2Ds

collection.

Dim NewMarker2DArrow As Marker2D

Set NewMarker2DArrow = TheMarker2Ds.Add2DArrow(Positions)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add2DCircle(CATSafeArrayVariant iCoordinates,

long iFillStatus) As Marker2D

Creates a circle marker 2D and adds it to the marker 2D collection. The

circle is defined using the coordinates of its center and a point through which

it passes.

Parameters:

iCoordinates

The coordinates

iCoordinates(0) is the X coordinate of the

center

iCoordinates(1) is the Y coordinate of the

center

iCoordinates(2) is the X coordinate of the a point on the

circle

iCoordinates(3) is the Y coordinate of the a point on the

circle

iFillStatus

The filling status (1 the figure is filled, 0 the figure is not

filled).

Returns:

The created marker 2D

Example:

This example creates a new marker 2D in the TheMarker2Ds

collection.

Dim NewMarker2DCircle As Marker2D

Set NewMarker2DCircle = TheMarker2Ds.Add2DCircle(Positions, 0)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add2DFreeHand(CATSafeArrayVariant iCoordinates) As

Marker2D

Creates a free hand drawing marker 2D and adds it to the marker 2D

collection. The free hand drawing is defined using the coordinates of a series

of points.

Parameters:

iCoordinates

The coordinates

iCoordinates(0) is the X coordinate of the first

point

iCoordinates(1) is the Y coordinate of the first

point

iCoordinates(2) is the X coordinate of the second

point

iCoordinates(3) is the Y coordinate of the second

point

iCoordinates(n*2-2) is the X coordinate of the n-th

point

iCoordinates(n*2-1) is the Y coordinate of the n-th point

Returns:

The created marker 2D

Example:

This example creates a new marker 2D in the TheMarker2Ds

collection.

Dim NewMarker2DFreeHand As Marker2D

Set NewMarker2DFreeHand = TheMarker2Ds.Add2DFreeHand(Positions)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add2DLine(CATSafeArrayVariant iCoordinates) As

Marker2D

Creates a line marker 2D and adds it to the marker 2D collection. The line

segment is defined using the coordinates of its two

endpoints.

Parameters:

iCoordinates

The coordinates of the endpoints

iCoordinates(0) is the X coordinate of the first

endpoint

iCoordinates(1) is the Y coordinate of the first

endpoint

iCoordinates(2) is the X coordinate of the second

endpoint

iCoordinates(3) is the Y coordinate of the second endpoint

Returns:

The created marker 2D

Example:

This example creates a new marker 2D in the TheMarker2Ds

collection.

Dim NewMarker2DLine As Marker2D

Set NewMarker2DLine = TheMarker2Ds.Add2DLine(Positions)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add2DPicture(CATSafeArrayVariant iCoordinates,

CATBSTR iPath) As Marker2D

Creates a picture marker 2D and adds it to the marker 2D collection. The

picture is defined as a rectangle whose bottom-left and top-right corners are

given.

Parameters:

iCoordinates

The coordinates of the corners

iCoordinates(0) is the X coordinate of the bottom-left

point

iCoordinates(1) is the Y coordinate of the bottom-left

point

iCoordinates(2) is the X coordinate of the top-right

point

iCoordinates(3) is the Y coordinate of the top-right point

iPath

The path to the picture file

Returns:

The created marker 2D

Example:

This example creates a new marker 2D in the TheMarker2Ds

collection.

Dim NewMarker2DPicture As Marker2D

Set NewMarker2DPicture = TheMarker2Ds.Add2DPicture(Positions, “e:picture.bmp”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add2DRectangle(CATSafeArrayVariant iCoordinates,

long iFillStatus) As Marker2D

Creates a rectangle marker 2D and adds it to the marker 2D collection. The

rectangle is defined using the coordinates of its bottom-left and top-right

corners.

Parameters:

iCoordinates

The coordinates

iCoordinates(0) is the X coordinate of the bottom-left

point

iCoordinates(1) is the Y coordinate of the bottom-left

point

iCoordinates(2) is the X coordinate of the top-right

point

iCoordinates(3) is the Y coordinate of the top-right point

iFillStatus

The filling status (1 the figure is filled, 0 the figure is not

filled).

Returns:

The created marker 2D

Example:

This example creates a new marker 2D in the TheMarker2Ds

collection.

Dim NewMarker2DRectangle As Marker2D

Set NewMarker2DRectangle = TheMarker2Ds.Add2DRectangle(Positions, 0)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add2DText(CATSafeArrayVariant iCoordinates,

CATBSTR iText) As Marker2D

Creates a text marker 2D and adds it to the marker 2D collection. The text

is anchored using the coordinates of its bottom-left

point.

Parameters:

iCoordinates

The coordinates

iCoordinates(0) is the X coordinate of the bottom-left

point

iCoordinates(1) is the Y coordinate of the bottom-left point

iText

The text

Returns:

The created marker 2D

Example:

This example creates a new marker 2D in the TheMarker2Ds

collection.

Dim NewMarker2DText As Marker2D

Set NewMarker2DText = TheMarker2Ds.Add2DText(Positions, “example”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As Marker2D

Returns a marker 2D using its index from the Marker2Ds

collection.

Parameters:

iIndex

The index of the marker 2D to retrieve from the collection of

Marker2Ds. As a numerics, this index is the rank of the marker 2D in the

collection. The index of the first marker 2D in the collection is 1, and the

index of the last marker 2D is Count.

Returns:

The retrieved marker 2D

Example:

This example retrieves in ThisMarker2D the ninth marker 2D

from the TheMarker2Ds collection.

Dim ThisMarker2D As Marker2D

Set ThisMarker2D = TheMarker2Ds.Item(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant iIndex)

Removes a marker 2D from the Marker2Ds collection.

Parameters:

iIndex

The index of the marker 2D to retrieve from he collection of

Marker2Ds. As a numerics, this index is the rank of the marker 2D in the

collection. The index of the first marker 2D in the collection is 1, and the

index of the last marker 2D is Count.

Example:

The following example removes the tenth marker 2D from the

TheMarker2Ds collection.

TheMarker2Ds.Remove(10)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddObject(AnyObject iObject)

Adds a link to an object.

Parameters:

iObject

The object to be linked.

Example:

This example links ThisProduct to the NewMarker3D marker

3D.

NewMarker3D.AddObject(ThisProduct)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CountObject() As long

Returns the number of objects which are linked to the marker

3D.

Example:

This example reads the number of objects in the marker3D

NewMarker3D.

Dim number As Integer

number = NewMarker3D.CountObject

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Fill() As long

Returns or sets the marker 3D’s filling status (1 the figure is filled, 0

the figure is not filled).

Example:

This example retrieves the filling status of NewMarker3D marker

3D.

Dim status As Integer

status = NewMarker3D.Fill

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Frame() As long

Returns or sets the marker 3D’s framing status (1 the figure is framed, 0

the figure is not framed).

Example:

This example retrieves the framing status of NewMarker3D marker

3D.

Dim status As Integer

status = NewMarker3D.Frame

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetObjectPositions(CATVariant iIndex,

CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the anchor point of the marker on the

object.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

oCoordinates

The coordinates of the anchor point

oCoordinates(0) is the X coordinate of the anchor

point

oCoordinates(1) is the Y coordinate of the anchor

point

oCoordinates(2) is the Z coordinate of the anchor point

Example:

This example retrieves the coordinates of the anchor in the

NewMarker3D marker 3D.

Dim Coordinates (3)

NewMarker3D.GetObjectPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetTextPositions(CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the positions of a text marker 3D. The

bottom-left corner of the text is anchored to a given

point.

Returns:

The coordinates of the text anchor point

oCoordinates(0) is the X coordinate of the text anchor

point

oCoordinates(1) is the Y coordinate of the text anchor

point

oCoordinates(2) is the Z coordinate of the text anchor point

Example:

This example retrieves the coordinates of the text in the

NewMarker3D marker 3D.

Dim Coordinates (2)

NewMarker3D.GetTextPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ItemObject(CATVariant iIndex) As CATBaseDispatch

Returns an object which is linked to the marker 3D using its

index.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

Returns:

The retrieved object

Example:

This example retrieves in ThisObject the ninth

object

from the NewMarker3D marker 3D.

Dim ThisObject As Marker3D

Set ThisObject = NewMarker3D.ItemObject(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveObject(CATVariant iIndex)

Removes an object which is linked to the marker 3D using its

index.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

Example:

This example removes the ninth object

from the NewMarker3D marker 3D.

NewMarker3D.RemoveObject(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetObjectPositions(CATVariant iIndex,

CATSafeArrayVariant iCoordinates)

Sets the coordinates of the anchor point of the marker on the

object.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

iCoordinates

The coordinates of the anchor point

oCoordinates(0) is the X coordinate of the anchor

point

oCoordinates(1) is the Y coordinate of the anchor

point

oCoordinates(2) is the Z coordinate of the anchor point

Example:

This example sets the coordinates of the anchor in the NewMarker3D

marker 3D.

Dim Coordinates (3)

NewMarker3D.SetObjectPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetTextPositions(CATSafeArrayVariant iCoordinates)

Sets the coordinates of the positions of a text marker 3D.

Parameters:

iCoordinates

The coordinates of the text anchor point

oCoordinates(0) is the X coordinate of the text anchor

point

oCoordinates(1) is the Y coordinate of the text anchor

point

oCoordinates(2) is the Z coordinate of the text anchor point

Example:

This example sets the coordinates of the text in the NewMarker3D

marker 3D.

Dim Coordinates (2)

NewMarker3D.SetTextPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Text() As CATBSTR

Returns or sets the text for a text marker 3D.

Example:

This example reads the text of NewMarker3D marker

3D.

Dim text As String

text = NewMarker3D.Text

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextFont() As CATBSTR

Returns or sets the text’s font for a marker 3D.

Example:

This example retrieves the text’s font of NewMarker3D marker

3D.

Dim font As String

font = NewMarker3D.TextFont

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextOrientation() As CatMarkerTextOrientation

Returns or sets the orientation of text.

Example:

This example retrieves the orientation of NewMarker3D marker

3D.

Dim orientation As CatMarkerTextOrientation

orientation = NewMarker3D.TextOrientation

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextSize() As double

Returns or sets the text’s size for a marker 3D.

Example:

This example retrieves the text’s size of NewMarker3D marker

3D.

Dim size As Double

size = NewMarker3D.TextSize

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Type() As CatMarker3DType (Read Only)

Returns the type of the marker 3D.

Example:

This example reads the type of NewMarker3D marker

3D.

Dim type As CatMarker3DType

type = NewMarker3D.Type

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Update()

Updates the the marker 3D: that is to take into account all modifications

which occur since last update.

Example:

This example updates the NewMarker3D marker 3D.

NewMarker3D.Update

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddObject(AnyObject iObject)

Adds a link to an object.

Parameters:

iObject

The object to be linked.

Example:

This example links ThisProduct to the NewMarker3D marker

3D.

NewMarker3D.AddObject(ThisProduct)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CountObject() As long

Returns the number of objects which are linked to the marker

3D.

Example:

This example reads the number of objects in the marker3D

NewMarker3D.

Dim number As Integer

number = NewMarker3D.CountObject

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Fill() As long

Returns or sets the marker 3D’s filling status (1 the figure is filled, 0

the figure is not filled).

Example:

This example retrieves the filling status of NewMarker3D marker

3D.

Dim status As Integer

status = NewMarker3D.Fill

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Frame() As long

Returns or sets the marker 3D’s framing status (1 the figure is framed, 0

the figure is not framed).

Example:

This example retrieves the framing status of NewMarker3D marker

3D.

Dim status As Integer

status = NewMarker3D.Frame

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetObjectPositions(CATVariant iIndex,

CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the anchor point of the marker on the

object.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

oCoordinates

The coordinates of the anchor point

oCoordinates(0) is the X coordinate of the anchor

point

oCoordinates(1) is the Y coordinate of the anchor

point

oCoordinates(2) is the Z coordinate of the anchor point

Example:

This example retrieves the coordinates of the anchor in the

NewMarker3D marker 3D.

Dim Coordinates (3)

NewMarker3D.GetObjectPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetTextPositions(CATSafeArrayVariant oCoordinates)

Retrieves the coordinates of the positions of a text marker 3D. The

bottom-left corner of the text is anchored to a given

point.

Returns:

The coordinates of the text anchor point

oCoordinates(0) is the X coordinate of the text anchor

point

oCoordinates(1) is the Y coordinate of the text anchor

point

oCoordinates(2) is the Z coordinate of the text anchor point

Example:

This example retrieves the coordinates of the text in the

NewMarker3D marker 3D.

Dim Coordinates (2)

NewMarker3D.GetTextPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ItemObject(CATVariant iIndex) As CATBaseDispatch

Returns an object which is linked to the marker 3D using its

index.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

Returns:

The retrieved object

Example:

This example retrieves in ThisObject the ninth

object

from the NewMarker3D marker 3D.

Dim ThisObject As Marker3D

Set ThisObject = NewMarker3D.ItemObject(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveObject(CATVariant iIndex)

Removes an object which is linked to the marker 3D using its

index.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

Example:

This example removes the ninth object

from the NewMarker3D marker 3D.

NewMarker3D.RemoveObject(9)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetObjectPositions(CATVariant iIndex,

CATSafeArrayVariant iCoordinates)

Sets the coordinates of the anchor point of the marker on the

object.

Parameters:

iIndex

The index of the object in the marker 3D. The index of the first

object is 1, and the index of the last object is CountObject.

iCoordinates

The coordinates of the anchor point

oCoordinates(0) is the X coordinate of the anchor

point

oCoordinates(1) is the Y coordinate of the anchor

point

oCoordinates(2) is the Z coordinate of the anchor point

Example:

This example sets the coordinates of the anchor in the NewMarker3D

marker 3D.

Dim Coordinates (3)

NewMarker3D.SetObjectPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetTextPositions(CATSafeArrayVariant iCoordinates)

Sets the coordinates of the positions of a text marker 3D.

Parameters:

iCoordinates

The coordinates of the text anchor point

oCoordinates(0) is the X coordinate of the text anchor

point

oCoordinates(1) is the Y coordinate of the text anchor

point

oCoordinates(2) is the Z coordinate of the text anchor point

Example:

This example sets the coordinates of the text in the NewMarker3D

marker 3D.

Dim Coordinates (2)

NewMarker3D.SetTextPositions Coordinates

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Text() As CATBSTR

Returns or sets the text for a text marker 3D.

Example:

This example reads the text of NewMarker3D marker

3D.

Dim text As String

text = NewMarker3D.Text

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextFont() As CATBSTR

Returns or sets the text’s font for a marker 3D.

Example:

This example retrieves the text’s font of NewMarker3D marker

3D.

Dim font As String

font = NewMarker3D.TextFont

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextOrientation() As CatMarkerTextOrientation

Returns or sets the orientation of text.

Example:

This example retrieves the orientation of NewMarker3D marker

3D.

Dim orientation As CatMarkerTextOrientation

orientation = NewMarker3D.TextOrientation

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TextSize() As double

Returns or sets the text’s size for a marker 3D.

Example:

This example retrieves the text’s size of NewMarker3D marker

3D.

Dim size As Double

size = NewMarker3D.TextSize

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Type() As CatMarker3DType (Read Only)

Returns the type of the marker 3D.

Example:

This example reads the type of NewMarker3D marker

3D.

Dim type As CatMarker3DType

type = NewMarker3D.Type

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Update()

Updates the the marker 3D: that is to take into account all modifications

which occur since last update.

Example:

This example updates the NewMarker3D marker 3D.

NewMarker3D.Update

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarker2DAutoNamingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Marker2DAutoNaming

parameter.

Role:Retrieves the state of the Marker2DAutoNaming parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarker3DAutoNamingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the Marker3DAutoNaming

parameter.

Role:Retrieves the state of the Marker3DAutoNaming parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetMarkerDefaultsColor(long oRed,

long oGreen,

long oBlue)

Returns the default color of an annotation (oRed, oGreen, oBlue: RGB values

of the color).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerDefaultsColorInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerDefaultsColor

parameter.

Role:Retrieves the state of the MarkerDefaultsColor parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerDefaultsDashedInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerDefaultsDashed

parameter.

Role:Retrieves the state of the MarkerDefaultsDashed parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerDefaultsWeightInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerDefaultsWeight

parameter.

Role:Retrieves the state of the MarkerDefaultsWeight parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetMarkerTextColor2D(long oRed,

long oGreen,

long oBlue)

Returns the default color of a 2D text annotation (oRed, oGreen, oBlue: RGB

values of the color).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextColor2DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerTextColor2D

parameter.

Role:Retrieves the state of the MarkerTextColor2D parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetMarkerTextColor3D(long oRed,

long oGreen,

long oBlue)

Returns the default color of a 3D text annotation (oRed, oGreen, oBlue: RGB

values of the color).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextColor3DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerTextColor3D

parameter.

Role:Retrieves the state of the MarkerTextColor3D parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextDashed2DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerTextDashed2D

parameter.

Role:Retrieves the state of the MarkerTextDashed2D parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextDashed3DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerTextDashed3D

parameter.

Role:Retrieves the state of the MarkerTextDashed3D parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextDefaultsFont2DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerDefaultsFont2D

parameter.

Role:Retrieves the state of the MarkerDefaultsFont2D parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextDefaultsFont3DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerDefaultsFont3D

parameter.

Role:Retrieves the state of the MarkerDefaultsFont3D parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextDefaultsSize2DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerDefaultsSize2D

parameter.

Role:Retrieves the state of the MarkerDefaultsSize2D parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextDefaultsSize3DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerDefaultsSize3D

parameter.

Role:Retrieves the state of the MarkerDefaultsSize3D parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextWeight2DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerTextWeight2D

parameter.

Role:Retrieves the state of the MarkerTextWeight2D parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetMarkerTextWeight3DInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the MarkerTextWeight3D

parameter.

Role:Retrieves the state of the MarkerTextWeight3D parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Marker2DAutoNaming() As boolean

Returns or sets the activation state for 2D annotations automatic naming

(TRUE naming is automatic, FALSE the naming is not automatic).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Marker3DAutoNaming() As boolean

Returns or sets the activation state for 3D annotations automatic naming

(TRUE naming is automatic, FALSE the naming is not automatic).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerDefaultsDashed() As long

Returns or sets the default dashed value of an annotation (oValue the

dashed value).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerDefaultsWeight() As long

Returns or sets the default weight value of an annotation (oValue the

weight value).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextDashed2D() As long

Returns or sets the default dashed value of a 2D text annotation (oValue

the dashed value).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextDashed3D() As long

Returns or sets the default dashed value of a 3D text annotation (oValue

the dashed value).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextDefaultsFont2D() As CATBSTR

Returns or sets the default font of a 2D annotation (oValue the font name).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextDefaultsFont3D(CATBSTR iValue)

Returns or sets the default font of a 3D annotation (oValue the font name).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextDefaultsSize2D() As long

Returns or sets the default size value of a 2d annotation (oValue the size

value)..

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextDefaultsSize3D(long iValue)

Returns or sets the default size value of a 3d annotation (oValue the size

value)..

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextWeight2D() As long

Returns or sets the default weight value of a 2D text annotation (oValue

the weight value).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property MarkerTextWeight3D(long iValue)

Returns or sets the default weight value of a 3D text annotation (oValue

the weight value).

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMarker2DAutoNamingLock(boolean iLocked)

Locks or unlocks the Marker2DAutoNaming parameter.

Role:Locks or unlocks the Marker2DAutoNaming parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMarker3DAutoNamingLock(boolean iLocked)

Locks or unlocks the Marker3DAutoNaming parameter.

Role:Locks or unlocks the Marker3DAutoNaming parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMarkerDefaultsColor(long iRed,

long iGreen,

long iBlue)

Sets the default color of an annotation (iRed, iGreen, iBlue: RGB values

for the desired color)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMarkerDefaultsColorLock(boolean iLocked)

Locks or unlocks the MarkerDefaultsColor parameter.

Role:Locks or unlocks the MarkerDefaultsColor parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMarkerDefaultsDashedLock(boolean iLocked)

Locks or unlocks the MarkerDefaultsDashed parameter.

Role:Locks or unlocks the MarkerDefaultsDashed parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMarkerDefaultsWeightLock(boolean iLocked)

Locks or unlocks the MarkerDefaultsWeight parameter.

Role:Locks or unlocks the MarkerDefaultsColor parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.