NXOpen.OpenXml.ImageDocumentData Class Reference

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

Inheritance diagram for NXOpen.OpenXml.ImageDocumentData:

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	GetCaption (out NXOpen.OpenXml.ImageDocumentData.CaptionPosition position)
	Gets the caption of the image data More...
unsafe string	GetFileName ()
	Gets the file name of the image data More...
unsafe void	SetCaption (NXOpen.OpenXml.ImageDocumentData.CaptionPosition position, string caption)
	Sets the caption of the image data More...
unsafe void	SetFileName (string fileName)
	Sets the file name 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...
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 image to be exported to the speific Open XML file.

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.OpenXml.ImageDocumentData.CaptionPosition

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 ( )

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.ImageDocumentData.GetCaption ( out NXOpen.OpenXml.ImageDocumentData.CaptionPosition  position )

inline

Gets the caption of the image data

Created in NX11.0.0

License requirements: None.

Parameters

position

Returns

unsafe string NXOpen.OpenXml.ImageDocumentData.GetFileName ( )

inline

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  )

inline

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 )

inline

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:

• OpenXml_ImageDocumentData.cs