NXOpen .NET Reference Guide
1899
|
Contains accessor methods for all the part load options. More...
Public Types | |
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 | LoadComponents { All, None, LastSet, LastFilter, SpecifyFilter } |
Options for specifying what component parts to load during part open More... | |
enum | LoadMethod { AsSaved, FromDirectory, SearchDirectories } |
Options for specifying how to load component parts More... | |
enum | LoadOption { FullyLoad, PartiallyLoad, FullyLoadLightweightDisplay, PartiallyLoadLightweightDisplay, MinimallyLoadLightweightDisplay } |
Option to control how much data is loaded from parts. More... | |
enum | ManagedModeLoadMethod { ByRevisionRule = 1, AsSaved } |
Options for specifying how to configure assembly structure in managed mode 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 | UpdateSubsetOnLoad { None, ReplayRecipe } |
Options for specifying what type of subset updation to be carried out while loading More... | |
Public Member Functions | |
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 string[] | GetDefaultReferenceSets () |
Returns the list of reference sets to be looked for, in order, when an assembly is loaded. More... | |
unsafe void | GetInterpartData (out bool interpartOption, out NXOpen.LoadOptions.Parent parentOption) |
Returns the interpart data option and the parent option More... | |
unsafe void | GetSearchDirectories (out string[] searchDirectories, out bool[] searchSubDirs) |
Returns which search directories are to appear in the list. More... | |
unsafe void | Restore (string optionsFile) |
Changes the load options settings to what they are in the specified file More... | |
unsafe void | Save (string optionsFile) |
Saves the current load options settings in a system file More... | |
unsafe void | SetBookmarkComponentsToLoad (bool restoreAnt, bool restoreFullyLoadedStatus, NXOpen.LoadOptions.BookmarkComponents componentsLoadOption) |
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 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 | SetSearchDirectories (string[] searchDirectories, bool[] searchSubDirs) |
Set which search directories are to appear in the list. More... | |
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageCtrl | AsyncProcessMessage (IMessage msg, IMessageSink replySink) |
Asynchronously processes the given message. More... | |
IMessage | SyncProcessMessage (IMessage msg) |
Synchronously processes the given message. More... | |
Properties | |
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... | |
Tag | Tag [get] |
Returns the tag of this object. 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... | |
Properties inherited from NXOpen.Utilities.NXRemotableObject | |
IMessageSink | NextSink [get] |
Gets the next message sink in the sink chain. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
void | initialize () |
<exclude> More... | |
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
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.
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 |
Options for specifying what component parts to load during part open
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 .
When NX is connected to a Teamcenter database, then the final setting, minimal loading, is only effective if the database supports minimal loading capabilities. If the database does not, then this setting behaves identically to the second-to-last setting, partial loading with lightweight display.
For minimal loading following properties are not supported and hence should not be set to true. If they are set in combination with minimal loading, they will be ignored (minimal loading will take priority). NXOpen.LoadOptions.SetInterpartData NXOpen.LoadOptions.AbortOnFailure
Options to allow you to specify how unloaded parents should be loaded when interpart data loading is turned on
|
inline |
The options for component parts to load and visualize when a bookmark is loaded.
Created in NX6.0.0
License requirements: None.
restoreAnt | whether to restore ANT's state |
componentsLoadOption | what components to load |
|
inline |
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.
|
inline |
Returns the interpart data option and the parent option
Created in NX3.0.0
License requirements: None.
interpartOption | |
parentOption |
|
inline |
Returns which search directories are to appear in the list.
Created in NX3.0.0
License requirements: None.
searchDirectories | True indicates that sub-directories will be searched as well |
searchSubDirs |
|
inline |
Changes the load options settings to what they are in the specified file
Created in NX3.0.0
License requirements: None.
optionsFile | Name of file to restore from. If this is Nothing, then the default load options file name will be used. |
|
inline |
Saves the current load options settings in a system file
Created in NX3.0.0
License requirements: None.
optionsFile | Name of file to save to. If this is Nothing, then the default load options file name will be used. |
|
inline |
Created in NX6.0.0
License requirements: None.
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 |
|
inline |
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.
referenceSets |
|
inline |
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.
interpartOption | whether or not to allow interpart loading |
parentOption | how to load unloaded parents |
|
inline |
Set which search directories are to appear in the list.
Created in NX3.0.0
License requirements: None.
searchDirectories | True indicates that sub-directories should be searched as well |
searchSubDirs |
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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")
|
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.
|
get |
Returns the tag of this object.
|
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.
|
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.