All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

SectioningSettingAtt (Object)

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


The interface to access a CATIASectioningSettingAtt.

Property Index

ClippingMode
Returns or sets the ClippingMode parameter.
DisplayCutInWireframe
Returns or sets the DisplayCutInWireframe parameter.
GridAutoFiltering
Returns or sets the GridAutoFiltering parameter.
GridAutoResize
Returns or sets the GridAutoResize parameter.
GridHeightStep
Returns or sets the GridHeightStep parameter.
GridPositionMode
Returns or sets the GridPositionMode parameter.
GridStyle
Returns or sets the GridStyle parameter.
GridWidthStep
Returns or sets the GridWidthStep parameter.
HidePlane
Returns or sets the HidePlane parameter.
HideResult
Returns or sets the HideResult parameter.
PlaneNormal
Returns or sets the PlaneNormal parameter.
PlaneOrigin
Returns or sets the PlaneOrigin parameter.
SectionFill
Returns or sets the SectionFill parameter.
UpdateResult
Returns or sets the UpdateResult parameter.
ViewerAutoOpen
Returns or sets the ViewerAutoOpen parameter.
ViewerAutoReframe
Returns or sets the ViewerAutoReframe parameter.
ViewerLock2D
Returns or sets the ViewerLock2D parameter.
WindowDefaultHeight

Role:Retrieve section window default height if the window open mode is catSecWindow_DefaultSize
WindowDefaultWidth

Role:Retrieve section window default width if the window open mode is catSecWindow_DefaultSize
WindowOpenMode

Role:Retrieve section window open mode

Method Index

GetClippingModeInfo
Retrieves environment informations for the ClippingMode parameter.
GetDisplayCutInWireframeInfo
Retrieves environment informations for the DisplayCutInWireframe parameter.
GetGridAutoFilteringInfo
Retrieves environment informations for the GridAutoFiltering parameter.
GetGridAutoResizeInfo
Retrieves environment informations for the GridAutoResize parameter.
GetGridHeightStepInfo
Retrieves environment informations for the GridHeightStep parameter.
GetGridPositionModeInfo
Retrieves environment informations for the GridPositionMode parameter.
GetGridStyleInfo
Retrieves environment informations for the GridStyle parameter.
GetGridWidthStepInfo
Retrieves environment informations for the GridWidthStep parameter.
GetHidePlaneInfo
Retrieves environment informations for the HidePlane parameter.
GetHideResultInfo
Retrieves environment informations for the HideResult parameter.
GetPlaneColor
Returns the PlaneColor parameter.
GetPlaneColorInfo
Retrieves environment informations for the PlaneColor parameter.
GetPlaneNormalInfo
Retrieves environment informations for the PlaneNormal parameter.
GetPlaneOriginInfo
Retrieves environment informations for the PlaneOrigin parameter.
GetSectionFillInfo
Retrieves environment informations for the SectionFill parameter.
GetUpdateResultInfo
Retrieves environment informations for the UpdateResult parameter.
GetViewerAutoOpenInfo
Retrieves environment informations for the ViewerAutoOpen parameter.
GetViewerAutoReframeInfo
Retrieves environment informations for the ViewerAutoReframe parameter.
GetViewerLock2DInfo
Retrieves environment informations for the ViewerLock2D parameter.
GetWindowDefaultHeightInfo
Retrieves environment informations for the WindowDefaultHeight parameter.
GetWindowDefaultWidthInfo
Retrieves environment informations for the WindowDefaultWidth parameter.
GetWindowOpenModeInfo
Retrieves environment informations for the WindowOpenMode parameter.
SetClippingModeLock
Locks or unlocks the ClippingMode parameter.
SetDisplayCutInWireframeLock
Locks or unlocks the DisplayCutInWireframe parameter.
SetGridAutoFilteringLock
Locks or unlocks the GridAutoFiltering parameter.
SetGridAutoResizeLock
Locks or unlocks the GridAutoResize parameter.
SetGridHeightStepLock
Locks or unlocks the GridHeightStep parameter.
SetGridPositionModeLock
Locks or unlocks the GridPositionMode parameter.
SetGridStyleLock
Locks or unlocks the GridStyle parameter.
SetGridWidthStepLock
Locks or unlocks the GridWidthStep parameter.
SetHidePlaneLock
Locks or unlocks the HidePlane parameter.
SetHideResultLock
Locks or unlocks the HideResult parameter.
SetPlaneColor
Sets the PlaneColor parameter.
SetPlaneColorLock
Locks or unlocks the PlaneColor parameter.
SetPlaneNormalLock
Locks or unlocks the PlaneNormal parameter.
SetPlaneOriginLock
Locks or unlocks the PlaneOrigin parameter.
SetSectionFillLock
Locks or unlocks the SectionFill parameter.
SetUpdateResultLock
Locks or unlocks the UpdateResult parameter.
SetViewerAutoOpenLock
Locks or unlocks the ViewerAutoOpen parameter.
SetViewerAutoReframeLock
Locks or unlocks the ViewerAutoReframe parameter.
SetViewerLock2DLock
Locks or unlocks the ViewerLock2D parameter.
SetWindowDefaultHeightLock
Locks or unlocks the WindowDefaultHeight parameter.
SetWindowDefaultWidthLock
Locks or unlocks the WindowDefaultWidth parameter.
SetWindowOpenModeLock
Locks or unlocks the WindowOpenMode parameter.

Properties


o Property ClippingMode() As CatSectionClippingMode
Returns or sets the ClippingMode parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property DisplayCutInWireframe() As boolean
Returns or sets the DisplayCutInWireframe parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property GridAutoFiltering() As boolean
Returns or sets the GridAutoFiltering parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property GridAutoResize() As boolean
Returns or sets the GridAutoResize parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property GridHeightStep() As float
Returns or sets the GridHeightStep parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property GridPositionMode() As CatGridPositionMode
Returns or sets the GridPositionMode parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property GridStyle() As CatSectionGridStyle
Returns or sets the GridStyle parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property GridWidthStep() As float
Returns or sets the GridWidthStep parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property HidePlane() As boolean
Returns or sets the HidePlane parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property HideResult() As boolean
Returns or sets the HideResult parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property PlaneNormal() As CatSectionPlaneNormal
Returns or sets the PlaneNormal parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property PlaneOrigin() As CatSectionPlaneOrigin
Returns or sets the PlaneOrigin parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property SectionFill() As boolean
Returns or sets the SectionFill parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property UpdateResult() As boolean
Returns or sets the UpdateResult parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property ViewerAutoOpen() As boolean
Returns or sets the ViewerAutoOpen parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property ViewerAutoReframe() As boolean
Returns or sets the ViewerAutoReframe parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property ViewerLock2D() As boolean
Returns or sets the ViewerLock2D parameter.

Ensure consistency with the C++ interface to which the work is delegated.

o Property WindowDefaultHeight() As long

Role:Retrieve section window default height if the window open mode is catSecWindow_DefaultSize
Parameters:
oWindowDefaultHeight
Returns:
S_OK Successfully retieved the window open mode E_FAIL Failed to retrieved the window open mode
o Property WindowDefaultWidth() As long

Role:Retrieve section window default width if the window open mode is catSecWindow_DefaultSize
Parameters:
oWindowDefaultWidth
Returns:
S_OK Successfully retieved the window open mode E_FAIL Failed to retrieved the window open mode
o Property WindowOpenMode() As CatSecWindowOpenMode

Role:Retrieve section window open mode
Parameters:
oWindowOpenMode
Legal values:
catSecWindow_DefaultSize :Opens the sectioning window(s) with the default size specified in the Tools->Options.
catSecWindow_TileVertically :Tiles the sectioning window(s) vertically in the viewer
Returns:
S_OK Successfully retieved the window open mode E_FAIL Failed to retrieved the window open mode

Methods


o Func GetClippingModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ClippingMode parameter.
Role:Retrieves the state of the ClippingMode 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 GetDisplayCutInWireframeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DisplayCutInWireframe parameter.
Role:Retrieves the state of the DisplayCutInWireframe 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 GetGridAutoFilteringInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the GridAutoFiltering parameter.
Role:Retrieves the state of the GridAutoFiltering 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 GetGridAutoResizeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the GridAutoResize parameter.
Role:Retrieves the state of the GridAutoResize 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 GetGridHeightStepInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the GridHeightStep parameter.
Role:Retrieves the state of the GridHeightStep 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 GetGridPositionModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the GridPositionMode parameter.
Role:Retrieves the state of the GridPositionMode 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 GetGridStyleInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the GridStyle parameter.
Role:Retrieves the state of the GridStyle 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 GetGridWidthStepInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the GridWidthStep parameter.
Role:Retrieves the state of the GridWidthStep 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 GetHidePlaneInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the HidePlane parameter.
Role:Retrieves the state of the HidePlane 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 GetHideResultInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the HideResult parameter.
Role:Retrieves the state of the HideResult 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 GetPlaneColor(long oR,
long oG,
long oB)
Returns the PlaneColor parameter.

Parameters:
oR
the red component of the color.
oG
the green component of the color.
oB
the blue component of the color.

Ensure consistency with the C++ interface to which the work is delegated.

o Func GetPlaneColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the PlaneColor parameter.
Role:Retrieves the state of the PlaneColor 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 GetPlaneNormalInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the PlaneNormal parameter.
Role:Retrieves the state of the PlaneNormal 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 GetPlaneOriginInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the PlaneOrigin parameter.
Role:Retrieves the state of the PlaneOrigin 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 GetSectionFillInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the SectionFill parameter.
Role:Retrieves the state of the SectionFill 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 GetUpdateResultInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the UpdateResult parameter.
Role:Retrieves the state of the UpdateResult 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 GetViewerAutoOpenInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ViewerAutoOpen parameter.
Role:Retrieves the state of the ViewerAutoOpen 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 GetViewerAutoReframeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ViewerAutoReframe parameter.
Role:Retrieves the state of the ViewerAutoReframe 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 GetViewerLock2DInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ViewerLock2D parameter.
Role:Retrieves the state of the ViewerLock2D 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 GetWindowDefaultHeightInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the WindowDefaultHeight parameter.
Role:Retrieves the state of the WindowDefaultHeight 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 GetWindowDefaultWidthInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the WindowDefaultWidth parameter.
Role:Retrieves the state of the WindowDefaultWidth 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 GetWindowOpenModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the WindowOpenMode parameter.
Role:Retrieves the state of the WindowOpenMode 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 SetClippingModeLock(boolean iLocked)
Locks or unlocks the ClippingMode parameter.
Role:Locks or unlocks the PlaneOrigin 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 SetDisplayCutInWireframeLock(boolean iLocked)
Locks or unlocks the DisplayCutInWireframe parameter.
Role:Locks or unlocks the DisplayCutInWireframe 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 SetGridAutoFilteringLock(boolean iLocked)
Locks or unlocks the GridAutoFiltering parameter.
Role:Locks or unlocks the GridAutoFiltering 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 SetGridAutoResizeLock(boolean iLocked)
Locks or unlocks the GridAutoResize parameter.
Role:Locks or unlocks the GridAutoResize 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 SetGridHeightStepLock(boolean iLocked)
Locks or unlocks the GridHeightStep parameter.
Role:Locks or unlocks the GridHeightStep 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 SetGridPositionModeLock(boolean iLocked)
Locks or unlocks the GridPositionMode parameter.
Role:Locks or unlocks the GridPositionMode 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 SetGridStyleLock(boolean iLocked)
Locks or unlocks the GridStyle parameter.
Role:Locks or unlocks the GridStyle 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 SetGridWidthStepLock(boolean iLocked)
Locks or unlocks the GridWidthStep parameter.
Role:Locks or unlocks the GridWidthStep 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 SetHidePlaneLock(boolean iLocked)
Locks or unlocks the HidePlane parameter.
Role:Locks or unlocks the HidePlane 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 SetHideResultLock(boolean iLocked)
Locks or unlocks the HideResult parameter.
Role:Locks or unlocks the HideResult 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 SetPlaneColor(long iR,
long iG,
long iB)
Sets the PlaneColor parameter.

Parameters:
oR
the red component of the color.
oG
the green component of the color.
oB
the blue component of the color.

Ensure consistency with the C++ interface to which the work is delegated.

o Sub SetPlaneColorLock(boolean iLocked)
Locks or unlocks the PlaneColor parameter.
Role:Locks or unlocks the PlaneColor 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 SetPlaneNormalLock(boolean iLocked)
Locks or unlocks the PlaneNormal parameter.
Role:Locks or unlocks the PlaneNormal 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 SetPlaneOriginLock(boolean iLocked)
Locks or unlocks the PlaneOrigin parameter.
Role:Locks or unlocks the PlaneOrigin 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 SetSectionFillLock(boolean iLocked)
Locks or unlocks the SectionFill parameter.
Role:Locks or unlocks the SectionFill 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 SetUpdateResultLock(boolean iLocked)
Locks or unlocks the UpdateResult parameter.
Role:Locks or unlocks the UpdateResult 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 SetViewerAutoOpenLock(boolean iLocked)
Locks or unlocks the ViewerAutoOpen parameter.
Role:Locks or unlocks the ViewerAutoOpen 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 SetViewerAutoReframeLock(boolean iLocked)
Locks or unlocks the ViewerAutoReframe parameter.
Role:Locks or unlocks the ViewerAutoReframe 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 SetViewerLock2DLock(boolean iLocked)
Locks or unlocks the ViewerLock2D parameter.
Role:Locks or unlocks the ViewerLock2D 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 SetWindowDefaultHeightLock(boolean iLocked)
Locks or unlocks the WindowDefaultHeight parameter.
Role:Locks or unlocks the WindowDefaultHeight 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 SetWindowDefaultWidthLock(boolean iLocked)
Locks or unlocks the WindowDefaultWidth parameter.
Role:Locks or unlocks the WindowDefaultWidth 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 SetWindowOpenModeLock(boolean iLocked)
Locks or unlocks the WindowOpenMode parameter.
Role:Locks or unlocks the WindowOpenMode 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.