NXOpen .NET Reference  12.0.0
Public Types | Properties | List of all members
NXOpen.GroupBuilder Class Reference

Represents a NXOpen.GroupBuilder More...

Inheritance diagram for NXOpen.GroupBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  Action {
  NewGroup, AddToGroup, RemoveFromGroup, Ungroup,
  EditGroup, NewSketchGroup
}
 Represents the type of action for this builder to perform. More...
 
enum  SketchType { Regular, Unique, Rigid, Scalable }
 Represents the type of sketch group to be created. More...
 
enum  UngroupOption { Top, Full }
 Represents the option to control the behavior when deleting a group. More...
 

Properties

unsafe int ActionType [get, set]
 Returns or sets the action type for this builder to perform. More...
 
unsafe bool ActivegroupOption [get, set]
 Returns or sets the activegroup option is for sketch group as active group in Direct Sketch, Sketch Task Environment or in Drafting Sketch. More...
 
unsafe bool GroupDisplayProperties [get, set]
 Returns or sets the group display option More...
 
unsafe NXOpen.SelectGroup GroupInAction [get]
 Returns the group in action More...
 
unsafe string GroupName [get, set]
 Returns or sets the group name More...
 
unsafe NXOpen.SelectObjectList ObjectsInGroup [get]
 Returns the objects in group More...
 
unsafe NXOpen.NXObject OwningObject [get, set]
 Returns or sets the owning object ie sketch object which currently has to be a sketch More...
 
unsafe
NXOpen.GroupBuilder.SketchType 
SketchGroupType [get, set]
 Returns or sets the type of sketch group that gets created More...
 
unsafe
NXOpen.GroupBuilder.UngroupOption 
UngroupLevel [get, set]
 Returns or sets the ungroup level More...
 
unsafe bool UniqueMembershipOption [get, set]
 Returns or sets the unique membership option ie umg option More...
 

Additional Inherited Members

- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Detailed Description

Represents a NXOpen.GroupBuilder

To create a new instance of this class, use NXOpen.BasePart.CreateGatewayGroupBuilder

Default values.

Property Value

ActionType

0

GroupDisplayProperties

true

Created in NX5.0.0

Member Enumeration Documentation

Represents the type of action for this builder to perform.

Enumerator
NewGroup 

Create New group in Modeling or Drafting

AddToGroup 

Add members to existing group in Modeling

RemoveFromGroup 

Remove members of existing group in Modeling

Ungroup 

Delete a group in Modeling or in Sketcher

EditGroup 

Edit a group in Modeling or in Sketcher

NewSketchGroup 

Create New sketch group in Direct Sketch, the Sketch Task Environment, or in Drafting Sketch

Represents the type of sketch group to be created.

Enumerator
Regular 

Regular sketch group that can contain any sketch curve or dimension

Unique 

A regular sketch group whose members cannot be members of any other sketch group

Rigid 

A sketch group which corresponds to a Rigid Sketch constraint

Scalable 

A sketch group which corresponds to a Scalable Sketch constraint

Represents the option to control the behavior when deleting a group.

Enumerator
Top 

Delete a group

Full 

Delete a group recursively

Property Documentation

unsafe int NXOpen.GroupBuilder.ActionType
getset

Returns or sets the action type for this builder to perform.

  • 0 signifies Create New group in Modeling or Drafting
  • 1 signifies Add members to existing group in Modeling
  • 2 signifies Remove members of existing group in Modeling
  • 3 signifies Delete a group in Modeling or in Sketcher
  • 4 signifies Edit a group in Modeling or in Sketcher
  • 5 signifies Create New sketch group in Direct Sketch, the Sketch Task Environment, or in Drafting Sketch

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GroupBuilder.ActivegroupOption
getset

Returns or sets the activegroup option is for sketch group as active group in Direct Sketch, Sketch Task Environment or in Drafting Sketch.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GroupBuilder.GroupDisplayProperties
getset

Returns or sets the group display option

Created in NX7.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.SelectGroup NXOpen.GroupBuilder.GroupInAction
get

Returns the group in action

Created in NX5.0.0

License requirements: None.

unsafe string NXOpen.GroupBuilder.GroupName
getset

Returns or sets the group name

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.SelectObjectList NXOpen.GroupBuilder.ObjectsInGroup
get

Returns the objects in group

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.NXObject NXOpen.GroupBuilder.OwningObject
getset

Returns or sets the owning object ie sketch object which currently has to be a sketch

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GroupBuilder.SketchType NXOpen.GroupBuilder.SketchGroupType
getset

Returns or sets the type of sketch group that gets created

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GroupBuilder.UngroupOption NXOpen.GroupBuilder.UngroupLevel
getset

Returns or sets the ungroup level

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.GroupBuilder.UniqueMembershipOption
getset

Returns or sets the unique membership option ie umg option

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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