All Frameworks  Class Hierarchy  This Framework  Indexes   

Drafting2DLInterfaces Interface CATID2o2DLSettingAtt

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATID2o2DLSettingAtt

Interface to access to settings of 2DLayout For 3D Design product.


Method Index


o GetActivate2DModeInfo(CATSettingInfo*)
Retrieves the state of the Activate2DMode parameter.
o GetActivate2DMode(boolean&)
Retrieves the Activate2DMode attribute.
o GetBackClippingPlaneInfo(CATSettingInfo*)
Retrieves the state of the BackClippingPlane parameter.
o GetBackClippingPlane(boolean&)
Retrieves the BackClippingPlane attribute.
o GetBoundaries2DLColorInfo(CATSettingInfo*)
Retrieves the state of the Boundaries2DLColor parameter.
o GetBoundaries2DLColor(int&,int&,int&)
Retrieves the Boundaries2DLColor attribute.
o GetBoundaries2DLDisplayInfo(CATSettingInfo*)
Sets the state of the Boundaries2DLDisplay parameter.
o GetBoundaries2DLDisplay(boolean&)
Retrieves the Boundaries2DLDisplay attribute.
o GetBoundaries2DLLineTypeInfo(CATSettingInfo*)
Retrieves the state of the Boundaries2DLLineType parameter.
o GetBoundaries2DLLineType(int&)
Retrieves the Boundaries2DLLineType attribute.
o GetBoundaries2DLThicknessInfo(CATSettingInfo*)
Retrieves the state of the Boundaries2DLThickness parameter.
o GetBoundaries2DLThickness(int&)
Retrieves the Boundaries2DLThickness attribute.
o GetCalloutCreationDialogBoxInfo(CATSettingInfo*)
Sets the state of the CalloutCreationDialogBox parameter.
o GetCalloutCreationDialogBox(boolean&)
Retrieves the CalloutCreationDialogBox attribute.
o GetClippingFrameInfo(CATSettingInfo*)
Retrieves the state of the ClippingFrame parameter.
o GetClippingFrameReframeOnModeInfo(CATSettingInfo*)
o GetClippingFrameReframeOnMode(CatClippingFrameReframeOnMode&)
Retrieves the ClippingFrameReframeOnMode attribute.
o GetClippingFrame(boolean&)
Retrieves the ClippingFrame attribute.
o GetClippingViewOutlineColorInfo(CATSettingInfo*)
Retrieves the state of the ClippingViewOutlineColor parameter.
o GetClippingViewOutlineColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the ClippingViewOutlineColor attribute.
o GetClippingViewOutlineLinetypeInfo(CATSettingInfo*)
Retrieves the state of the ClippingViewOutlineLinetype parameter.
o GetClippingViewOutlineLinetype(int&)
Retrieves the ClippingViewOutlineLinetype attribute.
o GetClippingViewOutlineThicknessInfo(CATSettingInfo*)
Retrieves the state of the ClippingViewOutlineThickness parameter.
o GetClippingViewOutlineThickness(int&)
Retrieves the ClippingViewOutlineThickness attribute.
o GetCreateAssociativeUseEdgesInfo(CATSettingInfo*)
Retrieves the state of the CreateAssociativeUseEdges parameter.
o GetCreateAssociativeUseEdges(boolean&)
Retrieves the CreateAssociativeUseEdges attribute.
o GetDedicatedFilterTypeInfo(CATSettingInfo*)
Retrieves the state of the DedicatedFilterType parameter.
o GetDedicatedFilterType(CatDedicatedFilterType&)
Retrieves the DedicatedFilterType attribute.
o GetDisplayBackAndCuttingPlaneInfo(CATSettingInfo*)
Retrieves the state of the DisplayBackAndCuttingPlane parameter.
o GetDisplayBackAndCuttingPlane(boolean&)
Retrieves the DisplayBackAndCuttingPlane attribute.
o GetDisplayClippingOutlineInfo(CATSettingInfo*)
Retrieves the state of the DisplayClippingOutline parameter.
o GetDisplayClippingOutline(boolean&)
Retrieves the DisplayClippingOutline attribute.
o GetEditDedicatedFilterDialogBoxInfo(CATSettingInfo*)
Retrieves the state of the EditDedicatedFilterDialogBox parameter.
o GetEditDedicatedFilterDialogBox(boolean&)
Retrieves the EditDedicatedFilterDialogBox attribute.
o GetHideIn3DInfo(CATSettingInfo*)
Retrieves the state of the PreventFileNew parameter.
o GetHideIn3D(boolean&)
Retrieves the HideIn3D attribute.
o GetLayoutDefaultRenderStyleInfo(CATSettingInfo*)
Retrieves the state of the setting info correspondnig to the default render style attribute.
o GetLayoutDefaultRenderStyle(int&)
Retrieves the default render style attribute value to apply to a Layout at its creation.
o GetPropagateHighlightInfo(CATSettingInfo*)
Retrieves the state of the PropagateHighlight parameter.
o GetPropagateHighlight(boolean&)
Retrieves the PropagateHighlight attribute.
o GetProtectedElementsColorInfo(CATSettingInfo*)
Retrieves the state of the ProtectedElementsColor parameter.
o GetProtectedElementsColor(unsigned int&,unsigned int&,unsigned int&)
Retrieves the ProtectedElementsColor attribute.
o GetViewBackgroundModeInfo(CATSettingInfo*)
Retrieves the state of the ViewBackgroundMode parameter.
o GetViewBackgroundMode(CatViewBackgroundMode&)
Retrieves the ViewBackgroundMode attribute.
o GetViewFilterCreationModeInfo(CATSettingInfo*)
Retrieves the state of the ViewFilterCreationMode parameter.
o GetViewFilterCreationMode(CatViewFilterCreationMode&)
Retrieves the ViewFilterCreationMode attribute.
o SetActivate2DModeLock(unsigned char)
Locks or unlocks the Activate2DMode parameter.
o SetActivate2DMode(boolean&)
Sets the Activate2DMode attribute.
o SetBackClippingPlaneLock(unsigned char)
Locks or unlocks the BackClippingPlane parameter.
o SetBackClippingPlane(boolean&)
Sets the BackClippingPlane attribute.
o SetBoundaries2DLColorLock(unsigned char)
Locks or unlocks the Boundaries2DLColor parameter.
o SetBoundaries2DLColor(int,int,int)
Sets the Boundaries2DLColor attribute.
o SetBoundaries2DLDisplayLock(unsigned char)
Locks or unlocks the Boundaries2DLDisplay parameter.
o SetBoundaries2DLDisplay(boolean&)
Sets the Boundaries2DLDisplay attribute.
o SetBoundaries2DLLineTypeLock(unsigned char)
Locks or unlocks the Boundaries2DLLineType parameter.
o SetBoundaries2DLLineType(int&)
Sets the Boundaries2DLLineType attribute.
o SetBoundaries2DLThicknessLock(unsigned char)
Locks or unlocks the Boundaries2DLThickness parameter.
o SetBoundaries2DLThickness(int&)
Sets the Boundaries2DLThickness attribute.
o SetCalloutCreationDialogBoxLock(unsigned char)
Locks or unlocks the CalloutCreationDialogBox parameter.
o SetCalloutCreationDialogBox(boolean&)
Sets the CalloutCreationDialogBox attribute.
o SetClippingFrameLock(unsigned char)
Locks or unlocks the ClippingFrame parameter.
o SetClippingFrameReframeOnModeLock(unsigned char)
o SetClippingFrameReframeOnMode(CatClippingFrameReframeOnMode&)
Sets the DedicatedFilterType attribute.
o SetClippingFrame(boolean&)
Sets the ClippingFrame attribute.
o SetClippingViewOutlineColorLock(unsigned char)
Locks or unlocks the ClippingViewOutlineColor parameter.
o SetClippingViewOutlineColor(unsigned int,unsigned int,unsigned int)
Sets the ClippingViewOutlineColor attribute.
o SetClippingViewOutlineLinetypeLock(unsigned char)
Locks or unlocks the ClippingViewOutlineLinetype parameter.
o SetClippingViewOutlineLinetype(int&)
Sets the ClippingViewOutlineLinetype attribute.
o SetClippingViewOutlineThicknessLock(unsigned char)
Locks or unlocks the ClippingViewOutlineThickness parameter.
o SetClippingViewOutlineThickness(int&)
Sets the ClippingViewOutlineThickness attribute.
o SetCreateAssociativeUseEdgesLock(unsigned char)
Locks or unlocks the CreateAssociativeUseEdges parameter.
o SetCreateAssociativeUseEdges(boolean&)
Sets the CreateAssociativeUseEdges attribute.
o SetDedicatedFilterTypeLock(unsigned char)
Locks or unlocks the DedicatedFilterType parameter.
o SetDedicatedFilterType(CatDedicatedFilterType&)
Sets the DedicatedFilterType attribute.
o SetDisplayBackAndCuttingPlaneLock(unsigned char)
Locks or unlocks the DisplayBackAndCuttingPlane parameter.
o SetDisplayBackAndCuttingPlane(boolean&)
Sets the DisplayBackAndCuttingPlane attribute.
o SetDisplayClippingOutlineLock(unsigned char)
Locks or unlocks the DisplayClippingOutline parameter.
o SetDisplayClippingOutline(boolean&)
Sets the DisplayClippingOutline attribute.
o SetEditDedicatedFilterDialogBoxLock(unsigned char)
Locks or unlocks the EditDedicatedFilterDialogBox parameter.
o SetEditDedicatedFilterDialogBox(boolean&)
Sets the EditDedicatedFilterDialogBox attribute.
o SetHideIn3DLock(unsigned char)
Locks or unlocks the PreventFileNew parameter.
o SetHideIn3D(boolean&)
Sets the HideIn3D attribute.
o SetLayoutDefaultRenderStyleLock(unsigned char)
Locks or unlocks the the default render style attribute.
o SetLayoutDefaultRenderStyle(int&)
Sets the default render style attribute value to apply to a Layout at its creation.
o SetPropagateHighlightLock(unsigned char)
Locks or unlocks the PropagateHighlight parameter.
o SetPropagateHighlight(boolean&)
Sets the PropagateHighlight attribute.
o SetProtectedElementsColorLock(unsigned char)
Locks or unlocks the ProtectedElementsColor parameter.
o SetProtectedElementsColor(unsigned int,unsigned int,unsigned int)
Sets the ProtectedElementsColor attribute.
o SetViewBackgroundModeLock(unsigned char)
Locks or unlocks the ViewBackgroundMode parameter.
o SetViewBackgroundMode(CatViewBackgroundMode&)
Sets the ViewBackgroundMode attribute.
o SetViewFilterCreationModeLock(unsigned char)
Locks or unlocks the ViewFilterCreationMode parameter.
o SetViewFilterCreationMode(CatViewFilterCreationMode&)
Sets the ViewFilterCreationMode attribute.

Methods


o GetActivate2DModeInfo
public virtual GetActivate2DModeInfo( oInfo)
Retrieves the state of the Activate2DMode parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetActivate2DMode
public virtual GetActivate2DMode( ioValue)
Retrieves the Activate2DMode attribute.
o GetBackClippingPlaneInfo
public virtual GetBackClippingPlaneInfo( oInfo)
Retrieves the state of the BackClippingPlane parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBackClippingPlane
public virtual GetBackClippingPlane( ioValue)
Retrieves the BackClippingPlane attribute.
o GetBoundaries2DLColorInfo
public virtual GetBoundaries2DLColorInfo( oInfo)
Retrieves the state of the Boundaries2DLColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoundaries2DLColor
public virtual GetBoundaries2DLColor( oValueR,
oValueG,
oValueB)
Retrieves the Boundaries2DLColor attribute.
Parameters:
oValueR
The RValue of the color Legal values:
0-255
oValueG
The GValue of the color Legal values:
0-255
oValueB
The RValue of the color Legal values:
0-255
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoundaries2DLDisplayInfo
public virtual GetBoundaries2DLDisplayInfo( oInfo)
Sets the state of the Boundaries2DLDisplay parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoundaries2DLDisplay
public virtual GetBoundaries2DLDisplay( ioValue)
Retrieves the Boundaries2DLDisplay attribute.
Parameters:
ioValue
The value that is retrieved Legal values:
1 : to check the parameter.
0: to uncheck the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoundaries2DLLineTypeInfo
public virtual GetBoundaries2DLLineTypeInfo( oInfo)
Retrieves the state of the Boundaries2DLLineType parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoundaries2DLLineType
public virtual GetBoundaries2DLLineType( oValue)
Retrieves the Boundaries2DLLineType attribute.
Parameters:
oValue
The value that is retrived
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoundaries2DLThicknessInfo
public virtual GetBoundaries2DLThicknessInfo( oInfo)
Retrieves the state of the Boundaries2DLThickness parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetBoundaries2DLThickness
public virtual GetBoundaries2DLThickness( oValue)
Retrieves the Boundaries2DLThickness attribute.
Parameters:
oValue
The value that is retrieved
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCalloutCreationDialogBoxInfo
public virtual GetCalloutCreationDialogBoxInfo( oInfo)
Sets the state of the CalloutCreationDialogBox parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCalloutCreationDialogBox
public virtual GetCalloutCreationDialogBox( ioValue)
Retrieves the CalloutCreationDialogBox attribute.
Parameters:
ioValue
The value that is retrieved Legal values:
1 : to check the parameter.
0: to uncheck the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClippingFrameInfo
public virtual GetClippingFrameInfo( oInfo)
Retrieves the state of the ClippingFrame parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClippingFrameReframeOnModeInfo
public virtual GetClippingFrameReframeOnModeInfo( oInfo)
Deprecated:
V5R18 Retrieves the state of the ClippingFrameReframeOnMode parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClippingFrameReframeOnMode
public virtual GetClippingFrameReframeOnMode( ioValue)
Retrieves the ClippingFrameReframeOnMode attribute.
Deprecated:
V5R18
o GetClippingFrame
public virtual GetClippingFrame( ioValue)
Retrieves the ClippingFrame attribute.
o GetClippingViewOutlineColorInfo
public virtual GetClippingViewOutlineColorInfo( oInfo)
Retrieves the state of the ClippingViewOutlineColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClippingViewOutlineColor
public virtual GetClippingViewOutlineColor( oValueR,
oValueG,
oValueB)
Retrieves the ClippingViewOutlineColor attribute.
o GetClippingViewOutlineLinetypeInfo
public virtual GetClippingViewOutlineLinetypeInfo( oInfo)
Retrieves the state of the ClippingViewOutlineLinetype parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClippingViewOutlineLinetype
public virtual GetClippingViewOutlineLinetype( oValue)
Retrieves the ClippingViewOutlineLinetype attribute.
o GetClippingViewOutlineThicknessInfo
public virtual GetClippingViewOutlineThicknessInfo( oInfo)
Retrieves the state of the ClippingViewOutlineThickness parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetClippingViewOutlineThickness
public virtual GetClippingViewOutlineThickness( oValue)
Retrieves the ClippingViewOutlineThickness attribute.
o GetCreateAssociativeUseEdgesInfo
public virtual GetCreateAssociativeUseEdgesInfo( oInfo)
Retrieves the state of the CreateAssociativeUseEdges parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetCreateAssociativeUseEdges
public virtual GetCreateAssociativeUseEdges( ioValue)
Retrieves the CreateAssociativeUseEdges attribute.
o GetDedicatedFilterTypeInfo
public virtual GetDedicatedFilterTypeInfo( oInfo)
Retrieves the state of the DedicatedFilterType parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDedicatedFilterType
public virtual GetDedicatedFilterType( ioValue)
Retrieves the DedicatedFilterType attribute.
o GetDisplayBackAndCuttingPlaneInfo
public virtual GetDisplayBackAndCuttingPlaneInfo( oInfo)
Retrieves the state of the DisplayBackAndCuttingPlane parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayBackAndCuttingPlane
public virtual GetDisplayBackAndCuttingPlane( ioValue)
Retrieves the DisplayBackAndCuttingPlane attribute.
o GetDisplayClippingOutlineInfo
public virtual GetDisplayClippingOutlineInfo( oInfo)
Retrieves the state of the DisplayClippingOutline parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetDisplayClippingOutline
public virtual GetDisplayClippingOutline( ioValue)
Retrieves the DisplayClippingOutline attribute.
o GetEditDedicatedFilterDialogBoxInfo
public virtual GetEditDedicatedFilterDialogBoxInfo( oInfo)
Retrieves the state of the EditDedicatedFilterDialogBox parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetEditDedicatedFilterDialogBox
public virtual GetEditDedicatedFilterDialogBox( ioValue)
Retrieves the EditDedicatedFilterDialogBox attribute.
o GetHideIn3DInfo
public virtual GetHideIn3DInfo( oInfo)
Retrieves the state of the PreventFileNew parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetHideIn3D
public virtual GetHideIn3D( ioValue)
Retrieves the HideIn3D attribute.
o GetLayoutDefaultRenderStyleInfo
public virtual GetLayoutDefaultRenderStyleInfo( oInfo)
Retrieves the state of the setting info correspondnig to the default render style attribute.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetLayoutDefaultRenderStyle
public virtual GetLayoutDefaultRenderStyle( oValue)
Retrieves the default render style attribute value to apply to a Layout at its creation.
Parameters:
oValue
The value that is retrived
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPropagateHighlightInfo
public virtual GetPropagateHighlightInfo( oInfo)
Retrieves the state of the PropagateHighlight parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetPropagateHighlight
public virtual GetPropagateHighlight( ioValue)
Retrieves the PropagateHighlight attribute.
o GetProtectedElementsColorInfo
public virtual GetProtectedElementsColorInfo( oInfo)
Retrieves the state of the ProtectedElementsColor parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetProtectedElementsColor
public virtual GetProtectedElementsColor( oValueR,
oValueG,
oValueB)
Retrieves the ProtectedElementsColor attribute.
o GetViewBackgroundModeInfo
public virtual GetViewBackgroundModeInfo( oInfo)
Retrieves the state of the ViewBackgroundMode parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewBackgroundMode
public virtual GetViewBackgroundMode( ioValue)
Retrieves the ViewBackgroundMode attribute.
o GetViewFilterCreationModeInfo
public virtual GetViewFilterCreationModeInfo( oInfo)
Retrieves the state of the ViewFilterCreationMode parameter.
Parameters:
oInfo
Address of an object CATSettingInfo.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o GetViewFilterCreationMode
public virtual GetViewFilterCreationMode( ioValue)
Retrieves the ViewFilterCreationMode attribute.
o SetActivate2DModeLock
public virtual SetActivate2DModeLock( iLocked)
Locks or unlocks the Activate2DMode parameter.
Role: Locks or unlocks the Activate2DMode parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetActivate2DMode
public virtual SetActivate2DMode( const iValue)
Sets the Activate2DMode attribute.
o SetBackClippingPlaneLock
public virtual SetBackClippingPlaneLock( iLocked)
Locks or unlocks the BackClippingPlane parameter.
Role: Locks or unlocks the BackClippingPlane parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBackClippingPlane
public virtual SetBackClippingPlane( const iValue)
Sets the BackClippingPlane attribute.
o SetBoundaries2DLColorLock
public virtual SetBoundaries2DLColorLock( iLocked)
Locks or unlocks the Boundaries2DLColor parameter.
Role: Locks or unlocks the Boundaries2DLColor parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoundaries2DLColor
public virtual SetBoundaries2DLColor( iValueR,
iValueG,
iValueB)
Sets the Boundaries2DLColor attribute.
Parameters:
iValueR
The RValue of the color Legal values:
0-255
iValueG
The GValue of the color Legal values:
0-255
iValueB
The RValue of the color Legal values:
0-255
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoundaries2DLDisplayLock
public virtual SetBoundaries2DLDisplayLock( iLocked)
Locks or unlocks the Boundaries2DLDisplay parameter.
Role: Locks or unlocks the Boundaries2DLDisplay parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoundaries2DLDisplay
public virtual SetBoundaries2DLDisplay( const iValue)
Sets the Boundaries2DLDisplay attribute.
Parameters:
iValue
The value that is set Legal values:
1 : to check the parameter.
0: to uncheck the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoundaries2DLLineTypeLock
public virtual SetBoundaries2DLLineTypeLock( iLocked)
Locks or unlocks the Boundaries2DLLineType parameter.
Role: Locks or unlocks the Boundaries2DLLineType parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoundaries2DLLineType
public virtual SetBoundaries2DLLineType( const iValue)
Sets the Boundaries2DLLineType attribute.
Parameters:
iValue
The value that is set
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoundaries2DLThicknessLock
public virtual SetBoundaries2DLThicknessLock( iLocked)
Locks or unlocks the Boundaries2DLThickness parameter.
Role: Locks or unlocks the Boundaries2DLThickness parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetBoundaries2DLThickness
public virtual SetBoundaries2DLThickness( const iValue)
Sets the Boundaries2DLThickness attribute.
Parameters:
iValue
The value that is set
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCalloutCreationDialogBoxLock
public virtual SetCalloutCreationDialogBoxLock( iLocked)
Locks or unlocks the CalloutCreationDialogBox parameter.
Role: Locks or unlocks the CalloutCreationDialogBox parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCalloutCreationDialogBox
public virtual SetCalloutCreationDialogBox( const iValue)
Sets the CalloutCreationDialogBox attribute.
Parameters:
iValue
The value that is set Legal values:
1 : to check the parameter.
0: to uncheck the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingFrameLock
public virtual SetClippingFrameLock( iLocked)
Locks or unlocks the ClippingFrame parameter.
Role: Locks or unlocks the ClippingFrame parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingFrameReframeOnModeLock
public virtual SetClippingFrameReframeOnModeLock( iLocked)
Deprecated:
V5R18 Locks or unlocks the ClippingFrameReframeOnMode parameter.
Role: Locks or unlocks the ClippingFrameReframeOnMode parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingFrameReframeOnMode
public virtual SetClippingFrameReframeOnMode( const iValue)
Sets the DedicatedFilterType attribute.
Deprecated:
V5R18
o SetClippingFrame
public virtual SetClippingFrame( const iValue)
Sets the ClippingFrame attribute.
o SetClippingViewOutlineColorLock
public virtual SetClippingViewOutlineColorLock( iLocked)
Locks or unlocks the ClippingViewOutlineColor parameter.
Role: Locks or unlocks the ClippingViewOutlineColor parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingViewOutlineColor
public virtual SetClippingViewOutlineColor( iValueR,
iValueG,
iValueB)
Sets the ClippingViewOutlineColor attribute.
o SetClippingViewOutlineLinetypeLock
public virtual SetClippingViewOutlineLinetypeLock( iLocked)
Locks or unlocks the ClippingViewOutlineLinetype parameter.
Role: Locks or unlocks the ClippingViewOutlineLinetype parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingViewOutlineLinetype
public virtual SetClippingViewOutlineLinetype( const iValue)
Sets the ClippingViewOutlineLinetype attribute.
o SetClippingViewOutlineThicknessLock
public virtual SetClippingViewOutlineThicknessLock( iLocked)
Locks or unlocks the ClippingViewOutlineThickness parameter.
Role: Locks or unlocks the ClippingViewOutlineThickness parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetClippingViewOutlineThickness
public virtual SetClippingViewOutlineThickness( const iValue)
Sets the ClippingViewOutlineThickness attribute.
o SetCreateAssociativeUseEdgesLock
public virtual SetCreateAssociativeUseEdgesLock( iLocked)
Locks or unlocks the CreateAssociativeUseEdges parameter.
Role: Locks or unlocks the CreateAssociativeUseEdges parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetCreateAssociativeUseEdges
public virtual SetCreateAssociativeUseEdges( const iValue)
Sets the CreateAssociativeUseEdges attribute.
o SetDedicatedFilterTypeLock
public virtual SetDedicatedFilterTypeLock( iLocked)
Locks or unlocks the DedicatedFilterType parameter.
Role: Locks or unlocks the DedicatedFilterType parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDedicatedFilterType
public virtual SetDedicatedFilterType( const iValue)
Sets the DedicatedFilterType attribute.
o SetDisplayBackAndCuttingPlaneLock
public virtual SetDisplayBackAndCuttingPlaneLock( iLocked)
Locks or unlocks the DisplayBackAndCuttingPlane parameter.
Role: Locks or unlocks the DisplayBackAndCuttingPlane parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDisplayBackAndCuttingPlane
public virtual SetDisplayBackAndCuttingPlane( const iValue)
Sets the DisplayBackAndCuttingPlane attribute.
o SetDisplayClippingOutlineLock
public virtual SetDisplayClippingOutlineLock( iLocked)
Locks or unlocks the DisplayClippingOutline parameter.
Role: Locks or unlocks the DisplayClippingOutline parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetDisplayClippingOutline
public virtual SetDisplayClippingOutline( const iValue)
Sets the DisplayClippingOutline attribute.
o SetEditDedicatedFilterDialogBoxLock
public virtual SetEditDedicatedFilterDialogBoxLock( iLocked)
Locks or unlocks the EditDedicatedFilterDialogBox parameter.
Role: Locks or unlocks the EditDedicatedFilterDialogBox parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetEditDedicatedFilterDialogBox
public virtual SetEditDedicatedFilterDialogBox( const iValue)
Sets the EditDedicatedFilterDialogBox attribute.
o SetHideIn3DLock
public virtual SetHideIn3DLock( iLocked)
Locks or unlocks the PreventFileNew parameter.
Role: Locks or unlocks the PreventFileNew parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetHideIn3D
public virtual SetHideIn3D( const iValue)
Sets the HideIn3D attribute.
o SetLayoutDefaultRenderStyleLock
public virtual SetLayoutDefaultRenderStyleLock( iLocked)
Locks or unlocks the the default render style attribute.
Role: Locks or unlocks the the default render style attribute if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetLayoutDefaultRenderStyle
public virtual SetLayoutDefaultRenderStyle( const iValue)
Sets the default render style attribute value to apply to a Layout at its creation.
Parameters:
iValue
The value that is set
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPropagateHighlightLock
public virtual SetPropagateHighlightLock( iLocked)
Locks or unlocks the PropagateHighlight parameter.
Role: Locks or unlocks the PropagateHighlight parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetPropagateHighlight
public virtual SetPropagateHighlight( const iValue)
Sets the PropagateHighlight attribute.
o SetProtectedElementsColorLock
public virtual SetProtectedElementsColorLock( iLocked)
Locks or unlocks the ProtectedElementsColor parameter.
Role: Locks or unlocks the ProtectedElementsColor parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetProtectedElementsColor
public virtual SetProtectedElementsColor( iValueR,
iValueG,
iValueB)
Sets the ProtectedElementsColor attribute.
o SetViewBackgroundModeLock
public virtual SetViewBackgroundModeLock( iLocked)
Locks or unlocks the ViewBackgroundMode parameter.
Role: Locks or unlocks the ViewBackgroundMode parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewBackgroundMode
public virtual SetViewBackgroundMode( const iValue)
Sets the ViewBackgroundMode attribute.
o SetViewFilterCreationModeLock
public virtual SetViewFilterCreationModeLock( iLocked)
Locks or unlocks the ViewFilterCreationMode parameter.
Role: Locks or unlocks the ViewFilterCreationMode parameter if the operation is allowed in the current administrated environment. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
1 : to lock the parameter.
0: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o SetViewFilterCreationMode
public virtual SetViewFilterCreationMode( const iValue)
Sets the ViewFilterCreationMode attribute.

This object is included in the file: CATID2o2DLSettingAtt.h
If needed, your Imakefile.mk should include the module: CATDrafting2DLItfCPP

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