NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.ExpressionGroupCollection Class Reference

Represents a collection of expressions groups. More...

Inheritance diagram for NXOpen.ExpressionGroupCollection:

Public Member Functions

NXOpen.ExpressionGroup[] ToArray ()
 Returns an array of NXOpen.ExpressionGroup objects. More...
 
unsafe NXOpen.ExpressionGroup Create (string name)
 Creates an expression group More...
 
unsafe void Rename (NXOpen.ExpressionGroup expressionGroup, string newName)
 Changes the name of the expression group. More...
 
unsafe NXOpen.ExpressionGroup FindObject (string journalIdentifier)
 Finds the NXOpen.ExpressionGroup with the given identifier as recorded in a journal. More...
 
unsafe void Delete (NXOpen.ExpressionGroup[] expressionGroup)
 Deletes an array of one or more expression groups. More...
 
unsafe NXOpen.ExpressionGroup GetGroupOfExpression (NXOpen.Expression expression)
 Returns expression group "owner" of an expression. More...
 
unsafe void SetAllGroupsVisible ()
 Make all expression groups visible More...
 
unsafe NXOpen.ExpressionGroup GetDefault ()
 Return the default expression group More...
 
unsafe NXOpen.ExpressionGroup[] GetAllExpressionGroupsInPart ()
 Returns an array of all expression groups in a part . More...
 
unsafe bool CheckName (string name)
 Returns whether or not expression group name is valid. More...
 
unsafe void ExportExpressionGroupsToFile (NXOpen.ExpressionGroup[] expressionGroups, string fileName, NXOpen.ExpressionCollection.SortType sortType)
 Exports the expressions in an expression group to a text file, or, if 'file_name' is a null reference (Nothing in Visual Basic), list the expressions in the listing window. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
unsafe NXOpen.ExpressionGroup Active [get, set]
 Returns or sets the active expression group More...
 

Detailed Description

Represents a collection of expressions groups.

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

Created in NX10.0.0

Member Function Documentation

unsafe bool NXOpen.ExpressionGroupCollection.CheckName ( string  name)

Returns whether or not expression group name is valid.

Created in NX10.0.0

License requirements: None.

Parameters
namethe name of the expression group to check.
Returns
the status of the name check. True if name is okay
unsafe NXOpen.ExpressionGroup NXOpen.ExpressionGroupCollection.Create ( string  name)

Creates an expression group

Created in NX10.0.0

License requirements: None.

Parameters
namethe name for the expression group.
Returns
the new expression group
unsafe void NXOpen.ExpressionGroupCollection.Delete ( NXOpen.ExpressionGroup[]  expressionGroup)

Deletes an array of one or more expression groups.

This method should be used when deleting an Expression group. DO NOT use the delete methods in Update.ja to delete expression groups

Created in NX10.0.0

License requirements: None.

Parameters
expressionGrouparray of expression groups to delete
override int NXOpen.ExpressionGroupCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
protected

Advances the enumerator to the next element of the collection.

unsafe void NXOpen.ExpressionGroupCollection.ExportExpressionGroupsToFile ( NXOpen.ExpressionGroup[]  expressionGroups,
string  fileName,
NXOpen.ExpressionCollection.SortType  sortType 
)

Exports the expressions in an expression group to a text file, or, if 'file_name' is a null reference (Nothing in Visual Basic), list the expressions in the listing window.

Throws an exception if there is any error.

NOTE: if the file already exists, an exception is thrown and the file is not overwritten.

Created in NX10.0.0

License requirements: None.

Parameters
expressionGroups
fileNameFile name specification to export expressions into.
sortTypeHow to sort the exported expressions
unsafe NXOpen.ExpressionGroup NXOpen.ExpressionGroupCollection.FindObject ( string  journalIdentifier)

Finds the NXOpen.ExpressionGroup 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 NX10.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier to be found
Returns
Expression found
unsafe NXOpen.ExpressionGroup [] NXOpen.ExpressionGroupCollection.GetAllExpressionGroupsInPart ( )

Returns an array of all expression groups in a part .

Created in NX10.0.0

License requirements: None.

Returns
array of groupsexpression groups
unsafe NXOpen.ExpressionGroup NXOpen.ExpressionGroupCollection.GetDefault ( )

Return the default expression group

Created in NX10.0.0

License requirements: None.

Returns
the default expression group
unsafe NXOpen.ExpressionGroup NXOpen.ExpressionGroupCollection.GetGroupOfExpression ( NXOpen.Expression  expression)

Returns expression group "owner" of an expression.

Created in NX10.0.0

License requirements: None.

Parameters
expressionthe expression to query
Returns
expression group of expression
unsafe void NXOpen.ExpressionGroupCollection.Rename ( NXOpen.ExpressionGroup  expressionGroup,
string  newName 
)

Changes the name of the expression group.

Created in NX11.0.0

License requirements: None.

Parameters
expressionGroupexpression group to be renamed
newNamenew name of the expression group
unsafe void NXOpen.ExpressionGroupCollection.SetAllGroupsVisible ( )

Make all expression groups visible

Created in NX10.0.0

License requirements: None.

NXOpen.ExpressionGroup [] NXOpen.ExpressionGroupCollection.ToArray ( )

Returns an array of NXOpen.ExpressionGroup objects.

Property Documentation

unsafe NXOpen.ExpressionGroup NXOpen.ExpressionGroupCollection.Active
getset

Returns or sets the active expression group

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.ExpressionGroupCollection.Tag
get

Returns the tag of this object.


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