All Frameworks  Object Hierarchy  This Framework  Indexes

ColorESSObjectSettingAtt (Object)

The interface to access a CATIAColorESSObjectSettingAtt.

Method Index

GetMemberColorInfo
Retrieves environment informations for the MemberColor parameter.
GetMemberColor
Returns or sets the MemberColor parameter.
GetPlateColorInfo
Retrieves environment informations for the PlateColor parameter.
GetPlateColor
Returns or sets the PlateColor parameter.
SetMemberColorLock
Locks or unlocks the MemberColor parameter.
SetMemberColor
SetPlateColorLock
Locks or unlocks the PlateColor parameter.
SetPlateColor

Methods


o Func GetMemberColorInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the MemberColor parameter.
Role:Retrieves the state of the MemberColor 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 GetMemberColor( oMemberColorR,
oMemberColorG,
oMemberColorB)
Returns or sets the MemberColor parameter.

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

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 Sub SetMemberColorLock( iLocked)
Locks or unlocks the MemberColor parameter.
Role:Locks or unlocks the MemberColor 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 SetMemberColor( iMemberColorR,
iMemberColorG,
iMemberColorB)
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)

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