All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

UnitsSheetSettingAtt (Object)

The interface to access a CATIAUnitsSheetSettingAtt.
This interface may be used to read or modify in the CATIA\Tools\Option the settings values of Units sheet.

Property Index

DisplayTrailingZeros
Returns or sets the DisplayTrailingZeros parameter.
ExpNotationValuesGreater
Returns or sets the ExpNotationValuesGreater parameter.
ExpNotationValuesLower
Returns or sets the ExpNotationValuesLower parameter.
ListOfMagnitudesSize
Returns or sets the ListOfMagnitudesSize parameter.
ListOfMagnitudes
Returns or sets the ListOfMagnitudes parameter.
SameDisplay
Returns or sets the SameDisplay parameter.

Method Index

CommitForUnits
Implements a function from an interface.
GetDecimalReadOnly
Returns the number of decimals for ReadOnly number.
GetDecimalReadWrite
Returns the number of decimals for ReadWrite number.
GetDimensionsDisplayInfo
Retrieves information about the DimensionsDisplay setting parameter.
GetDisplayTrailingZerosInfo
Retrieves environment informations for the DisplayTrailingZeros parameter.
GetExpNotationValuesGreaterInfo
Retrieves environment informations for the ExpNotationValuesGreater parameter.
GetExpNotationValuesLowerInfo
Retrieves environment informations for the ExpNotationValuesLower parameter.
GetListOfMagnitudesInfo
Retrieves information about the ListOfMagnitudes setting parameter.
GetMagnitudeValues
Returns the Magnitude parameters.
GetSameDisplayInfo
Retrieves environment informations for the SameDisplay parameter.
ResetToAdminValuesForUnits
Implements a function from an interface.
RollbackForUnits
Implements a function from an interface.
SaveRepositoryForUnits
Implements a function from an interface.
SetDimensionsDisplayLock
Locks or unlocks the DimensionsDisplay setting parameter.
SetDisplayTrailingZerosLock
SetExpNotationValuesGreaterLock
SetExpNotationValuesLowerLock
SetListOfMagnitudesLock
Locks or unlocks the ListOfMagnitudes setting parameter.
SetMagnitudeValues
Sets the Magnitude parameters.
SetSameDisplayLock

Properties


o Property DisplayTrailingZeros() As short
Returns or sets the DisplayTrailingZeros parameter.
Role:Return or Set the DisplayTrailingZeros parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oDisplayTrailingZeros
Legal values:
0 : to not display trailing zeros
1 : to display trailing zeros.
o Property ExpNotationValuesGreater() As double
Returns or sets the ExpNotationValuesGreater parameter.
Role:Return or Set the ExpNotationValuesGreater parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oExpNotationValuesGreater
The minimum value for exponential notation values.
o Property ExpNotationValuesLower() As double
Returns or sets the ExpNotationValuesLower parameter.
Role:Return or Set the ExpNotationValuesGreater parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oExpNotationValuesLower
The maximum value for exponential notation values.
o Property ListOfMagnitudesSize() As double (Read Only)
Returns or sets the ListOfMagnitudesSize parameter.

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

o Property ListOfMagnitudes() As CATSafeArrayVariant (Read Only)
Returns or sets the ListOfMagnitudes parameter.

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

o Property SameDisplay() As short
Returns or sets the SameDisplay parameter.
Role:Return or Set the SameDisplay parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
oSameDisplay
Legal values:
0 : to not display same display
1 : to display same display.

Methods


o Sub CommitForUnits()
Implements a function from an interface.
See also:
UnitsSheetSettingAtt.CommitForUnits
o Sub GetDecimalReadOnly(CATBSTR iMagnitudeName,
double oDecimalPlaceReadOnly)
Returns the number of decimals for ReadOnly number.
o Sub GetDecimalReadWrite(CATBSTR iMagnitudeName,
double oDecimalPlaceReadWrite)
Returns the number of decimals for ReadWrite number.
o Func GetDimensionsDisplayInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves information about the DimensionsDisplay setting parameter.
Refer to SettingController for a detailed description.
o Func GetDisplayTrailingZerosInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DisplayTrailingZeros parameter.
Role:Retrieves the state of the DisplayTrailingZeros 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 Func GetExpNotationValuesGreaterInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ExpNotationValuesGreater parameter.
Role:Retrieves the state of the ExpNotationValuesGreater 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 Func GetExpNotationValuesLowerInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ExpNotationValuesLower parameter.
Role:Retrieves the state of the ExpNotationValuesLower 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 Func GetListOfMagnitudesInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves information about the ListOfMagnitudes setting parameter.
Refer to SettingController for a detailed description.
o Sub GetMagnitudeValues(CATBSTR iMagnitudeName,
CATBSTR oUnitName,
double oDecimalPlaceReadWrite,
double oDecimalPlaceReadOnly)
Returns the Magnitude parameters.

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

o Func GetSameDisplayInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the SameDisplay parameter.
Role:Retrieves the state of the SameDisplay 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 ResetToAdminValuesForUnits()
Implements a function from an interface.
See also:
UnitsSheetSettingAtt.ResetToAdminValuesForUnits
o Sub RollbackForUnits()
Implements a function from an interface.
See also:
UnitsSheetSettingAtt.RollbackForUnits
o Sub SaveRepositoryForUnits()
Implements a function from an interface.
See also:
UnitsSheetSettingAtt.SaveRepositoryForUnits
o Sub SetDimensionsDisplayLock(boolean iLocked)
Locks or unlocks the DimensionsDisplay setting parameter.
Refer to SettingController for a detailed description.
o Sub SetDisplayTrailingZerosLock(boolean iLocked)
Deprecated:
V5R15. Use SetDimensionsDisplayLock. Locks or unlocks the DisplayTrailingZeros parameter.
Role:Locks or unlocks the DisplayTrailingZeros 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 SetExpNotationValuesGreaterLock(boolean iLocked)
Deprecated:
V5R15. Use SetSameDisplayLock. Locks or unlocks the ExpNotationValuesGreater parameter.
Role:Locks or unlocks the ExpNotationValuesGreater 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 SetExpNotationValuesLowerLock(boolean iLocked)
Deprecated:
V5R15. Use SetDimensionsDisplayLock. Locks or unlocks the ExpNotationValuesLower parameter.
Role:Locks or unlocks the ExpNotationValuesLower 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 SetListOfMagnitudesLock(boolean iLocked)
Locks or unlocks the ListOfMagnitudes setting parameter.
Refer to SettingController for a detailed description.
o Sub SetMagnitudeValues(CATBSTR iMagnitudeName,
CATBSTR iUnitName,
double iDecimalPlaceReadWrite,
double iDecimalPlaceReadOnly)
Sets the Magnitude parameters.

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

o Sub SetSameDisplayLock(boolean iLocked)
Deprecated:
V5R15. Use SetDimensionsDisplayLock. Locks or unlocks the SameDisplay parameter.
Role:Locks or unlocks the SameDisplay 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.