All Frameworks  Object Hierarchy  This Framework  Indexes

DocumentationSettingAtt (Object)

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

Property Index

CompanionPath
Returns the User Companion location (path) parameter.
DocLanguage
Returns the technical documentation language parameter.
Priority
Returns the contextual priority parameter.
TechnicalDocumentationPath
Returns the technical documentation location (path) parameter.

Method Index

GetCompanionPathInfo
Retrieves environment informations for the User Companion location parameter.
GetDocLanguageInfo
Retrieves environment informations for the technical documentation language parameter.
GetPriorityInfo
Retrieves environment informations for the contextual priority parameter.
GetTechnicalDocumentationPathInfo
Retrieves environment informations for the technical documentation location parameter.
SetCompanionPathLock
Locks or unlocks the User Companion location parameter.
SetDocLanguageLock
Locks or unlocks the technical documentation language parameter.
SetPriorityLock
Locks or unlocks the contextual priority parameter.
SetTechnicalDocumentationPathLock
Locks or unlocks the technical documentation location parameter.

Properties


o Property CompanionPath() As
Returns the User Companion location (path) parameter.
o Property DocLanguage() As
Returns the technical documentation language parameter.
o Property Priority() As
Returns the contextual priority parameter.
o Property TechnicalDocumentationPath() As
Returns the technical documentation location (path) parameter.

Methods


o Func GetCompanionPathInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the User Companion location parameter.
Role:Retrieves the state of the User Companion location 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 GetDocLanguageInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the technical documentation language parameter.
Role:Retrieves the state of the technical documentation language 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 GetPriorityInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the contextual priority parameter.
Role:Retrieves the state of the contextual priority 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 GetTechnicalDocumentationPathInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the technical documentation location parameter.
Role:Retrieves the state of the technical documentation location 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 SetCompanionPathLock( iLocked)
Locks or unlocks the User Companion location parameter.
Role:Locks or unlocks the User Companion location 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 SetDocLanguageLock( iLocked)
Locks or unlocks the technical documentation language parameter.
Role:Locks or unlocks the technical documentation language 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 SetPriorityLock( iLocked)
Locks or unlocks the contextual priority parameter.
Role:Locks or unlocks the contextual priority 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 SetTechnicalDocumentationPathLock( iLocked)
Locks or unlocks the technical documentation location parameter.
Role:Locks or unlocks the technical documentation location 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.