All Frameworks  Object Hierarchy  This Framework  Indexes

GeneralSessionSettingAtt (Object)

Setting controller for the General property tab page.
Role: This interface is implemented by a component which represents the controller of the general settings.

Property Index

AutoSave
Returns the data save parameter.
Conferencing
Returns the conference driver parameter.
DragDrop
Returns the drag & drop parameter.
RefDoc
Returns the referenced documents parameter.
TimeRoll
Returns the data save parameter (in milliseconds).
UIStyle
Returns the user interface style parameter.

Method Index

GetAutoSaveInfo
Retrieves environment informations for the data save parameter.
GetConferencingInfo
Retrieves environment informations for the conference driver parameter.
GetDragDropInfo
Retrieves environment informations for the drag & drop parameter.
GetRefDocInfo
Retrieves environment informations for the referenced documents parameter.
GetUIStyleInfo
Retrieves environment informations for the user interface style parameter.
SetAutoSaveLock
Locks or unlocks the data save parameter.
SetConferencingLock
Locks or unlocks the conference driver parameter.
SetDragDropLock
Locks or unlocks the drag & drop parameter.
SetRefDocLock
Locks or unlocks the referenced documents parameter.
SetUIStyleLock
Locks or unlocks the user interface style parameter.

Properties


o Property AutoSave() As
Returns the data save parameter.
o Property Conferencing() As
Returns the conference driver parameter.
o Property DragDrop() As
Returns the drag & drop parameter.
o Property RefDoc() As
Returns the referenced documents parameter.
o Property TimeRoll() As
Returns the data save parameter (in milliseconds).
o Property UIStyle() As
Returns the user interface style parameter.

Methods


o Func GetAutoSaveInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the data save parameter.
Role:Retrieves the state of the data save 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 GetConferencingInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the conference driver parameter.
Role:Retrieves the state of the conference driver 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 GetDragDropInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the drag & drop parameter.
Role:Retrieves the state of the drag & drop 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 GetRefDocInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the referenced documents parameter.
Role:Retrieves the state of the referenced documents 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 GetUIStyleInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the user interface style parameter.
Role:Retrieves the state of the user interface style 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 SetAutoSaveLock( iLocked)
Locks or unlocks the data save parameter.
Role:Locks or unlocks the data save 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 SetConferencingLock( iLocked)
Locks or unlocks the conference driver parameter.
Role:Locks or unlocks the conference driver 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 SetDragDropLock( iLocked)
Locks or unlocks the drag & drop parameter.
Role:Locks or unlocks the drag & drop 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 SetRefDocLock( iLocked)
Locks or unlocks the referenced documents parameter.
Role:Locks or unlocks the referenced documents 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 SetUIStyleLock( iLocked)
Locks or unlocks the user interface style parameter.
Role:Locks or unlocks the user interface style 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.