All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDftViewTextAccess

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIDftViewTextAccess

Interface to manage the text used as the view name label.
Role: Use this interface to create/retrieve a view text in the object which implements this interface (i.e. a drafting view, a 2D Layout for 3D Design view).

Notice that an authoring product license is required.

Method Index

o AddViewText(): Add a view text in the view.
o GetViewText(CATBaseUnknown_var&): Get the view text if any.

Methods

o AddViewText

public virtual AddViewText(

)

Add a view text in the view. This view text is created at the origin of the view with the formatting corresponding to the text style defined in the standard for View/ViewText/TextStyleName parameter (except for pre-V6R2011 standards).

Returns:

S_OK: The view text has been successfully added
S_FALSE: The view already has a view text, therefore the operation has been aborted
E_UNEXPECTED: An unexpected error occured

o GetViewText

public virtual GetViewText( ohViewText)

Get the view text if any.

Parameters:

ohViewText: [out] The view text.

Returns:

S_OK: The view text has been successfully retrieved
S_FALSE: The view does not have any view text
E_UNEXPECTED: An unexpected error occured

This object is included in the file: CATIDftViewTextAccess.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf