NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | List of all members
NXOpen.Report.ResultXmlFileWriter Class Reference

Contains methods for adding document data and generating result XML file for CAE Report. More...

Inheritance diagram for NXOpen.Report.ResultXmlFileWriter:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe
NXOpen.OpenXml.ImageGroupDocumentData 
AddImageGroup ()
 Creates a new NXOpen.OpenXml.ImageGroupDocumentData object. More...
 
unsafe
NXOpen.OpenXml.TableDocumentData 
AddTable (int columnSize, int rowSize)
 Creates a new NXOpen.OpenXml.TableDocumentData object. More...
 
unsafe
NXOpen.OpenXml.TextDocumentData 
AddText (string textContent)
 Creates a new NXOpen.OpenXml.TextDocumentData object. More...
 
unsafe void DeleteAllData ()
 Removes all document data More...
 
unsafe void DeleteNthData (int index)
 Removes the nth document data More...
 
unsafe int GetDataCount ()
 Gets the number of data to be exported More...
 
unsafe NXOpen.OpenXml.DocumentData GetNthData (int index)
 Gets the nth document data object. More...
 
unsafe void SaveToFile (string fileName)
 Exports all document data to result XML file 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

Contains methods for adding document data and generating result XML file for CAE Report.

Created in NX11.0.0

Member Function Documentation

unsafe NXOpen.OpenXml.ImageGroupDocumentData NXOpen.Report.ResultXmlFileWriter.AddImageGroup ( )
inline

Creates a new NXOpen.OpenXml.ImageGroupDocumentData object.

Does not to free this object, it will be free while deleting NXOpen.Report.ResultXmlFileWriter object

Created in NX11.0.0

License requirements: None.

Returns
the image group data
unsafe NXOpen.OpenXml.TableDocumentData NXOpen.Report.ResultXmlFileWriter.AddTable ( int  columnSize,
int  rowSize 
)
inline

Creates a new NXOpen.OpenXml.TableDocumentData object.

Does not to free this object, it will be free while deleting NXOpen.Report.ResultXmlFileWriter object

Created in NX11.0.0

License requirements: None.

Parameters
columnSizethe column size of the table
rowSizethe row size of the table
Returns
the table data
unsafe NXOpen.OpenXml.TextDocumentData NXOpen.Report.ResultXmlFileWriter.AddText ( string  textContent)
inline

Creates a new NXOpen.OpenXml.TextDocumentData object.

Does not to free this object, it will be free while deleting NXOpen.Report.ResultXmlFileWriter object

Created in NX11.0.0

License requirements: None.

Parameters
textContentthe content of the text data
Returns
the text data
unsafe void NXOpen.Report.ResultXmlFileWriter.DeleteAllData ( )
inline

Removes all document data

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.Report.ResultXmlFileWriter.DeleteNthData ( int  index)
inline

Removes the nth document data

Created in NX11.0.0

License requirements: None.

Parameters
indexthe index of data
override void NXOpen.Report.ResultXmlFileWriter.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.

Implements NXOpen.TransientObject.

unsafe int NXOpen.Report.ResultXmlFileWriter.GetDataCount ( )
inline

Gets the number of data to be exported

Created in NX11.0.0

License requirements: None.

Returns
the number of data
unsafe NXOpen.OpenXml.DocumentData NXOpen.Report.ResultXmlFileWriter.GetNthData ( int  index)
inline

Gets the nth document data object.

Does not to free this object, it will be free while deleting NXOpen.Report.ResultXmlFileWriter object

Created in NX11.0.0

License requirements: None.

Parameters
indexthe index of data
Returns
the data
unsafe void NXOpen.Report.ResultXmlFileWriter.SaveToFile ( string  fileName)
inline

Exports all document data to result XML file

Created in NX11.0.0

License requirements: None.

Parameters
fileNamethe file name to be exported

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