NXOpen.AttributeIterator Class Reference

This class is used to iterate over the user attributes of an object, with options to restrict or extend such searches More...

Inheritance diagram for NXOpen.AttributeIterator:

Public Member Functions
unsafe void	Reset ()
	Rewind the iterator and return all its constraints to their default values. More...
unsafe void	Rewind ()
	Rewind the iterator. More...
unsafe void	SetIncludeAllCategories ()
	Do not restrict searches to attributes with a previously given category. More...
unsafe void	SetIncludeAlsoUnset (bool includeAlsoUnset)
	Widen (or cancel the widening of) searches to attributes that have not been set, but for which the object has associated templates. More...
unsafe void	SetIncludeOnlyArrays (bool includeOnlyArrays)
	Restricts searches to array attributes. More...
unsafe void	SetIncludeOnlyCategory (string category)
	Restrict searches to attributes with the given category. More...
unsafe void	SetIncludeOnlyTitle (string title)
	Restrict searches to attributes with the given title. More...
unsafe void	SetIncludeOnlyType (NXOpen.NXObject.AttributeType type)
	Restrict searches to attributes with the given type. More...
unsafe void	SetIncludeOnlyUnset (bool includeOnlyUnset)
	Restricts (or cancel the restriction of) searches to attributes that have not been set, but for which the object has associated templates. 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 ()
	Delete the iterator More...

Additional Inherited Members
Properties inherited from NXOpen.TransientObject
IntPtr	Handle [get]
	Handle of the internal object represented by this object. More...

Detailed Description

This class is used to iterate over the user attributes of an object, with options to restrict or extend such searches

Created in NX11.0.0

Member Function Documentation

override void NXOpen.AttributeIterator.FreeResource ( )

inlineprotectedvirtual

Delete the iterator

Created in NX11.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe void NXOpen.AttributeIterator.Reset ( )

inline

Rewind the iterator and return all its constraints to their default values.

This allows the iterator to be safely reused.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.AttributeIterator.Rewind ( )

inline

Rewind the iterator.

This allows the iterator to be reused with the same constraints.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.AttributeIterator.SetIncludeAllCategories ( )

inline

Do not restrict searches to attributes with a previously given category.

Note: If this function will allow the iterator to return attributes with any or no category. It can be use to cancel a previous restriction to, for example, attributes with no category.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.AttributeIterator.SetIncludeAlsoUnset ( bool  includeAlsoUnset )

inline

Widen (or cancel the widening of) searches to attributes that have not been set, but for which the object has associated templates.

Default: Unset attributes (not being there) are not included. Note: 'unset' attributes are really attribute templates that the object has access to, but the object has no corresponding attributes.

Created in NX11.0.0

License requirements: None.

Parameters

includeAlsoUnset

unsafe void NXOpen.AttributeIterator.SetIncludeOnlyArrays ( bool  includeOnlyArrays )

inline

Restricts searches to array attributes.

NOTE: Array attributes with no or just one element are included unless otherwise excluded. . Default: no constraint.

Created in NX11.0.0

License requirements: None.

Parameters

includeOnlyArrays

unsafe void NXOpen.AttributeIterator.SetIncludeOnlyCategory ( string  category )

inline

Restrict searches to attributes with the given category.

Note: If this function is called with a NULL or empty category, then the search is restricted to attributes that have no assigned category To cancel this restriction, use SetIncludeAllCategories. . Default: no constraint.

Created in NX11.0.0

License requirements: None.

Parameters

category

The desired category of the returned attributes

unsafe void NXOpen.AttributeIterator.SetIncludeOnlyTitle ( string  title )

inline

Restrict searches to attributes with the given title.

Note: If this function is called with a NULL or empty title, then iterator will no longer be restricted to a given title. . Default: no constraint.

Created in NX11.0.0

License requirements: None.

Parameters

title

The desired title of the returned attributes

unsafe void NXOpen.AttributeIterator.SetIncludeOnlyType ( NXOpen.NXObject.AttributeType  type )

inline

Restrict searches to attributes with the given type.

Default: no constraint.

Created in NX11.0.0

License requirements: None.

Parameters

type	The desired type of the returned attributes (if not NXOpen.NXObject.AttributeType.Any )

unsafe void NXOpen.AttributeIterator.SetIncludeOnlyUnset ( bool  includeOnlyUnset )

inline

Restricts (or cancel the restriction of) searches to attributes that have not been set, but for which the object has associated templates.

Default: no constraint.

Created in NX11.0.0

License requirements: None.

Parameters

includeOnlyUnset

---

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

• AttributeIterator.cs