All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

SpaceAnalysisInterfaces Interface CATISPAMeasureSettingAtt

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISPAMeasureSettingAtt
 

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


interface CATISPAMeasureSettingAtt

Definition of all parameters in Measure Tools.


Method Index


o GetBoxDisplay(int*)
Retrieves the BoxDisplay attribute.
o GetBoxDisplayInfo(CATSettingInfo*)
Retrieves the state of the BoxDisplay parameter.
o GetLabelColor(unsigned int*)
Retrieves the LabelColor attribute.
o GetLabelColorInfo(CATSettingInfo*)
Retrieves the state of the LabelColor parameter.
o GetLineWidth(int*)
Retrieves the LineWidth attribute.
o GetLineWidthInfo(CATSettingInfo*)
Retrieves the state of the LineWidth parameter.
o GetPartUpdateStatus(int*)
Retrieves the PartUpdateStatus attribute.
o GetPartUpdateStatusInfo(CATSettingInfo*)
Retrieves the state of the PartUpdateStatus parameter.
o GetProductUpdateStatus(int*)
Retrieves the ProductUpdateStatus attribute.
o GetProductUpdateStatusInfo(CATSettingInfo*)
Retrieves the state of the ProductUpdateStatus parameter.
o GetTextColor(unsigned int*)
Retrieves the TextColor attribute.
o GetTextColorInfo(CATSettingInfo*)
Retrieves the state of the TextColor parameter.
o GetTildeDisplay(int*)
Retrieves the TildeDisplay attribute.
o GetTildeDisplayInfo(CATSettingInfo*)
Retrieves the state of the TildeDisplay parameter.
o SetBoxDisplay(int*)
Sets the BoxDisplay attribute.
o SetBoxDisplayLock(unsigned char)
Locks or unlocks the BoxDisplay parameter.
o SetLabelColor(unsigned int*)
Sets the LabelColor attribute.
o SetLabelColorLock(unsigned char)
Locks or unlocks the LabelColor parameter.
o SetLineWidth(int*)
Sets the LineWidth attribute.
o SetLineWidthLock(unsigned char)
Locks or unlocks the LineWidth parameter.
o SetPartUpdateStatus(int*)
Sets the PartUpdateStatus attribute.
o SetPartUpdateStatusLock(unsigned char)
Locks or unlocks the PartUpdateStatus parameter.
o SetProductUpdateStatus(int*)
Sets the ProductUpdateStatus attribute.
o SetProductUpdateStatusLock(unsigned char)
Locks or unlocks the ProductUpdateStatus parameter.
o SetTextColor(unsigned int*)
Sets the TextColor attribute.
o SetTextColorLock(unsigned char)
Locks or unlocks the TextColor parameter.
o SetTildeDisplay(int*)
Sets the TildeDisplay attribute.
o SetTildeDisplayLock(unsigned char)
Locks or unlocks the TildeDisplay parameter.

Methods


o GetBoxDisplay
public virtual HRESULT GetBoxDisplay(int* oBoxDisplay)= 0
Retrieves the BoxDisplay attribute.
Parameters:
ioBoxDisplay
Legal values:
0 : Measure label background is filled.
1 : Measure label has no background, only borders.
o GetBoxDisplayInfo
public virtual HRESULT GetBoxDisplayInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the BoxDisplay parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLabelColor
public virtual HRESULT GetLabelColor(unsigned int* oLabelColor)= 0
Retrieves the LabelColor attribute.
Parameters:
ioLabelColor:
Legal values:
Array of 3 unsigned int (R,G,B).
o GetLabelColorInfo
public virtual HRESULT GetLabelColorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the LabelColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLineWidth
public virtual HRESULT GetLineWidth(int* oLineWidth)= 0
Retrieves the LineWidth attribute.
Parameters:
ioLineWidth:
Legal values:
The line weight returned ranges from 1 to 63.
o GetLineWidthInfo
public virtual HRESULT GetLineWidthInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the LineWidth parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPartUpdateStatus
public virtual HRESULT GetPartUpdateStatus(int* oPartUpdateStatus)= 0
Retrieves the PartUpdateStatus attribute.
Parameters:
ioPartUpdateStatus
Legal values:
0 : No automatic update in part.
1 : Automatic update in part.
o GetPartUpdateStatusInfo
public virtual HRESULT GetPartUpdateStatusInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the PartUpdateStatus parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetProductUpdateStatus
public virtual HRESULT GetProductUpdateStatus(int* oProductUpdateStatus)= 0
Retrieves the ProductUpdateStatus attribute.
Parameters:
ioProductUpdateStatus
Legal values:
0 : No automatic update in product.
1 : Automatic update in product.
o GetProductUpdateStatusInfo
public virtual HRESULT GetProductUpdateStatusInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the ProductUpdateStatus parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTextColor
public virtual HRESULT GetTextColor(unsigned int* oTextColor)= 0
Retrieves the TextColor attribute.
Parameters:
ioTextColor:
Legal values:
Array of 3 unsigned int (R,G,B).
o GetTextColorInfo
public virtual HRESULT GetTextColorInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the TextColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetTildeDisplay
public virtual HRESULT GetTildeDisplay(int* oTildeDisplay)= 0
Retrieves the TildeDisplay attribute.
Parameters:
ioTildeDisplay
Legal values:
0 : No tilde displayed for approximate measurement.
1 : Tilde displayed for approximate measurement.
o GetTildeDisplayInfo
public virtual HRESULT GetTildeDisplayInfo(CATSettingInfo* oInfo)= 0
Retrieves the state of the TildeDisplay parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoxDisplay
public virtual HRESULT SetBoxDisplay(int* iBoxDisplay)= 0
Sets the BoxDisplay attribute.
Parameters:
iBoxDisplay
Legal values:
0 : Measure label background is filled.
1 : Measure label has no background, only borders.
o SetBoxDisplayLock
public virtual HRESULT SetBoxDisplayLock(unsigned char iLocked)= 0
Locks or unlocks the BoxDisplay parameter.
Role: Locks or unlocks the BoxDisplay parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLabelColor
public virtual HRESULT SetLabelColor(unsigned int* iLabelColor)= 0
Sets the LabelColor attribute.
Parameters:
iLabelColor:
Legal values:
Array of 3 unsigned int (R,G,B).
o SetLabelColorLock
public virtual HRESULT SetLabelColorLock(unsigned char iLocked)= 0
Locks or unlocks the LabelColor parameter.
Role: Locks or unlocks the LabelColor parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLineWidth
public virtual HRESULT SetLineWidth(int* iLineWidth)= 0
Sets the LineWidth attribute.
Parameters:
iLineWidth:
Legal values:
The line weight returned ranges from 1 to 63.
o SetLineWidthLock
public virtual HRESULT SetLineWidthLock(unsigned char iLocked)= 0
Locks or unlocks the LineWidth parameter.
Role: Locks or unlocks the LineWidth parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPartUpdateStatus
public virtual HRESULT SetPartUpdateStatus(int* iPartUpdateStatus)= 0
Sets the PartUpdateStatus attribute.
Parameters:
iPartUpdateStatus
Legal values:
0 : No automatic update in part.
1 : Automatic update in part.
o SetPartUpdateStatusLock
public virtual HRESULT SetPartUpdateStatusLock(unsigned char iLocked)= 0
Locks or unlocks the PartUpdateStatus parameter.
Role: Locks or unlocks the PartUpdateStatus parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetProductUpdateStatus
public virtual HRESULT SetProductUpdateStatus(int* iProductUpdateStatus)= 0
Sets the ProductUpdateStatus attribute.
Parameters:
iProductUpdateStatus
Legal values:
0 : No automatic update in product.
1 : Automatic update in product.
o SetProductUpdateStatusLock
public virtual HRESULT SetProductUpdateStatusLock(unsigned char iLocked)= 0
Locks or unlocks the ProductUpdateStatus parameter.
Role: Locks or unlocks the ProductUpdateStatus parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTextColor
public virtual HRESULT SetTextColor(unsigned int* iTextColor)= 0
Sets the TextColor attribute.
Parameters:
iTextColor:
Legal values:
Array of 3 unsigned int (R,G,B).
o SetTextColorLock
public virtual HRESULT SetTextColorLock(unsigned char iLocked)= 0
Locks or unlocks the TextColor parameter.
Role: Locks or unlocks the TextColor parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetTildeDisplay
public virtual HRESULT SetTildeDisplay(int* iTildeDisplay)= 0
Sets the TildeDisplay attribute.
Parameters:
iTildeDisplay
Legal values:
0 : No tilde displayed for approximate measurement.
1 : Tilde displayed for approximate measurement.
o SetTildeDisplayLock
public virtual HRESULT SetTildeDisplayLock(unsigned char iLocked)= 0
Locks or unlocks the TildeDisplay parameter.
Role: Locks or unlocks the TildeDisplay parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure

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

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