All Frameworks  Object Hierarchy  This Framework  Indexes

MacrosSettingAtt (Object)

Setting controller for the Macros tab page.

Method Index

GetDefaultMacroLibrariesInfo
Retrieves environment informations for the default macro libraries setting.
GetDefaultMacroLibraries
Returns the list of default macro libraries.
GetExternalReferencesInfo
Retrieves environment informations for the external references setting.
GetExternalReferences
Returns the list of external references.
GetLanguageEditorInfo
Retrieves environment informations for the language editors setting.
GetLanguageEditor
Returns the editor path for the specified language.
SetDefaultMacroLibrariesLock
Locks or unlocks the default macro libraries setting.
SetDefaultMacroLibraries
Sets the list of default macro libraries.
SetExternalReferencesLock
Locks or unlocks the external references setting.
SetExternalReferences
Sets the list of external references.
SetLanguageEditorLock
Locks or unlocks the language editors setting.
SetLanguageEditor
Sets the editor path for the specified language.

Methods


o Func GetDefaultMacroLibrariesInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the default macro libraries setting.
Role:Retrieves the state of the parameter default macro libraries setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDefaultMacroLibraries() As
Returns the list of default macro libraries.
o Func GetExternalReferencesInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the external references setting.
Role:Retrieves the state of the parameter external references setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetExternalReferences() As
Returns the list of external references.
o Func GetLanguageEditorInfo( AdminLevel,
oLocked) As
Retrieves environment informations for the language editors setting.
Role:Retrieves the state of the parameter language editors setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetLanguageEditor( iLanguage) As
Returns the editor path for the specified language.
o Sub SetDefaultMacroLibrariesLock( iLocked)
Locks or unlocks the default macro libraries setting.
Role:Locks or unlocks the default macro libraries setting 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 SetDefaultMacroLibraries( iLibraries)
Sets the list of default macro libraries.
o Sub SetExternalReferencesLock( iLocked)
Locks or unlocks the external references setting.
Role:Locks or unlocks the external references setting 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 SetExternalReferences( iReferences)
Sets the list of external references.
o Sub SetLanguageEditorLock( iLocked)
Locks or unlocks the language editors setting.
Role:Locks or unlocks the language editors setting 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 SetLanguageEditor( iLanguage,
iEditorPath)
Sets the editor path for the specified language.

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