NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Annotations.PartsListContentsBuilder Class Reference

Represents a Annotations.PartsListContentsBuilder . More...

Inheritance diagram for NXOpen.Annotations.PartsListContentsBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ScopeType { AllLevels, TopLevelOnly, LeavesOnly }
 The options specify the configuration type level for the parts list More...
 
enum  TopLevelAssemblyType { ChildPart = 1, SubChildPart }
 The options specify the top level assembly type for the parts list More...
 

Public Member Functions

unsafe void AddMember (NXOpen.TaggedObject member, bool selectSubassemblies)
 Adds member to parts list. More...
 
unsafe void RemoveMember (NXOpen.TaggedObject member, bool removeSubassemblies)
 Removes member from parts list. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. 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
NXOpen.Assemblies.ArrangementsBuilder 
Arrangement [get]
 Returns the arrangement More...
 
unsafe bool IncludeSubOrdinateDesignElements [get, set]
 Returns or sets the Include Subordinate Design Elements for Parts list in 4GD mode More...
 
unsafe
NXOpen.Annotations.PartsListContentsBuilder.ScopeType 
Scope [get, set]
 Returns or sets the scope specifies the configuration type for parts list More...
 
unsafe
NXOpen.Annotations.PartsListContentsBuilder.TopLevelAssemblyType 
TopLevelAssembly [get, set]
 Returns or sets the top level assembly type for parts list More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. 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.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a Annotations.PartsListContentsBuilder .

This is a sub-builder class and cannot be directly instantiated

Created in NX1847.0.0

Member Enumeration Documentation

The options specify the configuration type level for the parts list

Enumerator
AllLevels 

All levels.

TopLevelOnly 

Top level only.

LeavesOnly 

Leaves only.

The options specify the top level assembly type for the parts list

Enumerator
ChildPart 

Child Part.

SubChildPart 

Sub Child Part.

Member Function Documentation

unsafe void NXOpen.Annotations.PartsListContentsBuilder.AddMember ( NXOpen.TaggedObject  member,
bool  selectSubassemblies 
)
inline

Adds member to parts list.

If 'Select Subassemblies flag' is true then child components of input assembly will also be added to parts list. If 'Select Subassemblies flag' is false, then only input member will be added to parts list.

Created in NX1847.0.0

License requirements: None.

Parameters
memberObject of the member to add.
selectSubassembliesSelect subassemblies flag
unsafe void NXOpen.Annotations.PartsListContentsBuilder.RemoveMember ( NXOpen.TaggedObject  member,
bool  removeSubassemblies 
)
inline

Removes member from parts list.

If 'Remove subassemblies flag' is true then child components of input assembly will also be removed from parts list. If 'Remove subassemblies flag' is false, then only input member will be removed from parts list.

Created in NX1847.0.0

License requirements: None.

Parameters
memberObject of the member to remove.
removeSubassembliesRemove subassemblies flag
unsafe bool NXOpen.Annotations.PartsListContentsBuilder.Validate ( )
inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Assemblies.ArrangementsBuilder NXOpen.Annotations.PartsListContentsBuilder.Arrangement
get

Returns the arrangement

Created in NX1899.0.0

License requirements: None.

unsafe bool NXOpen.Annotations.PartsListContentsBuilder.IncludeSubOrdinateDesignElements
getset

Returns or sets the Include Subordinate Design Elements for Parts list in 4GD mode

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListContentsBuilder.ScopeType NXOpen.Annotations.PartsListContentsBuilder.Scope
getset

Returns or sets the scope specifies the configuration type for parts list

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.PartsListContentsBuilder.TopLevelAssemblyType NXOpen.Annotations.PartsListContentsBuilder.TopLevelAssembly
getset

Returns or sets the top level assembly type for parts list

Created in NX1847.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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.