NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
NXOpen.OpenXml.ImageDocumentData Class Reference

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

Inheritance diagram for NXOpen.OpenXml.ImageDocumentData:
NXOpen.OpenXml.DocumentData

Public Types

enum  CaptionPosition { Above, Bellow }
 the location of the caption for image 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 string GetFileName ()
 Gets the file name of the image data More...
 
unsafe void SetFileName (string fileName)
 Sets the file name of the image data More...
 
unsafe string GetCaption (out NXOpen.OpenXml.ImageDocumentData.CaptionPosition position)
 Gets the caption of the image data More...
 
unsafe void SetCaption (NXOpen.OpenXml.ImageDocumentData.CaptionPosition position, string caption)
 Sets the caption of the image data More...
 
- Public Member Functions inherited from NXOpen.OpenXml.DocumentData
unsafe
NXOpen.OpenXml.DocumentData.Type 
GetDataType ()
 Gets a specified document data type More...
 

Protected Member Functions

override void FreeResource ()
 Frees the object from memory. More...
 
- Protected Member Functions inherited from NXOpen.OpenXml.DocumentData
override void FreeResource ()
 Frees the object from memory. More...
 

Detailed Description

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

Created in NX11.0.0

Member Enumeration Documentation

the location of the caption for image data

Enumerator
Above 

the above position

Bellow 

the bellow position

Member Function Documentation

override void NXOpen.OpenXml.ImageDocumentData.FreeResource ( )
protected

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.

unsafe string NXOpen.OpenXml.ImageDocumentData.GetCaption ( out NXOpen.OpenXml.ImageDocumentData.CaptionPosition  position)

Gets the caption of the image data

Created in NX11.0.0

License requirements: None.

Parameters
position
Returns
unsafe string NXOpen.OpenXml.ImageDocumentData.GetFileName ( )

Gets the file name of the image data

Created in NX11.0.0

License requirements: None.

Returns
unsafe void NXOpen.OpenXml.ImageDocumentData.SetCaption ( NXOpen.OpenXml.ImageDocumentData.CaptionPosition  position,
string  caption 
)

Sets the caption of the image data

Created in NX11.0.0

License requirements: None.

Parameters
position
caption
unsafe void NXOpen.OpenXml.ImageDocumentData.SetFileName ( string  fileName)

Sets the file name of the image data

Created in NX11.0.0

License requirements: None.

Parameters
fileName

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