All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwDimText

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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&,CATUnicodeString&)
o GetPSText(CATUnicodeString&,int)
Gets prefix or suffix text
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 void GetBAULText(CATUnicodeString& before,
CATUnicodeString& after,
CATUnicodeString& upper,
CATUnicodeString& lower) const = 0
Gets before, after, upper and lower texts.
Parameters:
before
Before text.
after
After text.
upper
Upper text.
lower
Lower text.
o GetPSText
public virtual void GetPSText(CATUnicodeString& prefix,
CATUnicodeString& suffix) const = 0
Deprecated:
V5R18 use #GetPSText Gets prefix and suffix texts.
Parameters:
prefix
Prefix text.
suffix
Suffix text.
o GetPSText
public virtual HRESULT GetPSText(CATUnicodeString& oPSText,
int iIndex) const = 0
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 GetStyle
public virtual CATIDrwDimDressUp_var GetStyle()const = 0
Gets style.
Returns:
Style.
o SetBAULText
public virtual void SetBAULText( const CATUnicodeString before,
const CATUnicodeString after,
const CATUnicodeString upper,
const CATUnicodeString lower) = 0
Sets before, after, upper and lower texts.
Parameters:
before
Before text.
after
After text.
upper
Upper text.
lower
Lower text.
o SetPSText
public virtual HRESULT SetPSText( const CATUnicodeString& iPSText,
int iIndex) = 0
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 void SetPSText( const CATUnicodeString prefix,
const CATUnicodeString suffix) = 0
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: CATDraftingInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.