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

Provides basic data for BOM List. More...

Inheritance diagram for NXOpen.Tooling.BomListDataProvider:
NXOpen.TaggedObject NXOpen.ITableEditorDataProvider NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ExportedStatus { Null, Partial, All }
 Represents the exported status of a cell. More...
 

Public Member Functions

unsafe void Destroy ()
 Deletes the data provider. More...
 
unsafe bool GetBoolean (int row, int column)
 Gets the boolean data at a particular location in the table. More...
 
unsafe double GetDouble (int row, int column, out bool isUnassigned)
 Gets the double data at a particular location in the table. More...
 
unsafe int GetInteger (int row, int column, out bool isUnassigned)
 Gets the integer data at a particular location in the table. More...
 
unsafe string GetString (int row, int column)
 Gets the string data at a particular location in the table. More...
 
unsafe bool SetBoolean (int rows, int column, bool booleanData)
 Sets boolean data at a particular location in the table. More...
 
unsafe bool SetBoolean (int[] rows, int column, bool booleanData)
 Sets boolean data on a range of table cells in a specified column. More...
 
unsafe bool SetDouble (int rows, int column, double doubleData)
 Sets double data at a particular location in the table. More...
 
unsafe bool SetDouble (int[] rows, int column, double doubleData)
 Sets double data on a range of table cells in a specified column. More...
 
unsafe bool SetInteger (int rows, int column, int integerData)
 Sets integer data at a particular location in the table. More...
 
unsafe bool SetInteger (int[] rows, int column, int integerData)
 Sets integer data on a range of table cells in a specified column. More...
 
unsafe bool SetString (int rows, int column, string stringData)
 Sets string data at a particular location in the table. More...
 
unsafe bool SetString (int[] rows, int column, string stringData)
 Sets string data on a range of table cells in a specified column. More...
 
unsafe bool UnsetValue (int row, int column)
 Unsets the data at a particular location in the table. More...
 
unsafe bool UnsetValue (int[] rows, int column)
 Unsets the data on a range of table cells in a specified column. 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 int ColumnCount [get, set]
 Returns or sets the number of columns in the table More...
 
unsafe int RowCount [get, set]
 Returns or sets the number of rows in the table 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...
 
- Properties inherited from NXOpen.ITableEditorDataProvider
int ColumnCount [get, set]
 Returns or sets the number of columns in the table More...
 
int RowCount [get, set]
 Returns or sets the number of rows in the table More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Provides basic data for BOM List.

When Builder.Commit is called a null reference (Nothing in Visual Basic) will be returned.

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

Created in NX11.0.0

Member Enumeration Documentation

Represents the exported status of a cell.

Enumerator
Null 

No parts in the row are exported

Partial 

Partial parts in the row are exported

All 

All parts in the row are exported

Member Function Documentation

unsafe void NXOpen.Tooling.BomListDataProvider.Destroy ( )
inline

Deletes the data provider.

This method should always be called when the data provider is no longer needed.

Created in NX11.0.0

License requirements: None.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.GetBoolean ( int  row,
int  column 
)
inline

Gets the boolean data at a particular location in the table.

Created in NX11.0.0

License requirements: None.

Parameters
rowthe rows to query
columnthe column to query
Returns
the boolean data at the row and column specified

Implements NXOpen.ITableEditorDataProvider.

unsafe double NXOpen.Tooling.BomListDataProvider.GetDouble ( int  row,
int  column,
out bool  isUnassigned 
)
inline

Gets the double data at a particular location in the table.

Created in NX11.0.0

License requirements: None.

Parameters
rowthe rows to query
columnthe column to query
isUnassignedis the value unassigned
Returns
the double data at the row and column specified

Implements NXOpen.ITableEditorDataProvider.

unsafe int NXOpen.Tooling.BomListDataProvider.GetInteger ( int  row,
int  column,
out bool  isUnassigned 
)
inline

Gets the integer data at a particular location in the table.

Created in NX11.0.0

License requirements: None.

Parameters
rowthe rows to query
columnthe column to query
isUnassignedis the value unassigned
Returns
the integer data at the row and column specified

Implements NXOpen.ITableEditorDataProvider.

unsafe string NXOpen.Tooling.BomListDataProvider.GetString ( int  row,
int  column 
)
inline

Gets the string data at a particular location in the table.

Created in NX10.0.0

License requirements: None.

Parameters
rowthe rows to query
columnthe column to query
Returns
the string data at the row and column specified

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetBoolean ( int  rows,
int  column,
bool  booleanData 
)
inline

Sets boolean data at a particular location in the table.

Created in NX11.0.0

License requirements: None.

Parameters
rowsthe row to set
columnthe column to set
booleanDatathe boolean data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetBoolean ( int[]  rows,
int  column,
bool  booleanData 
)
inline

Sets boolean data on a range of table cells in a specified column.

Returns whether any data was successfully set.

Created in NX11.0.0

License requirements: None.

Parameters
rowsthe rows to set
columnthe column to be set
booleanDatathe boolean data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetDouble ( int  rows,
int  column,
double  doubleData 
)
inline

Sets double data at a particular location in the table.

Created in NX11.0.0

License requirements: None.

Parameters
rowsthe row to set
columnthe column to set
doubleDatathe double data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetDouble ( int[]  rows,
int  column,
double  doubleData 
)
inline

Sets double data on a range of table cells in a specified column.

Returns whether any data was successfully set.

Created in NX11.0.0

License requirements: None.

Parameters
rowsthe rows to set
columnthe column to be set
doubleDatathe double data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetInteger ( int  rows,
int  column,
int  integerData 
)
inline

Sets integer data at a particular location in the table.

Created in NX11.0.0

License requirements: None.

Parameters
rowsthe row to set
columnthe column to set
integerDatathe integer data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetInteger ( int[]  rows,
int  column,
int  integerData 
)
inline

Sets integer data on a range of table cells in a specified column.

Returns whether any data was successfully set.

Created in NX11.0.0

License requirements: None.

Parameters
rowsthe rows to set
columnthe column to be set
integerDatathe integer data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetString ( int  rows,
int  column,
string  stringData 
)
inline

Sets string data at a particular location in the table.

Created in NX10.0.0

License requirements: None.

Parameters
rowsthe row to set
columnthe column to set
stringDatathe string data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.SetString ( int[]  rows,
int  column,
string  stringData 
)
inline

Sets string data on a range of table cells in a specified column.

Returns whether any data was successfully set.

Created in NX10.0.0

License requirements: None.

Parameters
rowsthe rows to set
columnthe column to be set
stringDatathe string data to set
Returns
whether or not the data was successfully set.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.UnsetValue ( int  row,
int  column 
)
inline

Unsets the data at a particular location in the table.

Created in NX11.0.0

License requirements: None.

Parameters
rowthe row to unset
columnthe column to unset
Returns
whether or not the data was successfully unset.

Implements NXOpen.ITableEditorDataProvider.

unsafe bool NXOpen.Tooling.BomListDataProvider.UnsetValue ( int[]  rows,
int  column 
)
inline

Unsets the data on a range of table cells in a specified column.

Returns whether any data was successfully unset.

Created in NX11.0.0

License requirements: None.

Parameters
rowsthe rows to unset
columnthe column to be unset
Returns
whether or not the data was successfully unset.

Implements NXOpen.ITableEditorDataProvider.

Property Documentation

unsafe int NXOpen.Tooling.BomListDataProvider.ColumnCount
getset

Returns or sets the number of columns in the table

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Tooling.BomListDataProvider.RowCount
getset

Returns or sets the number of rows in the table

Created in NX10.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.