All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDrwTextProperties
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---DraftingInterfaces.CATIDrwProperties
|
+---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
GetSupportedSymbols(int&,CATDrwSymbol**)
-
- o
GetSymbol(CATDrwSymbol&)
-
- 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
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(CATDrwSymbol&)
-
- 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
-
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:
- CATDrwAnchorPoint
o GetAutoFlip
public virtual HRESULT GetAutoFlip( | boolean& | oAutoFlip)= 0 |
-
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 HRESULT GetBlankingMode( | CATDrwBlankingMode& | oBlankingMode)= 0 |
-
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:
- CATDrwUnitDisplayMode
o GetBold
public virtual HRESULT GetBold( | boolean& | oBold)= 0 |
-
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 HRESULT GetCharacterSpacing( | double& | oCharSpacing)= 0 |
-
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 HRESULT GetFontColor( | unsigned int& | oRed, |
| unsigned int& | oGreen, |
| unsigned int& | oBlue, |
| unsigned int& | oAlpha)= 0 |
-
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
-
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:
- CATFont
o GetFontPitch
-
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:
- CATDrwPitchDefinition
o GetFontRatio
public virtual HRESULT GetFontRatio( | double& | oFontRatio)= 0 |
-
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 HRESULT GetFontSize( | double& | oFontSize)= 0 |
-
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 HRESULT GetFontSlant( | double& | oFontSlant)= 0 |
-
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 HRESULT GetFrameColor( | unsigned int& | oRed, |
| unsigned int& | oGreen, |
| unsigned int& | oBlue, |
| unsigned int& | oAlpha)= 0 |
-
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 HRESULT GetFrameLineType( | unsigned int& | oLineType)= 0 |
-
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:
- CATVisPropertiesValues
o GetFrameThickness
public virtual HRESULT GetFrameThickness( | unsigned int& | oThickness)= 0 |
-
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:
- CATVisPropertiesValues
o GetFrameType
-
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:
- CATDrwFrameType
o GetItalic
public virtual HRESULT GetItalic( | boolean& | oItalic)= 0 |
-
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
-
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:
- CATDrwJustification
o GetKerning
public virtual HRESULT GetKerning( | boolean& | oKerning)= 0 |
-
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 HRESULT GetLineSpacing( | double& | oLineSpacing)= 0 |
-
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:
- CATDrwLineSpacingDefinition
o GetLineSpacingMode
-
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:
- CATDrwLineSpacingDefinition
o GetMirroring
-
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:
- CATDrwMirroringDefinition
o GetOverline
public virtual HRESULT GetOverline( | boolean& | oOverline)= 0 |
-
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
-
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:
- CATDrwScaleMode
o GetStrikeThru
public virtual HRESULT GetStrikeThru( | boolean& | oStrikeThru)= 0 |
-
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 HRESULT GetSubscript( | boolean& | oSubscript)= 0 |
-
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 HRESULT GetSubscriptOffsetFactor( | double& | oValue) = 0 |
-
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 HRESULT GetSubscriptSizeFactor( | double& | oValue) = 0 |
-
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 HRESULT GetSuperscript( | boolean& | oSuperscript)= 0 |
-
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 HRESULT GetSuperscriptOffsetFactor( | double& | oValue) = 0 |
-
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 HRESULT GetSuperscriptSizeFactor( | double& | oValue) = 0 |
-
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 HRESULT GetSupportedFrameTypes( | int& | oNbOfSupportedFrameTypes, |
| CATDrwFrameType** | oSupportedFrameTypesArray)= 0 |
-
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:
- CATDrwFrameType
o GetSupportedSymbols
-
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 GetSupportedSymbols
public virtual HRESULT GetSupportedSymbols( | int& | oNbOfSupportedSymbols, |
| CATDrwSymbol** | oSupportedSymbolsArray)= 0 |
-
- Deprecated:
- V5R17 use CATIDrwTextProperties#GetSupportedSymbols(CATListOfCATUnicodeString & oSupportedSymbolsArray)
Gets all the engineering symbols supported by the text.
- Parameters:
-
- oNbOfSupportedSymbols
- The number of engineering symbols supported by the text.
Legal values:
- -1
- Supports all engineering symbols defined by CATDrwSymbol enum.
- 0
- No symbol supported.
- 1+
- Number of engineering symbols supported by the text.
- Their type is given in oSupportedSymbolsArray.
- oSupportedSymbolsArray
- Array of all the CATDrwSymbol 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:
- CATDrwSymbol
o GetSymbol
-
- Deprecated:
- V5R17 use CATIDrwTextProperties#GetSymbol(CATUnicodeString & oSymbol)
Gets the engineering symbol attached to the text.
- Parameters:
-
- oSymbol
- The engineering symbol attached to 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:
- CATDrwSymbol
o GetSymbol
-
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:
- CATIDrwTextProperties.GetSupportedSymbols
- 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 HRESULT GetTextBackField( | int& | oValue) = 0 |
-
Gets the text back field mode.
- Parameters:
-
- oValue
- The text back field mode.
Legal values:
0
- Back field mode is unset.
1
- 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
-
-
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 HRESULT GetUnderline( | boolean& | oUnderline)= 0 |
-
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
-
-
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:
- CATDrwUnitDisplayMode
- o GetWrappingWidth
-
public virtual HRESULT GetWrappingWidth( | double& | oWidth) = 0 |
-
Gets the text wrapping width.
- Parameters:
-
- oWidth
- Wrapping width value.
- o IsWrapped
-
-
Gets the wrapping text mode.
- Parameters:
-
- oMode
- Wrapping text mode.
Refer to CATDrwUtility.
- o SetAnchorPoint
-
-
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:
- CATDrwAnchorPoint
- o SetAutoFlip
-
public virtual HRESULT SetAutoFlip( | const boolean& | iAutoFlip)= 0 |
-
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 HRESULT SetBlankingMode( | const CATDrwBlankingMode& | iBlankingMode)= 0 |
-
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:
- CATDrwBlankingMode
- o SetBold
-
public virtual HRESULT SetBold( | const boolean& | iBold)= 0 |
-
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 HRESULT SetCharacterSpacing( | const double& | iCharSpacing)= 0 |
-
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 HRESULT SetFontColor( | const unsigned int& | iRed, |
| const unsigned int& | iGreen, |
| const unsigned int& | iBlue, |
| const unsigned int& | iAlpha | = 255 )= 0 |
-
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
-
-
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:
- CATFont
- o SetFontPitch
-
-
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:
- CATDrwPitchDefinition
- o SetFontRatio
-
public virtual HRESULT SetFontRatio( | const double& | iFontRatio)= 0 |
-
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 HRESULT SetFontSize( | const double& | iFontSize)= 0 |
-
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 HRESULT SetFontSlant( | const double& | iFontSlant)= 0 |
-
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 HRESULT SetFrameColor( | const unsigned int& | iRed, |
| const unsigned int& | iGreen, |
| const unsigned int& | iBlue, |
| const unsigned int& | iAlpha | = 255 )= 0 |
-
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 HRESULT SetFrameLineType( | const unsigned int& | iLineType)= 0 |
-
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:
- CATVisPropertiesValues
- o SetFrameThickness
-
public virtual HRESULT SetFrameThickness( | const unsigned int& | iThickness)= 0 |
-
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:
- CATVisPropertiesValues
- o SetFrameType
-
-
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:
- CATDrwFrameType
- o SetItalic
-
public virtual HRESULT SetItalic( | const boolean& | iItalic)= 0 |
-
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
-
-
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:
- CATDrwJustification
- o SetKerning
-
public virtual HRESULT SetKerning( | const boolean& | iKerning)= 0 |
-
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 HRESULT SetLineSpacing( | const double& | iLineSpacing)= 0 |
-
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:
- CATDrwLineSpacingDefinition
- o SetLineSpacingMode
-
-
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:
- CATDrwLineSpacingDefinition
- o SetMirroring
-
-
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:
- CATDrwMirroringDefinition
- o SetOverline
-
public virtual HRESULT SetOverline( | const boolean& | iOverline)= 0 |
-
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
-
-
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:
- CATDrwScaleMode
- o SetStrikeThru
-
public virtual HRESULT SetStrikeThru( | const boolean& | iStrikeThru)= 0 |
-
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 HRESULT SetSubscript( | const boolean& | iSubscript)= 0 |
-
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 HRESULT SetSubscriptOffsetFactor( | const double& | iValue) = 0 |
-
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 HRESULT SetSubscriptSizeFactor( | const double& | iValue) = 0 |
-
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 HRESULT SetSuperscript( | const boolean& | iSuperscript)= 0 |
-
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 HRESULT SetSuperscriptOffsetFactor( | const double& | iValue) = 0 |
-
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 HRESULT SetSuperscriptSizeFactor( | const double& | iValue) = 0 |
-
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
-
-
- Deprecated:
- V5R17 use CATIDrwTextProperties#SetSymbol(const CATUnicodeString & iSymbol)
Sets the engineering symbol attached to the text.
- Parameters:
-
- iSymbol
- The engineering symbol attached to 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:
- CATDrwSymbol
- o SetSymbol
-
-
Sets the engineering symbol attached to the text.
- See also:
- CATIDrwTextProperties.GetSupportedSymbols
- 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 HRESULT SetTextBackField( | const int& | iValue) = 0 |
-
Sets the text back field mode.
- Parameters:
-
- iValue
- The text back field mode.
Legal values:
0
- Back field mode unset.
1
- 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
-
-
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 HRESULT SetUnderline( | const boolean& | iUnderline)= 0 |
-
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
-
-
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:
- CATDrwUnitDisplayMode
- o SetValue
-
public virtual HRESULT SetValue( | const CATIDrwTextProperties_var& | iValue)= 0 |
-
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
-
-
Sets or unset the wrapping width.
- Parameters:
-
- iMode
- wrapping text mode.
Refer to CATDrwUtility.
- iWidth
- Wrapping Width value.
This object is included in the file: CATIDrwTextProperties.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces