All Frameworks  Object Hierarchy  This Framework  Indexes

FunctionalSystemSettingAtt (Object)

Enables attribute access to PFD options.

Property Index

DocumentContentAtCreation
Returns or sets the DocumentContentAtCreation parameter.
FunctionalActionPresentation
Returns or sets the FunctionalActionPresentation parameter.
ShowParameters
Returns or sets the ShowParameters parameter.
ShowRelations
Returns or sets the ShowRelations parameter.
ShowSynchroStatusOfLocalParamCache
Returns or sets the ShowSynchroStatusOfLocalParamCache parameter.
SplitFunctionalObjectName
Returns or sets the SplitFunctionalObjectName parameter.
StringUsedAsCarriageReturn
Returns or sets the StringUsedAsCarriageReturn parameter.
TypeOfIconOnFunctionalElement
Returns or sets the TypeOfIconOnFunctionalElement parameter.

Method Index

GetDocumentContentAtCreationInfo
Retrieves environment informations for the DocumentContentAtCreation parameter.
GetFunctionalActionPresentationInfo
Retrieves environment informations for the FunctionalActionPresentation parameter.
GetShowParametersInfo
Retrieves environment informations for the ShowParameters parameter.
GetShowRelationsInfo
Retrieves environment informations for the ShowRelations parameter.
GetShowSynchroStatusOfLocalParamCacheInfo
Retrieves environment informations for the ShowSynchroStatusOfLocalParamCache parameter.
GetSplitFunctionalObjectNameInfo
Retrieves environment informations for the SplitFunctionalObjectName parameter.
GetStringUsedAsCarriageReturnInfo
Retrieves environment informations for the StringUsedAsCarriageReturn parameter.
GetTypeOfIconOnFunctionalElementInfo
Retrieves environment informations for the TypeOfIconOnFunctionalElement parameter.
SetDocumentContentAtCreationLock
Locks or unlocks the DocumentContentAtCreation parameter.
SetFunctionalActionPresentationLock
Locks or unlocks the FunctionalActionPresentation parameter.
SetShowParametersLock
Locks or unlocks the ShowParameters parameter.
SetShowRelationsLock
Locks or unlocks the ShowRelations parameter.
SetShowSynchroStatusOfLocalParamCacheLock
Locks or unlocks the ShowSynchroStatusOfLocalParamCache parameter.
SetSplitFunctionalObjectNameLock
Locks or unlocks the SplitFunctionalObjectName parameter.
SetStringUsedAsCarriageReturnLock
Locks or unlocks the StringUsedAsCarriageReturn parameter.
SetTypeOfIconOnFunctionalElementLock
Locks or unlocks the TypeOfIconOnFunctionalElement parameter.

Properties


o Property DocumentContentAtCreation() As
Returns or sets the DocumentContentAtCreation parameter.
Parameters:
iDocumentContentAtCreation
oDocumentContentAtCreation Document Content At Creation Attribute Legal values:
0 : Sample elements
1: empty
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Property FunctionalActionPresentation() As
Returns or sets the FunctionalActionPresentation parameter.
Parameters:
iDocumentContentAtCreation
or oDocumentContentAtCreation Functional Action Presentation Legal values:
0 : A : Action
1: SAO : Subject Action Object
2: ASO : Action Subject Object
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Property ShowParameters() As
Returns or sets the ShowParameters parameter.
Parameters:
iShowParameters
or oShowParameters Show Parameters Legal values:
False :
True:
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Property ShowRelations() As
Returns or sets the ShowRelations parameter.
Parameters:
iShowRelations
or oShowRelations Show Relations Legal values:
False :
True:
o Property ShowSynchroStatusOfLocalParamCache() As
Returns or sets the ShowSynchroStatusOfLocalParamCache parameter.
Parameters:
iShowSynchroStatusOfLocalParamCache
or oShowSynchroStatusOfLocalParamCache Show Synchronisation Status OfLocal Parameter Cache Legal values:
False :
True :
o Property SplitFunctionalObjectName() As
Returns or sets the SplitFunctionalObjectName parameter.
Parameters:
iSplitFunctionalObjectName
or oSplitFunctionalObjectName Legal values:
False : don't split functional object name
True : split Functional object name
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Property StringUsedAsCarriageReturn() As
Returns or sets the StringUsedAsCarriageReturn parameter.
Parameters:
iStringUsedAsCarriageReturn
or oStringUsedAsCarriageReturn String Used As Carriage Return
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Property TypeOfIconOnFunctionalElement() As
Returns or sets the TypeOfIconOnFunctionalElement parameter.
Parameters:
iTypeOfIconOnFunctionalElement
or oTypeOfIconOnFunctionalElement Type Of Icon On Functional Elements Legal values:
0 : indicate a current association with PPR links.
1: indicate a current generative script.

Methods


o Func GetDocumentContentAtCreationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the DocumentContentAtCreation parameter.
Role:Retrieves the state of the DocumentContentAtCreation 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 GetFunctionalActionPresentationInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the FunctionalActionPresentation parameter.
Role:Retrieves the state of the FunctionalActionPresentation 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 GetShowParametersInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ShowParameters parameter.
Role:Retrieves the state of the ShowParameters 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 GetShowRelationsInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ShowRelations parameter.
Role:Retrieves the state of the ShowRelations 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 GetShowSynchroStatusOfLocalParamCacheInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ShowSynchroStatusOfLocalParamCache parameter.
Role:Retrieves the state of the ShowSynchroStatusOfLocalParamCache 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 GetSplitFunctionalObjectNameInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the SplitFunctionalObjectName parameter.
Role:Retrieves the state of the SplitFunctionalObjectName 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 GetStringUsedAsCarriageReturnInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the StringUsedAsCarriageReturn parameter.
Role:Retrieves the state of the StringUsedAsCarriageReturn 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 GetTypeOfIconOnFunctionalElementInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the TypeOfIconOnFunctionalElement parameter.
Role:Retrieves the state of the TypeOfIconOnFunctionalElement 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 SetDocumentContentAtCreationLock( iLocked)
Locks or unlocks the DocumentContentAtCreation parameter.
Role:Locks or unlocks the DocumentContentAtCreation 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.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetFunctionalActionPresentationLock( iLocked)
Locks or unlocks the FunctionalActionPresentation parameter.
Role:Locks or unlocks the FunctionalActionPresentation 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.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetShowParametersLock( iLocked)
Locks or unlocks the ShowParameters parameter.
Role:Locks or unlocks the ShowParameters 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.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetShowRelationsLock( iLocked)
Locks or unlocks the ShowRelations parameter.
Role:Locks or unlocks the ShowRelations 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.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetShowSynchroStatusOfLocalParamCacheLock( iLocked)
Locks or unlocks the ShowSynchroStatusOfLocalParamCache parameter.
Role:Locks or unlocks the ShowSynchroStatusOfLocalParamCache 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.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetSplitFunctionalObjectNameLock( iLocked)
Locks or unlocks the SplitFunctionalObjectName parameter.
Role:Locks or unlocks the SplitFunctionalObjectName 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.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetStringUsedAsCarriageReturnLock( iLocked)
Locks or unlocks the StringUsedAsCarriageReturn parameter.
Role:Locks or unlocks the StringUsedAsCarriageReturn 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 SetTypeOfIconOnFunctionalElementLock( iLocked)
Locks or unlocks the TypeOfIconOnFunctionalElement parameter.
Role:Locks or unlocks the TypeOfIconOnFunctionalElement 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.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure

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