NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.PartCleanup Class Reference

Provides utilities to to eliminate certain inaccessible objects from the part file. More...

Inheritance diagram for NXOpen.PartCleanup:

Public Types

enum  CleanupParts { Work, Components, All }
 Which parts to clean up More...
 
enum  DeleteGroups { None, Unnamed, All }
 Which empty groups to clean up More...
 
enum  ResetComponentDisplayAction { No, RemoveRedundantChanges, RemoveAllChanges }
 Assembly display clean up action More...
 

Public Member Functions

unsafe void DoCleanup ()
 Actually performs the part cleanup operation according to the properties set on this object More...
 
unsafe void Reset ()
 Resets all the properties back to the default values (i. More...
 

Protected Member Functions

override void FreeResource ()
 Free resources associated with the instance. More...
 

Properties

unsafe bool CleanupAssemblyConstraints [get, set]
 Returns or sets the option that specifies whether to cleanup assembly constraints. More...
 
unsafe bool CleanupCAMObjects [get, set]
 Returns or sets the option that specifies whether to delete or fix any corrupt internal CAM objects. More...
 
unsafe bool CleanupDraftingObjects [get, set]
 Returns or sets the option that specifies whether to perform drafting cleanup. More...
 
unsafe bool CleanupFeatureData [get, set]
 Returns or sets the option that specifies whether to perform solid cleanup. More...
 
unsafe bool CleanupMatingData [get, set]
 Returns or sets the option that specifies whether to cleanup mating data. More...
 
unsafe bool CleanupMotionData [get, set]
 Returns or sets the option which determines if the motion cleanup option should be performed. More...
 
unsafe bool CleanupPartFamilyData [get, set]
 Returns or sets the option that specifies if the part family data cleanup should be performed. More...
 
unsafe bool CleanupRoutingData [get, set]
 Returns or sets the option which determines if the routing part cleanup option should be performed. More...
 
unsafe bool DeleteBrokenInterpartLinks [get, set]
 Returns or sets the option that specifies whether or not to delete all inter-part links where one or more components in that inter-part link have been removed. More...
 
unsafe bool DeleteDuplicateLights [get, set]
 Returns or sets the option that specifies whether to delete duplicate light source objects from the part file. More...
 
unsafe bool DeleteInvalidAttributes [get, set]
 Returns or sets the option that specifies whether to delete all invalid user attributes from the part file. More...
 
unsafe bool DeleteMaterials [get, set]
 Returns or sets the option that specifies whether to delete all materials from the part file. More...
 
unsafe bool DeleteSpreadSheetData [get, set]
 Returns or sets the option that specifies whether to delete all spreadsheets from the part file. More...
 
unsafe bool DeleteUnusedExpressions [get, set]
 Returns or sets the option that specifies whether to delete expressions that are not used in the part. More...
 
unsafe bool DeleteUnusedExtractReferences [get, set]
 Returns or sets the option that specifies whether to delete all unused edge/face references in extract features from the part file. More...
 
unsafe bool DeleteUnusedFonts [get, set]
 Returns or sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part. More...
 
unsafe bool DeleteUnusedObjects [get, set]
 Returns or sets the option that specifies whether to delete all extraneous objects from the work part More...
 
unsafe bool DeleteUnusedUnits [get, set]
 Returns or sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part. More...
 
unsafe bool DeleteVisualEditorData [get, set]
 Returns or sets the option that specifies whether to delete Visual Editor data from the part file. More...
 
unsafe bool FixOffplaneSketchCurves [get, set]
 Returns or sets the option that specifies whether to fix off-plane sketch curves. More...
 
unsafe
NXOpen.PartCleanup.DeleteGroups 
GroupsToDelete [get, set]
 Returns or sets the option that specifies what empty groups should be deleted. More...
 
unsafe
NXOpen.PartCleanup.CleanupParts 
PartsToCleanup [get, set]
 Returns or sets the option that specifies what parts will be cleaned up when PartCleanup.DoCleanup is called. More...
 
unsafe
NXOpen.PartCleanup.ResetComponentDisplayAction 
ResetComponentDisplay [get, set]
 Returns or sets the option that specifies whether to remove assembly-specific geometry in component parts. More...
 
unsafe bool TurnOffHighlighting [get, set]
 Returns or sets the option that specifies whether to turn off highlighting for all displayable objects in the displayed part. More...
 

Detailed Description

Provides utilities to to eliminate certain inaccessible objects from the part file.

To use this utility, first create an instance of this class by calling Session.NewPartCleanup . Then, set any part cleanup actions that you wish to be performed by setting the appropriate properties on this class. By default, all the properties are set to "false" or "none". Once all the properties are set, then call the PartCleanup.DoCleanup method to actually perform the cleanup action.

For more information on what the various part cleanup options do, see the Part Cleanup Options Dialog section of the Gateway Help.

Created in NX3.0.0

Member Enumeration Documentation

Which parts to clean up

Enumerator
Work 

clean up the work part only

Components 

clean up the work part and its components

All 

clean up all loaded parts

Which empty groups to clean up

Enumerator
None 

delete none of the empty groups

Unnamed 

delete only the unnamed empty groups

All 

delete all the empty groups

Assembly display clean up action

Enumerator
No 

do nothing

RemoveRedundantChanges 

only remove changes that will not affect current display.

RemoveAllChanges 

remove all changes

Member Function Documentation

unsafe void NXOpen.PartCleanup.DoCleanup ( )

Actually performs the part cleanup operation according to the properties set on this object

Created in NX3.0.0

License requirements: None.

override void NXOpen.PartCleanup.FreeResource ( )
protected

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX3.0.0

License requirements: None.

unsafe void NXOpen.PartCleanup.Reset ( )

Resets all the properties back to the default values (i.

e. everything turned off).

Created in NX3.0.0

License requirements: None.

Property Documentation

unsafe bool NXOpen.PartCleanup.CleanupAssemblyConstraints
getset

Returns or sets the option that specifies whether to cleanup assembly constraints.

Created in NX7.5.5

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.CleanupCAMObjects
getset

Returns or sets the option that specifies whether to delete or fix any corrupt internal CAM objects.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.CleanupDraftingObjects
getset

Returns or sets the option that specifies whether to perform drafting cleanup.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.CleanupFeatureData
getset

Returns or sets the option that specifies whether to perform solid cleanup.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.CleanupMatingData
getset

Returns or sets the option that specifies whether to cleanup mating data.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.CleanupMotionData
getset

Returns or sets the option which determines if the motion cleanup option should be performed.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.CleanupPartFamilyData
getset

Returns or sets the option that specifies if the part family data cleanup should be performed.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.CleanupRoutingData
getset

Returns or sets the option which determines if the routing part cleanup option should be performed.

Created in NX7.5.4

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteBrokenInterpartLinks
getset

Returns or sets the option that specifies whether or not to delete all inter-part links where one or more components in that inter-part link have been removed.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteDuplicateLights
getset

Returns or sets the option that specifies whether to delete duplicate light source objects from the part file.

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteInvalidAttributes
getset

Returns or sets the option that specifies whether to delete all invalid user attributes from the part file.

Created in NX8.0.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteMaterials
getset

Returns or sets the option that specifies whether to delete all materials from the part file.

Created in NX7.5.2

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteSpreadSheetData
getset

Returns or sets the option that specifies whether to delete all spreadsheets from the part file.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteUnusedExpressions
getset

Returns or sets the option that specifies whether to delete expressions that are not used in the part.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteUnusedExtractReferences
getset

Returns or sets the option that specifies whether to delete all unused edge/face references in extract features from the part file.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteUnusedFonts
getset

Returns or sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteUnusedObjects
getset

Returns or sets the option that specifies whether to delete all extraneous objects from the work part

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteUnusedUnits
getset

Returns or sets the option that specifies whether to remove character fonts that are not used in any drafting text in the current part.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.DeleteVisualEditorData
getset

Returns or sets the option that specifies whether to delete Visual Editor data from the part file.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.FixOffplaneSketchCurves
getset

Returns or sets the option that specifies whether to fix off-plane sketch curves.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PartCleanup.DeleteGroups NXOpen.PartCleanup.GroupsToDelete
getset

Returns or sets the option that specifies what empty groups should be deleted.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PartCleanup.CleanupParts NXOpen.PartCleanup.PartsToCleanup
getset

Returns or sets the option that specifies what parts will be cleaned up when PartCleanup.DoCleanup is called.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.PartCleanup.ResetComponentDisplayAction NXOpen.PartCleanup.ResetComponentDisplay
getset

Returns or sets the option that specifies whether to remove assembly-specific geometry in component parts.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PartCleanup.TurnOffHighlighting
getset

Returns or sets the option that specifies whether to turn off highlighting for all displayable objects in the displayed part.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.