DocumentDataGroup Class¶
-
class
NXOpen.OpenXml.
DocumentDataGroup
¶ Bases:
NXOpen.OpenXml.DocumentData
Contains methods for adding document data for CAE Report.
New in version NX11.0.0.
Methods¶
Method | Description |
---|---|
AddImageGroup | Creates a new NXOpen.OpenXml.ImageGroupDocumentData object. |
AddTable | Creates a new NXOpen.OpenXml.TableDocumentData object. |
AddText | Creates a new NXOpen.OpenXml.TextDocumentData object. |
DeleteAllData | Deletes all document data |
DeleteNthData | Deletes the nth document data |
Dispose | Frees the object from memory. |
GetDataCount | Gets the number of data to be exported @return the number of data |
GetDataType | Gets a specified document data type @return the data type defined by the NXOpen.OpenXml.DocumentDataType |
GetNthData | Gets the nth document data object. |
Method Detail¶
AddImageGroup¶
-
DocumentDataGroup.
AddImageGroup
¶ Creates a new
NXOpen.OpenXml.ImageGroupDocumentData
object.Does not to free this object, it will be free while deleting
NXOpen.OpenXml.DocumentDataGroup
objectSignature
AddImageGroup()
Returns: the image group data Return type: NXOpen.OpenXml.ImageGroupDocumentData
New in version NX11.0.0.
License requirements: None.
AddTable¶
-
DocumentDataGroup.
AddTable
¶ Creates a new
NXOpen.OpenXml.TableDocumentData
object.Does not to free this object, it will be free while deleting
NXOpen.OpenXml.DocumentDataGroup
objectSignature
AddTable(columnCount, rowCount)
Parameters: - columnCount (int) – the column size of the table
- rowCount (int) – the row size of the table
Returns: the table data
Return type: New in version NX11.0.0.
License requirements: None.
AddText¶
-
DocumentDataGroup.
AddText
¶ Creates a new
NXOpen.OpenXml.TextDocumentData
object.Does not to free this object, it will be free while deleting
NXOpen.OpenXml.DocumentDataGroup
objectSignature
AddText(textContent)
Parameters: textContent (str) – the content of the text data Returns: the text data Return type: NXOpen.OpenXml.TextDocumentData
New in version NX11.0.0.
License requirements: None.
DeleteAllData¶
-
DocumentDataGroup.
DeleteAllData
¶ Deletes all document data
Signature
DeleteAllData()
New in version NX11.0.0.
License requirements: None.
DeleteNthData¶
-
DocumentDataGroup.
DeleteNthData
¶ Deletes the nth document data
Signature
DeleteNthData(index)
Parameters: index (int) – the index of data New in version NX11.0.0.
License requirements: None.
Dispose¶
-
DocumentDataGroup.
Dispose
¶ 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.
Signature
Dispose()
New in version NX11.0.0.
License requirements: None.
GetDataCount¶
-
DocumentDataGroup.
GetDataCount
¶ Gets the number of data to be exported
Signature
GetDataCount()
Returns: the number of data Return type: int New in version NX11.0.0.
License requirements: None.
GetNthData¶
-
DocumentDataGroup.
GetNthData
¶ Gets the nth document data object.
Does not to free this object, it will be free while deleting
NXOpen.OpenXml.DocumentDataGroup
objectSignature
GetNthData(index)
Parameters: index (int) – the index of data Returns: the data Return type: NXOpen.OpenXml.DocumentData
New in version NX11.0.0.
License requirements: None.