NXOpen.Display.ImageCollection Class Reference

Represents a collection of image objects More...

Inheritance diagram for NXOpen.Display.ImageCollection:

Public Member Functions
unsafe NXOpen.Display.RasterImageBuilder	CreateRasterImageBuilder (NXOpen.Display.RasterImage image)
	Creates a NXOpen.Display.RasterImageBuilder object used to build an image. More...
unsafe NXOpen.Display.ImageBase	FindObject (string journalIdentifier)
	Finds the NXOpen.Display.ImageBase with the given identifier as recorded in a journal. More...
NXOpen.Display.ImageBase[]	ToArray ()
	Returns an array of NXOpen.Display.ImageBase objects. More...
Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator	GetEnumerator ()
	Returns an enumerator that iterates through a collection. 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 int	EnumerateMoveNext (ref Tag currentTag, byte[] state)
	Advances the enumerator to the next element of the collection. More...
Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void	initialize ()
	<exclude> More...
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Properties
Tag	Tag [get]
	Returns the tag of this object. More...

Detailed Description

Represents a collection of image objects

To obtain an instance of this class, refer to NXOpen.BasePart

Created in NX9.0.0

Member Function Documentation

unsafe NXOpen.Display.RasterImageBuilder NXOpen.Display.ImageCollection.CreateRasterImageBuilder ( NXOpen.Display.RasterImage  image )

inline

Creates a NXOpen.Display.RasterImageBuilder object used to build an image.

If the image is not a null reference (Nothing in Visual Basic), the image object will be edited.

Created in NX9.0.0

License requirements: None.

Parameters

image

If image is not a null reference (Nothing in Visual Basic), this object will be edited

Returns

raster image builder

override int NXOpen.Display.ImageCollection.EnumerateMoveNext ( ref Tag  currentTag, byte[]  state  )

inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.Display.ImageBase NXOpen.Display.ImageCollection.FindObject ( string  journalIdentifier )

inline

Finds the NXOpen.Display.ImageBase with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general,this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Created in NX9.0.0

License requirements: None.

Parameters

journalIdentifier

Identifier to be found

Returns

Image found

NXOpen.Display.ImageBase [] NXOpen.Display.ImageCollection.ToArray ( )

inline

Returns an array of NXOpen.Display.ImageBase objects.

Property Documentation

Tag NXOpen.Display.ImageCollection.Tag

get

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• Display_ImageCollection.cs