=== enum_CatClippingFrameReframeOnMode_61985 ===
Drafting2DLInterfaces CatClippingFrameReframeOnModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatClippingFrameReframeOnMode (Enumeration)
enum CatClippingFrameReframeOnMode {
catOnViewContent,
catOnViewBackground
}
At creation of a view the clipping frame is reframed on.
Values:
catViewContent
Reframe on view content
catViewBackground
Reframe on view background
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatDedicatedFilterType_45337 ===
Drafting2DLInterfaces CatDedicatedFilterTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatDedicatedFilterType (Enumeration)
enum CatDedicatedFilterType {
catDisplayInBackground,
catMaskInBackground
}
Specifies if the dedicated filter mask or not the background.
Values:
catDisplayInBackground
View is diplayed in background
catMaskInBackground
View is masked in background
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatInsureViewNamesUniquenessScope_76755 ===
Drafting2DLInterfaces CatInsureViewNamesUniquenessScopeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatInsureViewNamesUniquenessScope (Enumeration)
enum CatInsureViewNamesUniquenessScope {
catInSheet,
catInLayout
}
Insures view names uniqueness.
Values:
catInSheet
Inside sheet
catInLayout
Inside Layout
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatView2DModeVisu_34884 ===
Drafting2DLInterfaces CatView2DModeVisuEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatView2DModeVisu (Enumeration)
enum CatView2DModeVisu {
catView2DModeNotActivated,
catView2DModeNoShow
}
Background 2D Mode values
Values:
catView2DModeNotActivated
2D Mode is not activated in background
catView2DModeNoShow
2D Mode is activated for background
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatViewBackgroundMode_42948 ===
Drafting2DLInterfaces CatViewBackgroundModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatViewBackgroundMode (Enumeration)
enum CatViewBackgroundMode {
catStandard,
catInvisible,
catUnpickable,
catLowIntensity,
catUnpickableLowIntensity
}
The way the background of a view is displayed at creation.
Values:
catInvisible
Background not display
catStandard
Background pickable and not in low intensity
catUnpickable
Background unpickable and not in low intensity
catLowIntensity
Background pickable and in low intensity
catUnpickableLowIntensity
Background unpickable and in low intensity
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatViewFilterCreationMode_52119 ===
Drafting2DLInterfaces CatViewFilterCreationModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatViewFilterCreationMode (Enumeration)
enum CatViewFilterCreationMode {
catDefaultFilter,
catDisplayFilterDialogBox,
catDedicatedFilter
}
At creation of a view, this enum defines how the filter of this view is configured.
Values:
catDefaultFilter
A default filter is used (the first in the list)
catDedicatedFilter
A filter is created for the view
catDisplayFilterDialogBox
Filter dialog box is displayed after the creation of the view to assign a filter
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatViewSide_27021 ===
Drafting2DLInterfaces CatViewSideEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatViewSide (Enumeration)
enum CatViewSide {
catTopSide,
catBottomSide,
catLeftSide,
catRightSide,
catTLCorner,
catTRCorner,
catBLCorner,
catBRCorner
}
CatViewSide is used in conjonction with a reference View2DL
and a ViewBox.
It then determines precisely a View2DL type in the ViewBox.
example: with the default ViewBox:
- Front + TopSide  = Top.
- Right + LeftSide = Front.
- Front + TRCorner = isometric on the corner near Front, Right, Top.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatViewType_27264 ===
Drafting2DLInterfaces CatViewTypeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatViewType (Enumeration)
enum CatViewType {
catAuxiliaryView,
catSectionView,
catSectionCutView
}
Type of a view.
Values:
catAuxiliaryView
The auxiliary view is a representation of a part regarding to an user defined
projection plane
catSectionView
The section view is a view of a part which is first sectionned regarding to
a user defined profile.
The part geometry beside the section plane is visible.
catSectionCutView
The section cut view is a view of a part which is first sectionned regarding to
a user defined profile.
Only the geometry in the section plane is visible.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatVisuBackgroundMode_43006 ===
Drafting2DLInterfaces CatVisuBackgroundModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatVisuBackgroundMode (Enumeration)
enum CatVisuBackgroundMode {
catNoBackground,
catPick,
catNoPick,
catLowIntPick,
catLowIntNoPick
}
Background  Visu Mode.
Values:
catNoBackground
Hide visu background.
catPick
Background is shown and pickable
catNoPick
Background is shown and not pickable
catLowIntPick
Background is shown in low intensity and pickable
catLowIntNoPick
Background is shown in low intensity and not pickable
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== enum_CatVisuIn3DMode_31171 ===
Drafting2DLInterfaces CatVisuIn3DModeEnumeration
All Frameworks
Class Hierarchy
This Framework
Indexes
CatVisuIn3DMode (Enumeration)
enum CatVisuIn3DMode {
catShowAll,
catHideAll
}
3D Visu Mode.
Values:
catShowAll
Show all geometry and annotation in the 3D Viewer.
catHideAll
Hide all geometry and annotation in the 3D Viewer.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Layout2DFactory_35190 ===
Drafting2DLInterfaces Layout2DFactory (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Layout2DFactory (Object)
Method Index
Create2DLayout
Create the 2DLayout associated to the 3D mechanical feature tha implement this interface.
Methods
Func Create2DLayout( iStandardName) As
Create the 2DLayout associated to the 3D mechanical feature tha implement this interface.
E.g. a Mechanical Part.
Parameters:
CATBSTR
iStandardName The standard name to apply to the new layout.
oLayout
The created 2DLayout. This feature is unique for a given 3D context feature. Consequently
requesting this interface on a 3D feature that is already associated to a 2DLayout
feature will fail. You must first request for any existing 2DLayout via
method using CATLayoutRoot key parameter to check for 2DLayout pre-existing feature as follow :
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot")
if MyRoot Is Nothing then
Dim MyRootFact As Layout2DFactory
Set MyRootFact = CATIA.ActiveDocument.Part.GetItem("CATLayoutRootFactory")
Set MyRoot = MyRootFact.Create2DLayout("ISO_3D")
end if
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Layout2DRoot_31024 ===
Drafting2DLInterfaces Layout2DRoot (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Layout2DRoot (Object)
Interface to manage the 2D Layout root.
Property Index
ActiveSheet
Retrieves or sets the active sheet of the layout.
Parameters
Returns the collection of parameters of the layout.
Relations
Returns the collection of relations of the part document.
RenderingMode
Set/Get the rendering mode of Layout2D.
Sheets
Returns the collection of Layout2D sheets of the part document.
Standard
Returns or sets the DrawingStandard of the part document.
VisuIn3D
Set/Get the 3D visualization mode of the layout in the 3D Viewer
ie in the 3D windows and in the background of each view in every 2D context.
Method Index
reorder_Sheets
Changes the positions of the sheets in this drawing according to the given
ordered list.
Properties
Property ActiveSheet() As
Retrieves or sets the active sheet of the layout.
Example:
This example retrieves the active sheet
currently managed by the layout root of a part of the active document,
supposed to be a part document.
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.ActiveDocument.Part.GetItem("CATLayout2DRoot)"
Dim MySheet = MyRoot.GetActiveSheet
Property Parameters() As   (Read Only)
Returns the collection of parameters of the layout.
Example:
This example retrieves in layoutParameters the collection of
parameters currently managed by the layout root of a part of the active document,
supposed to be a part document.
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.ActiveDocument.Part.GetItem("CATLayout2DRoot)"
Dim layoutParameters As Parameters
Set layoutParameters = MyRoot.Parameters
Property Relations() As   (Read Only)
Returns the collection of relations of the part document.
Example:
This example retrieves in layoutRelations the collection of
relations currently managed by the layout root of a part of the active document,
supposed to be a part document.
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.ActiveDocument.Part.GetItem("CATLayout2DRoot)"
Dim layoutRelations As Relations
Set layoutRelations = MyRoot.Relations
Property RenderingMode() As
Set/Get the rendering mode of Layout2D. get_RenderingMode method can fail if rendering value stored on Layout is not a value defined in CatRenderingMode enum.
Example:
This example sets the rendering mode to catRenderShadingWithEdges for the layout root of a part of the active document.
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.ActiveDocument.Part.GetItem("CATLayout2DRoot)"
MyRoot. RenderingMode  = catRenderShadingWithEdges
Property Sheets() As   (Read Only)
Returns the collection of Layout2D sheets of the part document.
Example:
This example retrieves in SheetCollection the collection of
sheets currently managed by the layout root of a part of the active document,
supposed to be a part document.
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.ActiveDocument.Part.GetItem("CATLayout2DRoot)"
Dim SheetCollection As Layout2DSheets
Set SheetCollection = MyRoot.Sheets.
Property Standard() As
Returns or sets the DrawingStandard of the part document.
Example:
This example sets the drawing standard
currently managed by the layout root of a part of the active document,
supposed to be a part document, to ISO.
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.ActiveDocument.Part.GetItem("CATLayout2DRoot)"
MyRoot.Standard = catISO
Property VisuIn3D() As
Set/Get the 3D visualization mode of the layout in the 3D Viewer
ie in the 3D windows and in the background of each view in every 2D context.
See also:
Methods
Sub reorder_Sheets( iOrderedSheets)
Changes the positions of the sheets in this drawing according to the given
ordered list.
iOrderedSheets is the result of a permutation applied to
the list of all the sheets of this drawing, with the following
constraint: For every non-detail sheet, there is not any detail sheet
appearing before in iOrderedSheets.
Example:
This example inverts the sheet order of a drawing made of exactly two
regular sheets.
Set drwsheetsorder =  CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot")
Set drwsheets = drwsheetsorder.Sheets
Set sheet1 = drwsheets.item(1)
Set sheet2 = drwsheets.item(2)
newsheetorder = Array(sheet2, sheet1)
drwsheetsorder.reorder_Sheets(newsheetorder)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Layout2DSettingAtt_39927 ===
Drafting2DLInterfaces Layout2DSettingAtt (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Layout2DSettingAtt (Object)
The interface to access a CATIA2DLSettingAtt.
Property Index
Activate2DMode
Returns the Activate2DMode parameter.
BackClippingPlane
Returns the BackClippingPlane parameter.
Boundaries2DLDisplay
Returns the Boundaries2DLDisplay parameter.
Boundaries2DLLineType
Returns the Boundaries2DLLineType parameter.
Boundaries2DLThickness
Returns the Boundaries2DLThickness parameter.
CalloutCreationDialogBox
Returns the CalloutCreationDialogBox parameter.
CalloutCreationInActiveView
Returns the CalloutCreationInActiveView 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.
FitAllInSheetFormat
Returns the FitAllInSheetFormat parameter.
HideIn3D
Returns the HideIn3D parameter.
InsureFilterNamesUniqueness
Returns the InsureFilterNamesUniqueness attribute value to apply to a Layout at its creation parameter.
InsureSheetNamesUniqueness
Returns the InsureSheetNamesUniqueness attribute value to apply to a Layout at its creation parameter.
InsureViewNamesUniqueness
Returns the InsureViewNamesUniqueness attribute value to apply to a Layout at its creation parameter.
InsureViewNamesUniquenessScope
Returns the InsureViewNamesUniquenessScope parameter.
LayoutDefaultRenderStyle
Returns the default render style attribute value to apply to a Layout at its creation parameter.
PropagateHighlight
Returns the PropagateHighlight parameter.
TileLayoutWindow
Returns the tile of Layout window 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.
GetBoundaries2DLColor
Returns the Boundaries2DLColor parameter.
GetBoundaries2DLColorInfo
Retrieves environment informations for the Boundaries2DLColor parameter.
GetBoundaries2DLDisplayInfo
Retrieves environment informations for the Boundaries2DLDisplay parameter.
GetBoundaries2DLLineTypeInfo
Retrieves environment informations for the Boundaries2DLLineType parameter.
GetBoundaries2DLThicknessInfo
Retrieves environment informations for the Boundaries2DLThickness parameter.
GetCalloutCreationDialogBoxInfo
Retrieves environment informations for the CalloutCreationDialogBox parameter.
GetCalloutCreationInActiveViewInfo
Retrieves environment informations for the CalloutCreationInActiveView 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.
GetFitAllInSheetFormatInfo
Retrieves environment informations for the FitAllInSheetFormat parameter.
GetHideIn3DInfo
Retrieves environment informations for the HideIn3D parameter.
GetInsureFilterNamesUniquenessInfo
Retrieves environment informations for the InsureFilterNamesUniqueness parameter.
GetInsureSheetNamesUniquenessInfo
Retrieves environment informations for the InsureSheetNamesUniqueness parameter.
GetInsureViewNamesUniquenessInfo
Retrieves environment informations for the InsureViewNamesUniqueness parameter.
GetInsureViewNamesUniquenessScopeInfo
Retrieves environment informations for the InsureViewNamesUniquenessScope parameter.
GetLayoutDefaultRenderStyleInfo
Retrieves environment informations for the default render style parameter.
GetPropagateHighlightInfo
Retrieves environment informations for the PropagateHighlight parameter.
GetProtectedElementsColor
Returns the ProtectedElementsColor parameter.
GetProtectedElementsColorInfo
Retrieves environment informations for the ProtectedElementsColor parameter.
GetTileLayoutWindowInfo
Retrieves environment informations for the tile of Layout window 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.
SetBoundaries2DLColor
Sets the Boundaries2DLColor parameter.
SetBoundaries2DLColorLock
Locks or unlocks the Boundaries2DLColor parameter.
SetBoundaries2DLDisplayLock
Locks or unlocks the Boundaries2DLDisplay parameter.
SetBoundaries2DLLineTypeLock
Locks or unlocks the Boundaries2DLLineType parameter.
SetBoundaries2DLThicknessLock
Locks or unlocks the Boundaries2DLThickness parameter.
SetCalloutCreationDialogBoxLock
Locks or unlocks the CalloutCreationDialogBox parameter.
SetCalloutCreationInActiveViewLock
Locks or unlocks the CalloutCreationInActiveView 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.
SetFitAllInSheetFormatLock
Locks or unlocks the FitAllInSheetFormat parameter.
SetHideIn3DLock
Locks or unlocks the HideIn3D parameter.
SetInsureFilterNamesUniquenessLock
Locks or unlocks the InsureFilterNamesUniqueness parameter.
SetInsureSheetNamesUniquenessLock
Locks or unlocks the InsureSheetNamesUniqueness parameter.
SetInsureViewNamesUniquenessLock
Locks or unlocks InsureViewNamesUniqueness parameter.
SetInsureViewNamesUniquenessScopeLock
Locks or unlocks the InsureViewNamesUniquenessScope parameter.
SetLayoutDefaultRenderStyleLock
Locks or unlocks the default render style parameter.
SetPropagateHighlightLock
Locks or unlocks the PropagateHighlight parameter.
SetProtectedElementsColor
Sets the ProtectedElementsColor parameter.
SetProtectedElementsColorLock
Locks or unlocks the ProtectedElementsColor parameter.
SetTileLayoutWindowLock
Locks or unlocks the tile of Layout window parameter.
SetViewBackgroundModeLock
Locks or unlocks the ViewBackgroundMode parameter.
SetViewFilterCreationModeLock
Locks or unlocks the ViewFilterCreationMode parameter.
Properties
Property Activate2DMode() As
Returns the Activate2DMode parameter.
Property BackClippingPlane() As
Returns the BackClippingPlane parameter.
Property Boundaries2DLDisplay() As
Returns the Boundaries2DLDisplay parameter.
Property Boundaries2DLLineType() As
Returns the Boundaries2DLLineType parameter.
Property Boundaries2DLThickness() As
Returns the Boundaries2DLThickness parameter.
Property CalloutCreationDialogBox() As
Returns the CalloutCreationDialogBox parameter.
Property CalloutCreationInActiveView() As
Returns the CalloutCreationInActiveView parameter.
Property ClippingFrame() As
Returns the ClippingFrame parameter.
Property ClippingFrameReframeOnMode() As
Returns the ClippingFrameReframeOnMode parameter.
Deprecated:
V5R18
Property ClippingViewOutlineLinetype() As
Returns the ClippingViewOutlineLinetype parameter.
Property ClippingViewOutlineThickness() As
Returns the ClippingViewOutlineThickness parameter.
Property CreateAssociativeUseEdges() As
Returns the CreateAssociativeUseEdges parameter.
Property DedicatedFilterType() As
Returns the DedicatedFilterType parameter.
Property DisplayBackAndCuttingPlane() As
Returns the DisplayBackAndCuttingPlane parameter.
Property DisplayClippingOutline() As
Returns the DisplayClippingOutline parameter.
Property EditDedicatedFilterDialogBox() As
Returns the EditDedicatedFilterDialogBox parameter.
Property FitAllInSheetFormat() As
Returns the FitAllInSheetFormat parameter.
Property HideIn3D() As
Returns the HideIn3D parameter.
Property InsureFilterNamesUniqueness() As
Returns the InsureFilterNamesUniqueness attribute value to apply to a Layout at its creation parameter.
Property InsureSheetNamesUniqueness() As
Returns the InsureSheetNamesUniqueness attribute value to apply to a Layout at its creation parameter.
Property InsureViewNamesUniqueness() As
Returns the InsureViewNamesUniqueness attribute value to apply to a Layout at its creation parameter.
Property InsureViewNamesUniquenessScope() As
Returns the InsureViewNamesUniquenessScope parameter.
Property LayoutDefaultRenderStyle() As
Returns the default render style attribute value to apply to a Layout at its creation parameter.
Property PropagateHighlight() As
Returns the PropagateHighlight parameter.
Property TileLayoutWindow() As
Returns the tile of Layout window parameter.
Property ViewBackgroundMode() As
Returns the ViewBackgroundMode parameter.
Property ViewFilterCreationMode() As
Returns the ViewFilterCreationMode parameter.
Methods
Sub GetActivate2DModeInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the Activate2DMode parameter.
Role:Retrieves the state of the Activate2DMode parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetBackClippingPlaneInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the BackClippingPlane parameter.
Role:Retrieves the state of the BackClippingPlane parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetBoundaries2DLColor( oValueR, oValueG, oValueB)
Returns the Boundaries2DLColor parameter.
Sub GetBoundaries2DLColorInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the Boundaries2DLColor parameter.
Role:Retrieves the state of the Boundaries2DLColor parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetBoundaries2DLDisplayInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the Boundaries2DLDisplay parameter.
Role:Retrieves the state of the Boundaries2DLDisplay parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetBoundaries2DLLineTypeInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the Boundaries2DLLineType parameter.
Role:Retrieves the state of the Boundaries2DLLineType parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetBoundaries2DLThicknessInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the Boundaries2DLThickness parameter.
Role:Retrieves the state of the Boundaries2DLThickness parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetCalloutCreationDialogBoxInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the CalloutCreationDialogBox parameter.
Role:Retrieves the state of the CalloutCreationDialogBox parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetCalloutCreationInActiveViewInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the CalloutCreationInActiveView parameter.
Role:Retrieves the state of the CalloutCreationInActiveView 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.
Sub GetClippingFrameInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the ClippingFrame parameter.
Role:Retrieves the state of the ClippingFrame parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetClippingFrameReframeOnModeInfo( ioAdminLevel, ioLocked) As
Deprecated:
V5R18
Retrieves environment informations for the ClippingFrameReframeOnMode parameter.
Role:Retrieves the state of the ClippingFrameReframeOnMode parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetClippingViewOutlineColor( oValueR, oValueG, oValueB)
Returns the ClippingViewOutlineColor parameter.
Sub GetClippingViewOutlineColorInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the ClippingViewOutlineColor parameter.
Role:Retrieves the state of the ClippingViewOutlineColor parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetClippingViewOutlineLinetypeInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the ClippingViewOutlineLinetype parameter.
Role:Retrieves the state of the ClippingViewOutlineLinetype parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetClippingViewOutlineThicknessInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the ClippingViewOutlineThickness parameter.
Role:Retrieves the state of the ClippingViewOutlineThickness parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetCreateAssociativeUseEdgesInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the CreateAssociativeUseEdges parameter.
Role:Retrieves the state of the CreateAssociativeUseEdges parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetDedicatedFilterTypeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the DedicatedFilterType parameter.
Role:Retrieves the state of the DedicatedFilterType parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetDisplayBackAndCuttingPlaneInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the DisplayBackAndCuttingPlane parameter.
Role:Retrieves the state of the DisplayBackAndCuttingPlane parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetDisplayClippingOutlineInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the DisplayClippingOutline parameter.
Role:Retrieves the state of the DisplayClippingOutline parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetEditDedicatedFilterDialogBoxInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the EditDedicatedFilterDialogBox parameter.
Role:Retrieves the state of the EditDedicatedFilterDialogBox parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetFitAllInSheetFormatInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the FitAllInSheetFormat parameter.
Role:Retrieves the state of the FitAllInSheetFormat 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.
Sub GetHideIn3DInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the HideIn3D parameter.
Role:Retrieves the state of the HideIn3D parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetInsureFilterNamesUniquenessInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the InsureFilterNamesUniqueness parameter.
Role:Retrieves the state of the InsureFilterNamesUniqueness 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.
Sub GetInsureSheetNamesUniquenessInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the InsureSheetNamesUniqueness parameter.
Role:Retrieves the state of the InsureSheetNamesUniqueness 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.
Sub GetInsureViewNamesUniquenessInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the InsureViewNamesUniqueness parameter.
Role:Retrieves the state of the InsureViewNamesUniqueness 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.
Func GetInsureViewNamesUniquenessScopeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the InsureViewNamesUniquenessScope parameter.
Role:Retrieves the state of the InsureViewNamesUniquenessScope 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.
Sub GetLayoutDefaultRenderStyleInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the default render style parameter.
Role:Retrieves the state of the default render style parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetPropagateHighlightInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the PropagateHighlight parameter.
Role:Retrieves the state of the PropagateHighlight parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetProtectedElementsColor( oValueR, oValueG, oValueB)
Returns the ProtectedElementsColor parameter.
Sub GetProtectedElementsColorInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the ProtectedElementsColor parameter.
Role:Retrieves the state of the ProtectedElementsColor parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub GetTileLayoutWindowInfo( ioAdminLevel, ioLocked, oModified)
Retrieves environment informations for the tile of Layout window parameter.
Role:Retrieves the state of the tile of Layout window 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.
Func GetViewBackgroundModeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the ViewBackgroundMode parameter.
Role:Retrieves the state of the ViewBackgroundMode parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Func GetViewFilterCreationModeInfo( ioAdminLevel, ioLocked) As
Retrieves environment informations for the ViewFilterCreationMode parameter.
Role:Retrieves the state of the ViewFilterCreationMode parameter
in the current environment.
Parameters:
ioAdminLevel
If the parameter is locked, AdminLevel gives the administration
level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration
level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain
to the administrated value.
Sub SetActivate2DModeLock( iLocked)
Locks or unlocks the Activate2DMode parameter.
Role:Locks or unlocks the Activate2DMode parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetBackClippingPlaneLock( iLocked)
Locks or unlocks the BackClippingPlane parameter.
Role:Locks or unlocks the BackClippingPlane parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetBoundaries2DLColor( iValueR, iValueG, iValueB)
Sets the Boundaries2DLColor parameter.
Sub SetBoundaries2DLColorLock( iLocked)
Locks or unlocks the Boundaries2DLColor parameter.
Role:Locks or unlocks the Boundaries2DLColor parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetBoundaries2DLDisplayLock( iLocked)
Locks or unlocks the Boundaries2DLDisplay parameter.
Role:Locks or unlocks the Boundaries2DLDisplay parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetBoundaries2DLLineTypeLock( iLocked)
Locks or unlocks the Boundaries2DLLineType parameter.
Role:Locks or unlocks the Boundaries2DLLineType parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetBoundaries2DLThicknessLock( iLocked)
Locks or unlocks the Boundaries2DLThickness parameter.
Role:Locks or unlocks the Boundaries2DLThickness parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetCalloutCreationDialogBoxLock( iLocked)
Locks or unlocks the CalloutCreationDialogBox parameter.
Role:Locks or unlocks the CalloutCreationDialogBox parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetCalloutCreationInActiveViewLock( iLocked)
Locks or unlocks the CalloutCreationInActiveView parameter.
Role:Locks or unlocks the CalloutCreationInActiveView 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.
Sub SetClippingFrameLock( iLocked)
Locks or unlocks the ClippingFrame parameter.
Role:Locks or unlocks the ClippingFrame parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetClippingFrameReframeOnModeLock( iLocked)
Deprecated:
V5R18
Locks or unlocks the ClippingFrameReframeOnMode parameter.
Role:Locks or unlocks the ClippingFrameReframeOnMode parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetClippingViewOutlineColor( iValueR, iValueG, iValueB)
Sets the ClippingViewOutlineColor parameter.
Sub SetClippingViewOutlineColorLock( iLocked)
Locks or unlocks the ClippingViewOutlineColor parameter.
Role:Locks or unlocks the ClippingViewOutlineColor parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetClippingViewOutlineLinetypeLock( iLocked)
Locks or unlocks the ClippingViewOutlineLinetype parameter.
Role:Locks or unlocks the ClippingViewOutlineLinetype parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetClippingViewOutlineThicknessLock( iLocked)
Locks or unlocks the ClippingViewOutlineThickness parameter.
Role:Locks or unlocks the ClippingViewOutlineThickness parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetCreateAssociativeUseEdgesLock( iLocked)
Locks or unlocks the CreateAssociativeUseEdges parameter.
Role:Locks or unlocks the CreateAssociativeUseEdges parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetDedicatedFilterTypeLock( iLocked)
Locks or unlocks the DedicatedFilterType parameter.
Role:Locks or unlocks the DedicatedFilterType parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetDisplayBackAndCuttingPlaneLock( iLocked)
Locks or unlocks the DisplayBackAndCuttingPlane parameter.
Role:Locks or unlocks the DisplayBackAndCuttingPlane parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetDisplayClippingOutlineLock( iLocked)
Locks or unlocks the DisplayClippingOutline parameter.
Role:Locks or unlocks the DisplayClippingOutline parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetEditDedicatedFilterDialogBoxLock( iLocked)
Locks or unlocks the EditDedicatedFilterDialogBox parameter.
Role:Locks or unlocks the EditDedicatedFilterDialogBox parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetFitAllInSheetFormatLock( iLocked)
Locks or unlocks the FitAllInSheetFormat parameter.
Role:Locks or unlocks the FitAllInSheetFormat 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.
Sub SetHideIn3DLock( iLocked)
Locks or unlocks the HideIn3D parameter.
Role:Locks or unlocks the HideIn3D parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetInsureFilterNamesUniquenessLock( iLocked)
Locks or unlocks the InsureFilterNamesUniqueness parameter.
Role:Locks or unlocks the InsureFilterNamesUniqueness 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.
Sub SetInsureSheetNamesUniquenessLock( iLocked)
Locks or unlocks the InsureSheetNamesUniqueness parameter.
Role:Locks or unlocks the InsureSheetNamesUniqueness 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.
Sub SetInsureViewNamesUniquenessLock( iLocked)
Locks or unlocks InsureViewNamesUniqueness parameter.
Role:Locks or unlocks the InsureViewNamesUniqueness 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.
Sub SetInsureViewNamesUniquenessScopeLock( iLocked)
Locks or unlocks the InsureViewNamesUniquenessScope parameter.
Role:Locks or unlocks the InsureViewNamesUniquenessScope 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.
Sub SetLayoutDefaultRenderStyleLock( iLocked)
Locks or unlocks the default render style parameter.
Role:Locks or unlocks the default render style parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetPropagateHighlightLock( iLocked)
Locks or unlocks the PropagateHighlight parameter.
Role:Locks or unlocks the PropagateHighlight parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetProtectedElementsColor( iValueR, iValueG, iValueB)
Sets the ProtectedElementsColor parameter.
Sub SetProtectedElementsColorLock( iLocked)
Locks or unlocks the ProtectedElementsColor parameter.
Role:Locks or unlocks the ProtectedElementsColor parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetTileLayoutWindowLock( iLocked)
Locks or unlocks the tile of Layout window parameter.
Role:Locks or unlocks the tile of Layout window 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.
Sub SetViewBackgroundModeLock( iLocked)
Locks or unlocks the ViewBackgroundMode parameter.
Role:Locks or unlocks the ViewBackgroundMode parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Sub SetViewFilterCreationModeLock( iLocked)
Locks or unlocks the ViewFilterCreationMode parameter.
Role:Locks or unlocks the ViewFilterCreationMode parameter if it is possible
in the current administrative context. In user mode this method will always
return E_FAIL.
Parameters:
iLocked
the locking operation to be performed
Legal values:
TRUE :   to lock the parameter.
FALSE:   to unlock the parameter.
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Layout2DSheet_32096 ===
Drafting2DLInterfaces Layout2DSheet (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Layout2DSheet (Object)
The interface to access a Layout2D Sheet.
Property Index
Orientation
Returns or sets the paper orientation.
PageSetup
Returns the page setup.
PaperHeight
Gets or Sets the paper width of the layout sheet.
PaperName
Returns or sets the paper format name.
PaperSize
Returns or sets the paper size.
PaperWidth
Gets or Sets the paper width of the layout sheet.
PrintArea
Returns the print area definition object.
ProjectionMethod
Returns or sets the sheet projection mode .
SheetScale
Returns or sets the scale of the Layout2D sheet.
Views
Returns the Layout2D view collection of the Layout2D sheet.
VisuIn3D
Set/Get the 3D visualization mode of the sheet in the 3D Viewer
ie in the 3D windows and in the background of each view in every 2D context.
Method Index
Activate
Activates the Layout2D sheet.
IsDetail
Checks whether the sheet is a detail sheet.
PrintOut
Prints the Layout2D sheet according to its page setup on the default printer.
PrintOut2
Prints the Layout2D sheet according to its page setup on the default printer.
PrintToFile
Prints the Layout2D sheet according its page setup
in a file instead of being sent to a printer.
PrintToFile2
Prints the Layout2D sheet according its page setup
in a file instead of being sent to a printer.
reorder_Views
Changes the positions of the views in this sheet according to the given
ordered list.
Properties
Property Orientation() As
Returns or sets the paper orientation.
Example:
This example sets the paper orientation for the MySheet
Layout2D sheet to catPaperLandscape.
MySheet.Orientation = catPaperLandscape
Property PageSetup() As   (Read Only)
Returns the page setup.
Example:
This example returns the page setup for the MySheet
Layout2D sheet.
Dim MySheetPageSetup As DrawingPageSetup
Set MySheetPageSetup = MySheet.PageSetup
Property PaperHeight() As
Gets or Sets the paper width of the layout sheet.
Parameters:
oPaperHeight
Example:
This example get the height of the Layout2DSheet1.
Layout2DSheet1.GetPaperHeight oPaperHeight
Property PaperName() As
Returns or sets the paper format name.
Example:
This example sets the paper format name for the MySheet
Layout2D sheet to DSFormat1.
MySheet.PaperName = DSFormat1
Property PaperSize() As
Returns or sets the paper size.
Example:
This example sets the page size for the MySheet
Layout2D sheet to catPaperA4.
MySheet.PaperSize = catPaperA4
Property PaperWidth() As
Gets or Sets the paper width of the layout sheet.
Parameters:
oPaperWidth
Example:
This example get the width of the Sheet1.
Sheet1.GetPaperWidth oPaperWidth
Property PrintArea() As   (Read Only)
Returns the print area definition object.
Example:
This example returns the print area for the MySheet
Layout2D sheet 2DL.
Dim MyPrintArea As PrintArea
Set MyPrintArea = MySheet.PrintArea
Property ProjectionMethod() As
Returns or sets the sheet projection mode .
Example:
This example sets the projection mode of the MySheet Layout2D sheet to catFirstAngle.
MySheet.ProjectionMethod = catFirstAngle
Property SheetScale() As
Returns or sets the scale of the Layout2D sheet.
Example:
This example sets the scale of the MySheet Layout2D sheet to 0.5.
MySheet.SheetScale = 0.5
Property Views() As   (Read Only)
Returns the Layout2D view collection of the Layout2D sheet.
Example:
This example retrieves in ViewCollection the collection of
views 2DL of the MySheet Layout2D sheet.
Dim ViewCollection As Layout2DViews
Set ViewCollection = MySheet.Views.
Property VisuIn3D() As
Set/Get the 3D visualization mode of the sheet in the 3D Viewer
ie in the 3D windows and in the background of each view in every 2D context.
See also:
Methods
Sub Activate()
Activates the Layout2D sheet.
Activating a Layout2D sheet means that this Layout2D sheet is the one on which
the end user is now working.
The window in the application's window collection which contains this
Layout2D sheet becomes the active one.
Example:
This example activates the MySheet layout2dsheet.
MySheet.Activate
Func IsDetail() As
Checks whether the sheet is a detail sheet.
TRUE if the sheet is a detail sheet.
Example:
This example checks whether MySheet is a detail sheet.
IsDetail = MySheet.IsDetail
Sub PrintOut( iRenderingMode)
Prints the Layout2D sheet according to its page setup on the default printer.
Parameters:
iRenderingMode
The rendering mode to use for the backgrounds of the views in the sheet.
Example:
This example prints the Layout2DSheet1
on the default printer.
Layout2DSheet1.PrintOut catRenderShadingWithEdges
Sub PrintOut2()
Prints the Layout2D sheet according to its page setup on the default printer.
If a rendering mode has been stored on the 2D Layout, it is used during print
process for the backgrounds. Otherwise, "Shading with edges" rendering mode is used.
Example:
This example prints the Layout2DSheet1
on the default printer.
Layout2DSheet1.PrintOut2
Sub PrintToFile( fileName, iRenderingMode)
Prints the Layout2D sheet according its page setup
in a file instead of being sent to a printer.
Parameters:
fileName
The full pathname of the file receiving the data.
iRenderingMode
The rendering mode to use for the backgrounds of the views in the sheet.
Example:
This example prints the Layout2DSheet1
in a file.
Layout2DSheet1.PrintToFile "e:\temp\sheet1.prn",catRenderShadingWithEdges
Sub PrintToFile2( fileName)
Prints the Layout2D sheet according its page setup
in a file instead of being sent to a printer.
If a rendering mode has been stored on the 2D Layout, it is used during print
process for the backgrounds. Otherwise, "Shading with edges" rendering mode is used.
Parameters:
fileName
The full pathname of the file receiving the data.
Example:
This example prints the Layout2DSheet1
in a file.
Layout2DSheet1.PrintToFile2 "e:\temp\sheet1.prn"
Sub reorder_Views( iOrderedViews)
Changes the positions of the views in this sheet according to the given
ordered list.
iOrderedViews is the result of a permutation applied to
the list of all the views of this sheet with the following
constraint: the two first elements of the list must be
respectively the sheet's mainview and background view.
Example:
This example modifies the  views order of a sheet made of
a mainview, a backgroundview and two user-created views.
(user-created views are inverted).
Set drw =  CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot")
Set drwviewsorder = drwsheetsorder.Sheets.ActiveSheet
Set drwviews = drwviewsorder.Views
Set mainview = drwviews.item(1)
Set backview = drwviews.item(2)
Set view1 = drwviews.item(3)
Set view2 = drwviews.item(4)
newvieworder = Array(mainview, backview, view2, view1)
drwviewsorder.reorder_Views(newvieworder)
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Layout2DSheets_33591 ===
Drafting2DLInterfaces Layout2DSheets (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Layout2DSheets (Object)
A collection of all the Layout sheets 2DL currently managed by the LayoutRoot.
Property Index
ActiveSheet
Returns the active Layout sheet of the Layout document.
Method Index
Add
Creates a Layout sheet and adds it to the Layout2DSheets collection.
AddDetail
Creates a detail Layout sheet 2DL and adds it to the LayoutSheets2DL collection.
Item
Returns a Layout sheet using its index or its name from the Layout2DSheets collection.
Remove
Removes a Layout2Dsheet from the Layout2DSheets collection.
Properties
Property ActiveSheet() As   (Read Only)
Returns the active Layout sheet of the Layout document.
Example:
The following example shows how to get the active sheet
and retrieved in MySheet in the Layout sheet collection of the layout root of Part
supposed to be in the active document
Dim MyLayoutRoot As Layout2DRoot
Set MyLayoutRoot = CATIA.Documents.Part.GetItem("CATLayoutRoot")
Dim MySheet As Layout2DSheet
Set MySheet =  MyLayoutRoot.Sheets.ActiveSheet
Methods
Func Add( iLayoutSheetName) As
Creates a Layout sheet and adds it to the Layout2DSheets collection.
This Layout sheet becomes the active one.
Parameters:
iLayoutSheetName
The name to assign to the created Layout2DSheet object
Returns:
The created Layout sheet
Example:
The following example creates a Layout sheet named FirstSheet
and retrieved in MySheet in the Layout sheet collection of the layout root of Part
supposed to be in the active document
Dim MyLayoutRoot As Layout2DRoot
Set MyLayoutRoot = CATIA.Documents.Part.GetItem("CATLayoutRoot")
Dim MySheet As Layout2DSheet
Set MySheet = MyLayoutRoot.Sheets.Add("FirstSheet").
Func AddDetail( iLayoutSheetName) As
Creates a detail Layout sheet 2DL and adds it to the LayoutSheets2DL collection.
This detail Layout sheet becomes the active one.
Parameters:
iLayoutSheetName
The name to assign to the created detail LayoutSheet object
Returns:
The created layout sheet
Example:
The following example creates a detail Layout sheet named FirstSheet
and retrieved in MySheet in the Layout sheet collection of the layout root of Part
supposed to be in the active document
Dim MyLayoutRoot As Layout2DRoot
Set MyLayoutRoot = CATIA.Documents.Part.GetItem("CATLayoutRoot")
Dim MySheet As Layout2DSheet
Set MySheet = MyLayoutRoot.Sheets.Add("FirstSheet")
Func Item( iIndex) As
Returns a Layout sheet using its index or its name from the Layout2DSheets collection.
Parameters:
iIndex
The index or the name of the Layout sheet to retrieve from
the collection of Layout sheets.
As a numerics, this index is the rank of the Layout sheet
in the collection.
The index of the first Layout sheet in the collection is 1, and
the index of the last Layout sheet is Count.
As a string, it is the name you assigned to the Layout sheet using
the
property or when creating it using   the
method.
Returns:
The retrieved Layout sheet
Example:
This example retrieves in ThisLayoutSheet the third Layout sheet,
and in ThatLayoutSheet the Layout sheet named
MySheet in the Layout sheet collection of the layout root of Part
supposed to be in the active document.
Dim ThisLayoutRoot As Layout2DRoot
Set ThisLayoutRoot = CATIA.ActiveDocument.Part.GetItem("CATlayoutRoot")
Dim ThisLayoutSheet As Layout2DSheet
Set ThisLayoutSheet = ThisLayoutRoot.Sheets.Item(3)
Dim ThatLayoutSheet As Layout2DSheet
Set ThatLayoutSheet = ThisLayoutRoot.Sheets.Item("MySheet")
Sub Remove( iIndex)
Removes a Layout2Dsheet from the Layout2DSheets collection.
Parameters:
iIndex
The index or the name of the Layout sheet to remove from
the collection of Layout sheets.
As a numerics, this index is the rank of the Layout sheet
in the collection.
The index of the first Layout sheet in the collection is 1, and
the index of the last Layout sheet is Count.
As a string, it is the name you assigned to the Layout sheet using
the
property or when creating it using   the
method.
Example:
The following example removes the second Layout sheet and the Layout sheet named
SheetToBeRemoved in the Layout sheet collection of the layout root of Part
supposed to be in the active document.
Dim ThisLayoutRoot As Layout2DRoot
Set ThisLayoutRoot = CATIA.ActiveDocument.Part.GetItem("CATlayoutRoot")
ThisLayoutRoot.Layout2DSheets.Remove("SheetToBeRemoved")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Layout2DView_30935 ===
Drafting2DLInterfaces Layout2DView (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Layout2DView (Object)
The interface to access a Layout2D View.
Property Index
Angle
Returns or sets the angle of the Layout2D view.
Arrows
Returns the drawing arrow collection of the Layout2D view.
Components
Returns the Layout2D component instances collection (i.
CoordDims
Returns the drawing CoordDim collection of the Layout2D view.
Dimensions
Returns the drawing dimension collection of the Layout2D view.
Factory2D
Returns the 2D factory of the Layout2D view.
FrameVisualization
Returns or sets the Layout2D view frame visualization state.
GDTs
Returns the drawing GDT collection of the Layout2D view.
GeometricElements
Returns the collection of geometric elements included in the Layout2D view sketch.
LockStatus
Returns or sets the lock status of a Layout2D view.
Pictures
Returns the drawing picture collection of the Layout2D view.
ReferenceView
Returns or sets the reference view.
Tables
Returns the drawing table collection of the drawing view.
Texts
Returns the drawing text collection of the Layout2D view.
Threads
Returns the drawing thread collection of the Layout2D view.
ViewScale
Returns or sets the scale of the Layout2D view.
Visu2DMode
Sets/Gets the 2D mode for background visualization of the view.
VisuBackground
Sets/Gets the 2D-3D background visu mode of the view
ie in the 3D windows and in the background of each view in every 2D context.
VisuIn3D
Sets/Gets the 3D visualization mode of the view in the 3D Viewer
ie in the 3D windows and in the background of each view in every 2D context.
Weldings
Returns the drawing welding collection of the Layout2D view.
x
Returns or sets the x coordinate of the Layout2D view coordinate system origin.
y
Returns or sets the y coordinate of the Layout2D view coordinate system origin.
Method Index
Activate
Activates the Layout2D view.
AlignedWithReferenceView
Activates the alignment with the reference view.
GetViewName
Returns the prefix, the ident and the suffix of the name of
the Layout2D view.
SaveEdition
Saves the Sketch Edition.
SetViewName
Sets the prefix, the ident and the suffix of the name of
the Layout2D view.
Size
Returns the bounding box of the Layout2D view.
UnAlignedWithReferenceView
Deactivates the alignment with the reference view.
Properties
Property Angle() As
Returns or sets the angle of the Layout2D view.
The angle is measured between the axis system of the Layout2D view and the
axis system of the Layout2D sheet where the Layout2D view lies.
The angle is measured in radians and is counted counterclockwise.
Example:
This example sets the angle of the MyView Layout2D view to 90
degrees clockwise.
You first need to compute the angle in radians and set the
minus sign to indicate the rotation is clockwise.
PI = 3.1415926535
Angle90Clockwise = -PI/2
MyView.Angle = Angle90Clockwise
Property Arrows() As   (Read Only)
Returns the drawing arrow collection of the Layout2D view.
Example:
This example retrieves in ArrowCollection the collection of
arrows of the MyView Layout2D view.
Dim ArrowCollection As DrawingArrows
Set ArrowCollection = MyView.Arrows
Property Components() As   (Read Only)
Returns the Layout2D component instances collection (i.e. ditto collection) of the Layout2D view.
Example:
This example retrieves in ComponentCollection the collection of
component instances of the MyView Layout2D view.
Dim ComponentCollection As DrawingComponents
Set ComponentCollection = MyView.Components
Property CoordDims() As   (Read Only)
Returns the drawing CoordDim collection of the Layout2D view.
Example:
This example retrieves in CoordDimCollection the collection of
CoordDims of the MyView Layout2D view.
Dim CoordDimCollection As DrawingCoordDims
Set CoordDimCollection = MyView.CoordDims
Property Dimensions() As   (Read Only)
Returns the drawing dimension collection of the Layout2D view.
Example:
This example retrieves in DimensionCollection the collection of
dimensions of the MyView Layout2D view.
Dim DimensionCollection As DrawingDimensions
Set DimensionCollection = MyView.Dimensions
Property Factory2D() As   (Read Only)
Returns the 2D factory of the Layout2D view.
Take care that you must open edition
on a sketch before adding or modifying elements in it.
Take care that you must close edition on a sketch to keep all modifications before saving document.
To get Sketch from factory2D:
Set mySketch = my2DFactory.Parent
Example:
The following example returns in my2DFactory the 2D factory
of the view myView:
Set my2DFactory = myView.Factory2D
Property FrameVisualization() As
Returns or sets the Layout2D view frame visualization state.
True if the Layout2D view frame is visible.
Example:
This example shows the frame of the MyView Layout2D view.
MyView.FrameVisualization = True
Property GDTs() As   (Read Only)
Returns the drawing GDT collection of the Layout2D view.
Example:
This example retrieves in GDTCollection the collection of
GDTs of the MyView Layout2D view.
Dim GDTCollection As DrawingGDTs
Set GDTCollection = MyView.GDTs
Property GeometricElements() As   (Read Only)
Returns the collection of geometric elements included in the Layout2D view sketch.
Example:
The following example returns in colGeometry the list of geometric
elements in the view myView:
Dim colGeometry As GeometricElements
Set colGeometry = MyView.GeometricElements
Property LockStatus() As
Returns or sets the lock status of a Layout2D view.
precondition: This property does not exist for the detail view. In this case, the method returns failed.
Example:
This example locks the ViewToWorkOn Layout2D view.
ViewToWorkOn.LockStatus = True
Property Pictures() As   (Read Only)
Returns the drawing picture collection of the Layout2D view.
Example:
This example retrieves in PictureCollection the collection of
pictures of the MyView Layout2D view.
Dim PictureCollection As DrawingPictures
Set PictureCollection = MyView.Pictures
Property ReferenceView() As
Returns or sets the reference view.
The reference view is also the parent view to which the current Layout2D view
is linked and which is used as reference for alignment.
Generally, the reference view is the front view, and the other views,
such as the top, bottom, left, and right views, are linked to it.
This reference Layout2D view is used:
When moving the current Layout2D view. Its location remains constrained
to the reference view, depending on its type. For example,
a left view can move horizontally and a top view can move vertically.
To update the scale of the current Layout2D view according to the
modification performed to the one of the reference Layout2D view.
Example:
This example retrieves in ReferenceView the view used as reference
by the MyView Layout2D view.
Dim ReferenceView As Layout2DView
Set ReferenceView = MyView.RefView
Property Tables() As   (Read Only)
Returns the drawing table collection of the drawing view.
Example:
This example retrieves in TextCollection the collection of
texts of the MyView Layout2D view.
Dim TableCollection As DrawingTables
Set TableCollection = MyView.Tables
Property Texts() As   (Read Only)
Returns the drawing text collection of the Layout2D view.
Example:
This example retrieves in TextCollection the collection of
texts of the MyView Layout2D view.
Dim TextCollection As DrawingTexts
Set TextCollection = MyView.Texts
Property Threads() As   (Read Only)
Returns the drawing thread collection of the Layout2D view.
Example:
This example retrieves in ThreadCollection the collection of
threads of the MyView Layout2D view.
Dim ThreadCollection As DrawingThreads
Set ThreadCollection = MyView.Threads
Property ViewScale() As
Returns or sets the scale of the Layout2D view.
Example:
This example sets the scale of the MyView Layout2D view to 0.5.
MyView.Scale = 0.5
Property Visu2DMode() As
Sets/Gets the 2D mode for background visualization of the view.
See also:
Example:
This example shows how to switch on the background 2D mode
View1.Visu2DMode = catView2DModeNoShow
Property VisuBackground() As
Sets/Gets the 2D-3D background visu mode of the view
ie in the 3D windows and in the background of each view in every 2D context.
See also:
Example:
This example shows how to set the background to LowInt
View1.VisuBackground = catLowIntPick
Property VisuIn3D() As
Sets/Gets the 3D visualization mode of the view in the 3D Viewer
ie in the 3D windows and in the background of each view in every 2D context.
See also:
Example:
This example shows how to make the View1 Layout2D view visible in 3D
View1.HideIn3DSize = catShowAll
Property Weldings() As   (Read Only)
Returns the drawing welding collection of the Layout2D view.
Example:
This example retrieves in weldingCollection the collection of
weldings of the MyView Layout2D view.
Dim weldingCollection As DrawingWeldings
Set weldingCollection = MyView.Weldings
Property x() As
Returns or sets the x coordinate of the Layout2D view coordinate system origin.
It is expressed with respect to the sheet coordinate system.
This coordinate, like any length, is measured in millimeters.
Example:
This example retrieves the x coordinate of the coordinate system origin of the
MyView.
X = MyView.x
Property y() As
Returns or sets the y coordinate of the Layout2D view coordinate system origin.
It is expressed with respect to the sheet coordinate system.
This coordinate, like any length, is measured in millimeters.
Example:
This example sets the y coordinate of the coordinate system origin of the
MyView to 5 inches.
You need first to convert the 5 inches into millimeters.
NewYCoordinate = 5*25.4
MyView.y = NewYCoordinate
Methods
Sub Activate()
Activates the Layout2D view.
Activating a Layout2D view means that this Layout2D view is the one on which
the end-user is now working.
Example:
This example activates the ViewToWorkOn Layout2D view.
ViewToWorkOn.Activate()
Sub AlignedWithReferenceView()
Activates the alignment with the reference view.
Activating the alignment with the reference view restores the constraints
that the reference view imposes to the current Layout2D view.
Example:
This example activates the alignment from the MyView
Layout2D view to its reference view.
MyView.AlignedWithReferenceView()
Sub GetViewName( iViewNamePrefix, iViewNameIdent, iViewNameSuffix)
Returns the prefix, the ident and the suffix of the name of
the Layout2D view. The method returns an error in case of 2D component reference.
Do not confuse with the method Name which can be different.
Example:
This example gets the prefix, the ident, and the suffix of the name
of the MyView Layout2D view
Dim MyPrefix, MyIdent, MySuffix As CATBSTR
MyView.GetViewName (MyPrefix, MyIdent, MySuffix)
Sub SaveEdition()
Saves the Sketch Edition. Once you have finished working with the Layout2D view, you
must save its edition in order to register modification for UNDO/REDO.
Indeed when activating a view, this view is open in edition while the previous active
view is closed in edition. So calling SaveEdition() before exiting a macro without
changing active view will allow a correct UNDO/REDO behavior.
Example:
The following example saves the edition of the Layout2D view MyView:
MyView.SaveEdition
Sub SetViewName( iViewNamePrefix, iViewNameIdent, iViewNameSuffix)
Sets the prefix, the ident and the suffix of the name of
the Layout2D view. The method returns an error in case of 2D component reference.
Do not confuse with the method Name which can be different.
Example:
This example sets the prefix, the ident, and the suffix of the name
of the MyView Layout2D view respectively to "MyPrefix", "MyIdent",
and "MySuffix".
MyView.SetViewName ("MyPrefix", "MyIdent", "MySuffix")
Sub Size( oValues)
Returns the bounding box of the Layout2D view.
Warning: This method is not implemented.
Parameters:
oValues
The values of the view bounding box: Xmin, Xmax, Ymin, Ymax
Example:
This example gets the bounding box of the ViewToWorkOn Layout2D view.
Dim oXY(4) As Double
ViewToWorkOn.Size oXY
Xmin = oXY(0)
Xmax = oXY(1)
Ymin = oXY(2)
Ymax = oXY(3)
Sub UnAlignedWithReferenceView()
Deactivates the alignment with the reference view.
Deactivating the alignment to the reference view removes the constraints
that the reference view imposes to the current Layout2D view.
You can then, for example, move and position it freely.
Example:
This example deactivates the alignment from the MyView
Layout2D view to its reference view.
MyView.UnAlignedWithReferenceView()
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.

=== interface_Layout2DViews_32315 ===
Drafting2DLInterfaces Layout2DViews (Object)
All Frameworks
Class Hierarchy
This Framework
Indexes
Previous
Next
Layout2DViews (Object)
Property Index
ActiveView
Returns the active Layout2D view of the active Layout2D sheet.
Method Index
AddAuxiliary
Creates a section or section-cut or auxiliary View2DL from a given Layout View2DL.
AddDetail
Creates a detail view and adds it to the layout view collection.
AddFrom3DPlane
Creates a viewFrom3D View2DL with the given 3Dplane as its
view plane at the given position in the given Sheet2DL.
AddPrimary
Creates a Layout view and adds it to the Layout view collection.
AddRelated
Creates a projection or isometric Layout View2DL from a given View2DL.
Item
Returns a Layout2D view using its index or its name from the Layout2DViews collection.
Remove
Removes a layout2D view from the Layout2DViews collection.
Properties
Property ActiveView() As   (Read Only)
Returns the active Layout2D view of the active Layout2D sheet.
Example:
The following example retrieves in ViewToWorkIn
the active Layout2D view in the Layout2DSheets collection of the layoutRoot
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.Documents.Part.GetItem("CATLayoutRoot")
Dim ViewToWorkIn As Layout2DView
Set ViewToWorkIn = MyRoot.Sheets.ActiveSheet.Layout2DViews.ActiveView
Methods
Func AddAuxiliary( iReferenceView, iBCSegment, iXorient, iYorient, iSectionType, iX, iY) As
Creates a section or section-cut or auxiliary View2DL from a given Layout View2DL.
The View2DL must be in this collection.
Caracteristics of new view (view plane etc) are computed based on the given
basic callout and reference view 2DL viewplane.
Precondition : 1/ The reference View2DL must be in this collection
Precondition : 2/ The reference View2DL must be a projection view.
Precondition : 3/ The callout segment's length must not be 0.
Precondition : 4/ iViewType must be either auxiliary or section or section cut.
Parameters:
iReferenceView
[in] The reference view. Must be a projection View.
iBCSegment
[in]  The callout's segment gives the trace of the auxiliary View2DL's projection
plane in the reference View2DL.
It has the following contents:
iBCSegment[0] = X1     x coordinate of the first point
iBCSegment[1] = Y1     y coordinate of the first point
iBCSegment[2] = X2     x coordinate of the second point
iBCSegment[3] = Y2     y coordinate of the second point
iBCOrient
[in]  The callout's orientation gives the direction taken into account when Layout2D
the auxilliary View2DL.
iXorient
[in]
iYorient
[in]  This point determine the type taken into account when Layout2D the auxilliary View2DL.
iSectionType
iX
[in]
iY
[in]  The coordinate in the Sheet2DL for the new View2DL.
Returns:
The created Layout2D view
Example:
The following example creates a Layout2D view named from the active view
and retrieved in MyView
in the Layout2D view collection of the MySheet Layout2D sheet.
This sheet belongs to the Layout2D sheet collection of the layoutRoot
Dim x As double
Set x = 10.
Dim y As double
Set y = 10.
Dim MySegment
ReDim MySegment(3)
MySegment(0) = 10.
MySegment(1) = 200.
MySegment(2) = 100.
MySegment(3) = 200.
Dim MyRoot As Layout2DRoot
Set MyRoot = CATIA.Documents.Part.GetItem("CATLayoutRoot")
Dim MyFirstView As Layout2DView
Set MyFirstView = MyRoot.Sheets.ActiveSheet.Views.ActiveView
Dim MyView As Layout2DView
Set MyView = MyRoot.Sheets.ActiveSheet.Views.
Func AddDetail( iDetailName) As
Creates a detail view and adds it to the layout view collection.
This layout view becomes the active one.
Precondition : The collection view must be a Detail Sheet
Parameters:
iDetailName
The name to assign to the created layout view
Returns:
The created layout view
Example:
The following example creates a detail view named Ditto
and retrieved in MyView in the layout view collection
of the MyDetailSheet layout sheet. Where MyDetailSheet
is the active sheet of the layout sheet collection of the layout root
Dim MyLayoutRoot As Layout2DRoot
Set MyLayoutRoot = CATIA.Documents.Part.GetItem("CATLayoutRoot")
Dim MyDetailSheet As Layout2DSheet
Set MyDetailSheet = .Sheets.ActiveSheet
Dim MyView As Layout2DView
Set MyView = MyDetailSheet.Views.AddDetail("Ditto")
Dim MyView As Layout2DView
Set MyView = CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot").Sheets.ActiveSheet.
Views.AddDetail()
Func AddFrom3DPlane( iPlane, iViewType, iX, iY) As
Creates a viewFrom3D View2DL with the given 3Dplane as its
view plane at the given position in the given Sheet2DL.
Parameters:
iPlane
[in] Define the plane on wich the view as to be created
It has the following contents:
iPlane[0] = X      x coordinate of plane origin in 3D space
iPlane[1] = Y      y coordinate of plane origin in 3D space
iPlane[2] = Z      z coordinate of plane origin in 3D space
iPlane[3] = H1     Define the direction which the view's viewplane H
iPlane[4] = H2     axis has to be colinear with
iPlane[5] = H3
iPlane[6] = V1     Define the direction which the view's viewplane V
iPlane[7] = V2     axis has to be colinear with
iPlane[8] = V3
Precondition : 1/iViewType must be either auxiliary or section or section cut.
Precondition : 2/ iFirstDirection and iSecondDirection must be orthogonal.
iViewType
The view type: catAuxiliary or catSectionCut or catSectionView
iX
[in]
iY
[in] The coordinate of the new View2DL in the Sheet2DL
Returns:
The created Layout2D view
Func AddPrimary( iX, iY) As
Creates a Layout view and adds it to the Layout view collection.
This Layout view becomes the active one.
Parameters:
iX
[in]
iY
[in]  The coordinate in the Sheet2DL for the new View2DL.
Returns:
The created Layout2D view
Example:
The following example creates a Layout2D view and retrieved in MyView
in the Layout2D view collection of the Layout2D sheet.
This sheet belongs to the Layout2D sheet collection.
Dim x as double
Set x = 10.
Dim y as double
Set y = 10.
Dim MyView As Layout2DView
Set MyView = CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot").Sheets.ActiveSheet.
Views.AddPrimary(x, y).
Func AddRelated( iReferenceView, iSide, iX, iY) As
Creates a projection or isometric Layout View2DL from a given View2DL.
The view will be created in the same collection as the given
View2DL, at the given position.
The caracteristics (ex: view plane etc) of this new View2DL are computed
based on the caracteristics stored in the ViewBox its iReferenceView
is associated with.
Parameters:
iReferenceView
[in]   The reference View2DL from which the new View2DL is created.
iSide
[in]   Used with the ViewBox and iReferenceView to give the related view to create (type etc).
iX
[in]
iY
[in]  The coordinate in the Sheet2DL for the new View2DL.
Returns:
The created Layout2D view
Precondition : The reference View2DL must be in this collection
Example:
The following example creates a Layout2D view named from the active view
and retrieved in MyView
in the Layout2D view collection of the MySheet Layout2D sheet.
This sheet belongs to the Layout2D sheet collection of the layoutRoot.
Dim x as double
Set x = 10.
Dim y as double
Set y = 10.
Dim MyFirstView As Layout2DView
Set MyFirstView = CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot").Sheets.ActiveSheet.Views.ActiveView
Dim MyView As Layout2DView
Set MyView = CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot").Sheets.ActiveSheet.Views.
AddRelated(MyFirstView,catLeftSide, x, y)
Func Item( iIndex) As
Returns a Layout2D view using its index or its name from the Layout2DViews collection.
Parameters:
iIndex
The index or the name of the Layout2D view to retrieve from
the collection of Layout2D views.
As a numerics, this index is the rank of the Layout2D view
in the collection.
The index of the first Layout2D view in the collection is 1, and
the index of the last Layout2D view is Count.
As a string, it is the name you assigned to the Layout2D view using
the
property or when creating it using   the
method.
Returns:
The retrieved Layout2D view
Example:
This example retrieves in ThisLayout2DView the second Layout2D view,
and in ThatLayout2DView the Layout2D view named
MyView in the Layout2D view collection of the active sheet of a layoutRoot
of a part of the active document, supposed to be a part document.
Dim MySheet As Layout2DSheet
Set MySheet = CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot").Sheets.ActiveSheet
Dim ThisLayout2DView As Layout2DView
Set ThisLayout2DView = MySheet.Views.ActiveView.Item(2)
Dim ThatLayout2DView As Layout2DView
Set ThatLayout2DView = MySheet.Views.ActiveView.Item("MyView")
Sub Remove( iIndex)
Removes a layout2D view from the Layout2DViews collection.
Parameters:
iIndex
The index or the name of the Layout2D view to remove from
the collection of Layout2D views.
As a numerics, this index is the rank of the Layout2D view
in the collection.
The index of the first Layout2D view in the collection is 1, and
the index of the last Layout2D view is Count.
As a string, it is the name you assigned to the Layout2D view using
the
property or when creating it using   the
method.
Example:
The following example removes the third Layout2D view and the Layout2D view
named TopView in the Layout2D view collection of the active sheet of a layoutRoot
of a part of the active document, supposed to be a part document.
Dim MySheet As Layout2DSheet
Set MySheet = CATIA.ActiveDocument.Part.GetItem("CATLayoutRoot").Sheets.ActiveSheet
MySheet.ActiveViews.Remove(3)
MySheet.ActiveViews.Remove("TopView")
Copyright © 1999-2019, Dassault Systèmes. All rights reserved.