All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwText

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---DraftingInterfaces.CATIDrwAnnotation
        |
        +---DraftingInterfaces.CATIDrwAnnotationComponent
          |
          +---CATIDrwText
 

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


interface CATIDrwText

Interface to manage a text.

See also:
CATIDrwSubString, CATIDrwTextProperties


Method Index


o GetGlobalParameter(CATDrwTextSetting,double&)
Read global parameter text double values.
o GetGlobalParameter(CATDrwTextSetting,int&)
Read global parameter text integer values.
o GetListOfVariables(CATListValCATBaseUnknown_var*&)
Get list of linked objects.
o GetParameterOnSubString(CATDrwTextProperty,int,int,CATUnicodeString&,int&)
Get text parameter string values.
o GetParameterOnSubString(CATDrwTextProperty,int,int,double&,int&)
Get text parameter double values.
o GetParameterOnSubString(CATDrwTextProperty,int,int,int&,int&)
Get text parameter integer values.
o GetStringAt(CATUnicodeString&,int,int)
Get the text string between to character indexes.
o GetVariablePositions(CATBaseUnknown*,CATListOfInt&)
Get positions in list of linked objects.
o GetWrappingWidth(double&)
Read the text wrapping width.
o InsertSymbol(CATUnicodeString,int,int,CATUnicodeString)
o InsertVariable(int,CATBaseUnknown*,CATUnicodeString&)
Insert a text semantic link.
o IsWrapped(CATDrwWrappingMode&)
Get the wrapping text mode.
o Isolate(CATBaseUnknown*)
Isolate the text from its semantic link.
o SetGlobalParameter(CATDrwTextSetting,double)
Set global parameter text double values.
o SetGlobalParameter(CATDrwTextSetting,int)
Set global parameter text integer values.
o SetParameterOnSubString(CATDrwTextProperty,int,int,CATUnicodeString)
Set text parameter string values.
o SetParameterOnSubString(CATDrwTextProperty,int,int,double)
Set text parameter double values.
o SetParameterOnSubString(CATDrwTextProperty,int,int,int)
Set text parameter integer values.
o SetStringAt(CATUnicodeString,int,int)
Manage the text string.
o SetWrappingWidth(CATDrwWrappingMode,double)
Set or unset the wrapping width.

Methods


o GetGlobalParameter
public virtual HRESULT GetGlobalParameter(CATDrwTextSetting iParam,
double& oValue) = 0
Read global parameter text double values.
Parameters:
iParam
Parameter type.
oValue
Parameter output value.
See also:
CATDrwTextSetting
o GetGlobalParameter
public virtual HRESULT GetGlobalParameter(CATDrwTextSetting iParam,
int& oValue) = 0
Read global parameter text integer values.
Parameters:
iParam
Parameter type.
oValue
Parameter output value.
See also:
CATDrwTextSetting
o GetListOfVariables
public virtual HRESULT GetListOfVariables(CATListValCATBaseUnknown_var*& oList) = 0
Get list of linked objects.
Parameters:
oList
[out, delete] [out] Linked objects list.
o GetParameterOnSubString
public virtual HRESULT GetParameterOnSubString(CATDrwTextProperty iParam,
int iStart,
int iEnd,
CATUnicodeString& oValue,
int& oPure) = 0
Get text parameter string values.
Parameters:
iParam
Parameter type.
iStart
First character to get.
iEnd
Last character to get
oValue
Parameter output value.
oPure
Parameter constancy.
Equals 1 if parameter value is the same between iStart and iEnd characters.
Equals 0 if parameter value is not the same between iStart and iEnd characters.
See also:
CATDrwTextProperty
o GetParameterOnSubString
public virtual HRESULT GetParameterOnSubString(CATDrwTextProperty iParam,
int iStart,
int iEnd,
double& oValue,
int& oPure) = 0
Get text parameter double values.
Parameters:
iParam
Parameter type.
iStart
First character to get.
iEnd
Last character to get
oValue
Parameter output value.
oPure
Parameter constancy.
Equals 1 if parameter value is the same between iStart and iEnd characters.
Equals 0 if parameter value is not the same between iStart and iEnd characters.
See also:
CATDrwTextProperty
o GetParameterOnSubString
public virtual HRESULT GetParameterOnSubString(CATDrwTextProperty iParam,
int iStart,
int iEnd,
int& oValue,
int& oPure) = 0
Get text parameter integer values.
Parameters:
iParam
Parameter type.
iStart
First character to get.
iEnd
Last character to get
oValue
Parameter output value.
oPure
Parameter constancy.
Equals 1 if parameter value is the same between iStart and iEnd characters.
Equals 0 if parameter value is not the same between iStart and iEnd characters.
See also:
CATDrwTextProperty
o GetStringAt
public virtual HRESULT GetStringAt(CATUnicodeString& oString,
int iStart=0,
int iEnd=0) = 0
Get the text string between to character indexes.
Parameters:
iStart
First character to get.
If iStart equals 0 string is got from the begining.
iEnd
Last character to get.
If iEnd equals 0 string is got to the end.
oString
Output string.
o GetVariablePositions
public virtual HRESULT GetVariablePositions(CATBaseUnknown* ipObject,
CATListOfInt& oList) = 0
Get positions in list of linked objects.
Parameters:
ipObject
Linked object.
oList
List of positions where link is referenced.
o GetWrappingWidth
public virtual HRESULT GetWrappingWidth(double& oWidth) = 0
Read the text wrapping width.
Parameters:
oWidth
Wrapping width value.
o InsertSymbol
public virtual HRESULT InsertSymbol(CATUnicodeString iSymbol,
int iStart,
int iEnd,
CATUnicodeString iFont="") = 0
Deprecated:
V5R17 use CATIDrwSubString#SetSymbol Insert a symbol in a text.
This symbol will remain displayed even if text font is changed.
Parameters:
iSymbol
Unicode symbol value.
iStart
Start location .
iEnd
End location
iFont
Font name to use for this symbol.
If no font is given a default one is taken according to the current standard and the unicode value.
o InsertVariable
public virtual HRESULT InsertVariable(int iPos,
CATBaseUnknown* ipObject,
const CATUnicodeString& iAttName="") = 0
Insert a text semantic link.
Parameters:
iPos
Character insertion position.
ipObject
Object from which value will be extracted or Type of object to link with.
iAttName
Attribute name to extract value.
o IsWrapped
public virtual HRESULT IsWrapped(CATDrwWrappingMode& oMode) = 0
Get the wrapping text mode.
Parameters:
oMode
Wrapping text mode.
Refer to CATDrwUtility.
o Isolate
public virtual HRESULT Isolate(CATBaseUnknown* ipObject=NULL) = 0
Isolate the text from its semantic link.
Parameters:
ipObject
Object to isolate the text from.
If no object is given the text will be isolated from all its links.
o SetGlobalParameter
public virtual HRESULT SetGlobalParameter(CATDrwTextSetting iParam,
double iValue) = 0
Set global parameter text double values.
Parameters:
iParam
Parameter type.
iValue
Parameter input value.
See also:
CATDrwTextSetting
o SetGlobalParameter
public virtual HRESULT SetGlobalParameter(CATDrwTextSetting iParam,
int iValue) = 0
Set global parameter text integer values.
Parameters:
iParam
Parameter type.
iValue
Parameter input value.
See also:
CATDrwTextSetting
o SetParameterOnSubString
public virtual HRESULT SetParameterOnSubString(CATDrwTextProperty iParam,
int iStart,
int iEnd,
CATUnicodeString iValue) = 0
Set text parameter string values.
Parameters:
iParam
Parameter type.
iStart
First character to modify.
iEnd
Last character to modify.
iValue
Parameter input value.
See also:
CATDrwTextProperty
o SetParameterOnSubString
public virtual HRESULT SetParameterOnSubString(CATDrwTextProperty iParam,
int iStart,
int iEnd,
double iValue) = 0
Set text parameter double values.
Parameters:
iParam
Parameter type.
iStart
First character to modify.
iEnd
Last character to modify.
iValue
Parameter input value.
See also:
CATDrwTextProperty
o SetParameterOnSubString
public virtual HRESULT SetParameterOnSubString(CATDrwTextProperty iParam,
int iStart,
int iEnd,
int iValue) = 0
Set text parameter integer values.
Parameters:
iParam
Parameter type.
iStart
First character to modify.
iEnd
Last character to modify.
iValue
Parameter input value.
See also:
CATDrwTextProperty
o SetStringAt
public virtual HRESULT SetStringAt(CATUnicodeString iString,
int iStart=0,
int iEnd=0) = 0
Manage the text string.
Parameters:
iString
String to add to the text.
iStart
First character to modify.
iEnd
Last character to modify.

Parameters combinations :
If iStart and iEnd equal 0 iString is appended to the text.
If iStart equals 0 and iEnd is greater than 0 all text is replaced by iString.
If iStart greater than 0 and iEnd equals 0 iString is inserted at iStart character.
If iStart and iEnd are greater than 0 characters between iStart and iEnd will be replaced iString.
o SetWrappingWidth
public virtual HRESULT SetWrappingWidth(CATDrwWrappingMode imode=CATDrwWrappingAuto,
double iWidth=0.) = 0
Set or unset the wrapping width.
Parameters:
iMode
wrapping text mode.
Refer to CATDrwUtility.
iWidth
Wrapping Width value.

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

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