All Frameworks  Object Hierarchy  This Framework  Indexes

Layout2DSettingAtt (Object)

The interface to access a CATIA2DLSettingAtt.

Property Index

Activate2DMode
Returns the Activate2DMode parameter.
BackClippingPlane
Returns the BackClippingPlane parameter.
Boundaries2DLDisplay
Returns the Boundaries2DLDisplay parameter.
Boundaries2DLLineType
Returns the Boundaries2DLLineType parameter.
Boundaries2DLThickness
Returns the Boundaries2DLThickness parameter.
CalloutCreationDialogBox
Returns the CalloutCreationDialogBox parameter.
ClippingFrameReframeOnMode
Returns the ClippingFrameReframeOnMode parameter.
ClippingFrame
Returns the ClippingFrame parameter.
ClippingViewOutlineLinetype
Returns the ClippingViewOutlineLinetype parameter.
ClippingViewOutlineThickness
Returns the ClippingViewOutlineThickness parameter.
CreateAssociativeUseEdges
Returns the CreateAssociativeUseEdges parameter.
DedicatedFilterType
Returns the DedicatedFilterType parameter.
DisplayBackAndCuttingPlane
Returns the DisplayBackAndCuttingPlane parameter.
DisplayClippingOutline
Returns the DisplayClippingOutline parameter.
EditDedicatedFilterDialogBox
Returns the EditDedicatedFilterDialogBox parameter.
HideIn3D
Returns the HideIn3D parameter.
LayoutDefaultRenderStyle
Returns the default render style attribute value to apply to a Layout at its creation parameter.
PropagateHighlight
Returns the PropagateHighlight parameter.
ViewBackgroundMode
Returns the ViewBackgroundMode parameter.
ViewFilterCreationMode
Returns the ViewFilterCreationMode parameter.

Method Index

GetActivate2DModeInfo
Retrieves environment informations for the Activate2DMode parameter.
GetBackClippingPlaneInfo
Retrieves environment informations for the BackClippingPlane parameter.
GetBoundaries2DLColorInfo
Retrieves environment informations for the Boundaries2DLColor parameter.
GetBoundaries2DLColor
Returns the Boundaries2DLColor parameter.
GetBoundaries2DLDisplayInfo
Retrieves environment informations for the Boundaries2DLDisplay parameter.
GetBoundaries2DLLineTypeInfo
Retrieves environment informations for the Boundaries2DLLineType parameter.
GetBoundaries2DLThicknessInfo
Retrieves environment informations for the Boundaries2DLThickness parameter.
GetCalloutCreationDialogBoxInfo
Retrieves environment informations for the CalloutCreationDialogBox parameter.
GetClippingFrameInfo
Retrieves environment informations for the ClippingFrame parameter.
GetClippingFrameReframeOnModeInfo
GetClippingViewOutlineColorInfo
Retrieves environment informations for the ClippingViewOutlineColor parameter.
GetClippingViewOutlineColor
Returns the ClippingViewOutlineColor parameter.
GetClippingViewOutlineLinetypeInfo
Retrieves environment informations for the ClippingViewOutlineLinetype parameter.
GetClippingViewOutlineThicknessInfo
Retrieves environment informations for the ClippingViewOutlineThickness parameter.
GetCreateAssociativeUseEdgesInfo
Retrieves environment informations for the CreateAssociativeUseEdges parameter.
GetDedicatedFilterTypeInfo
Retrieves environment informations for the DedicatedFilterType parameter.
GetDisplayBackAndCuttingPlaneInfo
Retrieves environment informations for the DisplayBackAndCuttingPlane parameter.
GetDisplayClippingOutlineInfo
Retrieves environment informations for the DisplayClippingOutline parameter.
GetEditDedicatedFilterDialogBoxInfo
Retrieves environment informations for the EditDedicatedFilterDialogBox parameter.
GetHideIn3DInfo
Retrieves environment informations for the HideIn3D parameter.
GetLayoutDefaultRenderStyleInfo
Retrieves environment informations for the default render style parameter.
GetPropagateHighlightInfo
Retrieves environment informations for the PropagateHighlight parameter.
GetProtectedElementsColorInfo
Retrieves environment informations for the ProtectedElementsColor parameter.
GetProtectedElementsColor
Returns the ProtectedElementsColor parameter.
GetViewBackgroundModeInfo
Retrieves environment informations for the ViewBackgroundMode parameter.
GetViewFilterCreationModeInfo
Retrieves environment informations for the ViewFilterCreationMode parameter.
SetActivate2DModeLock
Locks or unlocks the Activate2DMode parameter.
SetBackClippingPlaneLock
Locks or unlocks the BackClippingPlane parameter.
SetBoundaries2DLColorLock
Locks or unlocks the Boundaries2DLColor parameter.
SetBoundaries2DLColor
Sets the Boundaries2DLColor parameter.
SetBoundaries2DLDisplayLock
Locks or unlocks the Boundaries2DLDisplay parameter.
SetBoundaries2DLLineTypeLock
Locks or unlocks the Boundaries2DLLineType parameter.
SetBoundaries2DLThicknessLock
Locks or unlocks the Boundaries2DLThickness parameter.
SetCalloutCreationDialogBoxLock
Locks or unlocks the CalloutCreationDialogBox parameter.
SetClippingFrameLock
Locks or unlocks the ClippingFrame parameter.
SetClippingFrameReframeOnModeLock
SetClippingViewOutlineColorLock
Locks or unlocks the ClippingViewOutlineColor parameter.
SetClippingViewOutlineColor
Sets the ClippingViewOutlineColor parameter.
SetClippingViewOutlineLinetypeLock
Locks or unlocks the ClippingViewOutlineLinetype parameter.
SetClippingViewOutlineThicknessLock
Locks or unlocks the ClippingViewOutlineThickness parameter.
SetCreateAssociativeUseEdgesLock
Locks or unlocks the CreateAssociativeUseEdges parameter.
SetDedicatedFilterTypeLock
Locks or unlocks the DedicatedFilterType parameter.
SetDisplayBackAndCuttingPlaneLock
Locks or unlocks the DisplayBackAndCuttingPlane parameter.
SetDisplayClippingOutlineLock
Locks or unlocks the DisplayClippingOutline parameter.
SetEditDedicatedFilterDialogBoxLock
Locks or unlocks the EditDedicatedFilterDialogBox parameter.
SetHideIn3DLock
Locks or unlocks the HideIn3D parameter.
SetLayoutDefaultRenderStyleLock
Locks or unlocks the default render style parameter.
SetPropagateHighlightLock
Locks or unlocks the PropagateHighlight parameter.
SetProtectedElementsColorLock
Locks or unlocks the ProtectedElementsColor parameter.
SetProtectedElementsColor
Sets the ProtectedElementsColor parameter.
SetViewBackgroundModeLock
Locks or unlocks the ViewBackgroundMode parameter.
SetViewFilterCreationModeLock
Locks or unlocks the ViewFilterCreationMode parameter.

Properties


o Property Activate2DMode() As
Returns the Activate2DMode parameter.
o Property BackClippingPlane() As
Returns the BackClippingPlane parameter.
o Property Boundaries2DLDisplay() As
Returns the Boundaries2DLDisplay parameter.
o Property Boundaries2DLLineType() As
Returns the Boundaries2DLLineType parameter.
o Property Boundaries2DLThickness() As
Returns the Boundaries2DLThickness parameter.
o Property CalloutCreationDialogBox() As
Returns the CalloutCreationDialogBox parameter.
o Property ClippingFrameReframeOnMode() As
Returns the ClippingFrameReframeOnMode parameter.
Deprecated:
V5R18
o Property ClippingFrame() As
Returns the ClippingFrame parameter.
o Property ClippingViewOutlineLinetype() As
Returns the ClippingViewOutlineLinetype parameter.
o Property ClippingViewOutlineThickness() As
Returns the ClippingViewOutlineThickness parameter.
o Property CreateAssociativeUseEdges() As
Returns the CreateAssociativeUseEdges parameter.
o Property DedicatedFilterType() As
Returns the DedicatedFilterType parameter.
o Property DisplayBackAndCuttingPlane() As
Returns the DisplayBackAndCuttingPlane parameter.
o Property DisplayClippingOutline() As
Returns the DisplayClippingOutline parameter.
o Property EditDedicatedFilterDialogBox() As
Returns the EditDedicatedFilterDialogBox parameter.
o Property HideIn3D() As
Returns the HideIn3D parameter.
o Property LayoutDefaultRenderStyle() As
Returns the default render style attribute value to apply to a Layout at its creation parameter.
o Property PropagateHighlight() As
Returns the PropagateHighlight parameter.
o Property ViewBackgroundMode() As
Returns the ViewBackgroundMode parameter.
o Property ViewFilterCreationMode() As
Returns the ViewFilterCreationMode parameter.

Methods


o Sub GetActivate2DModeInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the Activate2DMode parameter.
Role:Retrieves the state of the Activate2DMode 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 GetBackClippingPlaneInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the BackClippingPlane parameter.
Role:Retrieves the state of the BackClippingPlane 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 GetBoundaries2DLColorInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the Boundaries2DLColor parameter.
Role:Retrieves the state of the Boundaries2DLColor 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 GetBoundaries2DLColor( oValueR,
oValueG,
oValueB)
Returns the Boundaries2DLColor parameter.
o Sub GetBoundaries2DLDisplayInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the Boundaries2DLDisplay parameter.
Role:Retrieves the state of the Boundaries2DLDisplay 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 GetBoundaries2DLLineTypeInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the Boundaries2DLLineType parameter.
Role:Retrieves the state of the Boundaries2DLLineType 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 GetBoundaries2DLThicknessInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the Boundaries2DLThickness parameter.
Role:Retrieves the state of the Boundaries2DLThickness 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 GetCalloutCreationDialogBoxInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the CalloutCreationDialogBox parameter.
Role:Retrieves the state of the CalloutCreationDialogBox 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 GetClippingFrameInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the ClippingFrame parameter.
Role:Retrieves the state of the ClippingFrame 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 GetClippingFrameReframeOnModeInfo( ioAdminLevel,
ioLocked) As
Deprecated:
V5R18 Retrieves environment informations for the ClippingFrameReframeOnMode parameter.
Role:Retrieves the state of the ClippingFrameReframeOnMode 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 GetClippingViewOutlineColorInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the ClippingViewOutlineColor parameter.
Role:Retrieves the state of the ClippingViewOutlineColor 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 GetClippingViewOutlineColor( oValueR,
oValueG,
oValueB)
Returns the ClippingViewOutlineColor parameter.
o Sub GetClippingViewOutlineLinetypeInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the ClippingViewOutlineLinetype parameter.
Role:Retrieves the state of the ClippingViewOutlineLinetype 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 GetClippingViewOutlineThicknessInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the ClippingViewOutlineThickness parameter.
Role:Retrieves the state of the ClippingViewOutlineThickness 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 GetCreateAssociativeUseEdgesInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the CreateAssociativeUseEdges parameter.
Role:Retrieves the state of the CreateAssociativeUseEdges 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 GetDedicatedFilterTypeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the DedicatedFilterType parameter.
Role:Retrieves the state of the DedicatedFilterType 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 GetDisplayBackAndCuttingPlaneInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the DisplayBackAndCuttingPlane parameter.
Role:Retrieves the state of the DisplayBackAndCuttingPlane 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 GetDisplayClippingOutlineInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the DisplayClippingOutline parameter.
Role:Retrieves the state of the DisplayClippingOutline 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 GetEditDedicatedFilterDialogBoxInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the EditDedicatedFilterDialogBox parameter.
Role:Retrieves the state of the EditDedicatedFilterDialogBox 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 GetHideIn3DInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the HideIn3D parameter.
Role:Retrieves the state of the HideIn3D 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 GetLayoutDefaultRenderStyleInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the default render style parameter.
Role:Retrieves the state of the default render 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 GetPropagateHighlightInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the PropagateHighlight parameter.
Role:Retrieves the state of the PropagateHighlight 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 GetProtectedElementsColorInfo( ioAdminLevel,
ioLocked,
oModified)
Retrieves environment informations for the ProtectedElementsColor parameter.
Role:Retrieves the state of the ProtectedElementsColor 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 GetProtectedElementsColor( oValueR,
oValueG,
oValueB)
Returns the ProtectedElementsColor parameter.
o Func GetViewBackgroundModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ViewBackgroundMode parameter.
Role:Retrieves the state of the ViewBackgroundMode 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 GetViewFilterCreationModeInfo( ioAdminLevel,
ioLocked) As
Retrieves environment informations for the ViewFilterCreationMode parameter.
Role:Retrieves the state of the ViewFilterCreationMode 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 SetActivate2DModeLock( iLocked)
Locks or unlocks the Activate2DMode parameter.
Role:Locks or unlocks the Activate2DMode 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 SetBackClippingPlaneLock( iLocked)
Locks or unlocks the BackClippingPlane parameter.
Role:Locks or unlocks the BackClippingPlane 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 SetBoundaries2DLColorLock( iLocked)
Locks or unlocks the Boundaries2DLColor parameter.
Role:Locks or unlocks the Boundaries2DLColor 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 SetBoundaries2DLColor( iValueR,
iValueG,
iValueB)
Sets the Boundaries2DLColor parameter.
o Sub SetBoundaries2DLDisplayLock( iLocked)
Locks or unlocks the Boundaries2DLDisplay parameter.
Role:Locks or unlocks the Boundaries2DLDisplay 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 SetBoundaries2DLLineTypeLock( iLocked)
Locks or unlocks the Boundaries2DLLineType parameter.
Role:Locks or unlocks the Boundaries2DLLineType 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 SetBoundaries2DLThicknessLock( iLocked)
Locks or unlocks the Boundaries2DLThickness parameter.
Role:Locks or unlocks the Boundaries2DLThickness 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 SetCalloutCreationDialogBoxLock( iLocked)
Locks or unlocks the CalloutCreationDialogBox parameter.
Role:Locks or unlocks the CalloutCreationDialogBox 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 SetClippingFrameLock( iLocked)
Locks or unlocks the ClippingFrame parameter.
Role:Locks or unlocks the ClippingFrame 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 SetClippingFrameReframeOnModeLock( iLocked)
Deprecated:
V5R18 Locks or unlocks the ClippingFrameReframeOnMode parameter.
Role:Locks or unlocks the ClippingFrameReframeOnMode 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 SetClippingViewOutlineColorLock( iLocked)
Locks or unlocks the ClippingViewOutlineColor parameter.
Role:Locks or unlocks the ClippingViewOutlineColor 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 SetClippingViewOutlineColor( iValueR,
iValueG,
iValueB)
Sets the ClippingViewOutlineColor parameter.
o Sub SetClippingViewOutlineLinetypeLock( iLocked)
Locks or unlocks the ClippingViewOutlineLinetype parameter.
Role:Locks or unlocks the ClippingViewOutlineLinetype 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 SetClippingViewOutlineThicknessLock( iLocked)
Locks or unlocks the ClippingViewOutlineThickness parameter.
Role:Locks or unlocks the ClippingViewOutlineThickness 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 SetCreateAssociativeUseEdgesLock( iLocked)
Locks or unlocks the CreateAssociativeUseEdges parameter.
Role:Locks or unlocks the CreateAssociativeUseEdges 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 SetDedicatedFilterTypeLock( iLocked)
Locks or unlocks the DedicatedFilterType parameter.
Role:Locks or unlocks the DedicatedFilterType 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 SetDisplayBackAndCuttingPlaneLock( iLocked)
Locks or unlocks the DisplayBackAndCuttingPlane parameter.
Role:Locks or unlocks the DisplayBackAndCuttingPlane 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 SetDisplayClippingOutlineLock( iLocked)
Locks or unlocks the DisplayClippingOutline parameter.
Role:Locks or unlocks the DisplayClippingOutline 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 SetEditDedicatedFilterDialogBoxLock( iLocked)
Locks or unlocks the EditDedicatedFilterDialogBox parameter.
Role:Locks or unlocks the EditDedicatedFilterDialogBox 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 SetHideIn3DLock( iLocked)
Locks or unlocks the HideIn3D parameter.
Role:Locks or unlocks the HideIn3D 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 SetLayoutDefaultRenderStyleLock( iLocked)
Locks or unlocks the default render style parameter.
Role:Locks or unlocks the default render 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.
o Sub SetPropagateHighlightLock( iLocked)
Locks or unlocks the PropagateHighlight parameter.
Role:Locks or unlocks the PropagateHighlight 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 SetProtectedElementsColorLock( iLocked)
Locks or unlocks the ProtectedElementsColor parameter.
Role:Locks or unlocks the ProtectedElementsColor 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 SetProtectedElementsColor( iValueR,
iValueG,
iValueB)
Sets the ProtectedElementsColor parameter.
o Sub SetViewBackgroundModeLock( iLocked)
Locks or unlocks the ViewBackgroundMode parameter.
Role:Locks or unlocks the ViewBackgroundMode 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 SetViewFilterCreationModeLock( iLocked)
Locks or unlocks the ViewFilterCreationMode parameter.
Role:Locks or unlocks the ViewFilterCreationMode 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.