All Frameworks  Object Hierarchy  This Framework  Indexes

ColorSTDObjectSettingAtt (Object)

The interface to access a CATIAColorSTDObjectSettingAtt.

Method Index

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

Methods


o Func GetPlateColorInfo( ioAdminLevel,
ioLocked) As
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 GetPlateColor( oPlateColorR,
oPlateColorG,
oPlateColorB)
Returns or sets the PlateColor parameter.

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

o Func GetShapeColorInfo( ioAdminLevel,
ioLocked) As
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 GetShapeColor( oShapeColorR,
oShapeColorG,
oShapeColorB)
Returns or sets the ShapeColor parameter.

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

o Sub SetPlateColorLock( 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 SetPlateColor( iPlateColorR,
iPlateColorG,
iPlateColorB)
o Sub SetShapeColorLock( 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.
o Sub SetShapeColor( iShapeColorR,
iShapeColorG,
iShapeColorB)

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