All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATAnnotationUseItf Interface CATIDrwTextProperties

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

interface CATIDrwTextProperties

Interface to modify font and layout properties of any object that can be seen as a text block.
Role: You can manage all the properties related to the font (font name and size, scoring, color, etc) or to the layout (justification, orientation, frame, etc) of any object that can be seen as a text block using this interface.

Method Index

o GetAnchorPoint(CATDrwAnchorPoint&): Gets the AnchorPoint of the text box.
o GetAutoFlip(boolean&): Gets the AutoFlip style of the font.
o GetBlankingMode(CATDrwBlankingMode&): Get the blanking activity.
o GetBold(boolean&): Gets the Bold style of the font.
o GetCharacterSpacing(double&): Gets the character spacing of the font.
o GetFontColor(unsigned int&,unsigned int&,unsigned int&,unsigned int&): Gets the Color of the font.
o GetFontName(CATUnicodeString&): Gets the short name of the font.
o GetFontPitch(CATDrwPitchDefinition&): Gets the Pitch of the font.
o GetFontRatio(double&): Gets the FontRatio value of the text.
o GetFontSize(double&): Gets the size of the font in millimeter (mm).
o GetFontSlant(double&): Gets the FontSlant value of the text.
o GetFrameColor(unsigned int&,unsigned int&,unsigned int&,unsigned int&): Gets the Color of the frame.
o GetFrameLineType(unsigned int&): Gets the LineType of the frame.
o GetFrameThickness(unsigned int&): Gets the Thickness of the frame.
o GetFrameType(CATDrwFrameType&): Gets the Type of the Frame surrounding the text.
o GetItalic(boolean&): Gets the Italic style of the font.
o GetJustification(CATDrwJustification&): Gets the Justification of the text inside of its box.
o GetKerning(boolean&): Gets the kerning style of the font.
o GetLineSpacing(double&): Gets the LineSpacing value of the text.
o GetLineSpacingMode(CATDrwLineSpacingDefinition&): Gets the LineSpacing mode of the text.
o GetMirroring(CATDrwMirroringDefinition&): Gets the Mirroring style of the text.
o GetOverline(boolean&): Gets the Overline style of the font.
o GetScaleMode(CATDrwScaleMode&): Gets the scale behaviour of text.
o GetStrikeThru(boolean&): Gets the StrikeThru style of the font.
o GetSubscript(boolean&): Gets the Subscript style of the font.
o GetSubscriptOffsetFactor(double&): Gets subscript offset factor.
o GetSubscriptSizeFactor(double&): Gets subscript size factor.
o GetSuperscript(boolean&): Gets the Superscript style of the font.
o GetSuperscriptOffsetFactor(double&): Gets superscript offset factor.
o GetSuperscriptSizeFactor(double&): Gets superscript size factor.
o GetSupportedFrameTypes(int&,CATDrwFrameType**): Gets all the frame types supported by the text.
o GetSupportedSymbols(CATListOfCATUnicodeString&): Gets all the engineering symbols supported by the annotation.
o GetSymbol(CATUnicodeString&): Gets the engineering symbol attached to the annotation.
o GetTextBackField(int&): Gets the text back field mode.
o GetTextBoxDisplay(CATDftTextBoxDisplay&): Gets the text visualization mode.
o GetUnderline(boolean&): Gets the Underline style of the font.
o GetUnitDisplayMode(CATDrwUnitDisplayMode&): Gets the unit display mode of the text.
o GetWrappingWidth(double&): Gets the text wrapping width.
o IsWrapped(CATDrwWrappingMode&): Gets the wrapping text mode.
o Refresh(CATDrwRefreshContext&): Refreshes the object visualization according to its properties.
o SetAnchorPoint(CATDrwAnchorPoint&): Sets the AnchorPoint of the text box.
o SetAutoFlip(boolean&): Sets the AutoFlip style of the font.
o SetBlankingMode(CATDrwBlankingMode&): Sets the blanking activity.
o SetBold(boolean&): Sets the Bold style of the font.
o SetCharacterSpacing(double&): Sets the character spacing of the font.
o SetFontColor(unsigned int&,unsigned int&,unsigned int&,unsigned int&): Sets the Color of the font.
o SetFontName(CATUnicodeString&): Sets the short name of the font.
o SetFontPitch(CATDrwPitchDefinition&): Sets the Pitch of the font.
o SetFontRatio(double&): Sets the FontRatio value of the text.
o SetFontSize(double&): Sets the size of the font in millimeter (mm).
o SetFontSlant(double&): Sets the FontSlant value of the text.
o SetFrameColor(unsigned int&,unsigned int&,unsigned int&,unsigned int&): Sets the Color of the frame.
o SetFrameLineType(unsigned int&): Sets the LineType of the frame.
o SetFrameThickness(unsigned int&): Sets the Thickness of the frame.
o SetFrameType(CATDrwFrameType&): Sets the Type of the Frame surrounding the text.
o SetItalic(boolean&): Sets the Italic style of the font.
o SetJustification(CATDrwJustification&): Sets the Justification of the text inside of its box.
o SetKerning(boolean&): Sets the Kerning style of the font.
o SetLineSpacing(double&): Sets the LineSpacing value of the text.
o SetLineSpacingMode(CATDrwLineSpacingDefinition&): Sets the LineSpacing mode of the text.
o SetMirroring(CATDrwMirroringDefinition&): Sets the Mirroring style of the text.
o SetOverline(boolean&): Sets the Overline style of the font.
o SetScaleMode(CATDrwScaleMode&): Sets the scale behaviour of text.
o SetStrikeThru(boolean&): Sets the StrikeThru style of the font.
o SetSubscript(boolean&): Sets the Subscript style of the font.
o SetSubscriptOffsetFactor(double&): Sets superscript offset factor.
o SetSubscriptSizeFactor(double&): Sets superscript size factor.
o SetSuperscript(boolean&): Sets the Superscript style of the font.
o SetSuperscriptOffsetFactor(double&): Sets superscript offset factor.
o SetSuperscriptSizeFactor(double&): Sets superscript size factor.
o SetSymbol(CATUnicodeString&): Sets the engineering symbol attached to the text.
o SetTextBackField(int&): Sets the text back field mode.
o SetTextBoxDisplay(CATDftTextBoxDisplay&): Sets the text visualization mode.
o SetUnderline(boolean&): Sets the Underline style of the font.
o SetUnitDisplayMode(CATDrwUnitDisplayMode&): Sets the unit display mode of the text.
o SetValue(CATIDrwTextProperties_var&): Sets all possible property values according to the ones defined by iValue.
o SetWrappingWidth(CATDrwWrappingMode,double): Sets or unset the wrapping width.

Methods

o GetAnchorPoint

public virtual GetAnchorPoint( oAnchorPoint)

Gets the AnchorPoint of the text box.

Parameters:

oAnchorPoint: The AnchorPoint of the text box.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetAutoFlip

public virtual GetAutoFlip( oAutoFlip)

Gets the AutoFlip style of the font.

Parameters:

oAutoFlip

The AutoFlip style of the font.
Legal values:

True: writing angle between -90 deg and +90 deg.
False: writing angle between 0 deg and 360 deg.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetBlankingMode

public virtual GetBlankingMode( oBlankingMode)

Get the blanking activity.

Parameters:

oBlankingMode: The active mode on the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetBold

public virtual GetBold( oBold)

Gets the Bold style of the font.

Parameters:

oBold: The Bold style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetCharacterSpacing

public virtual GetCharacterSpacing( oCharSpacing)

Gets the character spacing of the font.

Parameters:

oCharSpacing: The space between two character.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFontColor

public virtual GetFontColor(		`oRed`,
		`oGreen`,
		`oBlue`,
		`oAlpha`)

Gets the Color of the font.

Parameters:

oRed: The red component of the font color.
Legal values:
Between 0 and 255
oGreen: The green component of the font color.
Legal values:
Between 0 and 255
oBlue: The blue component of the font color.
Legal values:
Between 0 and 255
oAlpha: The alpha component of the font color.
Legal values:
Between 0 and 255

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFontName

public virtual GetFontName( oFontName)

Gets the short name of the font.

Parameters:

oFontName: The short name of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetFontPitch

public virtual GetFontPitch( oFontPitch)

Gets the Pitch of the font.

Parameters:

oFontPitch: The Pitch of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetFontRatio

public virtual GetFontRatio( oFontRatio)

Gets the FontRatio value of the text.

Parameters:

oFontRatio: The font ratio (width/height) value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFontSize

public virtual GetFontSize( oFontSize)

Gets the size of the font in millimeter (mm).

Parameters:

oFontSize: The size of the font in millimeter (mm).

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFontSlant

public virtual GetFontSlant( oFontSlant)

Gets the FontSlant value of the text.

Parameters:

oFontSlant: The font slant (angle) value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFrameColor

public virtual GetFrameColor(		`oRed`,
		`oGreen`,
		`oBlue`,
		`oAlpha`)

Gets the Color of the frame.

Parameters:

oRed: The red component of the frame color.
Legal values:
Between 0 and 255
oGreen: The green component of the frame color.
Legal values:
Between 0 and 255
oBlue: The blue component of the frame color.
Legal values:
Between 0 and 255
oAlpha: The alpha component of the frame color.
Legal values:
Between 0 and 255

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetFrameLineType

public virtual GetFrameLineType( oLineType)

Gets the LineType of the frame.

Parameters:

oLineType: The indice defining the line type of the frame.
Legal values:
Between 1 and 63

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetFrameThickness

public virtual GetFrameThickness( oThickness)

Gets the Thickness of the frame.

Parameters:

oThickness: The indice defining the thickness of the frame.
Legal values:
Between 1 and 63

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetFrameType

public virtual GetFrameType( oFrameType)

Gets the Type of the Frame surrounding the text.

Parameters:

oFrameType: The Type of the Frame surrounding the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetItalic

public virtual GetItalic( oItalic)

Gets the Italic style of the font.

Parameters:

oItalic: The Italic style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetJustification

public virtual GetJustification( oJustification)

Gets the Justification of the text inside of its box.

Parameters:

oJustification: The Justification of the text inside of its box.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetKerning

public virtual GetKerning( oKerning)

Gets the kerning style of the font.

Parameters:

oKerning: The kerning style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetLineSpacing

public virtual GetLineSpacing( oLineSpacing)

Gets the LineSpacing value of the text.

Parameters:

oLineSpacing: The LineSpacing value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetLineSpacingMode

public virtual GetLineSpacingMode( oLineSpacingMode)

Gets the LineSpacing mode of the text.

Parameters:

oLineSpacingMode: The LineSpacing mode of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetMirroring

public virtual GetMirroring( oMirroring)

Gets the Mirroring style of the text.

Parameters:

oMirroring: The Mirroring style of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetOverline

public virtual GetOverline( oOverline)

Gets the Overline style of the font.

Underline and Overline styles are usualy mutualy exclusive.

Parameters:

oOverline: The Overline style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetScaleMode

public virtual GetScaleMode( oScaleMode)

Gets the scale behaviour of text.

Parameters:

oScaleMode: The scale mode for the text (does the text follow the view scale ?)

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetStrikeThru

public virtual GetStrikeThru( oStrikeThru)

Gets the StrikeThru style of the font.

Parameters:

oStrikeThru: The StrikeThru style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSubscript

public virtual GetSubscript( oSubscript)

Gets the Subscript style of the font.

Superscript and Subscript styles are mutualy exclusive.

Parameters:

oSubscript: The Subscript style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSubscriptOffsetFactor

public virtual GetSubscriptOffsetFactor( oValue)

Gets subscript offset factor.

Parameters:

oValue.: The subscript offset factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSubscriptSizeFactor

public virtual GetSubscriptSizeFactor( oValue)

Gets subscript size factor.

Parameters:

oValue.: The subscript size factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSuperscript

public virtual GetSuperscript( oSuperscript)

Gets the Superscript style of the font.

Superscript and Subscript styles are mutualy exclusive.

Parameters:

oSuperscript: The Superscript style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSuperscriptOffsetFactor

public virtual GetSuperscriptOffsetFactor( oValue)

Gets superscript offset factor.

Parameters:

oValue.: The superscript offset factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSuperscriptSizeFactor

public virtual GetSuperscriptSizeFactor( oValue)

Gets superscript size factor.

Parameters:

oValue.: The superscript size factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSupportedFrameTypes

public virtual GetSupportedFrameTypes(		`oNbOfSupportedFrameTypes`,
		`oSupportedFrameTypesArray`)

Gets all the frame types supported by the text.

Parameters:

oNbOfSupportedFrameTypes

The number of frame types supported by the text.
Legal values:

-1: Supports all frame types defined by CATDrwFrameType enum.
0: No frame type supported.; 1+; Number of frame types supported by the text.
Their type is given in oSupportedFrameTypesArray.

oSupportedFrameTypesArray

Array of all the CATDrwFrameType supported by the text. Can be NULL.

Must be allocated by the callee and deleted by the caller.

Returns:

An HRESULT value.
Legal values:

S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetSupportedSymbols

public virtual GetSupportedSymbols( oSupportedSymbols)

Gets all the engineering symbols supported by the annotation.

Parameters:

oSupportedSymbolsArray: Array of all the symbol supported by the annotation.

Returns:

An HRESULT value.
Legal values:

S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetSymbol

public virtual GetSymbol( oSymbol)

Gets the engineering symbol attached to the annotation.

Parameters:

oSymbol: The engineering symbol attached to the annotation. The list of available symbols is obtained by the method GetSupportedSymbols.

See also:

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetTextBackField

public virtual GetTextBackField( oValue)

Gets the text back field mode.

Parameters:

oValue

The text back field mode.
Legal values:

Back field mode is unset.

Back field mode is set.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetTextBoxDisplay

public virtual GetTextBoxDisplay( oModeDisplay)

Gets the text visualization mode.

Parameters:

oModeDisplay: The text visualization mode

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetUnderline

public virtual GetUnderline( oUnderline)

Gets the Underline style of the font.

Underline and Overline styles are usualy mutualy exclusive.

Parameters:

oUnderline: The Underline style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o GetUnitDisplayMode

public virtual GetUnitDisplayMode( oUnitDisplayMode)

Gets the unit display mode of the text.

Parameters:

oUnitDisplayMode: The display mode of units in a text (if the text contains (a) parameter(s) with unit(s))

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o GetWrappingWidth

public virtual GetWrappingWidth( oWidth)

Gets the text wrapping width.

Parameters:

oWidth: Wrapping width value.

o IsWrapped

public virtual IsWrapped( oMode)

Gets the wrapping text mode.

Parameters:

oMode: Wrapping text mode.
Refer to CATDrwUtility.

o Refresh

public virtual Refresh( const iRefreshContext = CATDrwRefreshNone )

Refreshes the object visualization according to its properties.

Parameters:

iRefreshContext

The specific context in which you want to refresh your object.
Legal values:

CATDrwRefreshNone: No specific context as been defined until now, so that it's the only legal value for now.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.
E_FAIL: Method execution failed. Reasons of the failure are not given.
E_NOTIMPL: No implementation available for this method.

See also:

o SetAnchorPoint

public virtual SetAnchorPoint( const iAnchorPoint)

Sets the AnchorPoint of the text box.

Parameters:

iAnchorPoint: The AnchorPoint of the text box.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetAutoFlip

public virtual SetAutoFlip( const iAutoFlip)

Sets the AutoFlip style of the font.

Parameters:

iAutoFlip

The AutoFlip style of the font.
Legal values:

True: writing angle between -90 deg and +90 deg.
False: writing angle between 0 deg and 360 deg.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetBlankingMode

public virtual SetBlankingMode( const iBlankingMode)

Sets the blanking activity.

Parameters:

iBlankingMode: The mode to activate on the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetBold

public virtual SetBold( const iBold)

Sets the Bold style of the font.

Parameters:

iBold: The Bold style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetCharacterSpacing

public virtual SetCharacterSpacing( const iCharSpacing)

Sets the character spacing of the font.

Parameters:

iCharSpacing: The space between two character.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFontColor

public virtual SetFontColor( const iRed,
const iGreen,
const iBlue,
const iAlpha = 255 )

Sets the Color of the font.

Parameters:

iRed: The red component of the font color.
Legal values:
Between 0 and 255
iGreen: The green component of the font color.
Legal values:
Between 0 and 255
iBlue: The blue component of the font color.
Legal values:
Between 0 and 255
iAlpha: The alpha component of the font color.
Legal values:
Between 0 and 255

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFontName

public virtual SetFontName( const iFontName)

Sets the short name of the font.

Parameters:

iFontName: The short name of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetFontPitch

public virtual SetFontPitch( const iFontPitch)

Sets the Pitch of the font.

Parameters:

iFontPitch: The Pitch of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetFontRatio

public virtual SetFontRatio( const iFontRatio)

Sets the FontRatio value of the text.

Parameters:

iFontRatio: The font ratio (width/height) value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFontSize

public virtual SetFontSize( const iFontSize)

Sets the size of the font in millimeter (mm).

Parameters:

iFontSize: The size of the font in millimeter (mm).

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFontSlant

public virtual SetFontSlant( const iFontSlant)

Sets the FontSlant value of the text.

Parameters:

iFontSlant: The font slant (angle) value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFrameColor

public virtual SetFrameColor( const iRed,
const iGreen,
const iBlue,
const iAlpha = 255 )

Sets the Color of the frame.

Parameters:

iRed: The red component of the frame color.
Legal values:
Between 0 and 255
iGreen: The green component of the frame color.
Legal values:
Between 0 and 255
iBlue: The blue component of the frame color.
Legal values:
Between 0 and 255
iAlpha: The alpha component of the frame color.
Legal values:
Between 0 and 255

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetFrameLineType

public virtual SetFrameLineType( const iLineType)

Sets the LineType of the frame.

Parameters:

iLineType: The indice defining the line type of the frame.
Legal values:
Between 1 and 63

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetFrameThickness

public virtual SetFrameThickness( const iThickness)

Sets the Thickness of the frame.

Parameters:

iThickness: The indice defining the thickness of the frame.
Legal values:
Between 1 and 63

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetFrameType

public virtual SetFrameType( const iFrameType)

Sets the Type of the Frame surrounding the text.

Parameters:

iFrameType: The Type of the Frame surrounding the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetItalic

public virtual SetItalic( const iItalic)

Sets the Italic style of the font.

Parameters:

iItalic: The Italic style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetJustification

public virtual SetJustification( const iJustification)

Sets the Justification of the text inside of its box.

Parameters:

iJustification: The Justification of the text inside of its box.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetKerning

public virtual SetKerning( const iKerning)

Sets the Kerning style of the font.

Parameters:

iKerning: The Kerning style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetLineSpacing

public virtual SetLineSpacing( const iLineSpacing)

Sets the LineSpacing value of the text.

Parameters:

iLineSpacing: The LineSpacing value of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetLineSpacingMode

public virtual SetLineSpacingMode( const iLineSpacingMode)

Sets the LineSpacing mode of the text.

Parameters:

iLineSpacingMode: The LineSpacing mode of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetMirroring

public virtual SetMirroring( const iMirroring)

Sets the Mirroring style of the text.

Parameters:

iMirroring: The Mirroring style of the text.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetOverline

public virtual SetOverline( const iOverline)

Sets the Overline style of the font.

Underline and Overline styles are usualy mutualy exclusive.

Parameters:

iOverline: The Overline style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetScaleMode

public virtual SetScaleMode( const iScaleMode)

Sets the scale behaviour of text.

Parameters:

iScaleMode: The scale mode for the text (should the text follow the view scale ?)

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetStrikeThru

public virtual SetStrikeThru( const iStrikeThru)

Sets the StrikeThru style of the font.

Parameters:

iStrikeThru: The StrikeThru style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSubscript

public virtual SetSubscript( const iSubscript)

Sets the Subscript style of the font.

Superscript and Subscript styles are mutualy exclusive.

Parameters:

iSubscript: The Subscript style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSubscriptOffsetFactor

public virtual SetSubscriptOffsetFactor( const iValue)

Sets superscript offset factor.

Parameters:

iValue.: The superscript offset factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSubscriptSizeFactor

public virtual SetSubscriptSizeFactor( const iValue)

Sets superscript size factor.

Parameters:

iValue.: The superscript size factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSuperscript

public virtual SetSuperscript( const iSuperscript)

Sets the Superscript style of the font.

Superscript and Subscript styles are mutualy exclusive.

Parameters:

iSuperscript: The Superscript style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSuperscriptOffsetFactor

public virtual SetSuperscriptOffsetFactor( const iValue)

Sets superscript offset factor.

Parameters:

iValue.: The superscript offset factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSuperscriptSizeFactor

public virtual SetSuperscriptSizeFactor( const iValue)

Sets superscript size factor.

Parameters:

iValue.: The superscript size factor.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetSymbol

public virtual SetSymbol( const iSymbol)

Sets the engineering symbol attached to the text.

See also:

Parameters:

iSymbol: The engineering symbol attached to the annotation.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetTextBackField

public virtual SetTextBackField( const iValue)

Sets the text back field mode.

Parameters:

iValue

The text back field mode.
Legal values:

Back field mode unset.

Back field mode set.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetTextBoxDisplay

public virtual SetTextBoxDisplay( const iModeDisplay)

Sets the text visualization mode.

Parameters:

iModeDisplay: The text visualization mode

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetUnderline

public virtual SetUnderline( const iUnderline)

Sets the Underline style of the font.

Underline and Overline styles are usualy mutualy exclusive.

Parameters:

iUnderline: The Underline style of the font.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetUnitDisplayMode

public virtual SetUnitDisplayMode( const iUnitDisplayMode)

Sets the unit display mode of the text.

Parameters:

iUnitDisplayMode: The display mode of units in a text (if the text contains (a) parameter(s) with unit(s))

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
S_READONLY: Method correctly executed.; Returned value cannot be modified, it's read-only.; Can be usefull when the property is fixed by a standard, etc.
S_UNDEFINED: Method correctly executed.; Returned value is undefined.; Case of an object having several subparts supporting the same property with a different value.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

See also:

o SetValue

public virtual SetValue( const iValue)

Sets all possible property values according to the ones defined by iValue.

Parameters:

iValue: The object which text properties will be copied.

Returns:

An HRESULT value.
Legal values:

S_OK: Method correctly executed.; No restriction.
E_FAIL: Method execution failed.; Reasons of the failure are not given.
E_IMPL: No implementation available for this method.

o SetWrappingWidth

public virtual SetWrappingWidth( imode = CATDrwWrappingAuto,
iWidth = 0.)

Sets or unset the wrapping width.

Parameters:

iMode: wrapping text mode.
Refer to CATDrwUtility.
iWidth: Wrapping Width value.

CATIDrwTextProperties.h
CATAnnotationUseItf

public virtual SetFontColor(	const	`iRed`,
	const	`iGreen`,
	const	`iBlue`,
	const	`iAlpha`	`= 255` )

public virtual SetFrameColor(	const	`iRed`,
	const	`iGreen`,
	const	`iBlue`,
	const	`iAlpha`	`= 255` )

public virtual SetWrappingWidth(		`imode`	`= CATDrwWrappingAuto`,
		`iWidth`	`= 0.`)