NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Protected Member Functions | List of all members
NXOpen.OpenXml.TableDocumentData Class Reference

Represents the table to be exported to the speific Open XML file. More...

Inheritance diagram for NXOpen.OpenXml.TableDocumentData:
NXOpen.OpenXml.DocumentData NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Types

enum  CaptionPosition { Above, Bellow }
 the location of the caption for table data More...
 
- Public Types inherited from NXOpen.OpenXml.DocumentData
enum  Type {
  Base, Text, Table, TableCell,
  Image, ImageGroup, Group
}
 the document data type More...
 

Public Member Functions

unsafe NXOpen.OpenXml.TableCellData AddCellData (int[] grids)
 Creates a new NXOpen.OpenXml.TableCellData object. More...
 
unsafe string GetCaption (out NXOpen.OpenXml.TableDocumentData.CaptionPosition position)
 Gets the caption of the table data More...
 
unsafe int GetCellsCount ()
 Gets the number of table cells More...
 
unsafe int GetColumnCount ()
 Gets the column count of table data More...
 
unsafe double[] GetColumnWidths ()
 Gets the width array of the columns More...
 
unsafe NXOpen.OpenXml.TableCellData GetNthCell (int index)
 Gets the nth table cell data More...
 
unsafe int GetRowCount ()
 Gets the row count of table data More...
 
unsafe double[] GetRowHeigths ()
 Gets the height array of the rows More...
 
unsafe void SetCaption (NXOpen.OpenXml.TableDocumentData.CaptionPosition position, string caption)
 Sets the caption of the table data More...
 
unsafe void SetColumnWidths (double[] widths)
 Sets the width array of the columns More...
 
unsafe void SetRowHeigths (double[] heigths)
 Sets the height array of the rows More...
 
- Public Member Functions inherited from NXOpen.OpenXml.DocumentData
unsafe
NXOpen.OpenXml.DocumentData.Type 
GetDataType ()
 Gets a specified document data type More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Frees the object from memory. More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents the table to be exported to the speific Open XML file.

Created in NX11.0.0

Member Enumeration Documentation

the location of the caption for table data

Enumerator
Above 

the above position

Bellow 

the bellow position

Member Function Documentation

unsafe NXOpen.OpenXml.TableCellData NXOpen.OpenXml.TableDocumentData.AddCellData ( int[]  grids)
inline

Creates a new NXOpen.OpenXml.TableCellData object.

Does not to free this object, it will be free while deleting NXOpen.OpenXml.TableDocumentData object

Created in NX11.0.0

License requirements: None.

Parameters
gridsthe grid IDs to be mergered into the cell data
Returns
the table cell data
override void NXOpen.OpenXml.TableDocumentData.FreeResource ( )
inlineprotectedvirtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX11.0.0

License requirements: None.

Reimplemented from NXOpen.OpenXml.DocumentData.

unsafe string NXOpen.OpenXml.TableDocumentData.GetCaption ( out NXOpen.OpenXml.TableDocumentData.CaptionPosition  position)
inline

Gets the caption of the table data

Created in NX11.0.0

License requirements: None.

Parameters
position
Returns
unsafe int NXOpen.OpenXml.TableDocumentData.GetCellsCount ( )
inline

Gets the number of table cells

Created in NX11.0.0

License requirements: None.

Returns
number of table cells
unsafe int NXOpen.OpenXml.TableDocumentData.GetColumnCount ( )
inline

Gets the column count of table data

Created in NX11.0.0

License requirements: None.

Returns
unsafe double [] NXOpen.OpenXml.TableDocumentData.GetColumnWidths ( )
inline

Gets the width array of the columns

Created in NX11.0.0

License requirements: None.

Returns
the column width array
unsafe NXOpen.OpenXml.TableCellData NXOpen.OpenXml.TableDocumentData.GetNthCell ( int  index)
inline

Gets the nth table cell data

Created in NX11.0.0

License requirements: None.

Parameters
indexthe index of table cell data
Returns
the table cell data
unsafe int NXOpen.OpenXml.TableDocumentData.GetRowCount ( )
inline

Gets the row count of table data

Created in NX11.0.0

License requirements: None.

Returns
unsafe double [] NXOpen.OpenXml.TableDocumentData.GetRowHeigths ( )
inline

Gets the height array of the rows

Created in NX11.0.0

License requirements: None.

Returns
the column width array
unsafe void NXOpen.OpenXml.TableDocumentData.SetCaption ( NXOpen.OpenXml.TableDocumentData.CaptionPosition  position,
string  caption 
)
inline

Sets the caption of the table data

Created in NX11.0.0

License requirements: None.

Parameters
position
caption
unsafe void NXOpen.OpenXml.TableDocumentData.SetColumnWidths ( double[]  widths)
inline

Sets the width array of the columns

Created in NX11.0.0

License requirements: None.

Parameters
widthsthe column width array
unsafe void NXOpen.OpenXml.TableDocumentData.SetRowHeigths ( double[]  heigths)
inline

Sets the height array of the rows

Created in NX11.0.0

License requirements: None.

Parameters
heigthsthe column width array

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