CATAnnotationUseItf Interface CATIDrwDimText

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

interface CATIDrwDimText

Manages the dimension texts.

Method Index

o GetBAULText(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Gets before, after, upper and lower texts.
o GetPSText(CATUnicodeString&,int): Gets prefix or suffix text
o GetPSText(CATUnicodeString&,CATUnicodeString&)
o GetStyle(): Gets style.
o SetBAULText(CATUnicodeString,CATUnicodeString,CATUnicodeString,CATUnicodeString): Sets before, after, upper and lower texts.
o SetPSText(CATUnicodeString&,int): Sets prefix or suffix text (both prefix and suffix cannot be set)
o SetPSText(CATUnicodeString,CATUnicodeString)

Methods

o GetBAULText

public virtual GetBAULText(		`before`,
		`after`,
		`upper`,
		`lower`)

Gets before, after, upper and lower texts.

Parameters:

before: Before text.
after: After text.
upper: Upper text.
lower: Lower text.

o GetPSText

public virtual GetPSText(		`oPSText`,
		`iIndex`)

Gets prefix or suffix text

Parameters:

oPSText: Prefix or suffix text.
iIndex: 1: gets prefix text 2: gets suffix text

Returns:

HRESULT

S_OK: Method correctly executed
S_READONLY: Method correctly executed.Returned value cannot be modified, it's read-only
E_FAIL: Method execution failed

o GetPSText

public virtual GetPSText(		`prefix`,
		`suffix`)

Deprecated:

V5R18 use #GetPSText Gets prefix and suffix texts.

Parameters:

prefix: Prefix text.
suffix: Suffix text.

o GetStyle

public virtual GetStyle(

)

Gets style.

Returns:: Style.

o SetBAULText

public virtual SetBAULText(	const	`before`,
	const	`after`,
	const	`upper`,
	const	`lower`)

Sets before, after, upper and lower texts.

Parameters:

before: Before text.
after: After text.
upper: Upper text.
lower: Lower text.

o SetPSText

public virtual SetPSText(	const	`iPSText`,
		`iIndex`)

Sets prefix or suffix text (both prefix and suffix cannot be set)

Parameters:

iPSText: Prefix or suffix text.
iIndex: 1: sets prefix text (the suffix text is deleted) 2: sets suffix text (the prefix text is deleted)

Returns:

HRESULT

S_OK: Method correctly executed
E_FAIL: Method execution failed : make sure that the value is not read-only (The prefix cannot be set is a string is defined as dimension value)

o SetPSText

public virtual SetPSText(	const	`prefix`,
	const	`suffix`)

Deprecated:

V5R18 use #SetPSText Sets prefix and suffix texts.

Parameters:

prefix: Prefix text.
suffix: Suffix text.

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