All Frameworks  Object Hierarchy  This Framework  Indexes

TreeVizManipSettingAtt (Object)

The Interface to retrieve and set the visual information on the specification tree.

Property Index

ArcSelectionActivation
Retrieves or Sets the arc-selection mode applied to the specification tree.
AutoExpandActivation
Retrieves or Sets the automatic expand mode applied to the specification tree.
AutoScrollActivation
Retrieves or Sets the automatic scrolling mode applied to the specification tree.
DisplayGeomOnScrolling
Retrieves or Sets the "display geometry on scrolling" mode.
Orientation
Retrieves or Sets the orientation applied to the specification tree.
ShowActivation
Retrieves or Sets the visualization Show/NoShow's mode applied to the specification tree.
SizeType
Retrieves or Sets the type of size applied to the text of the specification tree.
Size
Retrieves or Sets the number of characters shown for the text of the specification tree.
Type
Retrieves or Sets the type applied to the specification tree.

Method Index

GetArcSelectionActivationInfo
Retrieves environment informations for arc-selection mode applied to the specification tree.
GetAutoExpandActivationInfo
Retrieves environment informations for automatic expand mode applied to the specification tree.
GetAutoScrollActivationInfo
Retrieves environment informations for automatic scrolling mode applied to the specification tree.
GetDisplayGeomOnScrollingInfo
Retrieves environment informations for "display geometry on scrolling" mode.
GetOrientationInfo
Retrieves environment informations for the orientation applied to the specification tree.
GetShowActivationInfo
Retrieves environment informations for the visualization Show/NoShow's mode applied to the specification tree.
GetSizeTypeInfo
Retrieves environment informations for the type of size applied to the text of the specification tree.
GetTypeInfo
Retrieves environment informations for the type applied to the specification tree.
SetArcSelectionActivationLock
Locks or unlocks the arc-selection mode applied to the specification tree.
SetAutoExpandActivationLock
Locks or unlocks the automatic expand mode applied to the specification tree.
SetAutoScrollActivationLock
Locks or unlocks the automatic scrolling mode applied to the specification tree.
SetDisplayGeomOnScrollingLock
Locks or unlocks the "display geometry on scrolling" mode.
SetOrientationLock
Locks or unlocks the orientation applied to the specification tree.
SetShowActivationLock
Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree.
SetSizeTypeLock
Locks or unlocks the type of size applied to the text of the specification tree.
SetTypeLock
Locks or unlocks the type of the specification tree.

Properties


o Property ArcSelectionActivation() As
Retrieves or Sets the arc-selection mode applied to the specification tree.
o Property AutoExpandActivation() As
Retrieves or Sets the automatic expand mode applied to the specification tree.
o Property AutoScrollActivation() As
Retrieves or Sets the automatic scrolling mode applied to the specification tree.
o Property DisplayGeomOnScrolling() As
Retrieves or Sets the "display geometry on scrolling" mode.
o Property Orientation() As
Retrieves or Sets the orientation applied to the specification tree.
o Property ShowActivation() As
Retrieves or Sets the visualization Show/NoShow's mode applied to the specification tree.
o Property SizeType() As
Retrieves or Sets the type of size applied to the text of the specification tree.
o Property Size() As
Retrieves or Sets the number of characters shown for the text of the specification tree.
o Property Type() As
Retrieves or Sets the type applied to the specification tree.

Methods


o Func GetArcSelectionActivationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for arc-selection mode applied to the specification tree.
Role:Retrieves the state of arc-selection mode applied to the specification tree 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 GetAutoExpandActivationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for automatic expand mode applied to the specification tree.
Role:Retrieves the state of automatic expand mode applied to the specification tree 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 GetAutoScrollActivationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for automatic scrolling mode applied to the specification tree.
Role:Retrieves the state of the automatic scrolling mode applied to the specification tree 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 GetDisplayGeomOnScrollingInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for "display geometry on scrolling" mode.
Role:Retrieves the state of "display geometry on scrolling" mode 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 GetOrientationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the orientation applied to the specification tree.
Role:Retrieves the state of the orientation applied to the specification tree 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 GetShowActivationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the visualization Show/NoShow's mode applied to the specification tree.
Role:Retrieves the state of the visualization Show/NoShow's mode applied to the specification tree 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 GetSizeTypeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the type of size applied to the text of the specification tree.
Role:Retrieves the state of the type of size applied to the text of the specification tree in the current environment. Attributes "size" and "SizeType" are linked together by the same lock. So there is no function "GetSizeInfo".
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 GetTypeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the type applied to the specification tree.
Role:Retrieves the state of the type applied to the specification tree 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 SetArcSelectionActivationLock( iLocked)
Locks or unlocks the arc-selection mode applied to the specification tree.
Role:Locks or unlocks the arc-selection mode applied to the specification tree 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 SetAutoExpandActivationLock( iLocked)
Locks or unlocks the automatic expand mode applied to the specification tree.
Role:Locks or unlocks the automatic expand mode applied to the specification tree 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 SetAutoScrollActivationLock( iLocked)
Locks or unlocks the automatic scrolling mode applied to the specification tree.
Role:Locks or unlocks the automatic scrolling mode applied to the specification tree 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 SetDisplayGeomOnScrollingLock( iLocked)
Locks or unlocks the "display geometry on scrolling" mode.
Role:Locks or unlocks "display geometry on scrolling" mode 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 SetOrientationLock( iLocked)
Locks or unlocks the orientation applied to the specification tree.
Role:Locks or unlocks the orientation applied to the specification tree 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 SetShowActivationLock( iLocked)
Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree.
Role:Locks or unlocks the visualization Show/NoShow's mode applied to the specification tree 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 SetSizeTypeLock( iLocked)
Locks or unlocks the type of size applied to the text of the specification tree.
Role:Locks or unlocks the type of size applied to the text of the specification tree if it is possible in the current administrative context. In user mode this method will always return E_FAIL. Attributs "size" and "SizeType" are linked together by the same lock. So there is no function "SetSizeTypeLock".
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetTypeLock( iLocked)
Locks or unlocks the type of the specification tree.
Role:Locks or unlocks the type applied to the specification tree 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.