CATTPSUseItf Interface CATITPSViewTextAccess

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

interface CATITPSViewTextAccess

Interface providing an access to view text.
Implemented by the TPSView.

Method Index

o AddViewText(): Add a view text in the TPSview.
o GetViewText(CATITPSText**): Get the view text.

Methods

o AddViewText

public virtual AddViewText(

)

Add a view text in the TPSview. 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( opiViewText)

Get the view text.

Parameters:

opiViewText: [out] The view text.

Returns:

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

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