All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

ColorSTDObjectSettingAtt (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---SettingController
            |
            +---ColorSTDObjectSettingAtt
 


The interface to access a CATIAColorSTDObjectSettingAtt.

Method Index

GetPlateColor
Returns or sets the PlateColor parameter.
GetPlateColorInfo
Retrieves environment informations for the PlateColor parameter.
GetShapeColor
Returns or sets the ShapeColor parameter.
GetShapeColorInfo
Retrieves environment informations for the ShapeColor parameter.
SetPlateColor
SetPlateColorLock
Locks or unlocks the PlateColor parameter.
SetShapeColor
SetShapeColorLock
Locks or unlocks the ShapeColor parameter.

Methods


o Sub GetPlateColor(long oPlateColorR,
long oPlateColorG,
long oPlateColorB)
Returns or sets the PlateColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Func GetPlateColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the PlateColor parameter.
Role:Retrieves the state of the PlateColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub GetShapeColor(long oShapeColorR,
long oShapeColorG,
long oShapeColorB)
Returns or sets the ShapeColor parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Func GetShapeColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ShapeColor parameter.
Role:Retrieves the state of the ShapeColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub SetPlateColor(long iPlateColorR,
long iPlateColorG,
long iPlateColorB)
o Sub SetPlateColorLock(boolean iLocked)
Locks or unlocks the PlateColor parameter.
Role:Locks or unlocks the PlateColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetShapeColor(long iShapeColorR,
long iShapeColorG,
long iShapeColorB)
o Sub SetShapeColorLock(boolean iLocked)
Locks or unlocks the ShapeColor parameter.
Role:Locks or unlocks the ShapeColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.

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