All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

Layout2DSettingAtt (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---SettingController
            |
            +---Layout2DSettingAtt
 


The interface to access a CATIA2DLSettingAtt.

Property Index

Activate2DMode
Returns the Activate2DMode parameter.
BackClippingPlane
Returns the BackClippingPlane parameter.
ClippingFrame
Returns the ClippingFrame parameter.
ClippingFrameReframeOnMode
Returns the ClippingFrameReframeOnMode 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.
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.
GetClippingFrameInfo
Retrieves environment informations for the ClippingFrame parameter.
GetClippingFrameReframeOnModeInfo
GetClippingViewOutlineColor
Returns the ClippingViewOutlineColor parameter.
GetClippingViewOutlineColorInfo
Retrieves environment informations for 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.
GetPropagateHighlightInfo
Retrieves environment informations for the PropagateHighlight parameter.
GetProtectedElementsColor
Returns the ProtectedElementsColor parameter.
GetProtectedElementsColorInfo
Retrieves environment informations for 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.
SetClippingFrameLock
Locks or unlocks the ClippingFrame parameter.
SetClippingFrameReframeOnModeLock
SetClippingViewOutlineColor
Sets the ClippingViewOutlineColor parameter.
SetClippingViewOutlineColorLock
Locks or unlocks 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.
SetPropagateHighlightLock
Locks or unlocks the PropagateHighlight parameter.
SetProtectedElementsColor
Sets the ProtectedElementsColor parameter.
SetProtectedElementsColorLock
Locks or unlocks the ProtectedElementsColor parameter.
SetViewBackgroundModeLock
Locks or unlocks the ViewBackgroundMode parameter.
SetViewFilterCreationModeLock
Locks or unlocks the ViewFilterCreationMode parameter.

Properties


o Property Activate2DMode() As boolean
Returns the Activate2DMode parameter.
o Property BackClippingPlane() As boolean
Returns the BackClippingPlane parameter.
o Property ClippingFrame() As boolean
Returns the ClippingFrame parameter.
o Property ClippingFrameReframeOnMode() As CatClippingFrameReframeOnMode
Returns the ClippingFrameReframeOnMode parameter.
Deprecated:
V5R18
o Property ClippingViewOutlineLinetype() As long
Returns the ClippingViewOutlineLinetype parameter.
o Property ClippingViewOutlineThickness() As long
Returns the ClippingViewOutlineThickness parameter.
o Property CreateAssociativeUseEdges() As boolean
Returns the CreateAssociativeUseEdges parameter.
o Property DedicatedFilterType() As CatDedicatedFilterType
Returns the DedicatedFilterType parameter.
o Property DisplayBackAndCuttingPlane() As boolean
Returns the DisplayBackAndCuttingPlane parameter.
o Property DisplayClippingOutline() As boolean
Returns the DisplayClippingOutline parameter.
o Property EditDedicatedFilterDialogBox() As boolean
Returns the EditDedicatedFilterDialogBox parameter.
o Property HideIn3D() As boolean
Returns the HideIn3D parameter.
o Property PropagateHighlight() As boolean
Returns the PropagateHighlight parameter.
o Property ViewBackgroundMode() As CatViewBackgroundMode
Returns the ViewBackgroundMode parameter.
o Property ViewFilterCreationMode() As CatViewFilterCreationMode
Returns the ViewFilterCreationMode parameter.

Methods


o Sub GetActivate2DModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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 GetClippingFrameInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
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 GetClippingViewOutlineColor(long oValueR,
long oValueG,
long oValueB)
Returns the ClippingViewOutlineColor parameter.
o Sub GetClippingViewOutlineColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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 GetClippingViewOutlineLinetypeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
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(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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 GetPropagateHighlightInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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 GetProtectedElementsColor(long oValueR,
long oValueG,
long oValueB)
Returns the ProtectedElementsColor parameter.
o Sub GetProtectedElementsColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked,
boolean 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 Func GetViewBackgroundModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
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(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
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(boolean 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(boolean 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 SetClippingFrameLock(boolean 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(boolean 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 SetClippingViewOutlineColor(long iValueR,
long iValueG,
long iValueB)
Sets the ClippingViewOutlineColor parameter.
o Sub SetClippingViewOutlineColorLock(boolean 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 SetClippingViewOutlineLinetypeLock(boolean 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(boolean 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(boolean 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(boolean 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(boolean 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(boolean 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(boolean 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(boolean 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 SetPropagateHighlightLock(boolean 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 SetProtectedElementsColor(long iValueR,
long iValueG,
long iValueB)
Sets the ProtectedElementsColor parameter.
o Sub SetProtectedElementsColorLock(boolean 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 SetViewBackgroundModeLock(boolean 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(boolean 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.