NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.BlockStyler.SelectObject Class Reference

Represents a Select Object block More...

Inheritance diagram for NXOpen.BlockStyler.SelectObject:
NXOpen.BlockStyler.UIBlock NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  FilterType {
  Features = 1, Faces, Edges = 4, CurvesAndEdges = 8,
  Components = 16, SolidBodies = 32, SheetBodies = 64
}
 Indicates the general filter type for selection. More...
 

Public Member Functions

unsafe void AddFilter (int filterTypes)
 Adds the filters for select object block More...
 
unsafe void AddFilter (NXOpen.BlockStyler.SelectObject.FilterType filterTypes)
 Adds the filters for select object block More...
 
unsafe void AddFilter (int type, int subType, int solidBodyType)
 Adds the filter for select object block using type, subtype and solidBodyType More...
 
unsafe string[] GetBalloonTooltipLayoutMembers ()
 Gets the BalloonTooltipLayout members More...
 
unsafe string[] GetInterpartSelectionMembers ()
 Gets the InterpartSelection members More...
 
unsafe NXOpen.TaggedObject[] GetLastDeselectedObjects ()
 Gets the LastDeselectedObjects More...
 
unsafe NXOpen.TaggedObject[] GetLastSelectedObjects ()
 Gets the LastSelectedObjects More...
 
unsafe string[] GetMaximumScopeMembers ()
 Gets the MaximumScope members More...
 
unsafe NXOpen.TaggedObject[] GetSelectedObjects ()
 Gets the SelectedObjects More...
 
unsafe string[] GetSelectModeMembers ()
 Gets the SelectMode members More...
 
unsafe string[] GetStepStatusMembers ()
 Gets the StepStatus members More...
 
unsafe void ResetFilter ()
 Resets the filter for select object block More...
 
unsafe void SetSelectedObjects (NXOpen.TaggedObject[] objectVector)
 Sets the SelectedObjects More...
 
unsafe void SetSelectionFilter (NXOpen.Selection.SelectionAction maskAction, NXOpen.Selection.MaskTriple[] maskTriples)
 Sets the SelectionFilter More...
 
- Public Member Functions inherited from NXOpen.BlockStyler.UIBlock
unsafe void Focus ()
 Focuses on the block. More...
 
unsafe
NXOpen.BlockStyler.PropertyList 
GetProperties ()
 Returns the properties of the block More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override 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...
 

Properties

unsafe bool AllowConvergentObject [get, set]
 Returns or sets the AllowConvergentObject More...
 
unsafe bool AutomaticProgression [get, set]
 Returns or sets the AutomaticProgression More...
 
unsafe string BalloonTooltipImage [get, set]
 Returns or sets the BalloonTooltipImage More...
 
unsafe string BalloonTooltipLayoutAsString [get, set]
 Returns or sets the BalloonTooltipLayout as string More...
 
unsafe string BalloonTooltipText [get, set]
 Returns or sets the BalloonTooltipText More...
 
unsafe string Bitmap [get, set]
 Returns or sets the Bitmap More...
 
unsafe bool BlendVirtualCurveOverlay [get, set]
 Returns or sets the BlendVirtualCurveOverlay. More...
 
unsafe bool CreateInterpartLink [get, set]
 Returns or sets the CreateInterpartLink More...
 
unsafe string Cue [get, set]
 Returns or sets the Cue More...
 
unsafe string InterpartSelectionAsString [get, set]
 Returns or sets the InterpartSelection as string More...
 
unsafe string LabelString [get, set]
 Returns or sets the LabelString More...
 
unsafe string MaximumScopeAsString [get, set]
 Returns or sets the MaximumScope as string More...
 
unsafe NXOpen.Point3d PickPoint [get]
 Returns the PickPoint More...
 
unsafe bool PointOverlay [get, set]
 Returns or sets the PointOverlay. More...
 
unsafe string SelectModeAsString [get, set]
 Returns or sets the SelectMode as string More...
 
unsafe string SmartUpdateOptionAsString [get, set]
 Returns or sets the update option for points created by the point overlay. More...
 
unsafe int SnapPointTypesEnabled [get, set]
 Returns or sets the SnapPointTypesEnabled More...
 
unsafe int SnapPointTypesOnByDefault [get, set]
 Returns or sets the SnapPointTypesOnByDefault More...
 
unsafe string StepStatusAsString [get, set]
 Returns or sets the StepStatus as string More...
 
unsafe string ToolTip [get, set]
 Returns or sets the ToolTip More...
 
- Properties inherited from NXOpen.BlockStyler.UIBlock
unsafe bool Enable [get, set]
 Returns or sets the Enable. More...
 
unsafe bool Expanded [get, set]
 Returns or sets the Expanded More...
 
unsafe bool Group [get, set]
 Returns or sets the Group More...
 
unsafe string Label [get, set]
 Returns or sets the Label More...
 
unsafe string Name [get]
 Returns the name of the block or BlockID More...
 
unsafe bool Show [get, set]
 Returns or sets the Visibility of block. More...
 
unsafe string Type [get]
 Returns the type of block More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a Select Object block

Created in NX8.5.0

Member Enumeration Documentation

Indicates the general filter type for selection.

Enumerator
Features 

Filter to select all feature types

Faces 

Filter to select all face types

Edges 

Filter to select all edge types

CurvesAndEdges 

Filter to select all curve and edge types

Components 

Filter to select all components

SolidBodies 

Filter to select all solid bodies

SheetBodies 

Filter to select all sheet bodies

Member Function Documentation

unsafe void NXOpen.BlockStyler.SelectObject.AddFilter ( int  filterTypes)
inline

Adds the filters for select object block

This method takes the integer value of the desired enum values from NXOpen.BlockStyler.SelectObject.FilterType .

Created in NX8.5.0

License requirements: None.

Parameters
filterTypesValues from SelectObject.FilterType for specifying filters
unsafe void NXOpen.BlockStyler.SelectObject.AddFilter ( NXOpen.BlockStyler.SelectObject.FilterType  filterTypes)
inline

Adds the filters for select object block

This method takes the desired enumeration value from NXOpen.BlockStyler.SelectObject.FilterType .

Created in NX11.0.0

License requirements: None.

Parameters
filterTypesValues from SelectObject.FilterType for specifying filters
unsafe void NXOpen.BlockStyler.SelectObject.AddFilter ( int  type,
int  subType,
int  solidBodyType 
)
inline

Adds the filter for select object block using type, subtype and solidBodyType

Created in NX8.5.0

License requirements: None.

Parameters
typeObject type. This can be one of the object types that are listed in uf_object_types.h. For example, for point, use UF_point_type in C++ and NXOpen.UF.UFConstants.UF_point_type in .NET.
subTypeObject subtype. This can either be -1 (UF_all_subtype) for any subtype, or a subtype of the selected type. The subtypes are listed in uf_object_types.h.
solidBodyTypeSolid body subtype. This is only meaningful when the type is UF_solid_type. In that case, this should be set to one of the solid type constants listed in uf_ui_types.h under "Constants for selection solid_type". When this is used, subtype does not matter. For example, to select any face, use UF_UI_SEL_FEATURE_ANY_FACE in C++ and NXOpen.UF.UFConstants.UF_UI_SEL_FEATURE_ANY_FACE in .NET
unsafe string [] NXOpen.BlockStyler.SelectObject.GetBalloonTooltipLayoutMembers ( )
inline

Gets the BalloonTooltipLayout members

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property.
unsafe string [] NXOpen.BlockStyler.SelectObject.GetInterpartSelectionMembers ( )
inline

Gets the InterpartSelection members

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property
unsafe NXOpen.TaggedObject [] NXOpen.BlockStyler.SelectObject.GetLastDeselectedObjects ( )
inline

Gets the LastDeselectedObjects

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property
unsafe NXOpen.TaggedObject [] NXOpen.BlockStyler.SelectObject.GetLastSelectedObjects ( )
inline

Gets the LastSelectedObjects

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property
unsafe string [] NXOpen.BlockStyler.SelectObject.GetMaximumScopeMembers ( )
inline

Gets the MaximumScope members

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property.
unsafe NXOpen.TaggedObject [] NXOpen.BlockStyler.SelectObject.GetSelectedObjects ( )
inline

Gets the SelectedObjects

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property
unsafe string [] NXOpen.BlockStyler.SelectObject.GetSelectModeMembers ( )
inline

Gets the SelectMode members

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property
unsafe string [] NXOpen.BlockStyler.SelectObject.GetStepStatusMembers ( )
inline

Gets the StepStatus members

Created in NX8.5.0

License requirements: None.

Returns
Value to get from the property
unsafe void NXOpen.BlockStyler.SelectObject.ResetFilter ( )
inline

Resets the filter for select object block

Created in NX8.5.0

License requirements: None.

unsafe void NXOpen.BlockStyler.SelectObject.SetSelectedObjects ( NXOpen.TaggedObject[]  objectVector)
inline

Sets the SelectedObjects

Created in NX8.5.0

License requirements: None.

Parameters
objectVectorValue to set for the property
unsafe void NXOpen.BlockStyler.SelectObject.SetSelectionFilter ( NXOpen.Selection.SelectionAction  maskAction,
NXOpen.Selection.MaskTriple[]  maskTriples 
)
inline

Sets the SelectionFilter

Created in NX8.5.0

License requirements: None.

Parameters
maskActionMask action
maskTriplesMask triples

Property Documentation

unsafe bool NXOpen.BlockStyler.SelectObject.AllowConvergentObject
getset

Returns or sets the AllowConvergentObject

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SelectObject.AutomaticProgression
getset

Returns or sets the AutomaticProgression

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.BalloonTooltipImage
getset

Returns or sets the BalloonTooltipImage

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.BalloonTooltipLayoutAsString
getset

Returns or sets the BalloonTooltipLayout as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.BalloonTooltipText
getset

Returns or sets the BalloonTooltipText

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.Bitmap
getset

Returns or sets the Bitmap

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SelectObject.BlendVirtualCurveOverlay
getset

Returns or sets the BlendVirtualCurveOverlay.

If true, virtual curve is displayed during preselection.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.BlockStyler.SelectObject.CreateInterpartLink
getset

Returns or sets the CreateInterpartLink

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.Cue
getset

Returns or sets the Cue

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.InterpartSelectionAsString
getset

Returns or sets the InterpartSelection as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.LabelString
getset

Returns or sets the LabelString

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.MaximumScopeAsString
getset

Returns or sets the MaximumScope as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point3d NXOpen.BlockStyler.SelectObject.PickPoint
get

Returns the PickPoint

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.BlockStyler.SelectObject.PointOverlay
getset

Returns or sets the PointOverlay.

If true,on the fly point creation is allowed.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.SelectModeAsString
getset

Returns or sets the SelectMode as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.SmartUpdateOptionAsString
getset

Returns or sets the update option for points created by the point overlay.

Acceptable values are:

  • Within Modeling The smart object updates within Modeling in time stamp order. For example, if the smart object is referenced by Feature(i), the smart object will update after Feature (i-1) and right before Feature(i).
  • After Modeling The smart object updates after Modeling. Use for Drafting dimensions and other objects outside Modeling.
  • After Parent Body The smart object will always update after the last feature on the parent body.
  • Mixed The smart object will update after the last feature on the parent body when the parent body is in a different part; updates within Modeling in time-stamp order for parents in the same part.

Created in NX8.5.1

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.SelectObject.SnapPointTypesEnabled
getset

Returns or sets the SnapPointTypesEnabled

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.BlockStyler.SelectObject.SnapPointTypesOnByDefault
getset

Returns or sets the SnapPointTypesOnByDefault

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.StepStatusAsString
getset

Returns or sets the StepStatus as string

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.BlockStyler.SelectObject.ToolTip
getset

Returns or sets the ToolTip

Created in NX8.5.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 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.