All Frameworks  Object Hierarchy  This Framework  Indexes  

Export3DXmlSettingAtt (Object)

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


Represents a setting controller for the 3D XML export settings.
Role: This interface is implemented by a component which represents the controller of the 3D XML export settings.

Property Index

AlternateView
Animation
Returns or sets the animation activation flag.
AnnotatedView
Annotation3D
Returns or sets the 3D annotation activation flag.
DesignReview
Returns or sets the Design Review activation flag.
GeometryRepresentationFormat
Returns or sets the format of geometry representation.
Measure
PPRSaveConfig
Returns or sets the PPR config.
Presentation
Section
SurfaceAccuracy
Returns or sets the surface accuracy.
WorkInstructions
Returns or sets the Work Instructions activation flag.

Method Index

GetAlternateViewInfo
GetAnimationInfo
Retrieves environment informations for the animation setting.
GetAnnotatedViewInfo
GetAnnotation3DInfo
Retrieves environment informations for the 3D annotation setting.
GetDesignReviewInfo
Retrieves environment informations for the Design Review setting.
GetGeometryRepresentationFormatInfo
Retrieves environment informations for the geometry representation format setting.
GetMeasureInfo
GetPPRSaveConfigInfo
Retrieves environment informations for the PPRSaveConfig setting.
GetPresentationInfo
GetSectionInfo
GetSurfaceAccuracyInfo
Retrieves environment informations for the surface accuracy setting.
GetWorkInstructionsInfo
Retrieves environment informations for the Work Instructions setting.
SetAlternateViewLock
SetAnimationLock
Locks or unlocks the flag.
SetAnnotatedViewLock
SetAnnotation3DLock
Locks or unlocks the flag.
SetDesignReviewLock
Locks or unlocks the flag.
SetGeometryRepresentationFormatLock
Locks or unlocks the flag.
SetMeasureLock
SetPPRSaveConfigLock
Locks or unlocks the flag.
SetPresentationLock
SetSectionLock
SetSurfaceAccuracyLock
Locks or unlocks the flag.
SetWorkInstructionsLock
Locks or unlocks the flag.

Properties


o Property AlternateView() As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.get_DesignReview Returns or sets the alternate view activation flag.
Example:
This example activates the alternate view export.
  
  export3DXmlSettingAtt.AlternateView = True
  
o Property Animation() As boolean
Returns or sets the animation activation flag.
Example:
This example activates the animation export.
  
  export3DXmlSettingAtt.Animation = True
  
o Property AnnotatedView() As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.get_DesignReview Returns or sets the annotated view activation flag.
Example:
This example activates the annotated view export.
  
  export3DXmlSettingAtt.AnnotatedView = True
  
o Property Annotation3D() As boolean
Returns or sets the 3D annotation activation flag.
Example:
This example activates the 3D annotation export.
  
  export3DXmlSettingAtt.Annotation3D = True
  
o Property DesignReview() As boolean
Returns or sets the Design Review activation flag.
Example:
This example activates the Design Review export.
  
  export3DXmlSettingAtt.DesignReview = True
  
o Property GeometryRepresentationFormat() As Cat3DXmlGeomRepresentationType
Returns or sets the format of geometry representation.
Example:
This example sets the representation format to the exact mode.
  
  export3DXmlSettingAtt.GeometryRepresentationFormat = cat3DXmlExact
  
o Property Measure() As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.get_DesignReview Returns or sets the measure activation flag.
Example:
This example activates the measure export.
  
  export3DXmlSettingAtt.Measure = True
  
o Property PPRSaveConfig() As Cat3DXmlPPRSaveConfig
Returns or sets the PPR config.
Example:
This example sets the PPR config. Product And resources export is acivated.
  
  export3DXmlSettingAtt.PPRSaveConfig = cat3DXmlProductAndResourceList
  
o Property Presentation() As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.get_DesignReview Returns or sets the presentation activation flag.
Example:
This example activates the presentation export.
  
  export3DXmlSettingAtt.Presentation = True
  
o Property Section() As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.get_DesignReview Returns or sets the section activation flag.
Example:
This example activates the section export.
  
  export3DXmlSettingAtt.Section = True
  
o Property SurfaceAccuracy() As float
Returns or sets the surface accuracy.
Example:
This example sets the surface accuracy used by the exact mode.
  
  export3DXmlSettingAtt.SurfaceAccuracy = 0.01
  
o Property WorkInstructions() As boolean
Returns or sets the Work Instructions activation flag.
Example:
This example activates the Work Instructions export.
  
  export3DXmlSettingAtt.DesignReview = True
  

Methods


o Func GetAlternateViewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations for the alternate view setting.
Role:Retrieves the state of the alternate view setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetAnimationInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the animation setting.
Role:Retrieves the state of the animation setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetAnnotatedViewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations for the annotated view setting.
Role:Retrieves the state of the annotated view setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetAnnotation3DInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the 3D annotation setting.
Role:Retrieves the state of the 3D annotation setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetDesignReviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the Design Review setting.
Role:Retrieves the state of the Design Review setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetGeometryRepresentationFormatInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the geometry representation format setting.
Role:Retrieves the state of the parameter geometry representation format setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetMeasureInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations for the measure setting.
Role:Retrieves the state of the measure setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetPPRSaveConfigInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the PPRSaveConfig setting.
Role:Retrieves the state of the PPRSaveConfig setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetPresentationInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations for the presentation setting.
Role:Retrieves the state of the presentation setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetSectionInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.GetDesignReviewInfo Retrieves environment informations for the section setting.
Role:Retrieves the state of the section setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetSurfaceAccuracyInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the surface accuracy setting.
Role:Retrieves the state of the surface accuracy setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Func GetWorkInstructionsInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the Work Instructions setting.
Role:Retrieves the state of the Work Instructions setting in the current environment.
Parameters:
AdminLevel

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.
oLocked
Indicates if the parameter has been locked.
oModified
Indicates if the parameter has been explicitly modified or remain to the administrated value.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetAlternateViewLock(boolean iLocked)
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetAnimationLock(boolean iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetAnnotatedViewLock(boolean iLocked)
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetAnnotation3DLock(boolean iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetDesignReviewLock(boolean iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetGeometryRepresentationFormatLock(boolean iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetMeasureLock(boolean iLocked)
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetPPRSaveConfigLock(boolean iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetPresentationLock(boolean iLocked)
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetSectionLock(boolean iLocked)
Deprecated:
R19 This method will be replaced by Export3DXmlSettingAtt.SetDesignReviewLock Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetSurfaceAccuracyLock(boolean iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure
o Sub SetWorkInstructionsLock(boolean iLocked)
Locks or unlocks the flag.
Role:Locks or unlocks the parameter if it is possible in the current administrated. In user mode this method will always return E_FAIL.
Parameters:
iLocked
The locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
Returns:
Legal values:
S_OK : on Success
E_FAIL: on failure

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