Contains accessor methods for all the part load options. More...

Inheritance diagram for NXOpen.LoadOptions:

Public Types
enum	LoadMethod { AsSaved, FromDirectory, SearchDirectories }
	Options for specifying how to load component parts More...

enum	ManagedModeLoadMethod { ByRevisionRule = 1, AsSaved }
	Options for specifying how to configure assembly structure in managed mode More...

enum	LoadComponents { All, None, LastSet, LastFilter, SpecifyFilter }
	Options for specifying what component parts to load during part open More...

enum	Parent { Partial, Immediate, All }
	Options to allow you to specify how unloaded parents should be loaded when interpart data loading is turned on More...

enum	BookmarkComponents { NoChange, LoadVisible, LoadLoaded, LoadLoadedAndNonDisplayed }
	The options to specify what components to load and visualize when loading bookmarks. More...

enum	BookmarkRefsets { ImportData, ImportAndOptimizeLoad, DontImport }
	the options that specify if reference set data from the bookmark should be restored and load should be optimized by loading topology from the selected reference sets only. More...

enum	UpdateSubsetOnLoad { None, ReplayRecipe }
	Options for specifying what type of subset updation to be carried out while loading More...

enum	LoadOption { FullyLoad, PartiallyLoad, FullyLoadLightweightDisplay, PartiallyLoadLightweightDisplay, MinimalLoadVisualize }
	Option to control how much data is loaded from parts. More...

Public Member Functions
unsafe void	SetInterpartData (bool interpartOption, NXOpen.LoadOptions.Parent parentOption)
	Sets the interpart data option which, when turned on, loads parts that are mated or contain interpart expressions, as well as those with WAVE data. More...

unsafe void	GetInterpartData (out bool interpartOption, out NXOpen.LoadOptions.Parent parentOption)
	Returns the interpart data option and the parent option More...

unsafe void	SetBookmarkComponentsToLoad (bool restoreAnt, bool restoreFullyLoadedStatus, NXOpen.LoadOptions.BookmarkComponents componentsLoadOption)
	More...

unsafe void	GetBookmarkComponentsToLoad (out bool restoreAnt, out NXOpen.LoadOptions.BookmarkComponents componentsLoadOption)
	The options for component parts to load and visualize when a bookmark is loaded. More...

unsafe void	SetSearchDirectories (string[] searchDirectories, bool[] searchSubDirs)
	Set which search directories are to appear in the list. More...

unsafe void	GetSearchDirectories (out string[] searchDirectories, out bool[] searchSubDirs)
	Returns which search directories are to appear in the list. More...

unsafe void	SetDefaultReferenceSets (string[] referenceSets)
	Sets the list of reference sets to be looked for, in order, when an assembly is loaded. More...

unsafe string[]	GetDefaultReferenceSets ()
	Returns the list of reference sets to be looked for, in order, when an assembly is loaded. More...

unsafe void	Save (string optionsFile)
	Saves the current load options settings in a system file More...

unsafe void	Restore (string optionsFile)
	Changes the load options settings to what they are in the specified file More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

unsafe bool	AbortOnFailure `[get, set]`
	Returns or sets the option that specifies what action the system should take if it can't find a component part file More...

unsafe bool	AllowSubstitution `[get, set]`
	Returns or sets the allow substition option. More...

unsafe NXOpen.LoadOptions.BookmarkRefsets	BookmarkRefsetLoadBehavior `[get, set]`
	Returns or sets the options that specify import and loading of components' reference sets when opening bookmarks. More...

unsafe NXOpen.LoadOptions.LoadMethod	ComponentLoadMethod `[get, set]`
	Returns or sets the option indicating what method to use to determine where to find component parts to load More...

unsafe NXOpen.LoadOptions.LoadComponents	ComponentsToLoad `[get, set]`
	Returns or sets the option indicating what component parts to load during part open. More...

unsafe bool	GenerateMissingPartFamilyMembers `[get, set]`
	Returns or sets the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly More...

unsafe bool	LoadLatest `[get, set]`
	Returns or sets the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match. More...

unsafe NXOpen.LoadOptions.ManagedModeLoadMethod	ManagedModeComponentLoadMethod `[get, set]`
	Returns or sets the option indicating what method to use to determine how to configure assembly structure in managed mode More...

unsafe NXOpen.LoadOptions.UpdateSubsetOnLoad	OptionUpdateSubsetOnLoad `[get, set]`
	Returns or sets the option that controls the subset updates during load More...

unsafe NXOpen.LoadOptions.LoadOption	PartLoadOption `[get, set]`
	Returns or sets the option that controls how the part is being loaded More...

unsafe bool	ReferenceSetOverride `[get, set]`
	Returns or sets the option that specifies if the default reference set list should be applied to components all the way down an assembly tree. More...

unsafe bool	UseLightweightRepresentations `[get, set]`
	Returns or sets the option that controls if components are displayed with a lightweight or exact representation. More...

unsafe bool	UsePartialLoading `[get, set]`
	Returns or sets the option that controls the partial loading of components. More...

Detailed Description

Contains accessor methods for all the part load options.

To obtain an instance of this class, refer to NXOpen.PartCollection

Created in NX3.0.0

Member Enumeration Documentation

enum NXOpen.LoadOptions.BookmarkComponents

The options to specify what components to load and visualize when loading bookmarks.

Note: The visiblity and fully loaded state will only be restored for components that are part of the bookmark's product assembly. The bookmark's product assembly is the one that was the displayed part at the time the bookmark was saved.

Enumerator
NoChange	This option has no effect. Using this value will leave the current setting active (not exposed in UI)
LoadVisible	Load and show only what was shown on the bookmark's save. Don't load invisible components.
LoadLoaded	Load and show only what was loaded on the bookmark's save Load invisible components and keep them invisible.
LoadLoadedAndNonDisplayed	Load and show only what was loaded on the bookmark's save, including non-display parts. Load invisible components and keep them invisible. All non-display parts are invisible.

enum NXOpen.LoadOptions.BookmarkRefsets

the options that specify if reference set data from the bookmark should be restored and load should be optimized by loading topology from the selected reference sets only.

Note: The reference set data will only be restored for components that are part of the bookmark's product assembly. The bookmark's product assembly is the one that was the displayed part at the time the bookmark was saved.

Enumerator
ImportData	Import reference set data
ImportAndOptimizeLoad	Import reference set data and use it to optimize load
DontImport	Do nothing with the bookmark reference set data

enum NXOpen.LoadOptions.LoadComponents

Options for specifying what component parts to load during part open

Enumerator
All	load all components
None	load none of the components
LastSet	use same set of components as when the assembly was last saved
LastFilter	use same filter used to last load the assembly
SpecifyFilter	display list of pre-defined component groups to select from

enum NXOpen.LoadOptions.LoadMethod

Options for specifying how to load component parts

Enumerator
AsSaved	use same directory in which they were saved
FromDirectory	use same directory as the parent assembly
SearchDirectories	use a list of search directories

enum NXOpen.LoadOptions.LoadOption

Option to control how much data is loaded from parts.

The first four settings are equivalent to the four possible combinations of the properties NXOpen.LoadOptions.UsePartialLoading and NXOpen.LoadOptions.UseLightweightRepresentations . The final setting is reserved for future use.

Enumerator
FullyLoad	partial load : off, use lightweight : off
PartiallyLoad	partial load : on, use lightweight : off
FullyLoadLightweightDisplay	partial load : off, use lightweight : on
PartiallyLoadLightweightDisplay	partial load : on, use lightweight : on
MinimalLoadVisualize	reserved for future use

enum NXOpen.LoadOptions.ManagedModeLoadMethod

Options for specifying how to configure assembly structure in managed mode

Enumerator
ByRevisionRule	use the assembly structure configured by revision rule for load
AsSaved	use assembly structure in the part file for load

enum NXOpen.LoadOptions.Parent

Options to allow you to specify how unloaded parents should be loaded when interpart data loading is turned on

Enumerator
Partial	Do not load any unloaded parents, but fully load partially loaded parts with parent geometry.
Immediate	Fully load parts that satisfy one level of parent references as well as any partially loaded parts with parent geometry.
All	Recursively fully load all parts with parent geometry linked to geometry in the parts selected for loading

enum NXOpen.LoadOptions.UpdateSubsetOnLoad

Options for specifying what type of subset updation to be carried out while loading

Enumerator
None	replay recipe
ReplayRecipe	do not update

Member Function Documentation

unsafe void NXOpen.LoadOptions.GetBookmarkComponentsToLoad	(	out bool	restoreAnt,
		out NXOpen.LoadOptions.BookmarkComponents	componentsLoadOption
	)

The options for component parts to load and visualize when a bookmark is loaded.

Created in NX6.0.0

License requirements: None.

Parameters

restoreAnt	whether to restore ANT's state
componentsLoadOption	what components to load

unsafe string [] NXOpen.LoadOptions.GetDefaultReferenceSets ( )

Returns the list of reference sets to be looked for, in order, when an assembly is loaded.

The default reference set list will always contain the four canned default reference sets: "As Saved", "Use Model", "Entire Part", and "Empty".

Created in NX3.0.0

License requirements: None.

Returns

unsafe void NXOpen.LoadOptions.GetInterpartData	(	out bool	interpartOption,
		out NXOpen.LoadOptions.Parent	parentOption
	)

Returns the interpart data option and the parent option

Created in NX3.0.0

License requirements: None.

Parameters

interpartOption
parentOption

unsafe void NXOpen.LoadOptions.GetSearchDirectories	(	out string[]	searchDirectories,
		out bool[]	searchSubDirs
	)

Returns which search directories are to appear in the list.

Created in NX3.0.0

License requirements: None.

Parameters

searchDirectories	True indicates that sub-directories will be searched as well
searchSubDirs

unsafe void NXOpen.LoadOptions.Restore ( string optionsFile )

Changes the load options settings to what they are in the specified file

Created in NX3.0.0

License requirements: None.

Parameters

optionsFile Name of file to restore from. If this is Nothing, then the default load options file name will be used.

unsafe void NXOpen.LoadOptions.Save ( string optionsFile )

Saves the current load options settings in a system file

Created in NX3.0.0

License requirements: None.

Parameters

optionsFile Name of file to save to. If this is Nothing, then the default load options file name will be used.

unsafe void NXOpen.LoadOptions.SetBookmarkComponentsToLoad	(	bool	restoreAnt,
		bool	restoreFullyLoadedStatus,
		NXOpen.LoadOptions.BookmarkComponents	componentsLoadOption
	)

Created in NX6.0.0

License requirements: None.

Parameters

restoreAnt	whether or not to restore the state of assembly navigator
restoreFullyLoadedStatus	whether or not to restore a part's full "loadness" state
componentsLoadOption	what components to load

unsafe void NXOpen.LoadOptions.SetDefaultReferenceSets ( string[] referenceSets )

Sets the list of reference sets to be looked for, in order, when an assembly is loaded.

The default reference set list will always contain the four canned default reference sets: "As Saved", "Use Model", "Entire Part", and "Empty". These cannot be removed, but their order can be changed.

Created in NX3.0.0

License requirements: None.

Parameters

referenceSets

unsafe void NXOpen.LoadOptions.SetInterpartData	(	bool	interpartOption,
		NXOpen.LoadOptions.Parent	parentOption
	)

Sets the interpart data option which, when turned on, loads parts that are mated or contain interpart expressions, as well as those with WAVE data.

This method also lets you specify how unloaded parents should be loaded when interpart data loading is turned on.

Created in NX3.0.0

License requirements: None.

Parameters

interpartOption	whether or not to allow interpart loading
parentOption	how to load unloaded parents

unsafe void NXOpen.LoadOptions.SetSearchDirectories	(	string[]	searchDirectories,
		bool[]	searchSubDirs
	)

Set which search directories are to appear in the list.

Created in NX3.0.0

License requirements: None.

Parameters

searchDirectories	True indicates that sub-directories should be searched as well
searchSubDirs

Property Documentation

unsafe bool NXOpen.LoadOptions.AbortOnFailure

getset

Returns or sets the option that specifies what action the system should take if it can't find a component part file

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.LoadOptions.AllowSubstitution

getset

Returns or sets the allow substition option.

If the component found by the assembly has the wrong internal identifier (but the correct name), this option enables the assembly to be loaded with this component even though it is a completely different part.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.LoadOptions.BookmarkRefsets NXOpen.LoadOptions.BookmarkRefsetLoadBehavior

getset

Returns or sets the options that specify import and loading of components' reference sets when opening bookmarks.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.LoadOptions.LoadMethod NXOpen.LoadOptions.ComponentLoadMethod

getset

Returns or sets the option indicating what method to use to determine where to find component parts to load

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.LoadOptions.LoadComponents NXOpen.LoadOptions.ComponentsToLoad

getset

Returns or sets the option indicating what component parts to load during part open.

Note that this property cannot be set to NXOpen.LoadOptions.LoadComponents.LastFilter or NXOpen.LoadOptions.LoadComponents.SpecifyFilter without an adv_assemblies license. A license exception will be thrown if an attempt is made to set this property to one of these two values without this license.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.LoadOptions.GenerateMissingPartFamilyMembers

getset

Returns or sets the option that controls whether to automatically regenerate missing part family members when it loads the parent assembly

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.LoadOptions.LoadLatest

getset

Returns or sets the option that specifies whether the system searches for the latest component according to the version rules, or looks for the exact match.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.LoadOptions.ManagedModeLoadMethod NXOpen.LoadOptions.ManagedModeComponentLoadMethod

getset

Returns or sets the option indicating what method to use to determine how to configure assembly structure in managed mode

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.LoadOptions.UpdateSubsetOnLoad NXOpen.LoadOptions.OptionUpdateSubsetOnLoad

getset

Returns or sets the option that controls the subset updates during load

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.LoadOptions.LoadOption NXOpen.LoadOptions.PartLoadOption

getset

Returns or sets the option that controls how the part is being loaded

Created in NX12.0.0

License requirements to get this property: assemblies ("ASSEMBLIES MODULE")

License requirements to set this property: assemblies ("ASSEMBLIES MODULE")

unsafe bool NXOpen.LoadOptions.ReferenceSetOverride

getset

Returns or sets the option that specifies if the default reference set list should be applied to components all the way down an assembly tree.

This option is referred to as "Apply to All Levels" in the User Interface.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.LoadOptions.Tag

get

Returns the tag of this object.

unsafe bool NXOpen.LoadOptions.UseLightweightRepresentations

getset

Returns or sets the option that controls if components are displayed with a lightweight or exact representation.

A value of True indicates that the lightweight representation is used for the components after the assembly is loaded

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.LoadOptions.UsePartialLoading

getset

Returns or sets the option that controls the partial loading of components.

A value of False means that when an assembly is opened its components are fully loaded with it

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:

dotnet_pool/LoadOptions.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation