All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftTextRange

System.IUnknown
  |
  +---CATIDftTextRange
 

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


interface CATIDftTextRange

Manage texts by selection in this text.


Method Index


o GetLength(int*)
Get the number of character of the text range.
o GetStart(int*)
Get the start index of the text range.
o GetString(wchar_t**)
Get the text of the current selection.
o GetTextProperties(CATIDftTextProperties**)
Returns a Properties interface on the text range.
o InsertSymbol(CATUnicodeString&,int)
Manage symbol.
o InsertSymbol(wchar_t*,int,int,wchar_t*)
o SetString(wchar_t*)
Modify the current text range with a new string.

Methods


o GetLength
public virtual HRESULT GetLength(int* oLength)=0
Get the number of character of the text range.
Parameters:
oLength
the text range length.
o GetStart
public virtual HRESULT GetStart(int* oStart)=0
Get the start index of the text range.
Parameters:
oStart
the start index of the text range.
o GetString
public virtual HRESULT GetString(wchar_t** oStg) = 0
Get the text of the current selection.
Parameters:
ostg
The returned text
o GetTextProperties
public virtual HRESULT GetTextProperties(CATIDftTextProperties** TextProperties) = 0
Returns a Properties interface on the text range.
Equivalent to a standard QueryInterface on the text range
Parameters:
oTextProperties
The pointer on the asked interface. Can be NULL if the adhesion doesn't exists.
o InsertSymbol
public virtual HRESULT InsertSymbol( const CATUnicodeString& iSymbolName,
int iStart) = 0
Manage symbol.
Parameters:
iSymbolName
symbol name as described in Standard
iStart
location
iEnd
location
o InsertSymbol
public virtual HRESULT InsertSymbol( const wchar_t* iSymbol,
int iStart,
int iEnd,
wchar_t* iFont=NULL) = 0
Deprecated:
V5R17 use CATIDftTextRange::InsertSymbol Manage symbol.
Parameters:
iSymbol
symbol
iStart
location
iEnd
location
iFont
Font name to use for this symbol. Default CATIASymbols.
o SetString
public virtual HRESULT SetString( const wchar_t* iStg) = 0
Modify the current text range with a new string.
Parameters:
iStg
Text to insert/replace.
If the selection is a cursor, the text will be inserted.
If not the slection will be replaced.

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

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