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

Represents a NXOpen.Tooling.BomListBuilder builder. More...

Inheritance diagram for NXOpen.Tooling.BomListBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  BomListTypes { BomList, HideList }
 Represents an index to components list type. More...
 
enum  BomListSortOption { Unsorted, Ascending, Descending }
 Represents an enumeration indicating whether the sorting needs to be performed in ascending or descending order. More...
 

Public Member Functions

unsafe void UpdateEwBlankAttributes ()
 Updates the blank attributes of electrodes in Electrode Design Application. More...
 
unsafe void ParseBomTemplate ()
 Parses the current BOM template. More...
 
unsafe void PopulateBomListData ()
 Populates BOM list data according to current template. More...
 
unsafe void AddBomData (NXOpen.Assemblies.Component[] partOccs, string[] dataStrings)
 Adds a new record into BOM list. More...
 
unsafe void ShowComponents (int rowID, NXOpen.Assemblies.Component[] partOccs)
 Shows the corresponding components of given row in the BOM List so that the components can be exported to spreadsheet. More...
 
unsafe void ShowRows (int[] rowIDs)
 Shows the given rows in the BOM List so that all the components of the rows can be exported to spreadsheet. More...
 
unsafe void IgnoreComponents (int rowID, NXOpen.Assemblies.Component[] partOccs)
 Ignores the corresponding components of given row in the Hide List so that the components can not be exported to spreadsheet. More...
 
unsafe void IgnoreRows (int[] rowIDs)
 Ignores the given rows in the Hide List so that all the components of the rows can not be exported to spreadsheet. More...
 
unsafe void SortColumn (int columnID, NXOpen.Tooling.BomListBuilder.BomListSortOption order)
 Sorts the given column. More...
 
unsafe NXOpen.DisplayableObject CreatePartsList (int[] columnWidths, NXOpen.Point3d point)
 Creates parts list for the assembly. More...
 
unsafe string GetColumnLabel (int columnID)
 Gets the column label. More...
 
unsafe string GetColumnAttribute (int columnID)
 Gets the corresponding attribute name of given column. More...
 
unsafe
NXOpen.Assemblies.Component[] 
GetPartOccs (int rowID)
 Gets the corresponding part occurrences of given row. More...
 
unsafe int[] GetRows (NXOpen.Tooling.BomListBuilder.BomListTypes bomListType)
 Gets all the row numbers in the given List More...
 
unsafe string[] GetAttributeStrings ()
 Gets all the attributes listed in the current template More...
 
unsafe void GetColumn (string attrString)
 Gets column number of given attribute More...
 
unsafe void ModifyBomData (int rowNumber, int columnNumber, string userString)
 Modifies BOM data More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe
NXOpen.Tooling.BomListDataProvider 
BomListDataProvider [get]
 Returns the data provider of BOM More...
 
unsafe
NXOpen.Tooling.BomListBuilder.BomListTypes 
BomListType [get, set]
 Returns or sets the tree list shows which kind of components should be included in More...
 
unsafe string BomTemplate [get, set]
 Returns or sets the template file of bom More...
 
unsafe
NXOpen.Assemblies.SelectComponentList 
SelectComponents [get]
 Returns the select component needed to get stocksize More...
 

Detailed Description

Represents a NXOpen.Tooling.BomListBuilder builder.

To create a new instance of this class, use NXOpen.Tooling.MoldwizardManager.CreateBomListBuilder

Default values.

Property Value

BomListType

BomList

Created in NX10.0.0

Member Enumeration Documentation

Represents an enumeration indicating whether the sorting needs to be performed in ascending or descending order.

Enumerator
Unsorted 

Unsorted

Ascending 

Ascending

Descending 

Descending

Represents an index to components list type.

Enumerator
BomList 

A list includes components in BOM

HideList 

A list includes hidden components

Member Function Documentation

unsafe void NXOpen.Tooling.BomListBuilder.AddBomData ( NXOpen.Assemblies.Component[]  partOccs,
string[]  dataStrings 
)

Adds a new record into BOM list.

Created in NX11.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
partOccsThe part occurrences to add into BOM. Sets NULL to add the current display part into BOM list.
dataStringsThe BOM data.
unsafe NXOpen.DisplayableObject NXOpen.Tooling.BomListBuilder.CreatePartsList ( int[]  columnWidths,
NXOpen.Point3d  point 
)

Creates parts list for the assembly.

Created in NX11.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
columnWidthsThe widths of each column.
pointThe position of parts list.
Returns
The created parts list.
unsafe string [] NXOpen.Tooling.BomListBuilder.GetAttributeStrings ( )

Gets all the attributes listed in the current template

Created in NX10.0.0

Deprecated in NX11.0.0. Use Tooling.BomListBuilder.GetColumnAttribute instead.

License requirements: None.

Returns
Attribute strings.
unsafe void NXOpen.Tooling.BomListBuilder.GetColumn ( string  attrString)

Gets column number of given attribute

Created in NX10.0.0

Deprecated in NX11.0.0. Use Tooling.BomListBuilder.GetColumnAttribute instead.

License requirements: None.

Parameters
attrString
unsafe string NXOpen.Tooling.BomListBuilder.GetColumnAttribute ( int  columnID)

Gets the corresponding attribute name of given column.

Created in NX11.0.0

License requirements: None.

Parameters
columnIDColumn index
Returns
Column attribute
unsafe string NXOpen.Tooling.BomListBuilder.GetColumnLabel ( int  columnID)

Gets the column label.

Created in NX11.0.0

License requirements: None.

Parameters
columnIDColumn index
Returns
Column Label
unsafe NXOpen.Assemblies.Component [] NXOpen.Tooling.BomListBuilder.GetPartOccs ( int  rowID)

Gets the corresponding part occurrences of given row.

Created in NX10.0.0

License requirements: None.

Parameters
rowID
Returns
The corresponding part occurrences of given row.
unsafe int [] NXOpen.Tooling.BomListBuilder.GetRows ( NXOpen.Tooling.BomListBuilder.BomListTypes  bomListType)

Gets all the row numbers in the given List

Created in NX10.0.0

Deprecated in NX11.0.0. Use Tooling.BomListDataProvider.RowCount instead.

License requirements: None.

Parameters
bomListType
Returns
All row numbers in the given list
unsafe void NXOpen.Tooling.BomListBuilder.IgnoreComponents ( int  rowID,
NXOpen.Assemblies.Component[]  partOccs 
)

Ignores the corresponding components of given row in the Hide List so that the components can not be exported to spreadsheet.

Created in NX10.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
rowID
partOccsThe part occurrences to be ignored in Hide List. Sets NULL to ignore all part occurrences in given row in Hide List.
unsafe void NXOpen.Tooling.BomListBuilder.IgnoreRows ( int[]  rowIDs)

Ignores the given rows in the Hide List so that all the components of the rows can not be exported to spreadsheet.

Created in NX11.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
rowIDs
unsafe void NXOpen.Tooling.BomListBuilder.ModifyBomData ( int  rowNumber,
int  columnNumber,
string  userString 
)

Modifies BOM data

Created in NX10.0.0

Deprecated in NX11.0.0. Use Tooling.BomListDataProvider.SetString instead.

License requirements: None.

Parameters
rowNumber
columnNumber
userString
unsafe void NXOpen.Tooling.BomListBuilder.ParseBomTemplate ( )

Parses the current BOM template.

Use this function to populate data in data provider of BOM.

Created in NX11.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

unsafe void NXOpen.Tooling.BomListBuilder.PopulateBomListData ( )

Populates BOM list data according to current template.

Created in NX10.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

unsafe void NXOpen.Tooling.BomListBuilder.ShowComponents ( int  rowID,
NXOpen.Assemblies.Component[]  partOccs 
)

Shows the corresponding components of given row in the BOM List so that the components can be exported to spreadsheet.

Created in NX10.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
rowID
partOccsThe part occurrences to be shown in BOM List. Sets NULL show all part occurrences in given row in BOM List.
unsafe void NXOpen.Tooling.BomListBuilder.ShowRows ( int[]  rowIDs)

Shows the given rows in the BOM List so that all the components of the rows can be exported to spreadsheet.

Created in NX11.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
rowIDs
unsafe void NXOpen.Tooling.BomListBuilder.SortColumn ( int  columnID,
NXOpen.Tooling.BomListBuilder.BomListSortOption  order 
)

Sorts the given column.

Created in NX11.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
columnID
order
unsafe void NXOpen.Tooling.BomListBuilder.UpdateEwBlankAttributes ( )

Updates the blank attributes of electrodes in Electrode Design Application.

Created in NX11.0.0

License requirements: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

Property Documentation

unsafe NXOpen.Tooling.BomListDataProvider NXOpen.Tooling.BomListBuilder.BomListDataProvider
get

Returns the data provider of BOM

Created in NX11.0.0

License requirements: None.

unsafe NXOpen.Tooling.BomListBuilder.BomListTypes NXOpen.Tooling.BomListBuilder.BomListType
getset

Returns or sets the tree list shows which kind of components should be included in

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

unsafe string NXOpen.Tooling.BomListBuilder.BomTemplate
getset

Returns or sets the template file of bom

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: ug_mold_design ("UG MOLD") OR nx_electrode_wizard ("NX Electrode Wizard") OR prog_die_wizard ("UG/Progressive Die Wizard")

unsafe NXOpen.Assemblies.SelectComponentList NXOpen.Tooling.BomListBuilder.SelectComponents
get

Returns the select component needed to get stocksize

Created in NX10.0.0

License requirements: None.


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